MediaTailor / Client / describe_vod_source

describe_vod_source

MediaTailor.Client.describe_vod_source(**kwargs)

Provides details about a specific video on demand (VOD) source in a specific source location.

See also: AWS API Documentation

Request Syntax

response = client.describe_vod_source(
    SourceLocationName='string',
    VodSourceName='string'
)

Parameters:

• SourceLocationName (string) –

  [REQUIRED]

  The name of the source location associated with this VOD Source.

• VodSourceName (string) –

  [REQUIRED]

  The name of the VOD Source.

Return type:

dict

Returns:

Response Syntax

{
    'AdBreakOpportunities': [
        {
            'OffsetMillis': 123
        },
    ],
    'Arn': 'string',
    'CreationTime': datetime(2015, 1, 1),
    'HttpPackageConfigurations': [
        {
            'Path': 'string',
            'SourceGroup': 'string',
            'Type': 'DASH'|'HLS'
        },
    ],
    'LastModifiedTime': datetime(2015, 1, 1),
    'SourceLocationName': 'string',
    'Tags': {
        'string': 'string'
    },
    'VodSourceName': 'string'
}

Response Structure

• (dict) –

  • AdBreakOpportunities (list) –

    The ad break opportunities within the VOD source.

    • (dict) –

      A location at which a zero-duration ad marker was detected in a VOD source manifest.

      • OffsetMillis (integer) –

        The offset in milliseconds from the start of the VOD source at which an ad marker was detected.

  • Arn (string) –

    The ARN of the VOD source.

  • CreationTime (datetime) –

    The timestamp that indicates when the VOD source was created.

  • HttpPackageConfigurations (list) –

    The HTTP package configurations.

    • (dict) –

      The HTTP package configuration properties for the requested VOD source.

      • Path (string) –

        The relative path to the URL for this VOD source. This is combined with SourceLocation::HttpConfiguration::BaseUrl to form a valid URL.

      • SourceGroup (string) –

        The name of the source group. This has to match one of the Channel::Outputs::SourceGroup.

      • Type (string) –

        The streaming protocol for this package configuration. Supported values are HLS and DASH.

  • LastModifiedTime (datetime) –

    The last modified time of the VOD source.

  • SourceLocationName (string) –

    The name of the source location associated with the VOD source.

  • Tags (dict) –

    The tags assigned to the VOD source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.

    • (string) –

      • (string) –

  • VodSourceName (string) –

    The name of the VOD source.