MediaPackage / Client / list_channels

list_channels#

MediaPackage.Client.list_channels(**kwargs)#

Returns a collection of Channels.

See also: AWS API Documentation

Request Syntax

response = client.list_channels(
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • MaxResults (integer) – Upper bound on number of records to return.

  • NextToken (string) – A token used to resume pagination from the end of a previous request.

Return type:

dict

Returns:

Response Syntax

{
    'Channels': [
        {
            'Arn': 'string',
            'CreatedAt': 'string',
            'Description': 'string',
            'EgressAccessLogs': {
                'LogGroupName': 'string'
            },
            'HlsIngest': {
                'IngestEndpoints': [
                    {
                        'Id': 'string',
                        'Password': 'string',
                        'Url': 'string',
                        'Username': 'string'
                    },
                ]
            },
            'Id': 'string',
            'IngressAccessLogs': {
                'LogGroupName': 'string'
            },
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) – A collection of Channel records.

    • Channels (list) – A list of Channel records.

      • (dict) – A Channel resource configuration.

        • Arn (string) – The Amazon Resource Name (ARN) assigned to the Channel.

        • CreatedAt (string) – The date and time the Channel was created.

        • Description (string) – A short text description of the Channel.

        • EgressAccessLogs (dict) – Configure egress access logging.

          • LogGroupName (string) – Customize the log group name.

        • HlsIngest (dict) – An HTTP Live Streaming (HLS) ingest resource configuration.

          • IngestEndpoints (list) – A list of endpoints to which the source stream should be sent.

            • (dict) – An endpoint for ingesting source content for a Channel.

              • Id (string) – The system generated unique identifier for the IngestEndpoint

              • Password (string) – The system generated password for ingest authentication.

              • Url (string) – The ingest URL to which the source stream should be sent.

              • Username (string) – The system generated username for ingest authentication.

        • Id (string) – The ID of the Channel.

        • IngressAccessLogs (dict) – Configure ingress access logging.

          • LogGroupName (string) – Customize the log group name.

        • Tags (dict) – A collection of tags associated with a resource

          • (string) –

            • (string) –

    • NextToken (string) – A token that can be used to resume pagination from the end of the collection.

Exceptions

  • MediaPackage.Client.exceptions.UnprocessableEntityException

  • MediaPackage.Client.exceptions.InternalServerErrorException

  • MediaPackage.Client.exceptions.ForbiddenException

  • MediaPackage.Client.exceptions.NotFoundException

  • MediaPackage.Client.exceptions.ServiceUnavailableException

  • MediaPackage.Client.exceptions.TooManyRequestsException