list_compositions ¶

def list_compositions(
    self,
    *,
    config_overrides: Optional[IVSRealTimeClientConfig] = None,
    filter_by_stage_arn: Optional[
        "capo_ivs_realtime.types.stage_arn.StageArn"
    ] = None,
    filter_by_encoder_configuration_arn: Optional[
        "capo_ivs_realtime.types.encoder_configuration_arn.EncoderConfigurationArn"
    ] = None,
    next_token: Optional[
        "capo_ivs_realtime.types.pagination_token.PaginationToken"
    ] = None,
    max_results: Optional[
        "capo_ivs_realtime.types.max_composition_results.MaxCompositionResults"
    ] = None,
) -> "capo_ivs_realtime.types.list_compositions_response.ListCompositionsResponse":
    """<p>Gets summary information about all Compositions in your account, in the AWS region where the API request is processed. </p>

    Args:
        filter_by_stage_arn: <p>Filters the Composition list to match the specified Stage ARN.</p>
        filter_by_encoder_configuration_arn: <p>Filters the Composition list to match the specified EncoderConfiguration attached to at least one of its output.</p>
        next_token: <p>The first Composition 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: 100.</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.internal_server_exception.InternalServerException: <p>Unexpected error during processing of request.</p>
        capo_ivs_realtime.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>Request would cause a service quota to be exceeded.</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.
    """

    def _handler(
        req: "OperationRequest[capo_ivs_realtime.types.list_compositions_request.ListCompositionsRequest]",
    ) -> OperationResponse[
        "capo_ivs_realtime.types.list_compositions_response.ListCompositionsResponse"
    ]:
        import capo_ivs_realtime._operations.amazon_interactive_video_service_real_time.list_compositions

        output, http_response = (
            capo_ivs_realtime._operations.amazon_interactive_video_service_real_time.list_compositions.list_compositions(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListCompositions")
    )
    input_: capo_ivs_realtime.types.list_compositions_request.ListCompositionsRequest = {}
    if filter_by_stage_arn is not None:
        input_["filter_by_stage_arn"] = filter_by_stage_arn
    if filter_by_encoder_configuration_arn is not None:
        input_["filter_by_encoder_configuration_arn"] = (
            filter_by_encoder_configuration_arn
        )
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output