FraudDetector / Client / get_labels

get_labels#

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.

Request Syntax

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

Parameters:

name (string) – The name of the label or labels to get.
nextToken (string) – The next token for the subsequent request.
maxResults (integer) – The maximum number of objects to return for the request.

Return type:

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

FraudDetector.Client.exceptions.ValidationException
FraudDetector.Client.exceptions.ResourceNotFoundException
FraudDetector.Client.exceptions.InternalServerException
FraudDetector.Client.exceptions.ThrottlingException
FraudDetector.Client.exceptions.AccessDeniedException