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.APIGateway.GetTags

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets the Tags collection for a given resource.

Synopsis

Creating a Request

getTags Source #

Arguments

:: Text	`gtResourceARN`
-> GetTags

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

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

gtLimit - (Not currently supported) The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
gtPosition - (Not currently supported) The current pagination position in the paged result set.
gtResourceARN - [Required] The ARN of a resource that can be tagged. The resource ARN must be URL-encoded. At present, Stage is the only taggable resource.

data GetTags Source #

Gets the Tags collection for a given resource.

See: getTags smart constructor.

Instances

Eq GetTags Source #
Methods (==) :: GetTags -> GetTags -> Bool # (/=) :: GetTags -> GetTags -> Bool #
Data GetTags Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetTags -> c GetTags # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetTags # toConstr :: GetTags -> Constr # dataTypeOf :: GetTags -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c GetTags) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetTags) # gmapT :: (forall b. Data b => b -> b) -> GetTags -> GetTags # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetTags -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetTags -> r # gmapQ :: (forall d. Data d => d -> u) -> GetTags -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> GetTags -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetTags -> m GetTags # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetTags -> m GetTags # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetTags -> m GetTags #
Read GetTags Source #
Methods readsPrec :: Int -> ReadS GetTags # readList :: ReadS [GetTags] # readPrec :: ReadPrec GetTags # readListPrec :: ReadPrec [GetTags] #
Show GetTags Source #
Methods showsPrec :: Int -> GetTags -> ShowS # show :: GetTags -> String # showList :: [GetTags] -> ShowS #
Generic GetTags Source #
Associated Types type Rep GetTags :: * -> * # Methods from :: GetTags -> Rep GetTags x # to :: Rep GetTags x -> GetTags #
Hashable GetTags Source #
Methods hashWithSalt :: Int -> GetTags -> Int # hash :: GetTags -> Int #
NFData GetTags Source #
Methods rnf :: GetTags -> () #
AWSRequest GetTags Source #
Associated Types type Rs GetTags :: * # Methods request :: GetTags -> Request GetTags # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * GetTags -> ClientResponse -> m (Response GetTags) #
ToHeaders GetTags Source #
Methods toHeaders :: GetTags -> [Header] #
ToPath GetTags Source #
Methods toPath :: GetTags -> ByteString #
ToQuery GetTags Source #
Methods toQuery :: GetTags -> QueryString #
type Rep GetTags Source #
type Rep GetTags = D1 * (MetaData "GetTags" "Network.AWS.APIGateway.GetTags" "amazonka-apigateway-1.6.0-JJ9NJtNe0aRBcVRYpJCEA2" False) (C1 * (MetaCons "GetTags'" PrefixI True) ((::) (S1 * (MetaSel (Just Symbol "_gtLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))) ((::) (S1 * (MetaSel (Just Symbol "_gtPosition") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_gtResourceARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))))
type Rs GetTags Source #
type Rs GetTags = GetTagsResponse

Request Lenses

gtLimit :: Lens' GetTags (Maybe Int) Source #

(Not currently supported) The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

gtPosition :: Lens' GetTags (Maybe Text) Source #

(Not currently supported) The current pagination position in the paged result set.

gtResourceARN :: Lens' GetTags Text Source #

Required: The ARN of a resource that can be tagged. The resource ARN must be URL-encoded. At present, Stage is the only taggable resource.

Destructuring the Response

getTagsResponse Source #

Arguments

:: Int	`gtrsResponseStatus`
-> GetTagsResponse

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

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

gtrsTags - The collection of tags. Each tag element is associated with a given resource.
gtrsResponseStatus - -- | The response status code.

data GetTagsResponse Source #

The collection of tags. Each tag element is associated with a given resource.

See: getTagsResponse smart constructor.

Instances

Eq GetTagsResponse Source #
Methods (==) :: GetTagsResponse -> GetTagsResponse -> Bool # (/=) :: GetTagsResponse -> GetTagsResponse -> Bool #
Data GetTagsResponse Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetTagsResponse -> c GetTagsResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetTagsResponse # toConstr :: GetTagsResponse -> Constr # dataTypeOf :: GetTagsResponse -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c GetTagsResponse) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetTagsResponse) # gmapT :: (forall b. Data b => b -> b) -> GetTagsResponse -> GetTagsResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetTagsResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetTagsResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> GetTagsResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> GetTagsResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetTagsResponse -> m GetTagsResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetTagsResponse -> m GetTagsResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetTagsResponse -> m GetTagsResponse #
Read GetTagsResponse Source #
Methods readsPrec :: Int -> ReadS GetTagsResponse # readList :: ReadS [GetTagsResponse] # readPrec :: ReadPrec GetTagsResponse # readListPrec :: ReadPrec [GetTagsResponse] #
Show GetTagsResponse Source #
Methods showsPrec :: Int -> GetTagsResponse -> ShowS # show :: GetTagsResponse -> String # showList :: [GetTagsResponse] -> ShowS #
Generic GetTagsResponse Source #
Associated Types type Rep GetTagsResponse :: * -> * # Methods from :: GetTagsResponse -> Rep GetTagsResponse x # to :: Rep GetTagsResponse x -> GetTagsResponse #
NFData GetTagsResponse Source #
Methods rnf :: GetTagsResponse -> () #
type Rep GetTagsResponse Source #
type Rep GetTagsResponse = D1 * (MetaData "GetTagsResponse" "Network.AWS.APIGateway.GetTags" "amazonka-apigateway-1.6.0-JJ9NJtNe0aRBcVRYpJCEA2" False) (C1 * (MetaCons "GetTagsResponse'" PrefixI True) ((::) (S1 * (MetaSel (Just Symbol "_gtrsTags") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text Text)))) (S1 * (MetaSel (Just Symbol "_gtrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

gtrsTags :: Lens' GetTagsResponse (HashMap Text Text) Source #

The collection of tags. Each tag element is associated with a given resource.

gtrsResponseStatus :: Lens' GetTagsResponse Int Source #

- | The response status code.