[ aws . ssm ]



Remove a label or labels from a parameter.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.


--name <value>
--parameter-version <value>
--labels <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]


--name (string)

The name of the parameter from which you want to delete one or more labels.

--parameter-version (long)

The specific version of the parameter which you want to delete one or more labels from. If it isn’t present, the call will fail.

--labels (list)

One or more labels to delete from the specified parameter version.



"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 delete parameter labels

The following unlabel-parameter-version example deletes the specified labels from the given parameter version.

aws ssm unlabel-parameter-version \
    --name "parameterName" \
    --parameter-version "version" \
    --labels "label_1" "label_2" "label_3"


    "RemovedLabels": [
    "InvalidLabels": []

For more information, see Delete parameter labels (AWS CLI) in the AWS Systems Manager User Guide.


RemovedLabels -> (list)

A list of all labels deleted from the parameter.


InvalidLabels -> (list)

The labels that aren’t attached to the given parameter version.