AWS Systems Manager
API Reference (API Version 2014-11-06)

LabelParameterVersion

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.

Request Syntax

{ "Labels": [ "string" ], "Name": "string", "ParameterVersion": number }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Labels

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

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes

Name

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: Yes

ParameterVersion

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

Type: Long

Required: No

Response Syntax

{ "InvalidLabels": [ "string" ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

InvalidLabels

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

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Length Constraints: Minimum length of 1. Maximum length of 100.

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerError

An error occurred on the server side.

HTTP Status Code: 500

ParameterNotFound

The parameter could not be found. Verify the name and try again.

HTTP Status Code: 400

ParameterVersionLabelLimitExceeded

A parameter version can have a maximum of ten labels.

HTTP Status Code: 400

ParameterVersionNotFound

The specified parameter version was not found. Verify the parameter name and version, and try again.

HTTP Status Code: 400

TooManyUpdates

There are concurrent updates for a resource that supports one update at a time.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: