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

Description

Retrieves the settings and status of an allow list.

Synopsis

Creating a Request

data GetAllowList Source #

See: newGetAllowList smart constructor.

Constructors

GetAllowList' 

Fields

  • id :: Text

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

Instances

Instances details
ToHeaders GetAllowList Source # 
Instance details

Defined in Amazonka.MacieV2.GetAllowList

Methods

toHeaders :: GetAllowList -> [Header] #

ToPath GetAllowList Source # 
Instance details

Defined in Amazonka.MacieV2.GetAllowList

Methods

toPath :: GetAllowList -> ByteString #

ToQuery GetAllowList Source # 
Instance details

Defined in Amazonka.MacieV2.GetAllowList

Methods

toQuery :: GetAllowList -> QueryString #

AWSRequest GetAllowList Source # 
Instance details

Defined in Amazonka.MacieV2.GetAllowList

Associated Types

type AWSResponse GetAllowList #

Methods

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

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

Generic GetAllowList Source # 
Instance details

Defined in Amazonka.MacieV2.GetAllowList

Associated Types

type Rep GetAllowList :: Type -> Type #

Methods

from :: GetAllowList -> Rep GetAllowList x #

to :: Rep GetAllowList x -> GetAllowList #

Read GetAllowList Source # 
Instance details

Defined in Amazonka.MacieV2.GetAllowList

Methods

readsPrec :: Int -> ReadS GetAllowList #

readList :: ReadS [GetAllowList] #

readPrec :: ReadPrec GetAllowList #

readListPrec :: ReadPrec [GetAllowList] #

Show GetAllowList Source # 
Instance details

Defined in Amazonka.MacieV2.GetAllowList

Methods

showsPrec :: Int -> GetAllowList -> ShowS #

show :: GetAllowList -> String #

showList :: [GetAllowList] -> ShowS #

NFData GetAllowList Source # 
Instance details

Defined in Amazonka.MacieV2.GetAllowList

Methods

rnf :: GetAllowList -> () #

Eq GetAllowList Source # 
Instance details

Defined in Amazonka.MacieV2.GetAllowList

Methods

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

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

Hashable GetAllowList Source # 
Instance details

Defined in Amazonka.MacieV2.GetAllowList

Methods

hashWithSalt :: Int -> GetAllowList -> Int #

hash :: GetAllowList -> Int #

type AWSResponse GetAllowList Source # 
Instance details

Defined in Amazonka.MacieV2.GetAllowList

type AWSResponse GetAllowList = GetAllowListResponse
type Rep GetAllowList Source # 
Instance details

Defined in Amazonka.MacieV2.GetAllowList

type Rep GetAllowList = D1 ('MetaData "GetAllowList" "Amazonka.MacieV2.GetAllowList" "amazonka-maciev2-2.0-5WBPWSHaxt7LOrO1LzXg18" 'False) (C1 ('MetaCons "GetAllowList'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetAllowList Source #

Arguments

:: Text

GetAllowList

-> GetAllowList 

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

GetAllowList, getAllowList_id - The unique identifier for the Amazon Macie resource that the request applies to.

Request Lenses

getAllowList_id :: Lens' GetAllowList Text Source #

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

Destructuring the Response

data GetAllowListResponse Source #

See: newGetAllowListResponse smart constructor.

Constructors

GetAllowListResponse' 

Fields

  • arn :: Maybe Text

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

  • createdAt :: Maybe ISO8601

    The date and time, in UTC and extended ISO 8601 format, when the allow list was created in Amazon Macie.

  • criteria :: Maybe 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.

  • description :: Maybe Text

    The custom description of the allow list.

  • id :: Maybe Text

    The unique identifier for the allow list.

  • name :: Maybe Text

    The custom name of the allow list.

  • status :: Maybe AllowListStatus

    The current status of the allow list, which indicates whether Amazon Macie can access and use the list's criteria.

  • tags :: Maybe (HashMap Text Text)

    A map of key-value pairs that specifies which tags (keys and values) are associated with the allow list.

  • updatedAt :: Maybe ISO8601

    The date and time, in UTC and extended ISO 8601 format, when the allow list's settings were most recently changed in Amazon Macie.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic GetAllowListResponse Source # 
Instance details

Defined in Amazonka.MacieV2.GetAllowList

Associated Types

type Rep GetAllowListResponse :: Type -> Type #

Methods

from :: GetAllowListResponse -> Rep GetAllowListResponse x #

to :: Rep GetAllowListResponse x -> GetAllowListResponse #

Read GetAllowListResponse Source # 
Instance details

Defined in Amazonka.MacieV2.GetAllowList

Methods

readsPrec :: Int -> ReadS GetAllowListResponse #

readList :: ReadS [GetAllowListResponse] #

readPrec :: ReadPrec GetAllowListResponse #

readListPrec :: ReadPrec [GetAllowListResponse] #

Show GetAllowListResponse Source # 
Instance details

Defined in Amazonka.MacieV2.GetAllowList

Methods

showsPrec :: Int -> GetAllowListResponse -> ShowS #

show :: GetAllowListResponse -> String #

showList :: [GetAllowListResponse] -> ShowS #

NFData GetAllowListResponse Source # 
Instance details

Defined in Amazonka.MacieV2.GetAllowList

Methods

rnf :: GetAllowListResponse -> () #

Eq GetAllowListResponse Source # 
Instance details

Defined in Amazonka.MacieV2.GetAllowList

Methods

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

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

type Rep GetAllowListResponse Source # 
Instance details

Defined in Amazonka.MacieV2.GetAllowList

type Rep GetAllowListResponse = D1 ('MetaData "GetAllowListResponse" "Amazonka.MacieV2.GetAllowList" "amazonka-maciev2-2.0-5WBPWSHaxt7LOrO1LzXg18" 'False) (C1 ('MetaCons "GetAllowListResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))) :*: (S1 ('MetaSel ('Just "criteria") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AllowListCriteria)) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AllowListStatus))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: (S1 ('MetaSel ('Just "updatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newGetAllowListResponse Source #

Arguments

:: Int

$sel:httpStatus:GetAllowListResponse'

-> GetAllowListResponse 

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

GetAllowListResponse, getAllowListResponse_arn - The Amazon Resource Name (ARN) of the allow list.

GetAllowListResponse, getAllowListResponse_createdAt - The date and time, in UTC and extended ISO 8601 format, when the allow list was created in Amazon Macie.

$sel:criteria:GetAllowListResponse', getAllowListResponse_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.

GetAllowListResponse, getAllowListResponse_description - The custom description of the allow list.

GetAllowList, getAllowListResponse_id - The unique identifier for the allow list.

GetAllowListResponse, getAllowListResponse_name - The custom name of the allow list.

GetAllowListResponse, getAllowListResponse_status - The current status of the allow list, which indicates whether Amazon Macie can access and use the list's criteria.

GetAllowListResponse, getAllowListResponse_tags - A map of key-value pairs that specifies which tags (keys and values) are associated with the allow list.

GetAllowListResponse, getAllowListResponse_updatedAt - The date and time, in UTC and extended ISO 8601 format, when the allow list's settings were most recently changed in Amazon Macie.

$sel:httpStatus:GetAllowListResponse', getAllowListResponse_httpStatus - The response's http status code.

Response Lenses

getAllowListResponse_arn :: Lens' GetAllowListResponse (Maybe Text) Source #

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

getAllowListResponse_createdAt :: Lens' GetAllowListResponse (Maybe UTCTime) Source #

The date and time, in UTC and extended ISO 8601 format, when the allow list was created in Amazon Macie.

getAllowListResponse_criteria :: Lens' GetAllowListResponse (Maybe 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.

getAllowListResponse_description :: Lens' GetAllowListResponse (Maybe Text) Source #

The custom description of the allow list.

getAllowListResponse_id :: Lens' GetAllowListResponse (Maybe Text) Source #

The unique identifier for the allow list.

getAllowListResponse_name :: Lens' GetAllowListResponse (Maybe Text) Source #

The custom name of the allow list.

getAllowListResponse_status :: Lens' GetAllowListResponse (Maybe AllowListStatus) Source #

The current status of the allow list, which indicates whether Amazon Macie can access and use the list's criteria.

getAllowListResponse_tags :: Lens' GetAllowListResponse (Maybe (HashMap Text Text)) Source #

A map of key-value pairs that specifies which tags (keys and values) are associated with the allow list.

getAllowListResponse_updatedAt :: Lens' GetAllowListResponse (Maybe UTCTime) Source #

The date and time, in UTC and extended ISO 8601 format, when the allow list's settings were most recently changed in Amazon Macie.

getAllowListResponse_httpStatus :: Lens' GetAllowListResponse Int Source #

The response's http status code.