MediaLive / Client / update_channel_placement_group

update_channel_placement_group#

MediaLive.Client.update_channel_placement_group(**kwargs)#

Change the settings for a ChannelPlacementGroup.

See also: AWS API Documentation

Request Syntax

response = client.update_channel_placement_group(
    ChannelPlacementGroupId='string',
    ClusterId='string',
    Name='string',
    Nodes=[
        'string',
    ]
)
Parameters:

  • ChannelPlacementGroupId (string) – [REQUIRED] The ID of the channel placement group.

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

  • Name (string) – Include this parameter only if you want to change the current name of the ChannelPlacementGroup. Specify a name that is unique in the Cluster. You can’t change the name. Names are case-sensitive.

  • Nodes (list) –

    Include this parameter only if you want to change the list of Nodes that are associated with the ChannelPlacementGroup.

    • (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) – The channel placement group has been successfully updated.

    • 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