SSM / Client / delete_parameters

delete_parameters

SSM.Client.delete_parameters(**kwargs)

Delete a list of parameters. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.

Warning

This operation is authorized against the ssm:DeleteParameters action, not against ssm:DeleteParameter. Denying ssm:DeleteParameter for a parameter doesn’t prevent a principal from deleting that parameter with this operation. For more information, see Restricting access to specific parameters and paths in the Amazon Web Services Systems Manager User Guide.

See also: AWS API Documentation

Request Syntax

response = client.delete_parameters(
    Names=[
        'string',
    ]
)
Parameters:

Names (list) –

[REQUIRED]

The names of the parameters to delete. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.

Note

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

  • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'DeletedParameters': [
        'string',
    ],
    'InvalidParameters': [
        'string',
    ]
}

Response Structure

  • (dict) –

    • DeletedParameters (list) –

      The names of the deleted parameters.

      • (string) –

    • InvalidParameters (list) –

      The names of parameters that weren’t deleted because the parameters aren’t valid.

      • (string) –

Exceptions