Transfer / Client / tag_resource

tag_resource#

Transfer.Client.tag_resource(**kwargs)#

Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.

There is no response returned from this call.

See also: AWS API Documentation

Request Syntax

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

  • Arn (string) –

    [REQUIRED]

    An Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a server, user, or role.

  • Tags (list) –

    [REQUIRED]

    Key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (servers, users, workflows, and so on) for any purpose.

    • (dict) –

      Creates a key-value pair for a specific resource. Tags are metadata that you can use to search for and group a resource for various purposes. You can apply tags to servers, users, and roles. A tag key can take more than one value. For example, to group servers for accounting purposes, you might create a tag called Group and assign the values Research and Accounting to that group.

      • Key (string) – [REQUIRED]

        The name assigned to the tag that you create.

      • Value (string) – [REQUIRED]

        Contains one or more values that you assigned to the key name you create.

Returns:

None

Exceptions