Backup / Client / list_tags

list_tags#

Backup.Client.list_tags(**kwargs)#

Returns the tags assigned to the resource, such as a target recovery point, backup plan, or backup vault.

See also: AWS API Documentation

Request Syntax

response = client.list_tags(
    ResourceArn='string',
    NextToken='string',
    MaxResults=123
)
Parameters:
  • ResourceArn (string) –

    [REQUIRED]

    An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the type of resource. Valid targets for ListTags are recovery points, backup plans, and backup vaults.

  • NextToken (string) – The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

  • MaxResults (integer) – The maximum number of items to be returned.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) –

    • NextToken (string) –

      The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

    • Tags (dict) –

      Information about the tags.

      • (string) –

        • (string) –

Exceptions

  • Backup.Client.exceptions.ResourceNotFoundException

  • Backup.Client.exceptions.InvalidParameterValueException

  • Backup.Client.exceptions.MissingParameterValueException

  • Backup.Client.exceptions.ServiceUnavailableException