[ aws . ssm ]

remove-tags-from-resource

Description

Removes tag keys from the specified resource.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  remove-tags-from-resource
--resource-type <value>
--resource-id <value>
--tag-keys <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--resource-type (string)

The type of resource from which you want to remove a tag.

Note

The ManagedInstance type for this API operation is only for on-premises managed instances. Specify the name of the managed instance in the following format: mi-*ID_number* `` . For example, ``mi-1a2b3c4d5e6f .

Possible values:

• Document

• ManagedInstance

• MaintenanceWindow

• Parameter

• PatchBaseline

• OpsItem

• OpsMetadata

--resource-id (string)

The ID of the resource from which you want to remove tags. For example:

ManagedInstance: mi-012345abcde

MaintenanceWindow: mw-012345abcde

PatchBaseline: pb-012345abcde

OpsMetadata object: ResourceID for tagging is created from the Amazon Resource Name (ARN) for the object. Specifically, ResourceID is created from the strings that come after the word opsmetadata in the ARN. For example, an OpsMetadata object with an ARN of arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager has a ResourceID of either aws/ssm/MyGroup/appmanager or /aws/ssm/MyGroup/appmanager .

For the Document and Parameter values, use the name of the resource.

Note

The ManagedInstance type for this API operation is only for on-premises managed instances. Specify the name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.

--tag-keys (list)

Tag keys that you want to remove from the specified resource.

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

Examples

To remove a tag from a patch baseline

The following remove-tags-from-resource example removes tags from a patch baseline.

aws ssm remove-tags-from-resource \
    --resource-type "PatchBaseline" \
    --resource-id "pb-0123456789abcdef0" \
    --tag-keys "Region"

This command produces no output.

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

Output

None