Skip to content

GetCustomDataIdentifierResponse

Source code in docs_src/capo_macie2/types/get_custom_data_identifier_response.py
class GetCustomDataIdentifierResponse(TypedDict, closed=True):
    arn: NotRequired["capo_macie2.types.__string.__string"]
    """<p>The Amazon Resource Name (ARN) of the custom data identifier.</p>"""
    created_at: NotRequired["capo_macie2.types.__timestamp_iso8601.__timestampIso8601"]
    """<p>The date and time, in UTC and extended ISO 8601 format, when the custom data identifier was created.</p>"""
    deleted: NotRequired["capo_macie2.types.__boolean.__boolean"]
    """<p>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.</p>"""
    description: NotRequired["capo_macie2.types.__string.__string"]
    """<p>The custom description of the custom data identifier.</p>"""
    id: NotRequired["capo_macie2.types.__string.__string"]
    """<p>The unique identifier for the custom data identifier.</p>"""
    ignore_words: NotRequired["capo_macie2.types.__list_of__string.__listOf__string"]
    """<p>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. Ignore words are case sensitive.</p>"""
    keywords: NotRequired["capo_macie2.types.__list_of__string.__listOf__string"]
    """<p>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. Keywords aren't case sensitive.</p>"""
    maximum_match_distance: NotRequired["capo_macie2.types.__integer.__integer"]
    """<p>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.</p>"""
    name: NotRequired["capo_macie2.types.__string.__string"]
    """<p>The custom name of the custom data identifier.</p>"""
    regex: NotRequired["capo_macie2.types.__string.__string"]
    """<p>The regular expression (<i>regex</i>) that defines the pattern to match.</p>"""
    severity_levels: NotRequired[
        "capo_macie2.types.severity_level_list.SeverityLevelList"
    ]
    """<p>Specifies the severity that's assigned to findings that the custom data identifier produces, based on the number of occurrences of text that match 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.</p>"""
    tags: NotRequired["capo_macie2.types.tag_map.TagMap"]
    """<p>A map of key-value pairs that identifies the tags (keys and values) that are associated with the custom data identifier.</p>"""

arn instance-attribute

arn: NotRequired[__string]

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

created_at instance-attribute

created_at: NotRequired[__timestampIso8601]

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

deleted instance-attribute

deleted: NotRequired[__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 instance-attribute

description: NotRequired[__string]

The custom description of the custom data identifier.

id instance-attribute

id: NotRequired[__string]

The unique identifier for the custom data identifier.

ignore_words instance-attribute

ignore_words: NotRequired[__listOf__string]

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.

keywords instance-attribute

keywords: NotRequired[__listOf__string]

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.

maximum_match_distance instance-attribute

maximum_match_distance: NotRequired[__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 instance-attribute

name: NotRequired[__string]

The custom name of the custom data identifier.

regex instance-attribute

regex: NotRequired[__string]

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

severity_levels instance-attribute

severity_levels: NotRequired[SeverityLevelList]

Specifies the severity that's assigned to findings that the custom data identifier produces, based on the number of occurrences of text that match 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.

tags instance-attribute

tags: NotRequired[TagMap]

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