Transfer / Client / list_tags_for_resource

list_tags_for_resource#

Transfer.Client.list_tags_for_resource(**kwargs)#

Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a user, server, or role.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    Arn='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • Arn (string) –

    [REQUIRED]

    Requests the tags associated with a particular Amazon Resource Name (ARN). An ARN is an identifier for a specific Amazon Web Services resource, such as a server, user, or role.

  • MaxResults (integer) – Specifies the number of tags to return as a response to the ListTagsForResource request.

  • NextToken (string) – When you request additional results from the ListTagsForResource operation, a NextToken parameter is returned in the input. You can then pass in a subsequent command to the NextToken parameter to continue listing additional tags.

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'NextToken': 'string',
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • Arn (string) –

      The ARN you specified to list the tags of.

    • NextToken (string) –

      When you can get additional results from the ListTagsForResource call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional tags.

    • Tags (list) –

      Key-value pairs that are assigned to a resource, usually for the purpose of grouping and searching for items. Tags are metadata that you define.

      • (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) –

          The name assigned to the tag that you create.

        • Value (string) –

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

Exceptions