MediaLive / Client / describe_channel_placement_group

describe_channel_placement_group#

MediaLive.Client.describe_channel_placement_group(**kwargs)#

Get details about a ChannelPlacementGroup.

Request Syntax

response = client.describe_channel_placement_group(
    ChannelPlacementGroupId='string',
    ClusterId='string'
)

Parameters:

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

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) – Details for one 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

MediaLive.Client.exceptions.BadRequestException
MediaLive.Client.exceptions.InternalServerErrorException
MediaLive.Client.exceptions.ForbiddenException
MediaLive.Client.exceptions.BadGatewayException
MediaLive.Client.exceptions.NotFoundException
MediaLive.Client.exceptions.GatewayTimeoutException
MediaLive.Client.exceptions.TooManyRequestsException