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, including the origin endpoints that are associated with it.

See also: AWS API Documentation

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

    • NextToken (string) –

      The pagination token from the GET list request.

Exceptions

  • mediapackagev2.Client.exceptions.ThrottlingException

  • mediapackagev2.Client.exceptions.InternalServerException

  • mediapackagev2.Client.exceptions.AccessDeniedException

  • mediapackagev2.Client.exceptions.ValidationException