[ aws . route53domains ]

list-tags-for-domain

Description

This operation returns all of the tags that are associated with the specified domain.

All tag operations are eventually consistent; subsequent operations might not immediately represent all issued operations.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-tags-for-domain
--domain-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--domain-name (string)

The domain for which you want to get a list of tags.

--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.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To list tags for a domain

The following list-tags-for-domain command lists the tags that are currently associated with the specified domain.

This command runs only in the us-east-1 Region. If your default region is set to us-east-1, you can omit the region parameter.

aws route53domains list-tags-for-domain \
    --region us-east-1 \
    --domain-name example.com

Output:

{
    "TagList": [
        {
            "Key": "key1",
            "Value": "value1"
        },
        {
            "Key": "key2",
            "Value": "value2"
        }
    ]
}

For more information, see Tagging Amazon Route 53 Resources in the Amazon Route 53 Developer Guide.

Output

TagList -> (list)

A list of the tags that are associated with the specified domain.

(structure)

Each tag includes the following elements.

Key -> (string)

The key (name) of a tag.

Valid values: A-Z, a-z, 0-9, space, “.:/=+-@”

Constraints: Each key can be 1-128 characters long.

Value -> (string)

The value of a tag.

Valid values: A-Z, a-z, 0-9, space, “.:/=+-@”

Constraints: Each value can be 0-256 characters long.