Skip to content

Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated

Description

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.

Usage

storagegateway_cancel_retrieval(GatewayARN, TapeARN)

Arguments

  • GatewayARN

    [required] The Amazon Resource Name (ARN) of the gateway. Use the list_gateways operation to return a list of gateways for your account and Amazon Web Services Region.

  • TapeARN

    [required] The Amazon Resource Name (ARN) of the virtual tape you want to cancel retrieval for.

Value

A list with the following syntax:

list(
  TapeARN = "string"
)

Request syntax

svc$cancel_retrieval(
  GatewayARN = "string",
  TapeARN = "string"
)

Examples

# Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to
# a gateway after the retrieval process is initiated.
svc$cancel_retrieval(
  GatewayARN = "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
  TapeARN = "arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4"
)