amazonka-maciev2-2.0: Amazon Macie 2 SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.MacieV2.GetCustomDataIdentifier

Description

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

Synopsis

Creating a Request

data GetCustomDataIdentifier Source #

See: newGetCustomDataIdentifier smart constructor.

Constructors

GetCustomDataIdentifier' 

Fields

  • id :: Text

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

Instances

Instances details
ToHeaders GetCustomDataIdentifier Source # 
Instance details

Defined in Amazonka.MacieV2.GetCustomDataIdentifier

ToPath GetCustomDataIdentifier Source # 
Instance details

Defined in Amazonka.MacieV2.GetCustomDataIdentifier

ToQuery GetCustomDataIdentifier Source # 
Instance details

Defined in Amazonka.MacieV2.GetCustomDataIdentifier

AWSRequest GetCustomDataIdentifier Source # 
Instance details

Defined in Amazonka.MacieV2.GetCustomDataIdentifier

Generic GetCustomDataIdentifier Source # 
Instance details

Defined in Amazonka.MacieV2.GetCustomDataIdentifier

Associated Types

type Rep GetCustomDataIdentifier :: Type -> Type #

Read GetCustomDataIdentifier Source # 
Instance details

Defined in Amazonka.MacieV2.GetCustomDataIdentifier

Show GetCustomDataIdentifier Source # 
Instance details

Defined in Amazonka.MacieV2.GetCustomDataIdentifier

NFData GetCustomDataIdentifier Source # 
Instance details

Defined in Amazonka.MacieV2.GetCustomDataIdentifier

Methods

rnf :: GetCustomDataIdentifier -> () #

Eq GetCustomDataIdentifier Source # 
Instance details

Defined in Amazonka.MacieV2.GetCustomDataIdentifier

Hashable GetCustomDataIdentifier Source # 
Instance details

Defined in Amazonka.MacieV2.GetCustomDataIdentifier

type AWSResponse GetCustomDataIdentifier Source # 
Instance details

Defined in Amazonka.MacieV2.GetCustomDataIdentifier

type Rep GetCustomDataIdentifier Source # 
Instance details

Defined in Amazonka.MacieV2.GetCustomDataIdentifier

type Rep GetCustomDataIdentifier = D1 ('MetaData "GetCustomDataIdentifier" "Amazonka.MacieV2.GetCustomDataIdentifier" "amazonka-maciev2-2.0-5WBPWSHaxt7LOrO1LzXg18" 'False) (C1 ('MetaCons "GetCustomDataIdentifier'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetCustomDataIdentifier Source #

Create a value of GetCustomDataIdentifier with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetCustomDataIdentifier, getCustomDataIdentifier_id - The unique identifier for the Amazon Macie resource that the request applies to.

Request Lenses

getCustomDataIdentifier_id :: Lens' GetCustomDataIdentifier Text Source #

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

Destructuring the Response

data GetCustomDataIdentifierResponse Source #

See: newGetCustomDataIdentifierResponse smart constructor.

Constructors

GetCustomDataIdentifierResponse' 

Fields

  • arn :: Maybe Text

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

  • createdAt :: Maybe ISO8601

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

  • deleted :: Maybe Bool

    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 :: Maybe Text

    The custom description of the custom data identifier.

  • id :: Maybe Text

    The unique identifier for the custom data identifier.

  • ignoreWords :: Maybe [Text]

    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 :: Maybe [Text]

    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.

  • maximumMatchDistance :: Maybe Int

    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 :: Maybe Text

    The custom name of the custom data identifier.

  • regex :: Maybe Text

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

  • severityLevels :: Maybe [SeverityLevel]

    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.

  • tags :: Maybe (HashMap Text Text)

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

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic GetCustomDataIdentifierResponse Source # 
Instance details

Defined in Amazonka.MacieV2.GetCustomDataIdentifier

Associated Types

type Rep GetCustomDataIdentifierResponse :: Type -> Type #

Read GetCustomDataIdentifierResponse Source # 
Instance details

Defined in Amazonka.MacieV2.GetCustomDataIdentifier

Show GetCustomDataIdentifierResponse Source # 
Instance details

Defined in Amazonka.MacieV2.GetCustomDataIdentifier

NFData GetCustomDataIdentifierResponse Source # 
Instance details

Defined in Amazonka.MacieV2.GetCustomDataIdentifier

Eq GetCustomDataIdentifierResponse Source # 
Instance details

Defined in Amazonka.MacieV2.GetCustomDataIdentifier

type Rep GetCustomDataIdentifierResponse Source # 
Instance details

Defined in Amazonka.MacieV2.GetCustomDataIdentifier

type Rep GetCustomDataIdentifierResponse = D1 ('MetaData "GetCustomDataIdentifierResponse" "Amazonka.MacieV2.GetCustomDataIdentifier" "amazonka-maciev2-2.0-5WBPWSHaxt7LOrO1LzXg18" 'False) (C1 ('MetaCons "GetCustomDataIdentifierResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "deleted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "ignoreWords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))) :*: ((S1 ('MetaSel ('Just "keywords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "maximumMatchDistance") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "regex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "severityLevels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SeverityLevel]))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newGetCustomDataIdentifierResponse Source #

Create a value of GetCustomDataIdentifierResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetCustomDataIdentifierResponse, getCustomDataIdentifierResponse_arn - The Amazon Resource Name (ARN) of the custom data identifier.

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

GetCustomDataIdentifierResponse, getCustomDataIdentifierResponse_deleted - 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.

GetCustomDataIdentifierResponse, getCustomDataIdentifierResponse_description - The custom description of the custom data identifier.

GetCustomDataIdentifier, getCustomDataIdentifierResponse_id - The unique identifier for the custom data identifier.

$sel:ignoreWords:GetCustomDataIdentifierResponse', getCustomDataIdentifierResponse_ignoreWords - 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.

$sel:keywords:GetCustomDataIdentifierResponse', getCustomDataIdentifierResponse_keywords - 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.

$sel:maximumMatchDistance:GetCustomDataIdentifierResponse', getCustomDataIdentifierResponse_maximumMatchDistance - 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.

GetCustomDataIdentifierResponse, getCustomDataIdentifierResponse_name - The custom name of the custom data identifier.

GetCustomDataIdentifierResponse, getCustomDataIdentifierResponse_regex - The regular expression (regex) that defines the pattern to match.

$sel:severityLevels:GetCustomDataIdentifierResponse', getCustomDataIdentifierResponse_severityLevels - 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.

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

$sel:httpStatus:GetCustomDataIdentifierResponse', getCustomDataIdentifierResponse_httpStatus - The response's http status code.

Response Lenses

getCustomDataIdentifierResponse_arn :: Lens' GetCustomDataIdentifierResponse (Maybe Text) Source #

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

getCustomDataIdentifierResponse_createdAt :: Lens' GetCustomDataIdentifierResponse (Maybe UTCTime) Source #

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

getCustomDataIdentifierResponse_deleted :: Lens' GetCustomDataIdentifierResponse (Maybe Bool) Source #

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.

getCustomDataIdentifierResponse_description :: Lens' GetCustomDataIdentifierResponse (Maybe Text) Source #

The custom description of the custom data identifier.

getCustomDataIdentifierResponse_id :: Lens' GetCustomDataIdentifierResponse (Maybe Text) Source #

The unique identifier for the custom data identifier.

getCustomDataIdentifierResponse_ignoreWords :: Lens' GetCustomDataIdentifierResponse (Maybe [Text]) Source #

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.

getCustomDataIdentifierResponse_keywords :: Lens' GetCustomDataIdentifierResponse (Maybe [Text]) Source #

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.

getCustomDataIdentifierResponse_maximumMatchDistance :: Lens' GetCustomDataIdentifierResponse (Maybe Int) Source #

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.

getCustomDataIdentifierResponse_regex :: Lens' GetCustomDataIdentifierResponse (Maybe Text) Source #

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

getCustomDataIdentifierResponse_severityLevels :: Lens' GetCustomDataIdentifierResponse (Maybe [SeverityLevel]) Source #

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.

getCustomDataIdentifierResponse_tags :: Lens' GetCustomDataIdentifierResponse (Maybe (HashMap Text Text)) Source #

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