libZSservicesZSamazonka-maciev2ZSamazonka-maciev2
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.MacieV2.CreateCustomDataIdentifier

Description

Creates and defines the criteria and other settings for a custom data identifier.

Synopsis

Creating a Request

data CreateCustomDataIdentifier Source #

See: newCreateCustomDataIdentifier smart constructor.

Constructors

CreateCustomDataIdentifier' 

Fields

  • clientToken :: Maybe Text

    A unique, case-sensitive token that you provide to ensure the idempotency of the request.

  • regex :: Maybe Text

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

  • name :: Maybe Text

    A custom name for the custom data identifier. The name can contain as many as 128 characters.

    We strongly recommend that you avoid including any sensitive data in the name of a custom data identifier. Other users of your account might be able to see the identifier's name, depending on the actions that they're allowed to perform in Amazon Macie.

  • keywords :: Maybe [Text]

    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 3-90 UTF-8 characters. Keywords aren't case sensitive.

  • 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 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 UTF-8 characters. Ignore words are case sensitive.

  • maximumMatchDistance :: Maybe Int

    The maximum number of characters that can exist between text that matches the regex pattern and the character sequences specified by the keywords array. Amazon 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.

  • description :: Maybe Text

    A custom description of the custom data identifier. The description can contain as many as 512 characters.

    We strongly recommend that you avoid including any sensitive data in the description of a custom data identifier. Other users of your account might be able to see the identifier's description, depending on the actions that they're allowed to perform in Amazon Macie.

  • tags :: Maybe (HashMap Text Text)

    A map of key-value pairs that specifies the tags to associate with the custom data identifier.

    A custom data identifier can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

Instances

Instances details
Eq CreateCustomDataIdentifier Source # 
Instance details

Defined in Amazonka.MacieV2.CreateCustomDataIdentifier

Read CreateCustomDataIdentifier Source # 
Instance details

Defined in Amazonka.MacieV2.CreateCustomDataIdentifier

Show CreateCustomDataIdentifier Source # 
Instance details

Defined in Amazonka.MacieV2.CreateCustomDataIdentifier

Generic CreateCustomDataIdentifier Source # 
Instance details

Defined in Amazonka.MacieV2.CreateCustomDataIdentifier

Associated Types

type Rep CreateCustomDataIdentifier :: Type -> Type #

NFData CreateCustomDataIdentifier Source # 
Instance details

Defined in Amazonka.MacieV2.CreateCustomDataIdentifier

Hashable CreateCustomDataIdentifier Source # 
Instance details

Defined in Amazonka.MacieV2.CreateCustomDataIdentifier

ToJSON CreateCustomDataIdentifier Source # 
Instance details

Defined in Amazonka.MacieV2.CreateCustomDataIdentifier

AWSRequest CreateCustomDataIdentifier Source # 
Instance details

Defined in Amazonka.MacieV2.CreateCustomDataIdentifier

ToHeaders CreateCustomDataIdentifier Source # 
Instance details

Defined in Amazonka.MacieV2.CreateCustomDataIdentifier

ToPath CreateCustomDataIdentifier Source # 
Instance details

Defined in Amazonka.MacieV2.CreateCustomDataIdentifier

ToQuery CreateCustomDataIdentifier Source # 
Instance details

Defined in Amazonka.MacieV2.CreateCustomDataIdentifier

type Rep CreateCustomDataIdentifier Source # 
Instance details

Defined in Amazonka.MacieV2.CreateCustomDataIdentifier

type Rep CreateCustomDataIdentifier = D1 ('MetaData "CreateCustomDataIdentifier" "Amazonka.MacieV2.CreateCustomDataIdentifier" "libZSservicesZSamazonka-maciev2ZSamazonka-maciev2" 'False) (C1 ('MetaCons "CreateCustomDataIdentifier'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "regex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "keywords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :*: ((S1 ('MetaSel ('Just "ignoreWords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "maximumMatchDistance") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))))))
type AWSResponse CreateCustomDataIdentifier Source # 
Instance details

Defined in Amazonka.MacieV2.CreateCustomDataIdentifier

newCreateCustomDataIdentifier :: CreateCustomDataIdentifier Source #

Create a value of CreateCustomDataIdentifier 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:

$sel:clientToken:CreateCustomDataIdentifier', createCustomDataIdentifier_clientToken - A unique, case-sensitive token that you provide to ensure the idempotency of the request.

$sel:regex:CreateCustomDataIdentifier', createCustomDataIdentifier_regex - The regular expression (regex) that defines the pattern to match. The expression can contain as many as 512 characters.

$sel:name:CreateCustomDataIdentifier', createCustomDataIdentifier_name - A custom name for the custom data identifier. The name can contain as many as 128 characters.

We strongly recommend that you avoid including any sensitive data in the name of a custom data identifier. Other users of your account might be able to see the identifier's name, depending on the actions that they're allowed to perform in Amazon Macie.

$sel:keywords:CreateCustomDataIdentifier', createCustomDataIdentifier_keywords - 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 3-90 UTF-8 characters. Keywords aren't case sensitive.

$sel:ignoreWords:CreateCustomDataIdentifier', createCustomDataIdentifier_ignoreWords - 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 UTF-8 characters. Ignore words are case sensitive.

$sel:maximumMatchDistance:CreateCustomDataIdentifier', createCustomDataIdentifier_maximumMatchDistance - The maximum number of characters that can exist between text that matches the regex pattern and the character sequences specified by the keywords array. Amazon 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.

$sel:description:CreateCustomDataIdentifier', createCustomDataIdentifier_description - A custom description of the custom data identifier. The description can contain as many as 512 characters.

We strongly recommend that you avoid including any sensitive data in the description of a custom data identifier. Other users of your account might be able to see the identifier's description, depending on the actions that they're allowed to perform in Amazon Macie.

$sel:tags:CreateCustomDataIdentifier', createCustomDataIdentifier_tags - A map of key-value pairs that specifies the tags to associate with the custom data identifier.

A custom data identifier can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

Request Lenses

createCustomDataIdentifier_clientToken :: Lens' CreateCustomDataIdentifier (Maybe Text) Source #

A unique, case-sensitive token that you provide to ensure the idempotency of the request.

createCustomDataIdentifier_regex :: Lens' CreateCustomDataIdentifier (Maybe Text) Source #

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

createCustomDataIdentifier_name :: Lens' CreateCustomDataIdentifier (Maybe Text) Source #

A custom name for the custom data identifier. The name can contain as many as 128 characters.

We strongly recommend that you avoid including any sensitive data in the name of a custom data identifier. Other users of your account might be able to see the identifier's name, depending on the actions that they're allowed to perform in Amazon Macie.

createCustomDataIdentifier_keywords :: Lens' CreateCustomDataIdentifier (Maybe [Text]) Source #

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 3-90 UTF-8 characters. Keywords aren't case sensitive.

createCustomDataIdentifier_ignoreWords :: Lens' CreateCustomDataIdentifier (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 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 UTF-8 characters. Ignore words are case sensitive.

createCustomDataIdentifier_maximumMatchDistance :: Lens' CreateCustomDataIdentifier (Maybe Int) Source #

The maximum number of characters that can exist between text that matches the regex pattern and the character sequences specified by the keywords array. Amazon 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.

createCustomDataIdentifier_description :: Lens' CreateCustomDataIdentifier (Maybe Text) Source #

A custom description of the custom data identifier. The description can contain as many as 512 characters.

We strongly recommend that you avoid including any sensitive data in the description of a custom data identifier. Other users of your account might be able to see the identifier's description, depending on the actions that they're allowed to perform in Amazon Macie.

createCustomDataIdentifier_tags :: Lens' CreateCustomDataIdentifier (Maybe (HashMap Text Text)) Source #

A map of key-value pairs that specifies the tags to associate with the custom data identifier.

A custom data identifier can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

Destructuring the Response

data CreateCustomDataIdentifierResponse Source #

Constructors

CreateCustomDataIdentifierResponse' 

Fields

Instances

Instances details
Eq CreateCustomDataIdentifierResponse Source # 
Instance details

Defined in Amazonka.MacieV2.CreateCustomDataIdentifier

Read CreateCustomDataIdentifierResponse Source # 
Instance details

Defined in Amazonka.MacieV2.CreateCustomDataIdentifier

Show CreateCustomDataIdentifierResponse Source # 
Instance details

Defined in Amazonka.MacieV2.CreateCustomDataIdentifier

Generic CreateCustomDataIdentifierResponse Source # 
Instance details

Defined in Amazonka.MacieV2.CreateCustomDataIdentifier

Associated Types

type Rep CreateCustomDataIdentifierResponse :: Type -> Type #

NFData CreateCustomDataIdentifierResponse Source # 
Instance details

Defined in Amazonka.MacieV2.CreateCustomDataIdentifier

type Rep CreateCustomDataIdentifierResponse Source # 
Instance details

Defined in Amazonka.MacieV2.CreateCustomDataIdentifier

type Rep CreateCustomDataIdentifierResponse = D1 ('MetaData "CreateCustomDataIdentifierResponse" "Amazonka.MacieV2.CreateCustomDataIdentifier" "libZSservicesZSamazonka-maciev2ZSamazonka-maciev2" 'False) (C1 ('MetaCons "CreateCustomDataIdentifierResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "customDataIdentifierId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateCustomDataIdentifierResponse Source #

Create a value of CreateCustomDataIdentifierResponse 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:

$sel:customDataIdentifierId:CreateCustomDataIdentifierResponse', createCustomDataIdentifierResponse_customDataIdentifierId - The unique identifier for the custom data identifier that was created.

$sel:httpStatus:CreateCustomDataIdentifierResponse', createCustomDataIdentifierResponse_httpStatus - The response's http status code.

Response Lenses

createCustomDataIdentifierResponse_customDataIdentifierId :: Lens' CreateCustomDataIdentifierResponse (Maybe Text) Source #

The unique identifier for the custom data identifier that was created.