mediapackagev2 / Client / list_channel_groups

list_channel_groups#

mediapackagev2.Client.list_channel_groups(**kwargs)#

Retrieves all channel groups that are configured in AWS Elemental MediaPackage, including the channels and origin endpoints that are associated with it.

Request Syntax

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

Parameters:

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': [
        {
            'ChannelGroupName': 'string',
            'Arn': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'ModifiedAt': datetime(2015, 1, 1),
            'Description': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- Items (list) –
  
  The objects being returned.
  - (dict) –
    
    The configuration of the 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.
    - Arn (string) –
      
      The Amazon Resource Name (ARN) associated with the resource.
    - CreatedAt (datetime) –
      
      The date and time the channel group was created.
    - ModifiedAt (datetime) –
      
      The date and time the channel group was modified.
    - Description (string) –
      
      Any descriptive information that you want to add to the channel group for future identification purposes.
- NextToken (string) –
  
  The pagination token from the GET list request. Use the token to fetch the next page of results.

Exceptions

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