Skip to content

list_recording_configurations 

list_recording_configurations(
    *,
    config_overrides: Optional[ivsClientConfig] = None,
    next_token: Optional[PaginationToken] = None,
    max_results: Optional[MaxRecordingConfigurationResults] = None,
) -> ListRecordingConfigurationsResponse

Gets summary information about all recording configurations in your account, in the Amazon Web Services region where the API request is processed.

Parameters:

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

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

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

    Maximum number of recording configurations to return. Default: your service quota or 100, whichever is smaller.

Raises:

Source code in docs_src/capo_ivs/_services/ivs.py 
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
def list_recording_configurations(
    self,
    *,
    config_overrides: Optional[ivsClientConfig] = None,
    next_token: Optional["capo_ivs.types.pagination_token.PaginationToken"] = None,
    max_results: Optional[
        "capo_ivs.types.max_recording_configuration_results.MaxRecordingConfigurationResults"
    ] = None,
) -> "capo_ivs.types.list_recording_configurations_response.ListRecordingConfigurationsResponse":
    """<p>Gets summary information about all recording configurations in your account, in the Amazon Web Services region where the API request is processed.</p>

    Args:
        next_token: <p>The first recording configuration to retrieve. This is used for pagination; see the <code>nextToken</code> response field.</p>
        max_results: <p>Maximum number of recording configurations to return. Default: your service quota or 100, whichever is smaller. </p>

    Raises:
        capo_ivs.errors.access_denied_exception.AccessDeniedException: <p>User does not have sufficient access to perform this action.</p>
        capo_ivs.errors.internal_server_exception.InternalServerException: <p>Unexpected error during processing of request.</p>
        capo_ivs.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_ivs.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ivs.types.list_recording_configurations_request.ListRecordingConfigurationsRequest]",
    ) -> OperationResponse[
        "capo_ivs.types.list_recording_configurations_response.ListRecordingConfigurationsResponse"
    ]:
        import capo_ivs._operations.amazon_interactive_video_service.list_recording_configurations

        output, http_response = (
            capo_ivs._operations.amazon_interactive_video_service.list_recording_configurations.list_recording_configurations(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListRecordingConfigurations")
    )
    input_: capo_ivs.types.list_recording_configurations_request.ListRecordingConfigurationsRequest = {}
    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