mediapackagev2 / Client / create_channel_group

create_channel_group#

mediapackagev2.Client.create_channel_group(**kwargs)#

Create a channel group to group your channels and origin endpoints. A channel group is the top-level resource that consists of channels and origin endpoints that are associated with it and that provides predictable URLs for stream delivery. All channels and origin endpoints within the channel group are guaranteed to share the DNS. You can create only one channel group with each request.

See also: AWS API Documentation

Request Syntax

response = client.create_channel_group(
    ChannelGroupName='string',
    ClientToken='string',
    Description='string',
    Tags={
        'string': '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. You can’t use spaces in the name. You can’t change the name after you create the channel group.

  • ClientToken (string) –

    A unique, case-sensitive token that you provide to ensure the idempotency of the request.

    This field is autopopulated if not provided.

  • Description (string) – Enter any descriptive text that helps you to identify the channel group.

  • Tags (dict) –

    A comma-separated list of tag key:value pairs that you define. For example:

    "Key1": "Value1",

    "Key2": "Value2"

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'ChannelGroupName': 'string',
    'Arn': 'string',
    'EgressDomain': 'string',
    'CreatedAt': datetime(2015, 1, 1),
    'ModifiedAt': datetime(2015, 1, 1),
    'ETag': 'string',
    'Description': 'string',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) –

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

    • Arn (string) –

      The Amazon Resource Name (ARN) associated with the resource.

    • EgressDomain (string) –

      The output domain where the source stream should be sent. Integrate the egress domain with a downstream CDN (such as Amazon CloudFront) or playback device.

    • CreatedAt (datetime) –

      The date and time the channel group was created.

    • ModifiedAt (datetime) –

      The date and time the channel group was modified.

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

    • Description (string) –

      The description for your channel group.

    • Tags (dict) –

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

      • (string) –

        • (string) –

Exceptions