Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1479429429.3 KB

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

get/custom-data-identifiers/{id}

Path parameters

idstring required

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

Response

Success

arnstring

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

createdAtstring date-time

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

deletedboolean

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.

descriptionstring

The custom description of the custom data identifier.

idstring

The unique identifier for the custom data identifier.

ignoreWordsString[]

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

keywordsString[]

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

maximumMatchDistanceinteger

The maximum number of characters that can exist between the end of at least one complete character sequence specified by the keywords array and the end of the text that matches the regex pattern. If a complete keyword precedes all the text that matches the pattern and the keyword is within the specified distance, Amazon Macie includes the result. Otherwise, Macie excludes the result.

namestring

The custom name of the custom data identifier.

regexstring

The regular expression (<i>regex</i>) that defines the pattern to match.

tagsobject

A map of key-value pairs that identifies the tags (keys and values) that are associated with the custom data identifier.