MediaTailor / Paginator / ListVodSources

ListVodSources#

class MediaTailor.Paginator.ListVodSources#
paginator = client.get_paginator('list_vod_sources')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from MediaTailor.Client.list_vod_sources().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    SourceLocationName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • SourceLocationName (string) –

    [REQUIRED]

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

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

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'
        },
    ],

}

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.