Lists all metadata tags attached to an DMS resource, including replication instance, endpoint, security group, and migration task. For more information, see ` Tag
https://docs.aws.amazon.com/dms/latest/APIReference/API_Tag.html`__ data type description.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
list-tags-for-resource
[--resource-arn <value>]
[--resource-arn-list <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--resource-arn
(string)
The Amazon Resource Name (ARN) string that uniquely identifies the DMS resource to list tags for. This returns a list of keys (names of tags) created for the resource and their associated tag values.
--resource-arn-list
(list)
List of ARNs that identify multiple DMS resources that you want to list tags for. This returns a list of keys (tag names) and their associated tag values. It also returns each tag’s associated
ResourceArn
value, which is the ARN of the resource for which each listed tag is created.(string)
Syntax:
"string" "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 the tags for a resource
The following list-tags-for-resource
example lists the tags for a replication instance.
aws dms list-tags-for-resource \
--resource-arn arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE
Output:
{
"TagList": [
{
"Key": "Project",
"Value": "dbMigration"
},
{
"Key": "Environment",
"Value": "PROD"
}
]
}
For more information, see Tagging Resources in the AWS Database Migration Service User Guide.
TagList -> (list)
A list of tags for the resource.
(structure)
A user-defined key-value pair that describes metadata added to an DMS resource and that is used by operations such as the following:
AddTagsToResource
ListTagsForResource
RemoveTagsFromResource
Key -> (string)
A key is the required name of the tag. The string value can be 1-128 Unicode characters in length and can’t be prefixed with “aws:” or “dms:”. The string can only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘/’, ‘=’, ‘+’, ‘-‘ (Java regular expressions: “^([\p{L}\p{Z}\p{N}_.:/=+-]*)$”).
Value -> (string)
A value is the optional value of the tag. The string value can be 1-256 Unicode characters in length and can’t be prefixed with “aws:” or “dms:”. The string can only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘/’, ‘=’, ‘+’, ‘-‘ (Java regular expressions: “^([\p{L}\p{Z}\p{N}_.:/=+-]*)$”).
ResourceArn -> (string)
The Amazon Resource Name (ARN) string that uniquely identifies the resource for which the tag is created.