:doc:`MediaLive <../../medialive>` / Client / list_channel_placement_groups

*****************************
list_channel_placement_groups
*****************************



.. py:method:: MediaLive.Client.list_channel_placement_groups(**kwargs)

  Retrieve the list of ChannelPlacementGroups in the specified Cluster.

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/medialive-2017-10-14/ListChannelPlacementGroups>`_  


  **Request Syntax**
  ::

    response = client.list_channel_placement_groups(
        ClusterId='string',
        MaxResults=123,
        NextToken='string'
    )
    
  :type ClusterId: string
  :param ClusterId: **[REQUIRED]** The ID of the cluster

  
  :type MaxResults: integer
  :param MaxResults: The maximum number of items to return.

  
  :type NextToken: string
  :param NextToken: The token to retrieve the next page of results.

  
  
  :rtype: 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'
              },
          ],
          'NextToken': 'string'
      }
      
    **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 single Node that is associated with the ChannelPlacementGroup.
            

            - *(string) --* Placeholder documentation for __string
        
          

          - **State** *(string) --* The current state of the ChannelPlacementGroup.
      
    
      

      - **NextToken** *(string) --* Token for the next result.
  
  **Exceptions**
  
  *   :py:class:`MediaLive.Client.exceptions.BadRequestException`

  
  *   :py:class:`MediaLive.Client.exceptions.InternalServerErrorException`

  
  *   :py:class:`MediaLive.Client.exceptions.ForbiddenException`

  
  *   :py:class:`MediaLive.Client.exceptions.BadGatewayException`

  
  *   :py:class:`MediaLive.Client.exceptions.GatewayTimeoutException`

  
  *   :py:class:`MediaLive.Client.exceptions.TooManyRequestsException`

  