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.TestCustomDataIdentifier

Description

Tests a custom data identifier.

Synopsis

Creating a Request

data TestCustomDataIdentifier Source #

See: newTestCustomDataIdentifier smart constructor.

Constructors

TestCustomDataIdentifier' 

Fields

  • 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.

  • regex :: Text

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

  • sampleText :: Text

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

Instances

Instances details
Eq TestCustomDataIdentifier Source # 
Instance details

Defined in Amazonka.MacieV2.TestCustomDataIdentifier

Read TestCustomDataIdentifier Source # 
Instance details

Defined in Amazonka.MacieV2.TestCustomDataIdentifier

Show TestCustomDataIdentifier Source # 
Instance details

Defined in Amazonka.MacieV2.TestCustomDataIdentifier

Generic TestCustomDataIdentifier Source # 
Instance details

Defined in Amazonka.MacieV2.TestCustomDataIdentifier

Associated Types

type Rep TestCustomDataIdentifier :: Type -> Type #

NFData TestCustomDataIdentifier Source # 
Instance details

Defined in Amazonka.MacieV2.TestCustomDataIdentifier

Hashable TestCustomDataIdentifier Source # 
Instance details

Defined in Amazonka.MacieV2.TestCustomDataIdentifier

ToJSON TestCustomDataIdentifier Source # 
Instance details

Defined in Amazonka.MacieV2.TestCustomDataIdentifier

AWSRequest TestCustomDataIdentifier Source # 
Instance details

Defined in Amazonka.MacieV2.TestCustomDataIdentifier

ToHeaders TestCustomDataIdentifier Source # 
Instance details

Defined in Amazonka.MacieV2.TestCustomDataIdentifier

ToPath TestCustomDataIdentifier Source # 
Instance details

Defined in Amazonka.MacieV2.TestCustomDataIdentifier

ToQuery TestCustomDataIdentifier Source # 
Instance details

Defined in Amazonka.MacieV2.TestCustomDataIdentifier

type Rep TestCustomDataIdentifier Source # 
Instance details

Defined in Amazonka.MacieV2.TestCustomDataIdentifier

type Rep TestCustomDataIdentifier = D1 ('MetaData "TestCustomDataIdentifier" "Amazonka.MacieV2.TestCustomDataIdentifier" "libZSservicesZSamazonka-maciev2ZSamazonka-maciev2" 'False) (C1 ('MetaCons "TestCustomDataIdentifier'" 'PrefixI 'True) ((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 "regex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "sampleText") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse TestCustomDataIdentifier Source # 
Instance details

Defined in Amazonka.MacieV2.TestCustomDataIdentifier

newTestCustomDataIdentifier Source #

Create a value of TestCustomDataIdentifier 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:keywords:TestCustomDataIdentifier', testCustomDataIdentifier_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:TestCustomDataIdentifier', testCustomDataIdentifier_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:TestCustomDataIdentifier', testCustomDataIdentifier_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:regex:TestCustomDataIdentifier', testCustomDataIdentifier_regex - The regular expression (regex) that defines the pattern to match. The expression can contain as many as 512 characters.

$sel:sampleText:TestCustomDataIdentifier', testCustomDataIdentifier_sampleText - The sample text to inspect by using the custom data identifier. The text can contain as many as 1,000 characters.

Request Lenses

testCustomDataIdentifier_keywords :: Lens' TestCustomDataIdentifier (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.

testCustomDataIdentifier_ignoreWords :: Lens' TestCustomDataIdentifier (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.

testCustomDataIdentifier_maximumMatchDistance :: Lens' TestCustomDataIdentifier (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.

testCustomDataIdentifier_regex :: Lens' TestCustomDataIdentifier Text Source #

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

testCustomDataIdentifier_sampleText :: Lens' TestCustomDataIdentifier Text Source #

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

Destructuring the Response

data TestCustomDataIdentifierResponse Source #

See: newTestCustomDataIdentifierResponse smart constructor.

Constructors

TestCustomDataIdentifierResponse' 

Fields

  • matchCount :: Maybe Int

    The number of instances of sample text that matched the detection criteria specified in the custom data identifier.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq TestCustomDataIdentifierResponse Source # 
Instance details

Defined in Amazonka.MacieV2.TestCustomDataIdentifier

Read TestCustomDataIdentifierResponse Source # 
Instance details

Defined in Amazonka.MacieV2.TestCustomDataIdentifier

Show TestCustomDataIdentifierResponse Source # 
Instance details

Defined in Amazonka.MacieV2.TestCustomDataIdentifier

Generic TestCustomDataIdentifierResponse Source # 
Instance details

Defined in Amazonka.MacieV2.TestCustomDataIdentifier

Associated Types

type Rep TestCustomDataIdentifierResponse :: Type -> Type #

NFData TestCustomDataIdentifierResponse Source # 
Instance details

Defined in Amazonka.MacieV2.TestCustomDataIdentifier

type Rep TestCustomDataIdentifierResponse Source # 
Instance details

Defined in Amazonka.MacieV2.TestCustomDataIdentifier

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

newTestCustomDataIdentifierResponse Source #

Create a value of TestCustomDataIdentifierResponse 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:matchCount:TestCustomDataIdentifierResponse', testCustomDataIdentifierResponse_matchCount - The number of instances of sample text that matched the detection criteria specified in the custom data identifier.

$sel:httpStatus:TestCustomDataIdentifierResponse', testCustomDataIdentifierResponse_httpStatus - The response's http status code.

Response Lenses

testCustomDataIdentifierResponse_matchCount :: Lens' TestCustomDataIdentifierResponse (Maybe Int) Source #

The number of instances of sample text that matched the detection criteria specified in the custom data identifier.