UpdateTagsForResource
Update the list of tags applied to an AWS Elastic Beanstalk resource. Two lists can be passed: TagsToAdd
for tags to add or update, and
TagsToRemove
.
Elastic Beanstalk supports tagging of all of its resources. For details about resource tagging, see Tagging Application Resources.
If you create a custom policy to control permission to this operation, specify one of the following two virtual actions (or both) instead of the API operation name:
- elasticbeanstalk:AddTags
-
Controls permission to call
UpdateTagsForResource
and pass a list of tags to add in theTagsToAdd
parameter. - elasticbeanstalk:RemoveTags
-
Controls permission to call
UpdateTagsForResource
and pass a list of tag keys to remove in theTagsToRemove
parameter.
For details about creating a custom user policy, see Creating a Custom User Policy.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- ResourceArn
-
The Amazon Resource Name (ARN) of the resouce to be updated.
Must be the ARN of an Elastic Beanstalk resource.
Type: String
Required: Yes
- TagsToAdd.member.N
-
A list of tags to add or update. If a key of an existing tag is added, the tag's value is updated.
Specify at least one of these parameters:
TagsToAdd
,TagsToRemove
.Type: Array of Tag objects
Required: No
- TagsToRemove.member.N
-
A list of tag keys to remove. If a tag key doesn't exist, it is silently ignored.
Specify at least one of these parameters:
TagsToAdd
,TagsToRemove
.Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: No
Errors
For information about the errors that are common to all actions, see Common Errors.
- InsufficientPrivileges
-
The specified account does not have sufficient privileges for one or more AWS services.
HTTP Status Code: 403
- OperationInProgressFailure
-
Unable to perform the specified operation because another operation that effects an element in this activity is already in progress.
HTTP Status Code: 400
- ResourceNotFound
-
A resource doesn't exist for the specified Amazon Resource Name (ARN).
HTTP Status Code: 400
- ResourceTypeNotSupported
-
The type of the specified Amazon Resource Name (ARN) isn't supported for this operation.
HTTP Status Code: 400
- TooManyTags
-
The number of tags in the resource would exceed the number of tags that each resource can have.
To calculate this, the operation considers both the number of tags the resource already has and the tags this operation would add if it succeeded.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: