MediaLive / Client / create_channel_placement_group

create_channel_placement_group#

MediaLive.Client.create_channel_placement_group(**kwargs)#

Create a ChannelPlacementGroup in the specified Cluster. As part of the create operation, you specify the Nodes to attach the group to.After you create a ChannelPlacementGroup, you add Channels to the group (you do this by modifying the Channels to add them to a specific group). You now have an association of Channels to ChannelPlacementGroup, and ChannelPlacementGroup to Nodes. This association means that all the Channels in the group are able to run on any of the Nodes associated with the group.

See also: AWS API Documentation

Request Syntax

response = client.create_channel_placement_group(
    ClusterId='string',
    Name='string',
    Nodes=[
        'string',
    ],
    RequestId='string',
    Tags={
        'string': 'string'
    }
)
Parameters:

  • ClusterId (string) – [REQUIRED] The ID of the cluster.

  • Name (string) – Specify a name that is unique in the Cluster. You can’t change the name. Names are case-sensitive.

  • Nodes (list) –

    An array of one ID for the Node that you want to associate with the ChannelPlacementGroup. (You can’t associate more than one Node with the ChannelPlacementGroup.) The Node and the ChannelPlacementGroup must be in the same Cluster.

    • (string) – Placeholder documentation for __string

  • RequestId (string) – An ID that you assign to a create request. This ID ensures idempotency when creating resources. the request.This field is autopopulated if not provided.

  • Tags (dict) –

    A collection of key-value pairs.

    • (string) – Placeholder documentation for __string

      • (string) – Placeholder documentation for __string

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'Channels': [
        'string',
    ],
    'ClusterId': 'string',
    'Id': 'string',
    'Name': 'string',
    'Nodes': [
        'string',
    ],
    'State': 'UNASSIGNED'|'ASSIGNING'|'ASSIGNED'|'DELETING'|'DELETE_FAILED'|'DELETED'|'UNASSIGNING'
}

Response Structure

  • (dict) – Successfully created the channel placement group.

    • Arn (string) – The ARN of this ChannelPlacementGroup. It is automatically assigned when the ChannelPlacementGroup is created.

    • Channels (list) – Used in ListChannelPlacementGroupsResult

      • (string) – Placeholder documentation for __string

    • ClusterId (string) – The ID of the Cluster that the Node belongs to.

    • Id (string) – The ID of the ChannelPlacementGroup. Unique in the AWS account. The ID is the resource-id portion of the ARN.

    • Name (string) – The name that you specified for the ChannelPlacementGroup.

    • Nodes (list) – An array with one item, which is the signle Node that is associated with the ChannelPlacementGroup.

      • (string) – Placeholder documentation for __string

    • State (string) – The current state of the ChannelPlacementGroup.

Exceptions