Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1479429429.3 KB

Creates and defines the criteria and other settings for a custom data identifier.

post/custom-data-identifiers

Request body

clientTokenstring

A unique, case-sensitive token that you provide to ensure the idempotency of the request.

descriptionstring
<p>A custom description of the custom data identifier. The description can contain as many as 512 characters.</p> <p>We strongly recommend that you avoid including any sensitive data in the description of a custom data identifier. Other users of your account might be able to see this description, depending on the actions that they're allowed to perform in Amazon Macie.</p>
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. The array can contain as many as 10 ignore words. Each ignore word can contain 4-90 UTF-8 characters. 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. The array can contain as many as 50 keywords. Each keyword can contain 3-90 UTF-8 characters. 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. The distance can be 1-300 characters. The default value is 50.

namestring required
<p>A custom name for the custom data identifier. The name can contain as many as 128 characters.</p> <p>We strongly recommend that you avoid including any sensitive data in the name of a custom data identifier. Other users of your account might be able to see this name, depending on the actions that they're allowed to perform in Amazon Macie.</p>
regexstring required

The regular expression (<i>regex</i>) that defines the pattern to match. The expression can contain as many as 512 characters.

tagsobject

A string-to-string map of key-value pairs that specifies the tags (keys and values) for an Amazon Macie resource.

Response

Success

customDataIdentifierIdstring

The unique identifier for the custom data identifier that was created.