Custom Data Identifier Descriptions - Amazon Macie

Custom Data Identifier Descriptions

A custom data identifier is a set of criteria that you defined to detect sensitive data in one or more data sources. The Custom Data Identifier Descriptions resource provides access to the repository of custom data identifiers for your account. It provides information about each custom data identifier that you can use in Amazon Macie.

You can use this resource to retrieve information about one or more custom data identifiers for your account. To refine your request, you can use the supported request parameter to specify which custom data identifiers to retrieve information about. To retrieve detailed information about the criteria and other settings for an individual custom data identifier, use the Custom Data Identifier resource.

URI

/custom-data-identifiers/get

HTTP Methods

POST

Operation ID: BatchGetCustomDataIdentifiers

Retrieves information about one or more custom data identifiers.

Responses
Status Code Response Model Description
200 BatchGetCustomDataIdentifiersResponse

The request succeeded.

400 ValidationException

The request failed because it contains a syntax error.

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

Example POST

{ "ids": [ "string" ] }

Response Bodies

Example BatchGetCustomDataIdentifiersResponse

{ "customDataIdentifiers": [ { "createdAt": "string", "deleted": boolean, "name": "string", "description": "string", "id": "string", "arn": "string" } ], "notFoundIdentifierIds": [ "string" ] }

Example ValidationException

{ "message": "string" }

Example ServiceQuotaExceededException

{ "message": "string" }

Example AccessDeniedException

{ "message": "string" }

Example ResourceNotFoundException

{ "message": "string" }

Example ConflictException

{ "message": "string" }

Example ThrottlingException

{ "message": "string" }

Example 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.

BatchGetCustomDataIdentifierSummary

Provides information about a custom data identifier.

Property Type Required Description
createdAt

string

Format: date-time

False

The date and time, in UTC and extended ISO 8601 format, when the custom data identifier was created.

deleted

boolean

False

Specifies whether the custom data identifier was deleted. If you delete a custom data identifier, Amazon Macie doesn't delete it permanently. Instead, it soft deletes the identifier.

name

string

False

The custom name of the custom data identifier.

description

string

False

The custom description of the custom data identifier.

id

string

False

The unique identifier for the custom data identifier.

arn

string

False

The Amazon Resource Name (ARN) of the custom data identifier.

BatchGetCustomDataIdentifiersRequest

Specifies one or more custom data identifiers to retrieve information about.

Property Type Required Description
ids

Array of type string

False

An array of strings that lists the unique identifiers for the custom data identifiers to retrieve information about.

BatchGetCustomDataIdentifiersResponse

Provides information about one or more custom data identifiers.

Property Type Required Description
customDataIdentifiers

Array of type BatchGetCustomDataIdentifierSummary

False

An array of objects, one for each custom data identifier that meets the criteria specified in the request.

notFoundIdentifierIds

Array of type string

False

An array of identifiers, one for each identifier that was specified in the request, but doesn't correlate to an existing custom data identifier.

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.

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.

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:

BatchGetCustomDataIdentifiers