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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Assigns one or more tags (key-value pairs) to the specified canary.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values.

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

You can use the TagResource action with a canary that already has tags. If you specify a new tag key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces the previous value for that tag.

You can associate as many as 50 tags with a canary.

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' {
- httpStatus :: Int
}
newTagResourceResponse :: Int -> TagResourceResponse
tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int

Creating a Request

data TagResource Source #

See: newTagResource smart constructor.

Constructors

TagResource'
Fields resourceArn :: Text The ARN of the canary that you're adding tags to. The ARN format of a canary is `arn:aws:synthetics:Region:account-id:canary:canary-name` . tags :: HashMap Text Text The list of key-value pairs to associate with the canary.

Instances

Instances details

Eq TagResource Source #
Instance details Defined in Amazonka.Synthetics.TagResource Methods (==) :: TagResource -> TagResource -> Bool # (/=) :: TagResource -> TagResource -> Bool #
Read TagResource Source #
Instance details Defined in Amazonka.Synthetics.TagResource Methods readsPrec :: Int -> ReadS TagResource # readList :: ReadS [TagResource] # readPrec :: ReadPrec TagResource # readListPrec :: ReadPrec [TagResource] #
Show TagResource Source #
Instance details Defined in Amazonka.Synthetics.TagResource Methods showsPrec :: Int -> TagResource -> ShowS # show :: TagResource -> String # showList :: [TagResource] -> ShowS #
Generic TagResource Source #
Instance details Defined in Amazonka.Synthetics.TagResource Associated Types type Rep TagResource :: Type -> Type # Methods from :: TagResource -> Rep TagResource x # to :: Rep TagResource x -> TagResource #
NFData TagResource Source #
Instance details Defined in Amazonka.Synthetics.TagResource Methods rnf :: TagResource -> () #
Hashable TagResource Source #
Instance details Defined in Amazonka.Synthetics.TagResource Methods hashWithSalt :: Int -> TagResource -> Int # hash :: TagResource -> Int #
ToJSON TagResource Source #
Instance details Defined in Amazonka.Synthetics.TagResource Methods toJSON :: TagResource -> Value # toEncoding :: TagResource -> Encoding # toJSONList :: [TagResource] -> Value # toEncodingList :: [TagResource] -> Encoding #
AWSRequest TagResource Source #
Instance details Defined in Amazonka.Synthetics.TagResource Associated Types type AWSResponse TagResource # Methods request :: TagResource -> Request TagResource # response :: MonadResource m => Logger -> Service -> Proxy TagResource -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse TagResource))) #
ToHeaders TagResource Source #
Instance details Defined in Amazonka.Synthetics.TagResource Methods toHeaders :: TagResource -> [Header] #
ToPath TagResource Source #
Instance details Defined in Amazonka.Synthetics.TagResource Methods toPath :: TagResource -> ByteString #
ToQuery TagResource Source #
Instance details Defined in Amazonka.Synthetics.TagResource Methods toQuery :: TagResource -> QueryString #
type Rep TagResource Source #
Instance details Defined in Amazonka.Synthetics.TagResource type Rep TagResource = D1 ('MetaData "TagResource" "Amazonka.Synthetics.TagResource" "libZSservicesZSamazonka-syntheticsZSamazonka-synthetics" '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))))
type AWSResponse TagResource Source #
Instance details Defined in Amazonka.Synthetics.TagResource type AWSResponse TagResource = TagResourceResponse

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 the canary that you're adding tags to.

The ARN format of a canary is arn:aws:synthetics:Region:account-id:canary:canary-name .

$sel:tags:TagResource', tagResource_tags - The list of key-value pairs to associate with the canary.

Request Lenses

tagResource_resourceArn :: Lens' TagResource Text Source #

The ARN of the canary that you're adding tags to.

The ARN format of a canary is arn:aws:synthetics:Region:account-id:canary:canary-name .

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

The list of key-value pairs to associate with the canary.

Destructuring the Response

data TagResourceResponse Source #

See: newTagResourceResponse smart constructor.

Constructors

TagResourceResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

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

newTagResourceResponse Source #

Arguments

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

Create a value of TagResourceResponse 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:httpStatus:TagResourceResponse', tagResourceResponse_httpStatus - The response's http status code.

Response Lenses

tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int Source #

The response's http status code.