Skip to content

delete_retention_configuration

delete_retention_configuration(
    retention_configuration_name: RetentionConfigurationName,
    *,
    config_overrides: Optional[ConfigServiceClientConfig] = None,
) -> None

Deletes the retention configuration.

Parameters:

Raises:

Source code in docs_src/capo_config_service/_services/config_service.py
def delete_retention_configuration(
    self,
    retention_configuration_name: "capo_config_service.types.retention_configuration_name.RetentionConfigurationName",
    *,
    config_overrides: Optional[ConfigServiceClientConfig] = None,
) -> None:
    """<p>Deletes the retention configuration.</p>

    Args:
        retention_configuration_name: <p>The name of the retention configuration to delete.</p>

    Raises:
        capo_config_service.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.</p>
        capo_config_service.errors.no_such_retention_configuration_exception.NoSuchRetentionConfigurationException: <p>You have specified a retention configuration that does not exist.</p>
        capo_config_service.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_config_service.types.delete_retention_configuration_request.DeleteRetentionConfigurationRequest]",
    ) -> OperationResponse[None]:
        import capo_config_service._operations.starling_dove_service.delete_retention_configuration

        output, http_response = (
            capo_config_service._operations.starling_dove_service.delete_retention_configuration.delete_retention_configuration(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteRetentionConfiguration")
    )
    input_: capo_config_service.types.delete_retention_configuration_request.DeleteRetentionConfigurationRequest = {
        "retention_configuration_name": retention_configuration_name
    }

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