mediapackagev2 / Paginator / ListOriginEndpoints

ListOriginEndpoints#

class mediapackagev2.Paginator.ListOriginEndpoints#

paginator = client.get_paginator('list_origin_endpoints')

paginate(**kwargs)#

Creates an iterator that will paginate through responses from mediapackagev2.Client.list_origin_endpoints().

Request Syntax

response_iterator = paginator.paginate(
    ChannelGroupName='string',
    ChannelName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

ChannelGroupName (string) –
[REQUIRED]

The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
ChannelName (string) –
[REQUIRED]

The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
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',
            'ChannelGroupName': 'string',
            'ChannelName': 'string',
            'OriginEndpointName': 'string',
            'ContainerType': 'TS'|'CMAF',
            'Description': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'ModifiedAt': datetime(2015, 1, 1),
            'HlsManifests': [
                {
                    'ManifestName': 'string',
                    'ChildManifestName': 'string',
                    'Url': 'string'
                },
            ],
            'LowLatencyHlsManifests': [
                {
                    'ManifestName': 'string',
                    'ChildManifestName': 'string',
                    'Url': 'string'
                },
            ],
            'DashManifests': [
                {
                    'ManifestName': 'string',
                    'Url': 'string'
                },
            ],
            'ForceEndpointErrorConfiguration': {
                'EndpointErrorConditions': [
                    'STALE_MANIFEST'|'INCOMPLETE_MANIFEST'|'MISSING_DRM_KEY'|'SLATE_INPUT',
                ]
            }
        },
    ],

}

Response Structure

(dict) –
- Items (list) –
  
  The objects being returned.
  - (dict) –
    
    The configuration of the origin endpoint.
    - Arn (string) –
      
      The Amazon Resource Name (ARN) associated with the resource.
    - ChannelGroupName (string) –
      
      The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
    - ChannelName (string) –
      
      The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
    - OriginEndpointName (string) –
      
      The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.
    - ContainerType (string) –
      
      The type of container attached to this origin endpoint. A container type is a file format that encapsulates one or more media streams, such as audio and video, into a single file.
    - Description (string) –
      
      Any descriptive information that you want to add to the origin endpoint for future identification purposes.
    - CreatedAt (datetime) –
      
      The date and time the origin endpoint was created.
    - ModifiedAt (datetime) –
      
      The date and time the origin endpoint was modified.
    - HlsManifests (list) –
      
      An HTTP live streaming (HLS) manifest configuration.
      - (dict) –
        
        List the HTTP live streaming (HLS) manifest configuration.
        
        ManifestName (string) –
        
        A short short string that’s appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don’t enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can’t use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.
        
        ChildManifestName (string) –
        
        A short string that’s appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don’t enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.
        
        Url (string) –
        
        The egress domain URL for stream delivery from MediaPackage.
    - LowLatencyHlsManifests (list) –
      
      A low-latency HLS manifest configuration.
      - (dict) –
        
        List the low-latency HTTP live streaming (HLS) manifest configuration.
        
        ManifestName (string) –
        
        A short short string that’s appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don’t enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can’t use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.
        
        ChildManifestName (string) –
        
        A short string that’s appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don’t enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.
        
        Url (string) –
        
        The egress domain URL for stream delivery from MediaPackage.
    - DashManifests (list) –
      
      A DASH manifest configuration.
      - (dict) –
        
        List the DASH manifest configuration.
        
        ManifestName (string) –
        
        A short string that’s appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don’t enter a value, MediaPackage uses the default manifest name, index.
        
        Url (string) –
        
        The egress domain URL for stream delivery from MediaPackage.
    - ForceEndpointErrorConfiguration (dict) –
      
      The failover settings for the endpoint.
      - EndpointErrorConditions (list) –
        
        The failover conditions for the endpoint. The options are:
        
        STALE_MANIFEST - The manifest stalled and there are no new segments or parts.
        
        INCOMPLETE_MANIFEST - There is a gap in the manifest.
        
        MISSING_DRM_KEY - Key rotation is enabled but we’re unable to fetch the key for the current key period.
        
        SLATE_INPUT - The segments which contain slate content are considered to be missing content.
        
        (string) –