Skip to content

delete_environment

delete_environment(
    environment_identifier: EnvironmentId,
    *,
    config_overrides: Optional[MigrationHubRefactorSpacesClientConfig] = None,
) -> DeleteEnvironmentResponse

Deletes an Amazon Web Services Migration Hub Refactor Spaces environment. Before you can delete an environment, you must first delete any applications and services within the environment.

Parameters:

  • environment_identifier (EnvironmentId) –

    The ID of the environment.

Raises:

Source code in docs_src/capo_migration_hub_refactor_spaces/_services/migration_hub_refactor_spaces.py
def delete_environment(
    self,
    environment_identifier: "capo_migration_hub_refactor_spaces.types.environment_id.EnvironmentId",
    *,
    config_overrides: Optional[MigrationHubRefactorSpacesClientConfig] = None,
) -> "capo_migration_hub_refactor_spaces.types.delete_environment_response.DeleteEnvironmentResponse":
    """<p>Deletes an Amazon Web Services Migration Hub Refactor Spaces environment. Before you can delete an environment, you must first delete any applications and services within the environment.</p>

    Args:
        environment_identifier: <p>The ID of the environment. </p>

    Raises:
        capo_migration_hub_refactor_spaces.errors.access_denied_exception.AccessDeniedException: <p>The user does not have sufficient access to perform this action. </p>
        capo_migration_hub_refactor_spaces.errors.conflict_exception.ConflictException: <p>Updating or deleting a resource can cause an inconsistent state.</p>
        capo_migration_hub_refactor_spaces.errors.internal_server_exception.InternalServerException: <p>An unexpected error occurred while processing the request.</p>
        capo_migration_hub_refactor_spaces.errors.resource_not_found_exception.ResourceNotFoundException: <p>The request references a resource that does not exist. </p>
        capo_migration_hub_refactor_spaces.errors.throttling_exception.ThrottlingException: <p>Request was denied because the request was throttled. </p>
        capo_migration_hub_refactor_spaces.errors.validation_exception.ValidationException: <p>The input does not satisfy the constraints specified by an Amazon Web Service. </p>
        capo_migration_hub_refactor_spaces.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

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

        output, http_response = (
            capo_migration_hub_refactor_spaces._operations.refactor_spaces.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_migration_hub_refactor_spaces.types.delete_environment_request.DeleteEnvironmentRequest = {
        "environment_identifier": environment_identifier
    }

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