:doc:`LookoutEquipment <../../lookoutequipment>` / Client / list_label_groups

*****************
list_label_groups
*****************



.. py:method:: LookoutEquipment.Client.list_label_groups(**kwargs)

  

  Returns a list of the label groups.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListLabelGroups>`_  


  **Request Syntax**
  ::

    response = client.list_label_groups(
        LabelGroupNameBeginsWith='string',
        NextToken='string',
        MaxResults=123
    )
    
  :type LabelGroupNameBeginsWith: string
  :param LabelGroupNameBeginsWith: 

    The beginning of the name of the label groups to be listed.

    

  
  :type NextToken: string
  :param NextToken: 

    An opaque pagination token indicating where to continue the listing of label groups.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    Specifies the maximum number of label groups to list.

    

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

    
    ::

      {
          'NextToken': 'string',
          'LabelGroupSummaries': [
              {
                  'LabelGroupName': 'string',
                  'LabelGroupArn': 'string',
                  'CreatedAt': datetime(2015, 1, 1),
                  'UpdatedAt': datetime(2015, 1, 1)
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        An opaque pagination token indicating where to continue the listing of label groups.

        
      

      - **LabelGroupSummaries** *(list) --* 

        A summary of the label groups.

        
        

        - *(dict) --* 

          Contains information about the label group.

          
          

          - **LabelGroupName** *(string) --* 

            The name of the label group.

            
          

          - **LabelGroupArn** *(string) --* 

            The Amazon Resource Name (ARN) of the label group.

            
          

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

            The time at which the label group was created.

            
          

          - **UpdatedAt** *(datetime) --* 

            The time at which the label group was updated.

            
      
    
  
  **Exceptions**
  
  *   :py:class:`LookoutEquipment.Client.exceptions.ValidationException`

  
  *   :py:class:`LookoutEquipment.Client.exceptions.ThrottlingException`

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

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

  