Copyright	(c) 2013-2021 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

Amazonka.APIGateway.GetTags

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets the Tags collection for a given resource.

Synopsis

data GetTags = GetTags' {
- limit :: Maybe Int
- position :: Maybe Text
- resourceArn :: Text
}
newGetTags :: Text -> GetTags
getTags_limit :: Lens' GetTags (Maybe Int)
getTags_position :: Lens' GetTags (Maybe Text)
getTags_resourceArn :: Lens' GetTags Text
data GetTagsResponse = GetTagsResponse' {
- tags :: Maybe (HashMap Text Text)
- httpStatus :: Int
}
newGetTagsResponse :: Int -> GetTagsResponse
getTagsResponse_tags :: Lens' GetTagsResponse (Maybe (HashMap Text Text))
getTagsResponse_httpStatus :: Lens' GetTagsResponse Int

Creating a Request

data GetTags Source #

Gets the Tags collection for a given resource.

See: newGetTags smart constructor.

Constructors

GetTags'
Fields limit :: Maybe Int (Not currently supported) The maximum number of returned results per page. The default value is 25 and the maximum value is 500. position :: Maybe Text (Not currently supported) The current pagination position in the paged result set. resourceArn :: Text Required The ARN of a resource that can be tagged.

Instances

Instances details

Eq GetTags Source #
Instance details Defined in Amazonka.APIGateway.GetTags Methods (==) :: GetTags -> GetTags -> Bool # (/=) :: GetTags -> GetTags -> Bool #
Read GetTags Source #
Instance details Defined in Amazonka.APIGateway.GetTags Methods readsPrec :: Int -> ReadS GetTags # readList :: ReadS [GetTags] # readPrec :: ReadPrec GetTags # readListPrec :: ReadPrec [GetTags] #
Show GetTags Source #
Instance details Defined in Amazonka.APIGateway.GetTags Methods showsPrec :: Int -> GetTags -> ShowS # show :: GetTags -> String # showList :: [GetTags] -> ShowS #
Generic GetTags Source #
Instance details Defined in Amazonka.APIGateway.GetTags Associated Types type Rep GetTags :: Type -> Type # Methods from :: GetTags -> Rep GetTags x # to :: Rep GetTags x -> GetTags #
NFData GetTags Source #
Instance details Defined in Amazonka.APIGateway.GetTags Methods rnf :: GetTags -> () #
Hashable GetTags Source #
Instance details Defined in Amazonka.APIGateway.GetTags Methods hashWithSalt :: Int -> GetTags -> Int # hash :: GetTags -> Int #
AWSRequest GetTags Source #
Instance details Defined in Amazonka.APIGateway.GetTags Associated Types type AWSResponse GetTags # Methods request :: GetTags -> Request GetTags # response :: MonadResource m => Logger -> Service -> Proxy GetTags -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetTags))) #
ToHeaders GetTags Source #
Instance details Defined in Amazonka.APIGateway.GetTags Methods toHeaders :: GetTags -> [Header] #
ToPath GetTags Source #
Instance details Defined in Amazonka.APIGateway.GetTags Methods toPath :: GetTags -> ByteString #
ToQuery GetTags Source #
Instance details Defined in Amazonka.APIGateway.GetTags Methods toQuery :: GetTags -> QueryString #
type Rep GetTags Source #
Instance details Defined in Amazonka.APIGateway.GetTags type Rep GetTags = D1 ('MetaData "GetTags" "Amazonka.APIGateway.GetTags" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "GetTags'" 'PrefixI 'True) (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "resourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse GetTags Source #
Instance details Defined in Amazonka.APIGateway.GetTags type AWSResponse GetTags = GetTagsResponse

newGetTags Source #

Arguments

:: Text	`$sel:resourceArn:GetTags'`
-> GetTags

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

$sel:limit:GetTags', getTags_limit - (Not currently supported) The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

$sel:position:GetTags', getTags_position - (Not currently supported) The current pagination position in the paged result set.

$sel:resourceArn:GetTags', getTags_resourceArn - [Required] The ARN of a resource that can be tagged.

Request Lenses

getTags_limit :: 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.

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

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

getTags_resourceArn :: Lens' GetTags Text Source #

Required: The ARN of a resource that can be tagged.

Destructuring the Response

data GetTagsResponse Source #

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

See: newGetTagsResponse smart constructor.

Constructors

GetTagsResponse'
Fields tags :: Maybe (HashMap Text Text) The collection of tags. Each tag element is associated with a given resource. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq GetTagsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetTags Methods (==) :: GetTagsResponse -> GetTagsResponse -> Bool # (/=) :: GetTagsResponse -> GetTagsResponse -> Bool #
Read GetTagsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetTags Methods readsPrec :: Int -> ReadS GetTagsResponse # readList :: ReadS [GetTagsResponse] # readPrec :: ReadPrec GetTagsResponse # readListPrec :: ReadPrec [GetTagsResponse] #
Show GetTagsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetTags Methods showsPrec :: Int -> GetTagsResponse -> ShowS # show :: GetTagsResponse -> String # showList :: [GetTagsResponse] -> ShowS #
Generic GetTagsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetTags Associated Types type Rep GetTagsResponse :: Type -> Type # Methods from :: GetTagsResponse -> Rep GetTagsResponse x # to :: Rep GetTagsResponse x -> GetTagsResponse #
NFData GetTagsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetTags Methods rnf :: GetTagsResponse -> () #
type Rep GetTagsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetTags type Rep GetTagsResponse = D1 ('MetaData "GetTagsResponse" "Amazonka.APIGateway.GetTags" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "GetTagsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetTagsResponse Source #

Arguments

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

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

$sel:tags:GetTagsResponse', getTagsResponse_tags - The collection of tags. Each tag element is associated with a given resource.

$sel:httpStatus:GetTagsResponse', getTagsResponse_httpStatus - The response's http status code.

Response Lenses

getTagsResponse_tags :: Lens' GetTagsResponse (Maybe (HashMap Text Text)) Source #

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

getTagsResponse_httpStatus :: Lens' GetTagsResponse Int Source #

The response's http status code.