list_recording_configurations

IVS.Client.list_recording_configurations(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_recording_configurations(
    maxResults=123,
    nextToken='string'
)

Parameters

• maxResults (integer) -- Maximum number of recording configurations to return. Default: your service quota or 100, whichever is smaller.
• nextToken (string) -- The first recording configuration to retrieve. This is used for pagination; see the nextToken response field.

Return type

dict

Returns

Response Syntax

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

Response Structure

• (dict) --

  • nextToken (string) --

    If there are more recording configurations than maxResults , use nextToken in the request to get the next set.

  • 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) --

Exceptions

• IVS.Client.exceptions.InternalServerException
• IVS.Client.exceptions.AccessDeniedException
• IVS.Client.exceptions.ValidationException