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

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Adds or updates a tag on a given resource.

Synopsis

data TagResource = TagResource' {
- resourceArn :: Text
- tags :: HashMap Text Text
}
newTagResource :: Text -> TagResource
tagResource_resourceArn :: Lens' TagResource Text
tagResource_tags :: Lens' TagResource (HashMap Text Text)
data TagResourceResponse = TagResourceResponse' {
}
newTagResourceResponse :: TagResourceResponse

Creating a Request

data TagResource Source #

Adds or updates a tag on a given resource.

See: newTagResource smart constructor.

Constructors

TagResource'
Fields resourceArn :: Text The ARN of a resource that can be tagged. tags :: HashMap Text Text The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with `aws:`. The tag value can be up to 256 characters.

Instances

Instances details

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

newTagResource Source #

Arguments

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

Create a value of TagResource 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:resourceArn:TagResource', tagResource_resourceArn - The ARN of a resource that can be tagged.

TagResource, tagResource_tags - The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

Request Lenses

tagResource_resourceArn :: Lens' TagResource Text Source #

The ARN of a resource that can be tagged.

tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

Destructuring the Response

data TagResourceResponse Source #

See: newTagResourceResponse smart constructor.

Constructors

TagResourceResponse'

Instances

Instances details

Generic TagResourceResponse Source #
Instance details Defined in Amazonka.APIGateway.TagResource Associated Types type Rep TagResourceResponse :: Type -> Type # Methods from :: TagResourceResponse -> Rep TagResourceResponse x # to :: Rep TagResourceResponse x -> TagResourceResponse #
Read TagResourceResponse Source #
Instance details Defined in Amazonka.APIGateway.TagResource Methods readsPrec :: Int -> ReadS TagResourceResponse # readList :: ReadS [TagResourceResponse] # readPrec :: ReadPrec TagResourceResponse # readListPrec :: ReadPrec [TagResourceResponse] #
Show TagResourceResponse Source #
Instance details Defined in Amazonka.APIGateway.TagResource Methods showsPrec :: Int -> TagResourceResponse -> ShowS # show :: TagResourceResponse -> String # showList :: [TagResourceResponse] -> ShowS #
NFData TagResourceResponse Source #
Instance details Defined in Amazonka.APIGateway.TagResource Methods rnf :: TagResourceResponse -> () #
Eq TagResourceResponse Source #
Instance details Defined in Amazonka.APIGateway.TagResource Methods (==) :: TagResourceResponse -> TagResourceResponse -> Bool # (/=) :: TagResourceResponse -> TagResourceResponse -> Bool #
type Rep TagResourceResponse Source #
Instance details Defined in Amazonka.APIGateway.TagResource type Rep TagResourceResponse = D1 ('MetaData "TagResourceResponse" "Amazonka.APIGateway.TagResource" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "TagResourceResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newTagResourceResponse :: TagResourceResponse Source #

Create a value of TagResourceResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.