label_parameter_version ¶

def label_parameter_version(
    self,
    name: "capo_ssm.types.ps_parameter_name.PSParameterName",
    labels: "capo_ssm.types.parameter_label_list.ParameterLabelList",
    *,
    config_overrides: Optional[SSMClientConfig] = None,
    parameter_version: Optional[
        "capo_ssm.types.ps_parameter_version.PSParameterVersion"
    ] = None,
) -> "capo_ssm.types.label_parameter_version_result.LabelParameterVersionResult":
    """<p>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. </p> <p>Parameter labels have the following requirements and restrictions.</p> <ul> <li> <p>A version of a parameter can have a maximum of 10 labels.</p> </li> <li> <p>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.</p> </li> <li> <p>You can move a label from one version of a parameter to another.</p> </li> <li> <p>You can't create a label when you create a new parameter. You must attach a label to a specific version of a parameter.</p> </li> <li> <p>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.</p> </li> <li> <p>A label can have a maximum of 100 characters.</p> </li> <li> <p>Labels can contain letters (case sensitive), numbers, periods (.), hyphens (-), or underscores (_).</p> </li> <li> <p>Labels can't begin with a number, "<code>aws</code>" or "<code>ssm</code>" (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.</p> </li> <li> <p>Parameter names can't contain spaces. The service removes any spaces specified for the beginning or end of a parameter name. If the specified name for a parameter contains spaces between characters, the request fails with a <code>ValidationException</code> error.</p> </li> </ul>

    Args:
        name: <p>The parameter name on which you want to attach one or more labels.</p> <note> <p>You can't enter the Amazon Resource Name (ARN) for a parameter, only the parameter name itself.</p> </note>
        parameter_version: <p>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.</p>
        labels: <p>One or more labels to attach to the specified parameter version.</p>

    Raises:
        capo_ssm.errors.internal_server_error.InternalServerError: <p>An error occurred on the server side.</p>
        capo_ssm.errors.parameter_not_found.ParameterNotFound: <p>The parameter couldn't be found. Verify the name and try again.</p> <note> <p>For the <code>DeleteParameter</code> and <code>GetParameter</code> actions, if the specified parameter doesn't exist, the <code>ParameterNotFound</code> exception is <i>not</i> recorded in CloudTrail event logs.</p> </note>
        capo_ssm.errors.parameter_version_label_limit_exceeded.ParameterVersionLabelLimitExceeded: <p>A parameter version can have a maximum of ten labels.</p>
        capo_ssm.errors.parameter_version_not_found.ParameterVersionNotFound: <p>The specified parameter version wasn't found. Verify the parameter name and version, and try again.</p>
        capo_ssm.errors.too_many_updates.TooManyUpdates: <p>There are concurrent updates for a resource that supports one update at a time.</p>
        capo_ssm.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ssm.types.label_parameter_version_request.LabelParameterVersionRequest]",
    ) -> OperationResponse[
        "capo_ssm.types.label_parameter_version_result.LabelParameterVersionResult"
    ]:
        import capo_ssm._operations.amazon_ssm.label_parameter_version

        output, http_response = (
            capo_ssm._operations.amazon_ssm.label_parameter_version.label_parameter_version(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("LabelParameterVersion")
    )
    input_: capo_ssm.types.label_parameter_version_request.LabelParameterVersionRequest = {
        "name": name,
        "labels": labels,
    }
    if parameter_version is not None:
        input_["parameter_version"] = parameter_version

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output