[ aws . ssm ]

list-tags-for-resource

Description

Returns a list of the tags assigned to the specified resource.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-tags-for-resource
--resource-type <value>
--resource-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--resource-type (string)

Returns a list of tags for a specific resource type.

Possible values:

• Document

• ManagedInstance

• MaintenanceWindow

• Parameter

• PatchBaseline

• OpsItem

--resource-id (string)

The resource ID for which you want to see 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.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To list the tags applied to a patch baseline

The following list-tags-for-resource example lists the tags for a patch baseline.

aws ssm list-tags-for-resource \
    --resource-type "PatchBaseline" \
    --resource-id "pb-0123456789abcdef0"

Output:

{
    "TagList": [
        {
            "Key": "Environment",
            "Value": "Production"
        },
        {
            "Key": "Region",
            "Value": "EMEA"
        }
    ]
}

For more information, see Tagging AWS Resources in the AWS General Reference.

Output

TagList -> (list)

A list of tags.

(structure)

Metadata that you assign to your AWS resources. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. In Systems Manager, you can apply tags to documents, managed instances, maintenance windows, Parameter Store parameters, and patch baselines.

Key -> (string)

The name of the tag.

Value -> (string)

The value of the tag.