[ aws . workspaces ]

describe-tags

Description

Describes the specified tags for the specified WorkSpaces resource.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-tags
--resource-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--resource-id (string)

The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, and IP access control groups.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

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

To describe the tags for a WorkSpace

The following describe-tags example lists the tag key names and their values for the specified WorkSpace.

aws workspaces describe-tags \
    --resource-id ws-12345678

Output:

{
    "TagList": [
        {
            "Key": "username",
            "Value": "jane1234"
        }
    ]
}

Output

TagList -> (list)

The tags.

(structure)

Describes a tag.

Key -> (string)

The key of the tag.

Value -> (string)

The value of the tag.