IVS / Client / list_ad_configurations

list_ad_configurations

IVS.Client.list_ad_configurations(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• nextToken (string) – The first ad configuration to retrieve. This is used for pagination; see the nextToken response field.

• maxResults (integer) – Maximum number of ad configurations to return. Default: your service quota or 100, whichever is smaller.

Return type:

dict

Returns:

Response Syntax

{
    'adConfigurations': [
        {
            'arn': 'string',
            'name': 'string',
            'mediaTailorPlaybackConfigurations': [
                {
                    'playbackConfigurationArn': 'string'
                },
            ],
            'tags': {
                'string': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) –

  • adConfigurations (list) –

    List of the matching ad configurations.

    • (dict) –

      Summary information about an ad configuration.

      • arn (string) –

        Ad configuration ARN.

      • name (string) –

        Ad configuration name. Defaults to “”.

      • mediaTailorPlaybackConfigurations (list) –

        List of integration configurations with media tailor resources.

        • (dict) –

          Object specifying a configuration for integration with an AWS Elemental MediaTailor (EMT).

          • playbackConfigurationArn (string) –

            ARN of the customer-created EMT PlaybackConfiguration resource in the same region and account.

      • tags (dict) –

        Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, 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) –

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

Exceptions

• IVS.Client.exceptions.InternalServerException

• IVS.Client.exceptions.AccessDeniedException

• IVS.Client.exceptions.ValidationException