MediaTailor / Client / list_vod_sources

list_vod_sources

MediaTailor.Client.list_vod_sources(**kwargs)

Lists the VOD sources contained in a source location. A source represents a piece of content.

See also: AWS API Documentation

Request Syntax

response = client.list_vod_sources(
    MaxResults=123,
    NextToken='string',
    SourceLocationName='string'
)

Parameters:

• MaxResults (integer) –

  The maximum number of VOD sources that you want MediaTailor to return in response to the current request. If there are more than MaxResults VOD sources, use the value of NextToken in the response to get the next page of results.

  The default value is 100. MediaTailor uses DynamoDB-based pagination, which means that a response might contain fewer than MaxResults items, including 0 items, even when more results are available. To retrieve all results, you must continue making requests using the NextToken value from each response until the response no longer includes a NextToken value.

• NextToken (string) –

  Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

  For the first ListVodSources request, omit this value. For subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request. Continue making requests until the response no longer includes a NextToken value, which indicates that all results have been retrieved.

• SourceLocationName (string) –

  [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'Items': [
        {
            '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'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • Items (list) –

    Lists the VOD sources.

    • (dict) –

      VOD source configuration parameters.

      • Arn (string) –

        The ARN for the VOD source.

      • CreationTime (datetime) –

        The timestamp that indicates when the VOD source was created.

      • HttpPackageConfigurations (list) –

        The HTTP package configurations for the VOD source.

        • (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 timestamp that indicates when the VOD source was last modified.

      • SourceLocationName (string) –

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

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

  • NextToken (string) –

    Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.