cancel_retrieval ¶

def cancel_retrieval(
    self,
    gateway_arn: "capo_storage_gateway.types.gateway_arn.GatewayARN",
    tape_arn: "capo_storage_gateway.types.tape_arn.TapeARN",
    *,
    config_overrides: Optional[StorageGatewayClientConfig] = None,
) -> "capo_storage_gateway.types.cancel_retrieval_output.CancelRetrievalOutput":
    """<p>Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated. The virtual tape is returned to the VTS. This operation is only supported in the tape gateway type.</p>

    Args:
        tape_arn: <p>The Amazon Resource Name (ARN) of the virtual tape you want to cancel retrieval for.</p>

    Raises:
        capo_storage_gateway.errors.internal_server_error.InternalServerError: <p>An internal server error has occurred during the request. For more information, see the error and message fields.</p>
        capo_storage_gateway.errors.invalid_gateway_request_exception.InvalidGatewayRequestException: <p>An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.</p>
        capo_storage_gateway.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To cancel virtual tape retrieval
        Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated.

        >>> client.cancel_retrieval(gateway_arn='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B', tape_arn='arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4')
    """

    def _handler(
        req: "OperationRequest[capo_storage_gateway.types.cancel_retrieval_input.CancelRetrievalInput]",
    ) -> OperationResponse[
        "capo_storage_gateway.types.cancel_retrieval_output.CancelRetrievalOutput"
    ]:
        import capo_storage_gateway._operations.storage_gateway_20130630.cancel_retrieval

        output, http_response = (
            capo_storage_gateway._operations.storage_gateway_20130630.cancel_retrieval.cancel_retrieval(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CancelRetrieval")
    )
    input_: capo_storage_gateway.types.cancel_retrieval_input.CancelRetrievalInput = {
        "gateway_arn": gateway_arn,
        "tape_arn": tape_arn,
    }

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