[ aws . macie2 ]

test-custom-data-identifier

Description

Tests a custom data identifier.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  test-custom-data-identifier
[--ignore-words <value>]
[--keywords <value>]
[--maximum-match-distance <value>]
--regex <value>
--sample-text <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--ignore-words (list)

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. The array can contain as many as 10 ignore words. Each ignore word can contain 4 - 90 characters. Ignore words are case sensitive.

(string)

Syntax:

"string" "string" ...

--keywords (list)

An array that lists specific character sequences (keywords), one of which must be within proximity (maximumMatchDistance) of the regular expression to match. The array can contain as many as 50 keywords. Each keyword can contain 4 - 90 characters. Keywords aren’t case sensitive.

(string)

Syntax:

"string" "string" ...

--maximum-match-distance (integer)

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. The distance can be 1 - 300 characters. The default value is 50.

--regex (string)

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

--sample-text (string)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

matchCount -> (integer)

The number of instances of sample text that matched the detection criteria specified in the custom data identifier.