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

Description

Updates the settings for an allow list.

Synopsis

Creating a Request

data UpdateAllowList Source #

See: newUpdateAllowList smart constructor.

Constructors

UpdateAllowList' 

Fields

  • description :: Maybe Text

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

  • id :: Text

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

  • 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 that defines a text pattern to ignore (regex).

    You can change a list's underlying criteria, such as the name of the S3 object or the regular expression to use. However, you can't change the type from s3WordsList to regex or the other way around.

  • name :: Text

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

Instances

Instances details
ToJSON UpdateAllowList Source # 
Instance details

Defined in Amazonka.MacieV2.UpdateAllowList

Methods

toJSON :: UpdateAllowList -> Value #

toEncoding :: UpdateAllowList -> Encoding #

toJSONList :: [UpdateAllowList] -> Value #

toEncodingList :: [UpdateAllowList] -> Encoding #

ToHeaders UpdateAllowList Source # 
Instance details

Defined in Amazonka.MacieV2.UpdateAllowList

Methods

toHeaders :: UpdateAllowList -> [Header] #

ToPath UpdateAllowList Source # 
Instance details

Defined in Amazonka.MacieV2.UpdateAllowList

Methods

toPath :: UpdateAllowList -> ByteString #

ToQuery UpdateAllowList Source # 
Instance details

Defined in Amazonka.MacieV2.UpdateAllowList

Methods

toQuery :: UpdateAllowList -> QueryString #

AWSRequest UpdateAllowList Source # 
Instance details

Defined in Amazonka.MacieV2.UpdateAllowList

Associated Types

type AWSResponse UpdateAllowList #

Methods

request :: (Service -> Service) -> UpdateAllowList -> Request UpdateAllowList #

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

Generic UpdateAllowList Source # 
Instance details

Defined in Amazonka.MacieV2.UpdateAllowList

Associated Types

type Rep UpdateAllowList :: Type -> Type #

Methods

from :: UpdateAllowList -> Rep UpdateAllowList x #

to :: Rep UpdateAllowList x -> UpdateAllowList #

Read UpdateAllowList Source # 
Instance details

Defined in Amazonka.MacieV2.UpdateAllowList

Methods

readsPrec :: Int -> ReadS UpdateAllowList #

readList :: ReadS [UpdateAllowList] #

readPrec :: ReadPrec UpdateAllowList #

readListPrec :: ReadPrec [UpdateAllowList] #

Show UpdateAllowList Source # 
Instance details

Defined in Amazonka.MacieV2.UpdateAllowList

Methods

showsPrec :: Int -> UpdateAllowList -> ShowS #

show :: UpdateAllowList -> String #

showList :: [UpdateAllowList] -> ShowS #

NFData UpdateAllowList Source # 
Instance details

Defined in Amazonka.MacieV2.UpdateAllowList

Methods

rnf :: UpdateAllowList -> () #

Eq UpdateAllowList Source # 
Instance details

Defined in Amazonka.MacieV2.UpdateAllowList

Methods

(==) :: UpdateAllowList -> UpdateAllowList -> Bool #

(/=) :: UpdateAllowList -> UpdateAllowList -> Bool #

Hashable UpdateAllowList Source # 
Instance details

Defined in Amazonka.MacieV2.UpdateAllowList

Methods

hashWithSalt :: Int -> UpdateAllowList -> Int #

hash :: UpdateAllowList -> Int #

type AWSResponse UpdateAllowList Source # 
Instance details

Defined in Amazonka.MacieV2.UpdateAllowList

type AWSResponse UpdateAllowList = UpdateAllowListResponse
type Rep UpdateAllowList Source # 
Instance details

Defined in Amazonka.MacieV2.UpdateAllowList

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

newUpdateAllowList Source #

Arguments

:: Text

UpdateAllowList

-> AllowListCriteria

$sel:criteria:UpdateAllowList'

-> Text

UpdateAllowList

-> UpdateAllowList 

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

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

UpdateAllowList, updateAllowList_id - The unique identifier for the Amazon Macie resource that the request applies to.

$sel:criteria:UpdateAllowList', updateAllowList_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 that defines a text pattern to ignore (regex).

You can change a list's underlying criteria, such as the name of the S3 object or the regular expression to use. However, you can't change the type from s3WordsList to regex or the other way around.

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

Request Lenses

updateAllowList_description :: Lens' UpdateAllowList (Maybe Text) Source #

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

updateAllowList_id :: Lens' UpdateAllowList Text Source #

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

updateAllowList_criteria :: Lens' UpdateAllowList 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 that defines a text pattern to ignore (regex).

You can change a list's underlying criteria, such as the name of the S3 object or the regular expression to use. However, you can't change the type from s3WordsList to regex or the other way around.

updateAllowList_name :: Lens' UpdateAllowList Text Source #

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

Destructuring the Response

data UpdateAllowListResponse Source #

See: newUpdateAllowListResponse smart constructor.

Constructors

UpdateAllowListResponse' 

Fields

Instances

Instances details
Generic UpdateAllowListResponse Source # 
Instance details

Defined in Amazonka.MacieV2.UpdateAllowList

Associated Types

type Rep UpdateAllowListResponse :: Type -> Type #

Methods

from :: UpdateAllowListResponse -> Rep UpdateAllowListResponse x #

to :: Rep UpdateAllowListResponse x -> UpdateAllowListResponse #

Read UpdateAllowListResponse Source # 
Instance details

Defined in Amazonka.MacieV2.UpdateAllowList

Methods

readsPrec :: Int -> ReadS UpdateAllowListResponse #

readList :: ReadS [UpdateAllowListResponse] #

readPrec :: ReadPrec UpdateAllowListResponse #

readListPrec :: ReadPrec [UpdateAllowListResponse] #

Show UpdateAllowListResponse Source # 
Instance details

Defined in Amazonka.MacieV2.UpdateAllowList

Methods

showsPrec :: Int -> UpdateAllowListResponse -> ShowS #

show :: UpdateAllowListResponse -> String #

showList :: [UpdateAllowListResponse] -> ShowS #

NFData UpdateAllowListResponse Source # 
Instance details

Defined in Amazonka.MacieV2.UpdateAllowList

Methods

rnf :: UpdateAllowListResponse -> () #

Eq UpdateAllowListResponse Source # 
Instance details

Defined in Amazonka.MacieV2.UpdateAllowList

Methods

(==) :: UpdateAllowListResponse -> UpdateAllowListResponse -> Bool #

(/=) :: UpdateAllowListResponse -> UpdateAllowListResponse -> Bool #

type Rep UpdateAllowListResponse Source # 
Instance details

Defined in Amazonka.MacieV2.UpdateAllowList

type Rep UpdateAllowListResponse = D1 ('MetaData "UpdateAllowListResponse" "Amazonka.MacieV2.UpdateAllowList" "amazonka-maciev2-2.0-5WBPWSHaxt7LOrO1LzXg18" 'False) (C1 ('MetaCons "UpdateAllowListResponse'" '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))))

newUpdateAllowListResponse Source #

Arguments

:: Int

$sel:httpStatus:UpdateAllowListResponse'

-> UpdateAllowListResponse 

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

UpdateAllowListResponse, updateAllowListResponse_arn - The Amazon Resource Name (ARN) of the allow list.

UpdateAllowList, updateAllowListResponse_id - The unique identifier for the allow list.

$sel:httpStatus:UpdateAllowListResponse', updateAllowListResponse_httpStatus - The response's http status code.

Response Lenses

updateAllowListResponse_arn :: Lens' UpdateAllowListResponse (Maybe Text) Source #

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

updateAllowListResponse_id :: Lens' UpdateAllowListResponse (Maybe Text) Source #

The unique identifier for the allow list.

updateAllowListResponse_httpStatus :: Lens' UpdateAllowListResponse Int Source #

The response's http status code.