Copyright	(c) 2013-2018 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.KMS.ListResourceTags

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of all tags for the specified customer master key (CMK).

You cannot perform this operation on a CMK in a different AWS account.

Creating a Request

listResourceTags #

Arguments

:: Text	`lrtKeyId`
-> ListResourceTags

Creates a value of ListResourceTags with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

lrtMarker - Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received. Do not attempt to construct this value. Use only the value of NextMarker from the truncated response you just received.
lrtLimit - Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer. This value is optional. If you include a value, it must be between 1 and 50, inclusive. If you do not include a value, it defaults to 50.
lrtKeyId - A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK. For example: * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey .

data ListResourceTags #

See: listResourceTags smart constructor.

Instances

Eq ListResourceTags #
Instance details Defined in Network.AWS.KMS.ListResourceTags Methods (==) :: ListResourceTags -> ListResourceTags -> Bool # (/=) :: ListResourceTags -> ListResourceTags -> Bool #
Data ListResourceTags #
Instance details Defined in Network.AWS.KMS.ListResourceTags Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListResourceTags -> c ListResourceTags # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListResourceTags # toConstr :: ListResourceTags -> Constr # dataTypeOf :: ListResourceTags -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ListResourceTags) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListResourceTags) # gmapT :: (forall b. Data b => b -> b) -> ListResourceTags -> ListResourceTags # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListResourceTags -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListResourceTags -> r # gmapQ :: (forall d. Data d => d -> u) -> ListResourceTags -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ListResourceTags -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListResourceTags -> m ListResourceTags # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListResourceTags -> m ListResourceTags # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListResourceTags -> m ListResourceTags #
Read ListResourceTags #
Instance details Defined in Network.AWS.KMS.ListResourceTags Methods readsPrec :: Int -> ReadS ListResourceTags # readList :: ReadS [ListResourceTags] # readPrec :: ReadPrec ListResourceTags # readListPrec :: ReadPrec [ListResourceTags] #
Show ListResourceTags #
Instance details Defined in Network.AWS.KMS.ListResourceTags Methods showsPrec :: Int -> ListResourceTags -> ShowS # show :: ListResourceTags -> String # showList :: [ListResourceTags] -> ShowS #
Generic ListResourceTags #
Instance details Defined in Network.AWS.KMS.ListResourceTags Associated Types type Rep ListResourceTags :: * -> * # Methods from :: ListResourceTags -> Rep ListResourceTags x # to :: Rep ListResourceTags x -> ListResourceTags #
Hashable ListResourceTags #
Instance details Defined in Network.AWS.KMS.ListResourceTags Methods hashWithSalt :: Int -> ListResourceTags -> Int # hash :: ListResourceTags -> Int #
ToJSON ListResourceTags #
Instance details Defined in Network.AWS.KMS.ListResourceTags Methods toJSON :: ListResourceTags -> Value # toEncoding :: ListResourceTags -> Encoding # toJSONList :: [ListResourceTags] -> Value # toEncodingList :: [ListResourceTags] -> Encoding #
AWSRequest ListResourceTags #
Instance details Defined in Network.AWS.KMS.ListResourceTags Associated Types type Rs ListResourceTags :: * # Methods request :: ListResourceTags -> Request ListResourceTags # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy ListResourceTags -> ClientResponse -> m (Response ListResourceTags) #
ToHeaders ListResourceTags #
Instance details Defined in Network.AWS.KMS.ListResourceTags Methods toHeaders :: ListResourceTags -> [Header] #
ToPath ListResourceTags #
Instance details Defined in Network.AWS.KMS.ListResourceTags Methods toPath :: ListResourceTags -> ByteString #
ToQuery ListResourceTags #
Instance details Defined in Network.AWS.KMS.ListResourceTags Methods toQuery :: ListResourceTags -> QueryString #
NFData ListResourceTags #
Instance details Defined in Network.AWS.KMS.ListResourceTags Methods rnf :: ListResourceTags -> () #
type Rep ListResourceTags #
Instance details Defined in Network.AWS.KMS.ListResourceTags type Rep ListResourceTags = D1 (MetaData "ListResourceTags" "Network.AWS.KMS.ListResourceTags" "amazonka-kms-1.6.0-J0DpkKKCQ2By8yYSyE2w7" False) (C1 (MetaCons "ListResourceTags'" PrefixI True) (S1 (MetaSel (Just "_lrtMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_lrtLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)) :: S1 (MetaSel (Just "_lrtKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))
type Rs ListResourceTags #
Instance details Defined in Network.AWS.KMS.ListResourceTags type Rs ListResourceTags = ListResourceTagsResponse

Request Lenses

lrtMarker :: Lens' ListResourceTags (Maybe Text) #

Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received. Do not attempt to construct this value. Use only the value of NextMarker from the truncated response you just received.

lrtLimit :: Lens' ListResourceTags (Maybe Natural) #

Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer. This value is optional. If you include a value, it must be between 1 and 50, inclusive. If you do not include a value, it defaults to 50.

lrtKeyId :: Lens' ListResourceTags Text #

A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK. For example: * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey .

Destructuring the Response

listResourceTagsResponse #

Arguments

:: Int	`lrtrsResponseStatus`
-> ListResourceTagsResponse

Creates a value of ListResourceTagsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

lrtrsTruncated - A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in this response to the Marker parameter in a subsequent request.
lrtrsNextMarker - When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request. Do not assume or infer any information from this value.
lrtrsTags - A list of tags. Each tag consists of a tag key and a tag value.
lrtrsResponseStatus - -- | The response status code.

data ListResourceTagsResponse #

See: listResourceTagsResponse smart constructor.

Instances

Eq ListResourceTagsResponse #
Instance details Defined in Network.AWS.KMS.ListResourceTags Methods (==) :: ListResourceTagsResponse -> ListResourceTagsResponse -> Bool # (/=) :: ListResourceTagsResponse -> ListResourceTagsResponse -> Bool #
Data ListResourceTagsResponse #
Instance details Defined in Network.AWS.KMS.ListResourceTags Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListResourceTagsResponse -> c ListResourceTagsResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListResourceTagsResponse # toConstr :: ListResourceTagsResponse -> Constr # dataTypeOf :: ListResourceTagsResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ListResourceTagsResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListResourceTagsResponse) # gmapT :: (forall b. Data b => b -> b) -> ListResourceTagsResponse -> ListResourceTagsResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListResourceTagsResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListResourceTagsResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> ListResourceTagsResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ListResourceTagsResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListResourceTagsResponse -> m ListResourceTagsResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListResourceTagsResponse -> m ListResourceTagsResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListResourceTagsResponse -> m ListResourceTagsResponse #
Read ListResourceTagsResponse #
Instance details Defined in Network.AWS.KMS.ListResourceTags Methods readsPrec :: Int -> ReadS ListResourceTagsResponse # readList :: ReadS [ListResourceTagsResponse] # readPrec :: ReadPrec ListResourceTagsResponse # readListPrec :: ReadPrec [ListResourceTagsResponse] #
Show ListResourceTagsResponse #
Instance details Defined in Network.AWS.KMS.ListResourceTags Methods showsPrec :: Int -> ListResourceTagsResponse -> ShowS # show :: ListResourceTagsResponse -> String # showList :: [ListResourceTagsResponse] -> ShowS #
Generic ListResourceTagsResponse #
Instance details Defined in Network.AWS.KMS.ListResourceTags Associated Types type Rep ListResourceTagsResponse :: * -> * # Methods from :: ListResourceTagsResponse -> Rep ListResourceTagsResponse x # to :: Rep ListResourceTagsResponse x -> ListResourceTagsResponse #
NFData ListResourceTagsResponse #
Instance details Defined in Network.AWS.KMS.ListResourceTags Methods rnf :: ListResourceTagsResponse -> () #
type Rep ListResourceTagsResponse #
Instance details Defined in Network.AWS.KMS.ListResourceTags type Rep ListResourceTagsResponse = D1 (MetaData "ListResourceTagsResponse" "Network.AWS.KMS.ListResourceTags" "amazonka-kms-1.6.0-J0DpkKKCQ2By8yYSyE2w7" False) (C1 (MetaCons "ListResourceTagsResponse'" PrefixI True) ((S1 (MetaSel (Just "_lrtrsTruncated") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :: S1 (MetaSel (Just "_lrtrsNextMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_lrtrsTags") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 (MetaSel (Just "_lrtrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

lrtrsTruncated :: Lens' ListResourceTagsResponse (Maybe Bool) #

A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in this response to the Marker parameter in a subsequent request.

lrtrsNextMarker :: Lens' ListResourceTagsResponse (Maybe Text) #

When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request. Do not assume or infer any information from this value.

lrtrsTags :: Lens' ListResourceTagsResponse [Tag] #

A list of tags. Each tag consists of a tag key and a tag value.

lrtrsResponseStatus :: Lens' ListResourceTagsResponse Int #

- | The response status code.