DocDB / Client / list_tags_for_resource

list_tags_for_resource#

DocDB.Client.list_tags_for_resource(**kwargs)#

Lists all tags on an Amazon DocumentDB resource.

Request Syntax

response = client.list_tags_for_resource(
    ResourceName='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ]
)

Parameters:

ResourceName (string) –
[REQUIRED]

The Amazon DocumentDB resource with tags to be listed. This value is an Amazon Resource Name (ARN).
Filters (list) –
This parameter is not currently supported.
- (dict) –
  
  A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.
  
  Wildcards are not supported in filters.
  - Name (string) – [REQUIRED]
    
    The name of the filter. Filter names are case sensitive.
  - Values (list) – [REQUIRED]
    
    One or more filter values. Filter values are case sensitive.
    - (string) –

Return type:

dict

Returns:

Response Syntax

{
    'TagList': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

(dict) –

Represents the output of ListTagsForResource.
- TagList (list) –
  
  A list of one or more tags.
  - (dict) –
    
    Metadata assigned to an Amazon DocumentDB resource consisting of a key-value pair.
    - Key (string) –
      
      The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can’t be prefixed with “ aws:” or “ rds:”. The string can contain only the set of Unicode letters, digits, white space, ‘_’, ‘.’, ‘/’, ‘=’, ‘+’, ‘-’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$”).
    - Value (string) –
      
      The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can’t be prefixed with “ aws:” or “ rds:”. The string can contain only the set of Unicode letters, digits, white space, ‘_’, ‘.’, ‘/’, ‘=’, ‘+’, ‘-’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$”).

Exceptions

DocDB.Client.exceptions.DBInstanceNotFoundFault
DocDB.Client.exceptions.DBSnapshotNotFoundFault
DocDB.Client.exceptions.DBClusterNotFoundFault