ElasticBeanstalk / Client / update_tags_for_resource

update_tags_for_resource

ElasticBeanstalk.Client.update_tags_for_resource(**kwargs)

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 IAM user 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 the TagsToAdd parameter.

elasticbeanstalk:RemoveTags

Controls permission to call UpdateTagsForResource and pass a list of tag keys to remove in the TagsToRemove parameter.

For details about creating a custom user policy, see Creating a Custom User Policy.

See also: AWS API Documentation

Request Syntax

response = client.update_tags_for_resource(
    ResourceArn='string',
    TagsToAdd=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    TagsToRemove=[
        'string',
    ]
)

Parameters:

• ResourceArn (string) –

  [REQUIRED]

  The Amazon Resource Name (ARN) of the resouce to be updated.

  Must be the ARN of an Elastic Beanstalk resource.

• TagsToAdd (list) –

  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.

  • (dict) –

    Describes a tag applied to a resource in an environment.

    • Key (string) –

      The key of the tag.

    • Value (string) –

      The value of the tag.

• TagsToRemove (list) –

  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.

  • (string) –

Returns:

None

Exceptions

• ElasticBeanstalk.Client.exceptions.InsufficientPrivilegesException

• ElasticBeanstalk.Client.exceptions.OperationInProgressException

• ElasticBeanstalk.Client.exceptions.TooManyTagsException

• ElasticBeanstalk.Client.exceptions.ResourceNotFoundException

• ElasticBeanstalk.Client.exceptions.ResourceTypeNotSupportedException