BackupGateway / Client / tag_resource

tag_resource#

BackupGateway.Client.tag_resource(**kwargs)#

Tag the resource.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    ResourceARN='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:
  • ResourceARN (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the resource to tag.

  • Tags (list) –

    [REQUIRED]

    A list of tags to assign to the resource.

    • (dict) –

      A key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, spaces, and the following characters: + - = . _ : /.

      • Key (string) – [REQUIRED]

        The key part of a tag’s key-value pair. The key can’t start with aws:.

      • Value (string) – [REQUIRED]

        The value part of a tag’s key-value pair.

Return type:

dict

Returns:

Response Syntax

{
    'ResourceARN': 'string'
}

Response Structure

  • (dict) –

    • ResourceARN (string) –

      The Amazon Resource Name (ARN) of the resource you tagged.

Exceptions

  • BackupGateway.Client.exceptions.ValidationException

  • BackupGateway.Client.exceptions.InternalServerException

  • BackupGateway.Client.exceptions.ResourceNotFoundException

  • BackupGateway.Client.exceptions.ThrottlingException