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.ResourceGroupsTagging.TagResources

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Applies one or more tags to the specified resources. Note the following:

Not all resources can have tags. For a list of services with resources that support tagging using this operation, see Services that support the Resource Groups Tagging API. If the resource doesn't yet support this operation, the resource's service might support tagging using its own API operations. For more information, refer to the documentation for that service.
Each resource can have up to 50 tags. For other limits, see Tag Naming and Usage Conventions in the Amazon Web Services General Reference.
You can only tag resources that are located in the specified Amazon Web Services Region for the Amazon Web Services account.
To add tags to a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for adding tags. For more information, see the documentation for each service.

Do not store personally identifiable information (PII) or other confidential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be used for private or sensitive data.

Minimum permissions

In addition to the tag:TagResources permission required by this operation, you must also have the tagging permission defined by the service that created the resource. For example, to tag an Amazon EC2 instance using the TagResources operation, you must have both of the following permissions:

```
tag:TagResource
```
```
ec2:CreateTags
```

Creating a Request

data TagResources Source #

See: newTagResources smart constructor.

Constructors

TagResources'

Fields

resourceARNList :: NonEmpty Text
Specifies the list of ARNs of the resources that you want to apply tags to.
An ARN (Amazon Resource Name) uniquely identifies a resource. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
tags :: HashMap Text Text
Specifies a list of tags that you want to add to the specified resources. A tag consists of a key and a value that you define.

Instances

Instances details

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

newTagResources Source #

Arguments

:: NonEmpty Text	`$sel:resourceARNList:TagResources'`
-> TagResources

Create a value of TagResources 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:resourceARNList:TagResources', tagResources_resourceARNList - Specifies the list of ARNs of the resources that you want to apply tags to.

An ARN (Amazon Resource Name) uniquely identifies a resource. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

TagResources, tagResources_tags - Specifies a list of tags that you want to add to the specified resources. A tag consists of a key and a value that you define.

Request Lenses

tagResources_resourceARNList :: Lens' TagResources (NonEmpty Text) Source #

Specifies the list of ARNs of the resources that you want to apply tags to.

An ARN (Amazon Resource Name) uniquely identifies a resource. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

tagResources_tags :: Lens' TagResources (HashMap Text Text) Source #

Specifies a list of tags that you want to add to the specified resources. A tag consists of a key and a value that you define.

Destructuring the Response

data TagResourcesResponse Source #

See: newTagResourcesResponse smart constructor.

Constructors

TagResourcesResponse'
Fields failedResourcesMap :: Maybe (HashMap Text FailureInfo) A map containing a key-value pair for each failed item that couldn't be tagged. The key is the ARN of the failed resource. The value is a `FailureInfo` object that contains an error code, a status code, and an error message. If there are no errors, the `FailedResourcesMap` is empty. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newTagResourcesResponse Source #

Arguments

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

Create a value of TagResourcesResponse 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:failedResourcesMap:TagResourcesResponse', tagResourcesResponse_failedResourcesMap - A map containing a key-value pair for each failed item that couldn't be tagged. The key is the ARN of the failed resource. The value is a FailureInfo object that contains an error code, a status code, and an error message. If there are no errors, the FailedResourcesMap is empty.

$sel:httpStatus:TagResourcesResponse', tagResourcesResponse_httpStatus - The response's http status code.

Response Lenses

tagResourcesResponse_failedResourcesMap :: Lens' TagResourcesResponse (Maybe (HashMap Text FailureInfo)) Source #

A map containing a key-value pair for each failed item that couldn't be tagged. The key is the ARN of the failed resource. The value is a FailureInfo object that contains an error code, a status code, and an error message. If there are no errors, the FailedResourcesMap is empty.

tagResourcesResponse_httpStatus :: Lens' TagResourcesResponse Int Source #

The response's http status code.