mediapackagev2 / Client / update_channel_group

update_channel_group#

mediapackagev2.Client.update_channel_group(**kwargs)#

Update the specified channel group. You can edit the description on a channel group for easier identification later from the AWS Elemental MediaPackage console. You can’t edit the name of the channel group.

Any edits you make that impact the video output may not be reflected for a few minutes.

See also: AWS API Documentation

Request Syntax

response = client.update_channel_group(
    ChannelGroupName='string',
    ETag='string',
    Description='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.

  • ETag (string) – The expected current Entity Tag (ETag) for the resource. If the specified ETag does not match the resource’s current entity tag, the update request will be rejected.

  • Description (string) – Any descriptive information that you want to add to the channel group for future identification purposes.

Return type:

dict

Returns:

Response Syntax

{
    'ChannelGroupName': 'string',
    'Arn': 'string',
    'EgressDomain': 'string',
    'CreatedAt': datetime(2015, 1, 1),
    'ModifiedAt': datetime(2015, 1, 1),
    'Description': 'string',
    'ETag': '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 is sent. Integrate the 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.

    • Description (string) –

      The description for your channel group.

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

      • (string) –

        • (string) –

Exceptions

  • mediapackagev2.Client.exceptions.ThrottlingException

  • mediapackagev2.Client.exceptions.ConflictException

  • mediapackagev2.Client.exceptions.InternalServerException

  • mediapackagev2.Client.exceptions.AccessDeniedException

  • mediapackagev2.Client.exceptions.ValidationException

  • mediapackagev2.Client.exceptions.ResourceNotFoundException