Amazonka.MacieV2.CreateAllowList

Creates and defines the settings for an allow list.

Creating a Request

data CreateAllowList

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

ToJSON CreateAllowList

Defined in Amazonka.MacieV2.CreateAllowList

Methods

toJSON :: CreateAllowList -> Value

toEncoding :: CreateAllowList -> Encoding

toJSONList :: [CreateAllowList] -> Value

toEncodingList :: [CreateAllowList] -> Encoding

ToHeaders CreateAllowList

Defined in Amazonka.MacieV2.CreateAllowList

Methods

toHeaders :: CreateAllowList -> [Header]

ToPath CreateAllowList

Defined in Amazonka.MacieV2.CreateAllowList

Methods

toPath :: CreateAllowList -> ByteString

ToQuery CreateAllowList

Defined in Amazonka.MacieV2.CreateAllowList

Methods

toQuery :: CreateAllowList -> QueryString

AWSRequest CreateAllowList

Defined in Amazonka.MacieV2.CreateAllowList

Associated Types

type AWSResponse CreateAllowList

Methods

request :: (Service -> Service) -> CreateAllowList -> Request CreateAllowList

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateAllowList -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateAllowList)))

Generic CreateAllowList

Defined in Amazonka.MacieV2.CreateAllowList

Associated Types

type Rep CreateAllowList :: Type -> Type

Methods

from :: CreateAllowList -> Rep CreateAllowList x

to :: Rep CreateAllowList x -> CreateAllowList

Read CreateAllowList

Defined in Amazonka.MacieV2.CreateAllowList

Methods

readsPrec :: Int -> ReadS CreateAllowList

readList :: ReadS [CreateAllowList]

readPrec :: ReadPrec CreateAllowList

readListPrec :: ReadPrec [CreateAllowList]

Show CreateAllowList

Defined in Amazonka.MacieV2.CreateAllowList

Methods

showsPrec :: Int -> CreateAllowList -> ShowS

show :: CreateAllowList -> String

showList :: [CreateAllowList] -> ShowS

NFData CreateAllowList

Defined in Amazonka.MacieV2.CreateAllowList

Methods

rnf :: CreateAllowList -> ()

Eq CreateAllowList

Defined in Amazonka.MacieV2.CreateAllowList

Methods

(==) :: CreateAllowList -> CreateAllowList -> Bool

(/=) :: CreateAllowList -> CreateAllowList -> Bool

Hashable CreateAllowList

Defined in Amazonka.MacieV2.CreateAllowList

Methods

hashWithSalt :: Int -> CreateAllowList -> Int

hash :: CreateAllowList -> Int

type AWSResponse CreateAllowList

Defined in Amazonka.MacieV2.CreateAllowList

type AWSResponse CreateAllowList = CreateAllowListResponse

type Rep CreateAllowList

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

Arguments

:: AllowListCriteria

$sel:criteria:CreateAllowList'

-> Text

$sel:clientToken:CreateAllowList'

-> Text

CreateAllowList

-> CreateAllowList

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)

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

createAllowList_tags :: Lens' CreateAllowList (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.

createAllowList_criteria :: Lens' CreateAllowList 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.

createAllowList_clientToken :: Lens' CreateAllowList Text

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

createAllowList_name :: Lens' CreateAllowList Text

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

Destructuring the Response

data CreateAllowListResponse

See: newCreateAllowListResponse smart constructor.

Constructors

CreateAllowListResponse'

Fields

• arn :: Maybe Text

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

• id :: Maybe Text

  The unique identifier for the allow list.

• httpStatus :: Int

  The response's http status code.

Instances

Generic CreateAllowListResponse

Defined in Amazonka.MacieV2.CreateAllowList

Associated Types

type Rep CreateAllowListResponse :: Type -> Type

Methods

from :: CreateAllowListResponse -> Rep CreateAllowListResponse x

to :: Rep CreateAllowListResponse x -> CreateAllowListResponse

Read CreateAllowListResponse

Defined in Amazonka.MacieV2.CreateAllowList

Methods

readsPrec :: Int -> ReadS CreateAllowListResponse

readList :: ReadS [CreateAllowListResponse]

readPrec :: ReadPrec CreateAllowListResponse

readListPrec :: ReadPrec [CreateAllowListResponse]

Show CreateAllowListResponse

Defined in Amazonka.MacieV2.CreateAllowList

Methods

showsPrec :: Int -> CreateAllowListResponse -> ShowS

show :: CreateAllowListResponse -> String

showList :: [CreateAllowListResponse] -> ShowS

NFData CreateAllowListResponse

Defined in Amazonka.MacieV2.CreateAllowList

Methods

rnf :: CreateAllowListResponse -> ()

Eq CreateAllowListResponse

Defined in Amazonka.MacieV2.CreateAllowList

Methods

(==) :: CreateAllowListResponse -> CreateAllowListResponse -> Bool

(/=) :: CreateAllowListResponse -> CreateAllowListResponse -> Bool

type Rep CreateAllowListResponse

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

Arguments

:: Int

$sel:httpStatus:CreateAllowListResponse'

-> CreateAllowListResponse

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)

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

createAllowListResponse_id :: Lens' CreateAllowListResponse (Maybe Text)

The unique identifier for the allow list.

createAllowListResponse_httpStatus :: Lens' CreateAllowListResponse Int

The response's http status code.