Skip to content

delete_hypervisor

delete_hypervisor(
    hypervisor_arn: ServerArn,
    *,
    config_overrides: Optional[BackupGatewayClientConfig] = None,
) -> DeleteHypervisorOutput

Deletes a hypervisor.

Parameters:

  • hypervisor_arn (ServerArn) –

    The Amazon Resource Name (ARN) of the hypervisor to delete.

Raises:

Source code in docs_src/capo_backup_gateway/_services/backup_gateway.py
def delete_hypervisor(
    self,
    hypervisor_arn: "capo_backup_gateway.types.server_arn.ServerArn",
    *,
    config_overrides: Optional[BackupGatewayClientConfig] = None,
) -> "capo_backup_gateway.types.delete_hypervisor_output.DeleteHypervisorOutput":
    """<p>Deletes a hypervisor.</p>

    Args:
        hypervisor_arn: <p>The Amazon Resource Name (ARN) of the hypervisor to delete.</p>

    Raises:
        capo_backup_gateway.errors.internal_server_exception.InternalServerException: <p>The operation did not succeed because an internal error occurred. Try again later.</p>
        capo_backup_gateway.errors.throttling_exception.ThrottlingException: <p>TPS has been limited to protect against intentional or unintentional high request volumes.</p>
        capo_backup_gateway.errors.validation_exception.ValidationException: <p>The operation did not succeed because a validation error occurred.</p>
        capo_backup_gateway.errors.access_denied_exception.AccessDeniedException: <p>The operation cannot proceed because you have insufficient permissions.</p>
        capo_backup_gateway.errors.conflict_exception.ConflictException: <p>The operation cannot proceed because it is not supported.</p>
        capo_backup_gateway.errors.resource_not_found_exception.ResourceNotFoundException: <p>A resource that is required for the action wasn't found.</p>
        capo_backup_gateway.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_backup_gateway.types.delete_hypervisor_input.DeleteHypervisorInput]",
    ) -> OperationResponse[
        "capo_backup_gateway.types.delete_hypervisor_output.DeleteHypervisorOutput"
    ]:
        import capo_backup_gateway._operations.backup_on_premises_v20210101.delete_hypervisor

        output, http_response = (
            capo_backup_gateway._operations.backup_on_premises_v20210101.delete_hypervisor.delete_hypervisor(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteHypervisor")
    )
    input_: capo_backup_gateway.types.delete_hypervisor_input.DeleteHypervisorInput = {
        "hypervisor_arn": hypervisor_arn
    }

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