delete_environment ¶

delete_environment(
    environment_id: IdType, *, config_overrides: Optional[finspaceClientConfig] = None
) -> DeleteEnvironmentResponse

Delete an FinSpace environment.

Parameters:

environment_id (IdType) –

The identifier for the FinSpace environment.

Raises:

AccessDeniedException –

You do not have sufficient access to perform this action.
InternalServerException –

The request processing has failed because of an unknown error, exception or failure.
ResourceNotFoundException –

One or more resources can't be found.
ThrottlingException –

The request was denied due to request throttling.
ValidationException –

The input fails to satisfy the constraints specified by an AWS service.
UnknownServiceError –

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

Source code in docs_src/capo_finspace/_services/finspace.py

def delete_environment(
    self,
    environment_id: "capo_finspace.types.id_type.IdType",
    *,
    config_overrides: Optional[finspaceClientConfig] = None,
) -> "capo_finspace.types.delete_environment_response.DeleteEnvironmentResponse":
    """<p>Delete an FinSpace environment.</p>

    Args:
        environment_id: <p>The identifier for the FinSpace environment.</p>

    Raises:
        capo_finspace.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_finspace.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception or failure.</p>
        capo_finspace.errors.resource_not_found_exception.ResourceNotFoundException: <p>One or more resources can't be found.</p>
        capo_finspace.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_finspace.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an AWS service.</p>
        capo_finspace.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_finspace.types.delete_environment_request.DeleteEnvironmentRequest]",
    ) -> OperationResponse[
        "capo_finspace.types.delete_environment_response.DeleteEnvironmentResponse"
    ]:
        import capo_finspace._operations.aws_habanero_management_service.delete_environment

        output, http_response = (
            capo_finspace._operations.aws_habanero_management_service.delete_environment.delete_environment(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteEnvironment")
    )
    input_: capo_finspace.types.delete_environment_request.DeleteEnvironmentRequest = {
        "environment_id": environment_id
    }

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