Skip to content

list_stages async

list_stages(
    *,
    config_overrides: Optional[AsyncIVSRealTimeClientConfig] = None,
    next_token: Optional[PaginationToken] = None,
    max_results: Optional[MaxStageResults] = None,
) -> ListStagesResponse

Gets summary information about all stages in your account, in the AWS region where the API request is processed.

Parameters:

  • next_token (Optional[PaginationToken], default: None ) –

    The first stage to retrieve. This is used for pagination; see the nextToken response field.

  • max_results (Optional[MaxStageResults], default: None ) –

    Maximum number of results to return. Default: 50.

Raises:

Source code in docs_src/capo_ivs_realtime/_services/async_ivs_real_time.py
async def list_stages(
    self,
    *,
    config_overrides: Optional[AsyncIVSRealTimeClientConfig] = None,
    next_token: Optional[
        "capo_ivs_realtime.types.pagination_token.PaginationToken"
    ] = None,
    max_results: Optional[
        "capo_ivs_realtime.types.max_stage_results.MaxStageResults"
    ] = None,
) -> "capo_ivs_realtime.types.list_stages_response.ListStagesResponse":
    """<p>Gets summary information about all stages in your account, in the AWS region where the API request is processed.</p>

    Args:
        next_token: <p>The first stage to retrieve. This is used for pagination; see the <code>nextToken</code> response field.</p>
        max_results: <p>Maximum number of results to return. Default: 50.</p>

    Raises:
        capo_ivs_realtime.errors.access_denied_exception.AccessDeniedException: <p>User does not have sufficient access to perform this action.</p>
        capo_ivs_realtime.errors.conflict_exception.ConflictException: <p>Updating or deleting a resource can cause an inconsistent state.</p>
        capo_ivs_realtime.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_ivs_realtime.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_ivs_realtime.types.list_stages_request.ListStagesRequest]",
    ) -> AsyncOperationResponse[
        "capo_ivs_realtime.types.list_stages_response.ListStagesResponse"
    ]:
        import capo_ivs_realtime._operations.amazon_interactive_video_service_real_time.list_stages

        (
            output,
            http_response,
        ) = await capo_ivs_realtime._operations.amazon_interactive_video_service_real_time.list_stages.async_list_stages(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListStages")
    )
    input_: capo_ivs_realtime.types.list_stages_request.ListStagesRequest = {}
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output