ResourceGroupsTaggingAPI.Client.
tag_resources
(**kwargs)¶Applies one or more tags to the specified resources. Note the following:
Warning
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
See also: AWS API Documentation
Request Syntax
response = client.tag_resources(
ResourceARNList=[
'string',
],
Tags={
'string': 'string'
}
)
[REQUIRED]
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 .
[REQUIRED]
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.
dict
Response Syntax
{
'FailedResourcesMap': {
'string': {
'StatusCode': 123,
'ErrorCode': 'InternalServiceException'|'InvalidParameterException',
'ErrorMessage': 'string'
}
}
}
Response Structure
(dict) --
FailedResourcesMap (dict) --
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.
(string) --
(dict) --
Information about the errors that are returned for each failed resource. This information can include InternalServiceException
and InvalidParameterException
errors. It can also include any valid error code returned by the Amazon Web Services service that hosts the resource that the ARN key represents.
The following are common error codes that you might receive from other Amazon Web Services services:
For more information on errors that are generated from other Amazon Web Services services, see the documentation for that service.
StatusCode (integer) --
The HTTP status code of the common error.
ErrorCode (string) --
The code of the common error. Valid values include InternalServiceException
, InvalidParameterException
, and any valid error code returned by the Amazon Web Services service that hosts the resource that you want to tag.
ErrorMessage (string) --
The message of the common error.
Exceptions
ResourceGroupsTaggingAPI.Client.exceptions.InvalidParameterException
ResourceGroupsTaggingAPI.Client.exceptions.ThrottledException
ResourceGroupsTaggingAPI.Client.exceptions.InternalServiceException