Macie2 / Client / list_custom_data_identifiers

list_custom_data_identifiers#

Macie2.Client.list_custom_data_identifiers(**kwargs)#

Retrieves a subset of information about the custom data identifiers for an account.

Request Syntax

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

Parameters:

maxResults (integer) – The maximum number of items to include in each page of the response.
nextToken (string) – The nextToken string that specifies which page of results to return in a paginated response.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'description': 'string',
            'id': 'string',
            'name': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –

The request succeeded.
- items (list) –
  
  An array of objects, one for each custom data identifier.
  - (dict) –
    
    Provides information about a custom data identifier.
    - arn (string) –
      
      The Amazon Resource Name (ARN) of the custom data identifier.
    - createdAt (datetime) –
      
      The date and time, in UTC and extended ISO 8601 format, when the custom data identifier was created.
    - description (string) –
      
      The custom description of the custom data identifier.
    - id (string) –
      
      The unique identifier for the custom data identifier.
    - name (string) –
      
      The custom name of the custom data identifier.
- nextToken (string) –
  
  The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

Exceptions

Macie2.Client.exceptions.ValidationException
Macie2.Client.exceptions.InternalServerException
Macie2.Client.exceptions.ServiceQuotaExceededException
Macie2.Client.exceptions.AccessDeniedException
Macie2.Client.exceptions.ResourceNotFoundException
Macie2.Client.exceptions.ThrottlingException
Macie2.Client.exceptions.ConflictException