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.
This operation returns results depending on the resource type used in the value for
resourceArn
. For example, recovery points of Amazon DynamoDB with Advanced Settings have an ARN (Amazon Resource Name) that begins witharn:aws:backup
. Recovery points (backups) of DynamoDB without Advanced Settings enabled have an ARN that begins witharn:aws:dynamodb
.When this operation is called and when you include values of
resourceArn
that have an ARN other thanarn:aws:backup
, it may return one of the exceptions listed below. To prevent this exception, include only values representing resource types that are fully managed by Backup. These have an ARN that beginsarn:aws:backup
and they are noted in the Feature availability by resource table.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