mediapackagev2 / Client / list_channels

list_channels¶

mediapackagev2.Client.list_channels(**kwargs)¶

Retrieves all channels in a specific channel group that are configured in AWS Elemental MediaPackage.

Request Syntax

response = client.list_channels(
    ChannelGroupName='string',
    MaxResults=123,
    NextToken='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.
MaxResults (integer) – The maximum number of results to return in the response.
NextToken (string) – The pagination token from the GET list request. Use the token to fetch the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'Items': [
        {
            'Arn': 'string',
            'ChannelName': 'string',
            'ChannelGroupName': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'ModifiedAt': datetime(2015, 1, 1),
            'Description': 'string',
            'InputType': 'HLS'|'CMAF'|'MULTIVIEW',
            'OutputLockingMode': 'EPOCH_LOCKED'|'NON_EPOCH_LOCKED',
            'MultiviewConfiguration': {
                'AvailableSources': [
                    'string',
                ],
                'AvailableLayouts': [
                    'LAYOUT_2EH'|'LAYOUT_2PL'|'LAYOUT_3EL'|'LAYOUT_3PL'|'LAYOUT_4E'|'LAYOUT_4PL',
                ]
            },
            'AttachedMultiviewChannels': [
                'string',
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- Items (list) –
  
  The objects being returned.
  - (dict) –
    
    The configuration of the channel.
    - Arn (string) –
      
      The Amazon Resource Name (ARN) associated with the resource.
    - 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.
    - 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.
    - CreatedAt (datetime) –
      
      The date and time the channel was created.
    - ModifiedAt (datetime) –
      
      The date and time the channel was modified.
    - Description (string) –
      
      Any descriptive information that you want to add to the channel for future identification purposes.
    - InputType (string) –
      
      The input type is an immutable field. It defines whether the channel allows CMAF ingest, HLS ingest, or server-side multiview output. Multiview channels receive no ingest of their own. If unprovided, the value defaults to HLS.
      
      The allowed values are:
      - HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).
      - CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).
      - MULTIVIEW – Server-side multiview. The channel receives no ingest of its own. Instead, it composites video from the source channels in its MultiviewConfiguration into a single tiled output stream.
    - OutputLockingMode (string) –
      
      The output locking mode configured for the channel.
      
      The allowed values are:
      - EPOCH_LOCKED - The channel uses epoch-locked behavior with deterministic sequence numbering and fixed segment boundaries aligned to epoch time.
      - NON_EPOCH_LOCKED - The channel uses non-epoch-locked behavior with duration-based segment combining and monotonically increasing sequence numbers starting from 0.
    - MultiviewConfiguration (dict) –
      
      The multiview configuration for the channel. This is present only when InputType is MULTIVIEW.
      - AvailableSources (list) –
        
        The channels that players can use as tiles in this multiview channel’s output. Each source channel must be in the same channel group as the multiview channel, and must have an InputType of CMAF. Only the channels that you list here are available as tiles.
        
        (string) –
      - AvailableLayouts (list) –
        
        The tile layouts that players can request from this multiview channel’s origin endpoints. Only the layouts that you list here are available. Each layout must appear at most once.
        
        (string) –
        
        A tile layout for a multiview channel. Each layout determines how many source tiles are composited into the output and how those tiles are arranged.
        
        The allowed values are:
        
        LAYOUT_SINGLE – One tile at full resolution. Use this to serve a single source as a standard stream.
        
        LAYOUT_2EH – Two tiles of equal size, arranged horizontally.
        
        LAYOUT_2PL – Two tiles, with one larger primary tile.
        
        LAYOUT_3EB – Three tiles of equal size, with two on top and one below.
        
        LAYOUT_3EL – Three tiles of equal size, arranged in two columns.
        
        LAYOUT_3PL – Three tiles, with one larger primary tile on the left and two stacked on the right.
        
        LAYOUT_4E – Four tiles of equal size, arranged in a two-by-two grid.
        
        LAYOUT_4PL – Four tiles, with one larger primary tile on the left and three stacked on the right.
    - AttachedMultiviewChannels (list) –
      
      The multiview channels, in the same channel group, that list this channel as an available source. This is a read-only field.
      - (string) –
- NextToken (string) –
  
  The pagination token from the GET list request.

Exceptions

mediapackagev2.Client.exceptions.ThrottlingException
mediapackagev2.Client.exceptions.AccessDeniedException
mediapackagev2.Client.exceptions.InternalServerException
mediapackagev2.Client.exceptions.ValidationException
mediapackagev2.Client.exceptions.ResourceNotFoundException