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'
        },
    ],
    'ETag': 'string',
    'Tags': {
        'string': 'string'
    }
}

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.

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

Exceptions

• mediapackagev2.Client.exceptions.ThrottlingException

• mediapackagev2.Client.exceptions.InternalServerException

• mediapackagev2.Client.exceptions.AccessDeniedException

• mediapackagev2.Client.exceptions.ValidationException

• mediapackagev2.Client.exceptions.ResourceNotFoundException