Lists all tags on an Amazon DocumentDB resource.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
list-tags-for-resource
--resource-name <value>
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--resource-name
(string)
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.
(structure)
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)
The name of the filter. Filter names are case sensitive.
Values -> (list)
One or more filter values. Filter values are case sensitive.
(string)
Shorthand Syntax:
Name=string,Values=string,string ...
JSON Syntax:
[
{
"Name": "string",
"Values": ["string", ...]
}
...
]
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
To list all the tags on an Amazon DocumentDB resource
The following list-tags-for-resource
example lists all tags on the Amazon DocumentDB cluster sample-cluster
.
aws docdb list-tags-for-resource \
--resource-name arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster
Output:
{
"TagList": [
{
"Key": "A",
"Value": "ALPHA"
},
{
"Key": "B",
"Value": ""
},
{
"Key": "C",
"Value": "CHARLIE"
}
]
}
For more information, see Listing Tags on an Amazon DocumentDB Resource in the Amazon DocumentDB Developer Guide.
TagList -> (list)
A list of one or more tags.
(structure)
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}_.:/=+-]*)$”).