Macie2 / Client / get_custom_data_identifier

get_custom_data_identifier

Macie2.Client.get_custom_data_identifier(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.get_custom_data_identifier(
    id='string'
)

Parameters:

id (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'arn': 'string',
    'createdAt': datetime(2015, 1, 1),
    'deleted': True|False,
    'description': 'string',
    'id': 'string',
    'ignoreWords': [
        'string',
    ],
    'keywords': [
        'string',
    ],
    'maximumMatchDistance': 123,
    'name': 'string',
    'regex': 'string',
    'severityLevels': [
        {
            'occurrencesThreshold': 123,
            'severity': 'LOW'|'MEDIUM'|'HIGH'
        },
    ],
    'tags': {
        'string': 'string'
    }
}

Response Structure

• (dict) –

  The request succeeded.

  • arn (string) –

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

  • createdAt (datetime) –

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

  • deleted (boolean) –

    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.

  • description (string) –

    The custom description of the custom data identifier.

  • id (string) –

    The unique identifier for the custom data identifier.

  • 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. 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. 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. Otherwise, Macie excludes the result.

  • name (string) –

    The custom name of the custom data identifier.

  • regex (string) –

    The regular expression (regex) that defines the pattern to match.

  • severityLevels (list) –

    Specifies the severity that’s assigned to findings that the custom data identifier produces, based on the number of occurrences of text that matches the custom data identifier’s detection criteria. By default, Amazon Macie creates findings for S3 objects that contain at least one occurrence of text that matches the detection criteria, and Macie assigns the MEDIUM severity to those findings.

    • (dict) –

      Specifies a severity level for findings that a custom data identifier produces. A severity level determines which severity is assigned to the findings, based on the number of occurrences of text that matches the custom data identifier’s detection criteria.

      • occurrencesThreshold (integer) –

        The minimum number of occurrences of text that must match the custom data identifier’s detection criteria in order to produce a finding with the specified severity (severity).

      • severity (string) –

        The severity to assign to a finding: if the number of occurrences is greater than or equal to the specified threshold (occurrencesThreshold); and, if applicable, the number of occurrences is less than the threshold for the next consecutive severity level for the custom data identifier, moving from LOW to HIGH.

  • tags (dict) –

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

    • (string) –

      • (string) –

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