| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.SSM.LabelParameterVersion
Description
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.
Synopsis
- data LabelParameterVersion = LabelParameterVersion' {}
- newLabelParameterVersion :: Text -> NonEmpty Text -> LabelParameterVersion
- labelParameterVersion_parameterVersion :: Lens' LabelParameterVersion (Maybe Integer)
- labelParameterVersion_name :: Lens' LabelParameterVersion Text
- labelParameterVersion_labels :: Lens' LabelParameterVersion (NonEmpty Text)
- data LabelParameterVersionResponse = LabelParameterVersionResponse' {}
- newLabelParameterVersionResponse :: Int -> LabelParameterVersionResponse
- labelParameterVersionResponse_invalidLabels :: Lens' LabelParameterVersionResponse (Maybe (NonEmpty Text))
- labelParameterVersionResponse_parameterVersion :: Lens' LabelParameterVersionResponse (Maybe Integer)
- labelParameterVersionResponse_httpStatus :: Lens' LabelParameterVersionResponse Int
Creating a Request
data LabelParameterVersion Source #
See: newLabelParameterVersion smart constructor.
Constructors
| LabelParameterVersion' | |
Fields
| |
Instances
newLabelParameterVersion Source #
Arguments
| :: Text | |
| -> NonEmpty Text | |
| -> LabelParameterVersion |
Create a value of LabelParameterVersion with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:parameterVersion:LabelParameterVersion', labelParameterVersion_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.
$sel:name:LabelParameterVersion', labelParameterVersion_name - The parameter name on which you want to attach one or more labels.
$sel:labels:LabelParameterVersion', labelParameterVersion_labels - One or more labels to attach to the specified parameter version.
Request Lenses
labelParameterVersion_parameterVersion :: Lens' LabelParameterVersion (Maybe Integer) Source #
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.
labelParameterVersion_name :: Lens' LabelParameterVersion Text Source #
The parameter name on which you want to attach one or more labels.
labelParameterVersion_labels :: Lens' LabelParameterVersion (NonEmpty Text) Source #
One or more labels to attach to the specified parameter version.
Destructuring the Response
data LabelParameterVersionResponse Source #
See: newLabelParameterVersionResponse smart constructor.
Constructors
| LabelParameterVersionResponse' | |
Fields
| |
Instances
newLabelParameterVersionResponse Source #
Create a value of LabelParameterVersionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:invalidLabels:LabelParameterVersionResponse', labelParameterVersionResponse_invalidLabels - The label doesn't meet the requirements. For information about
parameter label requirements, see
Labeling parameters
in the Amazon Web Services Systems Manager User Guide.
$sel:parameterVersion:LabelParameterVersion', labelParameterVersionResponse_parameterVersion - The version of the parameter that has been labeled.
$sel:httpStatus:LabelParameterVersionResponse', labelParameterVersionResponse_httpStatus - The response's http status code.
Response Lenses
labelParameterVersionResponse_invalidLabels :: Lens' LabelParameterVersionResponse (Maybe (NonEmpty Text)) Source #
The label doesn't meet the requirements. For information about parameter label requirements, see Labeling parameters in the Amazon Web Services Systems Manager User Guide.
labelParameterVersionResponse_parameterVersion :: Lens' LabelParameterVersionResponse (Maybe Integer) Source #
The version of the parameter that has been labeled.
labelParameterVersionResponse_httpStatus :: Lens' LabelParameterVersionResponse Int Source #
The response's http status code.