Custom Data Identifier - Amazon Macie

Custom Data Identifier

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 resource provides access to the repository of custom data identifiers for your account. It provides comprehensive, detailed information about each custom data identifier that you can use in Amazon Macie. This includes the criteria and other settings for each custom data identifier. The Custom Data Identifier resource also enables you to delete a custom data identifier.

When you use this resource to delete or retrieve information about a custom data identifier, you have to specify the unique identifier for the customer data identifier. To find this identifier, use the Custom Data Identifier List resource.

You can use the Custom Data Identifier resource to retrieve detailed information about a custom data identifier. You can also use this resource to delete a custom data identifier.

URI

/custom-data-identifiers/id

HTTP Methods

GET

Operation ID: GetCustomDataIdentifier

Retrieves information about the criteria and other settings for a custom data identifier.

Path Parameters
Name Type Required Description
id String True

The unique identifier for the Amazon Macie resource or account that the request applies to.

Responses
Status Code Response Model Description
200 GetCustomDataIdentifierResponse

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.

DELETE

Operation ID: DeleteCustomDataIdentifier

Soft deletes a custom data identifier.

Path Parameters
Name Type Required Description
id String True

The unique identifier for the Amazon Macie resource or account that the request applies to.

Responses
Status Code Response Model Description
200 Empty Schema

The request succeeded. The specified custom data identifier was deleted and there isn't any content to include in the body of the response (No Content).

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

Response Bodies

Example GetCustomDataIdentifierResponse

{ "createdAt": "string", "regex": "string", "deleted": boolean, "keywords": [ "string" ], "ignoreWords": [ "string" ], "name": "string", "description": "string", "maximumMatchDistance": integer, "id": "string", "arn": "string", "tags": { } }

Example Empty Schema

{ }

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.

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.

Empty

The request succeeded and there isn't any content to include in the body of the response (No Content).

GetCustomDataIdentifierResponse

Provides information about the criteria and other settings for 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.

regex

string

False

The regular expression (regex) that defines the pattern to match.

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.

keywords

Array of type string

False

An array that lists specific character sequences (keywords), one of which must be within proximity (maximumMatchDistance) of the regular expression to match. Keywords aren't case sensitive.

ignoreWords

Array of type string

False

An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression is the same as any string in this array, Amazon Macie ignores it. Ignore words are case sensitive.

name

string

False

The custom name of the custom data identifier.

description

string

False

The custom description of the custom data identifier.

maximumMatchDistance

integer

Format: int32

False

The maximum number of characters that can exist between text that matches the regex pattern and the character sequences specified by the keywords array. Macie includes or excludes a result based on the proximity of a keyword to text that matches the regex pattern.

id

string

False

The unique identifier for the custom data identifier.

arn

string

False

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

tags

TagMap

False

A map of key-value pairs that identifies the tags (keys and values) that are associated with 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.

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.

TagMap

A string-to-string map of key-value pairs that specifies the tags (keys and values) for a classification job, custom data identifier, findings filter, or member account.

Property Type Required Description

*

string

False

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:

GetCustomDataIdentifier

DeleteCustomDataIdentifier