IVS / Client / get_ad_configuration

get_ad_configuration¶

IVS.Client.get_ad_configuration(**kwargs)¶

Gets the ad configuration represented by the specified ARN.

Request Syntax

response = client.get_ad_configuration(
    arn='string'
)

Parameters:

arn (string) –

[REQUIRED]

ARN of the ad configuration to be retrieved.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –
- adConfiguration (dict) –
  - 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) –

Exceptions

IVS.Client.exceptions.ResourceNotFoundException
IVS.Client.exceptions.InternalServerException
IVS.Client.exceptions.AccessDeniedException
IVS.Client.exceptions.ValidationException