label-parameter-version¶

Description¶

A parameter label is a user-defined alias to help you manage different versions of a parameter. When you modify a parameter, Systems Manager automatically saves a new version and increments the version number by one. A label can help you remember the purpose of a parameter when there are multiple versions.

Parameter labels have the following requirements and restrictions.

A version of a parameter can have a maximum of 10 labels.
You can’t attach the same label to different versions of the same parameter. For example, if version 1 has the label Production, then you can’t attach Production to version 2.
You can move a label from one version of a parameter to another.
You can’t create a label when you create a new parameter. You must attach a label to a specific version of a parameter.
You can’t delete a parameter label. If you no longer want to use a parameter label, then you must move it to a different version of a parameter.
A label can have a maximum of 100 characters.
Labels can contain letters (case sensitive), numbers, periods (.), hyphens (-), or underscores (_).
Labels can’t begin with a number, “aws,” or “ssm” (not case sensitive). If a label fails to meet these requirements, then the label is not associated with a parameter and the system displays it in the list of InvalidLabels.

Synopsis¶

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

Options¶

--name (string)

The parameter name on which you want to attach one or more labels.

--parameter-version (long)

The specific version of the parameter on which you want to attach one or more labels. If no version is specified, the system attaches the label to the latest version.

--labels (list)

One or more labels to attach to the specified parameter version.

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

Example 1: To add a label to latest version of a parameter

The following label-parameter-version example adds a label to the latest version of the specified parameter.

aws ssm label-parameter-version \
    --name "MyStringParameter" \
    --labels "ProductionReady"

Output:

{
    "InvalidLabels": [],
    "ParameterVersion": 3
}

For more information, see Working with parameter labels in the AWS Systems Manager User Guide.

Example 2: To add a label to a specific version of a parameter

The following label-parameter-version example adds a label to the specified version of a parameter.

aws ssm label-parameter-version \
    --name "MyStringParameter" \
    --labels "ProductionReady" \
    --parameter-version "2" --labels "DevelopmentReady"

For more information, see Working with parameter labels in the AWS Systems Manager User Guide.

Output¶

InvalidLabels -> (list)

The label does not meet the requirements. For information about parameter label requirements, see Labeling parameters in the AWS Systems Manager User Guide .

(string)

ParameterVersion -> (long)

The version of the parameter that has been labeled.

Table of Contents

Feedback

User Guide