:doc:`FraudDetector <../../frauddetector>` / Client / get_labels

**********
get_labels
**********



.. py:method:: FraudDetector.Client.get_labels(**kwargs)

  

  Gets all labels or a specific label if name is provided. This is a paginated API. If you provide a null ``maxResults``, this action retrieves a maximum of 50 records per page. If you provide a ``maxResults``, the value must be between 10 and 50. To get the next page results, provide the pagination token from the ``GetGetLabelsResponse`` as part of your request. A null pagination token fetches the records from the beginning.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetLabels>`_  


  **Request Syntax**
  ::

    response = client.get_labels(
        name='string',
        nextToken='string',
        maxResults=123
    )
    
  :type name: string
  :param name: 

    The name of the label or labels to get.

    

  
  :type nextToken: string
  :param nextToken: 

    The next token for the subsequent request.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of objects to return for the request.

    

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

    
    ::

      {
          'labels': [
              {
                  'name': 'string',
                  'description': 'string',
                  'lastUpdatedTime': 'string',
                  'createdTime': 'string',
                  'arn': 'string'
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **labels** *(list) --* 

        An array of labels.

        
        

        - *(dict) --* 

          The label details.

          
          

          - **name** *(string) --* 

            The label name.

            
          

          - **description** *(string) --* 

            The label description.

            
          

          - **lastUpdatedTime** *(string) --* 

            Timestamp of when the label was last updated.

            
          

          - **createdTime** *(string) --* 

            Timestamp of when the event type was created.

            
          

          - **arn** *(string) --* 

            The label ARN.

            
      
    
      

      - **nextToken** *(string) --* 

        The next page token.

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

  
  *   :py:class:`FraudDetector.Client.exceptions.ResourceNotFoundException`

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

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

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

  