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

Description

Creates and defines the settings for an allow list.

Synopsis

Creating a Request

data CreateAllowList Source #

See: newCreateAllowList smart constructor.

Constructors

CreateAllowList' 

Fields

  • description :: Maybe Text

    A custom description of the allow list. The description can contain as many as 512 characters.

  • tags :: Maybe (HashMap Text Text)

    A map of key-value pairs that specifies the tags to associate with the allow list.

    An allow list 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.

  • criteria :: AllowListCriteria

    The criteria that specify the text or text pattern to ignore. The criteria can be the location and name of an S3 object that lists specific text to ignore (s3WordsList), or a regular expression (regex) that defines a text pattern to ignore.

  • clientToken :: Text

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

  • name :: Text

    A custom name for the allow list. The name can contain as many as 128 characters.

Instances

Instances details
ToJSON CreateAllowList Source # 
Instance details

Defined in Amazonka.MacieV2.CreateAllowList

ToHeaders CreateAllowList Source # 
Instance details

Defined in Amazonka.MacieV2.CreateAllowList

ToPath CreateAllowList Source # 
Instance details

Defined in Amazonka.MacieV2.CreateAllowList

ToQuery CreateAllowList Source # 
Instance details

Defined in Amazonka.MacieV2.CreateAllowList

AWSRequest CreateAllowList Source # 
Instance details

Defined in Amazonka.MacieV2.CreateAllowList

Associated Types

type AWSResponse CreateAllowList #

Generic CreateAllowList Source # 
Instance details

Defined in Amazonka.MacieV2.CreateAllowList

Associated Types

type Rep CreateAllowList :: Type -> Type #

Read CreateAllowList Source # 
Instance details

Defined in Amazonka.MacieV2.CreateAllowList

Show CreateAllowList Source # 
Instance details

Defined in Amazonka.MacieV2.CreateAllowList

NFData CreateAllowList Source # 
Instance details

Defined in Amazonka.MacieV2.CreateAllowList

Methods

rnf :: CreateAllowList -> () #

Eq CreateAllowList Source # 
Instance details

Defined in Amazonka.MacieV2.CreateAllowList

Hashable CreateAllowList Source # 
Instance details

Defined in Amazonka.MacieV2.CreateAllowList

type AWSResponse CreateAllowList Source # 
Instance details

Defined in Amazonka.MacieV2.CreateAllowList

type Rep CreateAllowList Source # 
Instance details

Defined in Amazonka.MacieV2.CreateAllowList

type Rep CreateAllowList = D1 ('MetaData "CreateAllowList" "Amazonka.MacieV2.CreateAllowList" "amazonka-maciev2-2.0-5WBPWSHaxt7LOrO1LzXg18" 'False) (C1 ('MetaCons "CreateAllowList'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :*: (S1 ('MetaSel ('Just "criteria") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AllowListCriteria) :*: (S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateAllowList Source #

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

CreateAllowList, createAllowList_description - A custom description of the allow list. The description can contain as many as 512 characters.

CreateAllowList, createAllowList_tags - A map of key-value pairs that specifies the tags to associate with the allow list.

An allow list 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.

$sel:criteria:CreateAllowList', createAllowList_criteria - The criteria that specify the text or text pattern to ignore. The criteria can be the location and name of an S3 object that lists specific text to ignore (s3WordsList), or a regular expression (regex) that defines a text pattern to ignore.

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

CreateAllowList, createAllowList_name - A custom name for the allow list. The name can contain as many as 128 characters.

Request Lenses

createAllowList_description :: Lens' CreateAllowList (Maybe Text) Source #

A custom description of the allow list. The description can contain as many as 512 characters.

createAllowList_tags :: Lens' CreateAllowList (Maybe (HashMap Text Text)) Source #

A map of key-value pairs that specifies the tags to associate with the allow list.

An allow list 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.

createAllowList_criteria :: Lens' CreateAllowList AllowListCriteria Source #

The criteria that specify the text or text pattern to ignore. The criteria can be the location and name of an S3 object that lists specific text to ignore (s3WordsList), or a regular expression (regex) that defines a text pattern to ignore.

createAllowList_clientToken :: Lens' CreateAllowList Text Source #

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

createAllowList_name :: Lens' CreateAllowList Text Source #

A custom name for the allow list. The name can contain as many as 128 characters.

Destructuring the Response

data CreateAllowListResponse Source #

See: newCreateAllowListResponse smart constructor.

Constructors

CreateAllowListResponse' 

Fields

Instances

Instances details
Generic CreateAllowListResponse Source # 
Instance details

Defined in Amazonka.MacieV2.CreateAllowList

Associated Types

type Rep CreateAllowListResponse :: Type -> Type #

Read CreateAllowListResponse Source # 
Instance details

Defined in Amazonka.MacieV2.CreateAllowList

Show CreateAllowListResponse Source # 
Instance details

Defined in Amazonka.MacieV2.CreateAllowList

NFData CreateAllowListResponse Source # 
Instance details

Defined in Amazonka.MacieV2.CreateAllowList

Methods

rnf :: CreateAllowListResponse -> () #

Eq CreateAllowListResponse Source # 
Instance details

Defined in Amazonka.MacieV2.CreateAllowList

type Rep CreateAllowListResponse Source # 
Instance details

Defined in Amazonka.MacieV2.CreateAllowList

type Rep CreateAllowListResponse = D1 ('MetaData "CreateAllowListResponse" "Amazonka.MacieV2.CreateAllowList" "amazonka-maciev2-2.0-5WBPWSHaxt7LOrO1LzXg18" 'False) (C1 ('MetaCons "CreateAllowListResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateAllowListResponse Source #

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

CreateAllowListResponse, createAllowListResponse_arn - The Amazon Resource Name (ARN) of the allow list.

CreateAllowListResponse, createAllowListResponse_id - The unique identifier for the allow list.

$sel:httpStatus:CreateAllowListResponse', createAllowListResponse_httpStatus - The response's http status code.

Response Lenses

createAllowListResponse_arn :: Lens' CreateAllowListResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the allow list.

createAllowListResponse_id :: Lens' CreateAllowListResponse (Maybe Text) Source #

The unique identifier for the allow list.