:doc:`mediapackagev2 <../../mediapackagev2>` / Client / list_channel_groups

*******************
list_channel_groups
*******************



.. py:method:: mediapackagev2.Client.list_channel_groups(**kwargs)

  

  Retrieves all channel groups that are configured in Elemental MediaPackage.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/ListChannelGroups>`_  


  **Request Syntax**
  ::

    response = client.list_channel_groups(
        MaxResults=123,
        NextToken='string'
    )
    
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of results to return in the response.

    

  
  :type NextToken: string
  :param NextToken: 

    The pagination token from the GET list request. Use the token to fetch the next page of results.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'Items': [
              {
                  'ChannelGroupName': 'string',
                  'Arn': 'string',
                  'CreatedAt': datetime(2015, 1, 1),
                  'ModifiedAt': datetime(2015, 1, 1),
                  'Description': 'string'
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Items** *(list) --* 

        The objects being returned.

        
        

        - *(dict) --* 

          The configuration of the channel group.

          
          

          - **ChannelGroupName** *(string) --* 

            The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

            
          

          - **Arn** *(string) --* 

            The Amazon Resource Name (ARN) associated with the resource.

            
          

          - **CreatedAt** *(datetime) --* 

            The date and time the channel group was created.

            
          

          - **ModifiedAt** *(datetime) --* 

            The date and time the channel group was modified.

            
          

          - **Description** *(string) --* 

            Any descriptive information that you want to add to the channel group for future identification purposes.

            
      
    
      

      - **NextToken** *(string) --* 

        The pagination token from the GET list request. Use the token to fetch the next page of results.

        
  
  **Exceptions**
  
  *   :py:class:`mediapackagev2.Client.exceptions.ThrottlingException`

  
  *   :py:class:`mediapackagev2.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`mediapackagev2.Client.exceptions.InternalServerException`

  
  *   :py:class:`mediapackagev2.Client.exceptions.ValidationException`

  