IVS / Paginator / ListRecordingConfigurations


class IVS.Paginator.ListRecordingConfigurations#
paginator = client.get_paginator('list_recording_configurations')

Creates an iterator that will paginate through responses from IVS.Client.list_recording_configurations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:



Response Syntax

    'recordingConfigurations': [
            'arn': 'string',
            'destinationConfiguration': {
                's3': {
                    'bucketName': 'string'
            'name': 'string',
            'state': 'CREATING'|'CREATE_FAILED'|'ACTIVE',
            'tags': {
                'string': 'string'
    'NextToken': 'string'

Response Structure

  • (dict) –

    • recordingConfigurations (list) –

      List of the matching recording configurations.

      • (dict) –

        Summary information about a RecordingConfiguration.

        • arn (string) –

          Recording-configuration ARN.

        • destinationConfiguration (dict) –

          A complex type that contains information about where recorded video will be stored.

          • s3 (dict) –

            An S3 destination configuration where recorded videos will be stored.

            • bucketName (string) –

              Location (S3 bucket name) where recorded videos will be stored.

        • name (string) –

          Recording-configuration name. The value does not need to be unique.

        • state (string) –

          Indicates the current state of the recording configuration. When the state is ACTIVE, the configuration is ready for recording a channel stream.

        • tags (dict) –

          Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and “Tag naming limits and requirements”; Amazon IVS has no service-specific constraints beyond what is documented there.

          • (string) –

            • (string) –

    • NextToken (string) –

      A token to resume pagination.