describe_channel

describe_channel(**kwargs)

Gets details about a Channel.

See also: AWS API Documentation

Request Syntax

response = client.describe_channel(
    Id='string'
)
Parameters
Id (string) -- [REQUIRED] The ID of a Channel.
Return type
dict
Returns
Response Syntax
{
    'Arn': 'string',
    'Description': 'string',
    'EgressAccessLogs': {
        'LogGroupName': 'string'
    },
    'HlsIngest': {
        'IngestEndpoints': [
            {
                'Id': 'string',
                'Password': 'string',
                'Url': 'string',
                'Username': 'string'
            },
        ]
    },
    'Id': 'string',
    'IngressAccessLogs': {
        'LogGroupName': 'string'
    },
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) -- A Channel record.
    • Arn (string) -- The Amazon Resource Name (ARN) assigned to the Channel.
    • 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) --

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