mediapackagev2 / Client / get_channel

get_channel#

mediapackagev2.Client.get_channel(**kwargs)#

Retrieves the specified channel that’s configured in AWS Elemental MediaPackage, including the origin endpoints that are associated with it.

See also: AWS API Documentation

Request Syntax

response = client.get_channel(
    ChannelGroupName='string',
    ChannelName='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.

  • ChannelName (string) –

    [REQUIRED]

    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.

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'ChannelName': 'string',
    'ChannelGroupName': 'string',
    'CreatedAt': datetime(2015, 1, 1),
    'ModifiedAt': datetime(2015, 1, 1),
    'Description': 'string',
    'IngestEndpoints': [
        {
            'Id': 'string',
            'Url': 'string'
        },
    ],
    'InputType': 'HLS'|'CMAF',
    'ETag': 'string',
    'Tags': {
        'string': 'string'
    },
    'InputSwitchConfiguration': {
        'MQCSInputSwitching': True|False
    },
    'OutputHeaderConfiguration': {
        'PublishMQCS': True|False
    }
}

Response Structure

  • (dict) –

    • 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) –

      The description for your channel.

    • IngestEndpoints (list) –

      The list of ingest endpoints.

      • (dict) –

        The ingest domain URL where the source stream should be sent.

        • Id (string) –

          The system-generated unique identifier for the IngestEndpoint.

        • Url (string) –

          The ingest domain URL where the source stream should be sent.

    • InputType (string) –

      The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.

      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).

    • ETag (string) –

      The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.

    • Tags (dict) –

      The comma-separated list of tag key:value pairs assigned to the channel.

      • (string) –

        • (string) –

    • InputSwitchConfiguration (dict) –

      The configuration for input switching based on the media quality confidence score (MQCS) as provided from AWS Elemental MediaLive. This setting is valid only when InputType is CMAF.

      • MQCSInputSwitching (boolean) –

        When true, AWS Elemental MediaPackage performs input switching based on the MQCS. Default is true. This setting is valid only when InputType is CMAF.

    • OutputHeaderConfiguration (dict) –

      The settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN. This setting is valid only when InputType is CMAF.

      • PublishMQCS (boolean) –

        When true, AWS Elemental MediaPackage includes the MQCS in responses to the CDN. This setting is valid only when InputType is CMAF.

Exceptions