MediaLive / Paginator / ListChannelPlacementGroups

ListChannelPlacementGroups

class MediaLive.Paginator.ListChannelPlacementGroups

paginator = client.get_paginator('list_channel_placement_groups')

paginate(**kwargs)

Creates an iterator that will paginate through responses from MediaLive.Client.list_channel_placement_groups().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ClusterId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

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

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

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

}

Response Structure

• (dict) – An array of channel placement groups.

  • ChannelPlacementGroups (list) – An array of ChannelPlacementGroups that exist in the Cluster.

    • (dict) – Contains the response for ListChannelPlacementGroups

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