

# Custom Data Identifier List


The Custom Data Identifier List resource represents the repository of custom data identifiers for your Amazon Macie account. A *custom data identifier* is a set of criteria that you define to detect sensitive data in a data source.

You can use this resource to retrieve a subset of information about the custom data identifiers for your account. To retrieve detailed information about the detection criteria and other settings for an individual custom data identifier, use the [Custom Data Identifier](custom-data-identifiers-id.md) resource.

## URI


`/custom-data-identifiers/list`

## HTTP methods


### POST


**Operation ID:** `ListCustomDataIdentifiers`

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


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | ListCustomDataIdentifiersResponse | The request succeeded. | 
| 400 | ValidationException | The request failed because the input doesn't satisfy the constraints specified by the service. | 
| 402 | ServiceQuotaExceededException | The request failed because fulfilling the request would exceed one or more service quotas for your account. | 
| 403 | AccessDeniedException | The request was denied because you don't have sufficient access to the specified resource. | 
| 404 | ResourceNotFoundException | The request failed because the specified resource wasn't found. | 
| 409 | ConflictException | The request failed because it conflicts with the current state of the specified resource. | 
| 429 | ThrottlingException | The request failed because you sent too many requests during a certain amount of time. | 
| 500 | InternalServerException | The request failed due to an unknown internal server error, exception, or failure. | 

## Schemas


### Request bodies


#### POST schema
POST

```
{
  "maxResults": integer,
  "nextToken": "string"
}
```

### Response bodies


#### ListCustomDataIdentifiersResponse schema
ListCustomDataIdentifiersResponse

```
{
  "items": [
    {
      "arn": "string",
      "createdAt": "string",
      "description": "string",
      "id": "string",
      "name": "string"
    }
  ],
  "nextToken": "string"
}
```

#### ValidationException schema
ValidationException

```
{
  "message": "string"
}
```

#### ServiceQuotaExceededException schema
ServiceQuotaExceededException

```
{
  "message": "string"
}
```

#### AccessDeniedException schema
AccessDeniedException

```
{
  "message": "string"
}
```

#### ResourceNotFoundException schema
ResourceNotFoundException

```
{
  "message": "string"
}
```

#### ConflictException schema
ConflictException

```
{
  "message": "string"
}
```

#### ThrottlingException schema
ThrottlingException

```
{
  "message": "string"
}
```

#### InternalServerException schema
InternalServerException

```
{
  "message": "string"
}
```

## Properties


### AccessDeniedException


Provides information about an error that occurred due to insufficient access to a specified resource.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | The explanation of the error that occurred. | 

### ConflictException


Provides information about an error that occurred due to a versioning conflict for a specified resource.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | The explanation of the error that occurred. | 

### CustomDataIdentifierSummary


Provides information about a custom data identifier.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | string | False | The Amazon Resource Name (ARN) of the custom data identifier. | 
| createdAt | stringFormat: date-time | False | The date and time, in UTC and extended ISO 8601 format, when the custom data identifier was created. | 
| description | string | False | The custom description of the custom data identifier. | 
| id | string | False | The unique identifier for the custom data identifier. | 
| name | string | False | The custom name of the custom data identifier. | 

### InternalServerException


Provides information about an error that occurred due to an unknown internal server error, exception, or failure.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | The explanation of the error that occurred. | 

### ListCustomDataIdentifiersRequest


Specifies criteria for paginating the results of a request for information about custom data identifiers.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| maxResults | integerFormat: int32 | False | The maximum number of items to include in each page of the response. | 
| nextToken | string | False | The `nextToken` string that specifies which page of results to return in a paginated response. | 

### ListCustomDataIdentifiersResponse


Provides the results of a request for information about custom data identifiers.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| items | Array of type [CustomDataIdentifierSummary](#custom-data-identifiers-list-model-customdataidentifiersummary) | False | An array of objects, one for each custom data identifier. | 
| nextToken | string | False | 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. | 

### ResourceNotFoundException


Provides information about an error that occurred because a specified resource wasn't found.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | The explanation of the error that occurred. | 

### ServiceQuotaExceededException


Provides information about an error that occurred due to one or more service quotas for an account.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | The explanation of the error that occurred. | 

### ThrottlingException


Provides information about an error that occurred because too many requests were sent during a certain amount of time.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | The explanation of the error that occurred. | 

### ValidationException


Provides information about an error that occurred due to a syntax error in a request.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | The explanation of the error that occurred. | 

## See also


For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

### ListCustomDataIdentifiers

+ [AWS Command Line Interface V2](/goto/cli2/macie2-2020-01-01/ListCustomDataIdentifiers)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/macie2-2020-01-01/ListCustomDataIdentifiers)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/macie2-2020-01-01/ListCustomDataIdentifiers)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/macie2-2020-01-01/ListCustomDataIdentifiers)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/macie2-2020-01-01/ListCustomDataIdentifiers)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/macie2-2020-01-01/ListCustomDataIdentifiers)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/macie2-2020-01-01/ListCustomDataIdentifiers)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/macie2-2020-01-01/ListCustomDataIdentifiers)
+ [AWS SDK for Python](/goto/boto3/macie2-2020-01-01/ListCustomDataIdentifiers)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/macie2-2020-01-01/ListCustomDataIdentifiers)