TestCustomDataIdentifierCommand

Suggest an Edit

Tests criteria for a custom data identifier.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { Macie2Client, TestCustomDataIdentifierCommand } from "@aws-sdk/client-macie2"; // ES Modules import
// const { Macie2Client, TestCustomDataIdentifierCommand } = require("@aws-sdk/client-macie2"); // CommonJS import
const client = new Macie2Client(config);
const input = { // TestCustomDataIdentifierRequest
  ignoreWords: [ // __listOf__string
    "STRING_VALUE",
  ],
  keywords: [
    "STRING_VALUE",
  ],
  maximumMatchDistance: Number("int"),
  regex: "STRING_VALUE", // required
  sampleText: "STRING_VALUE", // required
};
const command = new TestCustomDataIdentifierCommand(input);
const response = await client.send(command);
// { // TestCustomDataIdentifierResponse
//   matchCount: Number("int"),
// };

TestCustomDataIdentifierCommand Input

See TestCustomDataIdentifierCommandInput for more details

Parameter
Type
Description
regex
Required
string | undefined

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

sampleText
Required
string | undefined

The sample text to inspect by using the custom data identifier. The text can contain as many as 1,000 characters.

ignoreWords
string[] | undefined

An array that lists specific character sequences (ignore words) 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.

keywords
string[] | undefined

An array that lists specific character sequences (keywords), 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.

maximumMatchDistance
number | undefined

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.

TestCustomDataIdentifierCommand Output

See TestCustomDataIdentifierCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
matchCount
number | undefined

The number of occurrences of sample text that matched the criteria specified by the custom data identifier.

Throws

Name
Fault
Details
AccessDeniedException
client

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

ConflictException
client

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

InternalServerException
server

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

ResourceNotFoundException
client

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

ServiceQuotaExceededException
client

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

ThrottlingException
client

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

ValidationException
client

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

Macie2ServiceException
Base exception class for all service exceptions from Macie2 service.