SSM / Client / unlabel_parameter_version

unlabel_parameter_version#

SSM.Client.unlabel_parameter_version(**kwargs)#

Remove a label or labels from a parameter.

See also: AWS API Documentation

Request Syntax

response = client.unlabel_parameter_version(
    Name='string',
    ParameterVersion=123,
    Labels=[
        'string',
    ]
)
Parameters:

  • Name (string) –

    [REQUIRED]

    The name of the parameter from which you want to delete one or more labels.

    Note

    You can’t enter the Amazon Resource Name (ARN) for a parameter, only the parameter name itself.

  • ParameterVersion (integer) –

    [REQUIRED]

    The specific version of the parameter which you want to delete one or more labels from. If it isn’t present, the call will fail.

  • Labels (list) –

    [REQUIRED]

    One or more labels to delete from the specified parameter version.

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'RemovedLabels': [
        'string',
    ],
    'InvalidLabels': [
        'string',
    ]
}

Response Structure

  • (dict) –

    • RemovedLabels (list) –

      A list of all labels deleted from the parameter.

      • (string) –

    • InvalidLabels (list) –

      The labels that aren’t attached to the given parameter version.

      • (string) –

Exceptions