AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
A parameter label is a user-defined alias to help you manage different versions of a parameter. When you modify a parameter, Amazon Web Services 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.
If you no longer want to use a parameter label, then you can either delete it or 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 isn't associated with
a parameter and the system displays it in the list of InvalidLabels.
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginLabelParameterVersion and EndLabelParameterVersion.
Namespace: Amazon.SimpleSystemsManagement
Assembly: AWSSDK.SimpleSystemsManagement.dll
Version: 3.x.y.z
public abstract Task<LabelParameterVersionResponse> LabelParameterVersionAsync( LabelParameterVersionRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the LabelParameterVersion service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| InternalServerErrorException | An error occurred on the server side. |
| ParameterNotFoundException | The parameter couldn't be found. Verify the name and try again. |
| ParameterVersionLabelLimitExceededException | A parameter version can have a maximum of ten labels. |
| ParameterVersionNotFoundException | The specified parameter version wasn't found. Verify the parameter name and version, and try again. |
| TooManyUpdatesException | There are concurrent updates for a resource that supports one update at a time. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5