Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CloudTrail.ListTags

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the tags for the trail or event data store in the current region.

This operation returns paginated results.

Synopsis

data ListTags = ListTags' {
- nextToken :: Maybe Text
- resourceIdList :: [Text]
}
newListTags :: ListTags
listTags_nextToken :: Lens' ListTags (Maybe Text)
listTags_resourceIdList :: Lens' ListTags [Text]
data ListTagsResponse = ListTagsResponse' {
- nextToken :: Maybe Text
- resourceTagList :: Maybe [ResourceTag]
- httpStatus :: Int
}
newListTagsResponse :: Int -> ListTagsResponse
listTagsResponse_nextToken :: Lens' ListTagsResponse (Maybe Text)
listTagsResponse_resourceTagList :: Lens' ListTagsResponse (Maybe [ResourceTag])
listTagsResponse_httpStatus :: Lens' ListTagsResponse Int

Creating a Request

data ListTags Source #

Specifies a list of tags to return.

See: newListTags smart constructor.

Constructors

ListTags'
Fields nextToken :: Maybe Text Reserved for future use. resourceIdList :: [Text] Specifies a list of trail and event data store ARNs whose tags will be listed. The list has a limit of 20 ARNs.

Instances

newListTags :: ListTags Source #

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

ListTags, listTags_nextToken - Reserved for future use.

$sel:resourceIdList:ListTags', listTags_resourceIdList - Specifies a list of trail and event data store ARNs whose tags will be listed. The list has a limit of 20 ARNs.

Request Lenses

listTags_nextToken :: Lens' ListTags (Maybe Text) Source #

Reserved for future use.

listTags_resourceIdList :: Lens' ListTags [Text] Source #

Specifies a list of trail and event data store ARNs whose tags will be listed. The list has a limit of 20 ARNs.

Destructuring the Response

data ListTagsResponse Source #

Returns the objects or data listed below if successful. Otherwise, returns an error.

See: newListTagsResponse smart constructor.

Constructors

ListTagsResponse'
Fields nextToken :: Maybe Text Reserved for future use. resourceTagList :: Maybe [ResourceTag] A list of resource tags. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListTagsResponse Source #
Instance details Defined in Amazonka.CloudTrail.ListTags Associated Types type Rep ListTagsResponse :: Type -> Type # Methods from :: ListTagsResponse -> Rep ListTagsResponse x # to :: Rep ListTagsResponse x -> ListTagsResponse #
Read ListTagsResponse Source #
Instance details Defined in Amazonka.CloudTrail.ListTags Methods readsPrec :: Int -> ReadS ListTagsResponse # readList :: ReadS [ListTagsResponse] # readPrec :: ReadPrec ListTagsResponse # readListPrec :: ReadPrec [ListTagsResponse] #
Show ListTagsResponse Source #
Instance details Defined in Amazonka.CloudTrail.ListTags Methods showsPrec :: Int -> ListTagsResponse -> ShowS # show :: ListTagsResponse -> String # showList :: [ListTagsResponse] -> ShowS #
NFData ListTagsResponse Source #
Instance details Defined in Amazonka.CloudTrail.ListTags Methods rnf :: ListTagsResponse -> () #
Eq ListTagsResponse Source #
Instance details Defined in Amazonka.CloudTrail.ListTags Methods (==) :: ListTagsResponse -> ListTagsResponse -> Bool # (/=) :: ListTagsResponse -> ListTagsResponse -> Bool #
type Rep ListTagsResponse Source #
Instance details Defined in Amazonka.CloudTrail.ListTags type Rep ListTagsResponse = D1 ('MetaData "ListTagsResponse" "Amazonka.CloudTrail.ListTags" "amazonka-cloudtrail-2.0-6vmpMB1YeZzDIMmexWGsF3" 'False) (C1 ('MetaCons "ListTagsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "resourceTagList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ResourceTag])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListTagsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListTagsResponse'`
-> ListTagsResponse

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

ListTags, listTagsResponse_nextToken - Reserved for future use.

$sel:resourceTagList:ListTagsResponse', listTagsResponse_resourceTagList - A list of resource tags.

$sel:httpStatus:ListTagsResponse', listTagsResponse_httpStatus - The response's http status code.

Response Lenses

listTagsResponse_nextToken :: Lens' ListTagsResponse (Maybe Text) Source #

Reserved for future use.

listTagsResponse_resourceTagList :: Lens' ListTagsResponse (Maybe [ResourceTag]) Source #

A list of resource tags.

listTagsResponse_httpStatus :: Lens' ListTagsResponse Int Source #

The response's http status code.

ToJSON ListTags Source #
Instance details Defined in Amazonka.CloudTrail.ListTags Methods toJSON :: ListTags -> Value # toEncoding :: ListTags -> Encoding # toJSONList :: [ListTags] -> Value # toEncodingList :: [ListTags] -> Encoding #
ToHeaders ListTags Source #
Instance details Defined in Amazonka.CloudTrail.ListTags Methods toHeaders :: ListTags -> [Header] #
ToPath ListTags Source #
Instance details Defined in Amazonka.CloudTrail.ListTags Methods toPath :: ListTags -> ByteString #
ToQuery ListTags Source #
Instance details Defined in Amazonka.CloudTrail.ListTags Methods toQuery :: ListTags -> QueryString #
AWSPager ListTags Source #
Instance details Defined in Amazonka.CloudTrail.ListTags Methods page :: ListTags -> AWSResponse ListTags -> Maybe ListTags #
AWSRequest ListTags Source #
Instance details Defined in Amazonka.CloudTrail.ListTags Associated Types type AWSResponse ListTags # Methods request :: (Service -> Service) -> ListTags -> Request ListTags # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListTags -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListTags))) #
Generic ListTags Source #
Instance details Defined in Amazonka.CloudTrail.ListTags Associated Types type Rep ListTags :: Type -> Type # Methods from :: ListTags -> Rep ListTags x # to :: Rep ListTags x -> ListTags #
Read ListTags Source #
Instance details Defined in Amazonka.CloudTrail.ListTags Methods readsPrec :: Int -> ReadS ListTags # readList :: ReadS [ListTags] # readPrec :: ReadPrec ListTags # readListPrec :: ReadPrec [ListTags] #
Show ListTags Source #
Instance details Defined in Amazonka.CloudTrail.ListTags Methods showsPrec :: Int -> ListTags -> ShowS # show :: ListTags -> String # showList :: [ListTags] -> ShowS #
NFData ListTags Source #
Instance details Defined in Amazonka.CloudTrail.ListTags Methods rnf :: ListTags -> () #
Eq ListTags Source #
Instance details Defined in Amazonka.CloudTrail.ListTags Methods (==) :: ListTags -> ListTags -> Bool # (/=) :: ListTags -> ListTags -> Bool #
Hashable ListTags Source #
Instance details Defined in Amazonka.CloudTrail.ListTags Methods hashWithSalt :: Int -> ListTags -> Int # hash :: ListTags -> Int #
type AWSResponse ListTags Source #
Instance details Defined in Amazonka.CloudTrail.ListTags type AWSResponse ListTags = ListTagsResponse
type Rep ListTags Source #
Instance details Defined in Amazonka.CloudTrail.ListTags type Rep ListTags = D1 ('MetaData "ListTags" "Amazonka.CloudTrail.ListTags" "amazonka-cloudtrail-2.0-6vmpMB1YeZzDIMmexWGsF3" 'False) (C1 ('MetaCons "ListTags'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "resourceIdList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])))