Macie2 / Client / test_custom_data_identifier

test_custom_data_identifier#

Macie2.Client.test_custom_data_identifier(**kwargs)#

Tests a custom data identifier.

See also: AWS API Documentation

Request Syntax

response = client.test_custom_data_identifier(
    ignoreWords=[
        'string',
    ],
    keywords=[
        'string',
    ],
    maximumMatchDistance=123,
    regex='string',
    sampleText='string'
)
Parameters:

  • ignoreWords (list) –

    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.

    • (string) –

  • keywords (list) –

    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.

    • (string) –

  • maximumMatchDistance (integer) – 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.

  • regex (string) –

    [REQUIRED]

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

  • sampleText (string) –

    [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'matchCount': 123
}

Response Structure

  • (dict) –

    The request succeeded.

    • matchCount (integer) –

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

Exceptions

  • Macie2.Client.exceptions.ValidationException

  • Macie2.Client.exceptions.InternalServerException

  • Macie2.Client.exceptions.ServiceQuotaExceededException

  • Macie2.Client.exceptions.AccessDeniedException

  • Macie2.Client.exceptions.ResourceNotFoundException

  • Macie2.Client.exceptions.ThrottlingException

  • Macie2.Client.exceptions.ConflictException