labelParameterVersion method

Future<LabelParameterVersionResult> labelParameterVersion({
  1. required List<String> labels,
  2. required String name,
  3. int? parameterVersion,
})

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.

May throw InternalServerError. May throw TooManyUpdates. May throw ParameterNotFound. May throw ParameterVersionNotFound. May throw ParameterVersionLabelLimitExceeded.

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

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

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

Implementation

Future<LabelParameterVersionResult> labelParameterVersion({
  required List<String> labels,
  required String name,
  int? parameterVersion,
}) async {
  ArgumentError.checkNotNull(labels, 'labels');
  ArgumentError.checkNotNull(name, 'name');
  _s.validateStringLength(
    'name',
    name,
    1,
    2048,
    isRequired: true,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AmazonSSM.LabelParameterVersion'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'Labels': labels,
      'Name': name,
      if (parameterVersion != null) 'ParameterVersion': parameterVersion,
    },
  );

  return LabelParameterVersionResult.fromJson(jsonResponse.body);
}