You can return to the original look by selecting English in the language selector
above.

Labeling Parameters

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 version when there are multiple versions.

For example, let's say you have a parameter called /MyApp/DB/ConnectionString. The
value of the parameter is a connection string to a MySQL server in a local database
in a test environment. After you finish updating the application, you want the
parameter to use a connection string for a production database. You change the value
of /MyApp/DB/ConnectionString. Systems Manager automatically creates version two with
the new
connection string. To help you remember the purpose of each version, you attach a
label to each parameter. For version one, you attach the label
Test and for version two you attach the label
Production.

You can move labels from one version of a parameter to another version. For
example, if you create version three of the /MyApp/DB/ConnectionString parameter
with a connection string for a new production database, then you can move the
Production label from parameter two to parameter three.

Parameter labels are a lightweight alternative to parameter tags. Your
organization might have strict guidelines for tags that must be applied to different
AWS resources. In contrast, a label is simply a text association for a specific
version of a parameter.

Similar to tags, you can query parameters by using labels. You can view a list of
specific parameter versions that all use the same label if you query your parameter
set by using the GetParametersByPath API action, as described later in this
section.

Label Requirements and Restrictions

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.

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 attached to
the parameter version and the system displays it in the list of
InvalidLabels.

If the AWS Systems Manager home page opens first, choose the menu icon () to open the
navigation pane, and then choose Parameter Store.

Choose the name of a parameter to open the details page for that
parameter.

Choose the History tab.

Locate the parameter version for which you want to view all
attached labels. The Labels column shows all
labels attached to the parameter version.

Move a Parameter
Label

You can't delete a parameter label after you create it. You can, however,
move a label between versions of a parameter. The following procedure
describes how to move a parameter label to a different version of the same
parameter by using the Systems Manager console.

If the output shows the label you created in the
InvalidLabels list, then the label does not
meet the requirements described earlier in this topic. Review
the requirements and try again. If the
InvalidLabels list is empty, then your label
was successfully applied to the version of the parameter.

You can view the details of the parameter by using either a
version number or a label name. Run the following command and
specify the label you created in the previous step.

Selector in the output is either the
version number or the label that you specified in the
Name input field.

View Labels for a
Parameter

You can use the GetParameterHistory API action to view the full history and all
labels attached to a specified parameter. Or, you can use the GetParametersByPath API action to view a list of all parameters
that are assigned a specific label.

To view labels for a parameter by using the GetParameterHistory API
action

Run the following command to view a list of parameters for which
you can view labels.

Note

Parameters are only available in the Region where they were
created. If you don't see a parameter for which you want to move
a label, then verify your Region.

Move a Parameter
Label

You can't delete a parameter label after you create it. You can, however,
move a label between versions of a parameter. The following procedure
describes how to move a parameter label to a different version of the same
parameter.

To move a parameter label

Run the following command to view all versions of the
parameter.

aws ssm get-parameter-history --name "the_parameter_name"

Note the parameter version for which you want to attach a
label.

Run the following command to assign an existing label to a
different version of a parameter.