delete_parameter ¶

delete_parameter(
    name: PSParameterName, *, config_overrides: Optional[SSMClientConfig] = None
) -> DeleteParameterResult

Delete a parameter from the system. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.

Parameters:

name (PSParameterName) –

The name of the parameter to delete.

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

Raises:

InternalServerError –

An error occurred on the server side.
ParameterNotFound –

The parameter couldn't be found. Verify the name and try again.

For the DeleteParameter and GetParameter actions, if the specified parameter doesn't exist, the ParameterNotFound exception is not recorded in CloudTrail event logs.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_ssm/_services/ssm.py

def delete_parameter(
    self,
    name: "capo_ssm.types.ps_parameter_name.PSParameterName",
    *,
    config_overrides: Optional[SSMClientConfig] = None,
) -> "capo_ssm.types.delete_parameter_result.DeleteParameterResult":
    """<p>Delete a parameter from the system. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.</p>

    Args:
        name: <p>The name of the parameter to delete.</p> <note> <p>You can't enter the Amazon Resource Name (ARN) for a parameter, only the parameter name itself.</p> </note>

    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.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ssm.types.delete_parameter_request.DeleteParameterRequest]",
    ) -> OperationResponse[
        "capo_ssm.types.delete_parameter_result.DeleteParameterResult"
    ]:
        import capo_ssm._operations.amazon_ssm.delete_parameter

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteParameter")
    )
    input_: capo_ssm.types.delete_parameter_request.DeleteParameterRequest = {
        "name": name
    }

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