Amazonka.StorageGateway.CancelRetrieval

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.

Creating a Request

data CancelRetrieval

CancelRetrievalInput

See: newCancelRetrieval smart constructor.

Constructors

CancelRetrieval'

Fields

• gatewayARN :: Text
• tapeARN :: Text

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

Instances

ToJSON CancelRetrieval

Defined in Amazonka.StorageGateway.CancelRetrieval

Methods

toJSON :: CancelRetrieval -> Value

toEncoding :: CancelRetrieval -> Encoding

toJSONList :: [CancelRetrieval] -> Value

toEncodingList :: [CancelRetrieval] -> Encoding

ToHeaders CancelRetrieval

Defined in Amazonka.StorageGateway.CancelRetrieval

Methods

toHeaders :: CancelRetrieval -> [Header]

ToPath CancelRetrieval

Defined in Amazonka.StorageGateway.CancelRetrieval

Methods

toPath :: CancelRetrieval -> ByteString

ToQuery CancelRetrieval

Defined in Amazonka.StorageGateway.CancelRetrieval

Methods

toQuery :: CancelRetrieval -> QueryString

AWSRequest CancelRetrieval

Defined in Amazonka.StorageGateway.CancelRetrieval

Associated Types

type AWSResponse CancelRetrieval

Methods

request :: (Service -> Service) -> CancelRetrieval -> Request CancelRetrieval

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CancelRetrieval -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CancelRetrieval)))

Generic CancelRetrieval

Defined in Amazonka.StorageGateway.CancelRetrieval

Associated Types

type Rep CancelRetrieval :: Type -> Type

Methods

from :: CancelRetrieval -> Rep CancelRetrieval x

to :: Rep CancelRetrieval x -> CancelRetrieval

Read CancelRetrieval

Defined in Amazonka.StorageGateway.CancelRetrieval

Methods

readsPrec :: Int -> ReadS CancelRetrieval

readList :: ReadS [CancelRetrieval]

readPrec :: ReadPrec CancelRetrieval

readListPrec :: ReadPrec [CancelRetrieval]

Show CancelRetrieval

Defined in Amazonka.StorageGateway.CancelRetrieval

Methods

showsPrec :: Int -> CancelRetrieval -> ShowS

show :: CancelRetrieval -> String

showList :: [CancelRetrieval] -> ShowS

NFData CancelRetrieval

Defined in Amazonka.StorageGateway.CancelRetrieval

Methods

rnf :: CancelRetrieval -> ()

Eq CancelRetrieval

Defined in Amazonka.StorageGateway.CancelRetrieval

Methods

(==) :: CancelRetrieval -> CancelRetrieval -> Bool

(/=) :: CancelRetrieval -> CancelRetrieval -> Bool

Hashable CancelRetrieval

Defined in Amazonka.StorageGateway.CancelRetrieval

Methods

hashWithSalt :: Int -> CancelRetrieval -> Int

hash :: CancelRetrieval -> Int

type AWSResponse CancelRetrieval

Defined in Amazonka.StorageGateway.CancelRetrieval

type AWSResponse CancelRetrieval = CancelRetrievalResponse

type Rep CancelRetrieval

Defined in Amazonka.StorageGateway.CancelRetrieval

type Rep CancelRetrieval = D1 ('MetaData "CancelRetrieval" "Amazonka.StorageGateway.CancelRetrieval" "amazonka-storagegateway-2.0-A8x7b0LCNm33wkCZlwgcSL" 'False) (C1 ('MetaCons "CancelRetrieval'" 'PrefixI 'True) (S1 ('MetaSel ('Just "gatewayARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "tapeARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCancelRetrieval

Arguments

:: Text

CancelRetrieval

-> Text

CancelRetrieval

-> CancelRetrieval

Create a value of CancelRetrieval with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CancelRetrieval, cancelRetrieval_gatewayARN - Undocumented member.

CancelRetrieval, cancelRetrieval_tapeARN - The Amazon Resource Name (ARN) of the virtual tape you want to cancel retrieval for.

Request Lenses

cancelRetrieval_gatewayARN :: Lens' CancelRetrieval Text

Undocumented member.

cancelRetrieval_tapeARN :: Lens' CancelRetrieval Text

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

Destructuring the Response

data CancelRetrievalResponse

CancelRetrievalOutput

See: newCancelRetrievalResponse smart constructor.

Constructors

CancelRetrievalResponse'

Fields

• tapeARN :: Maybe Text

  The Amazon Resource Name (ARN) of the virtual tape for which retrieval was canceled.

• httpStatus :: Int

  The response's http status code.

Instances

Generic CancelRetrievalResponse

Defined in Amazonka.StorageGateway.CancelRetrieval

Associated Types

type Rep CancelRetrievalResponse :: Type -> Type

Methods

from :: CancelRetrievalResponse -> Rep CancelRetrievalResponse x

to :: Rep CancelRetrievalResponse x -> CancelRetrievalResponse

Read CancelRetrievalResponse

Defined in Amazonka.StorageGateway.CancelRetrieval

Methods

readsPrec :: Int -> ReadS CancelRetrievalResponse

readList :: ReadS [CancelRetrievalResponse]

readPrec :: ReadPrec CancelRetrievalResponse

readListPrec :: ReadPrec [CancelRetrievalResponse]

Show CancelRetrievalResponse

Defined in Amazonka.StorageGateway.CancelRetrieval

Methods

showsPrec :: Int -> CancelRetrievalResponse -> ShowS

show :: CancelRetrievalResponse -> String

showList :: [CancelRetrievalResponse] -> ShowS

NFData CancelRetrievalResponse

Defined in Amazonka.StorageGateway.CancelRetrieval

Methods

rnf :: CancelRetrievalResponse -> ()

Eq CancelRetrievalResponse

Defined in Amazonka.StorageGateway.CancelRetrieval

Methods

(==) :: CancelRetrievalResponse -> CancelRetrievalResponse -> Bool

(/=) :: CancelRetrievalResponse -> CancelRetrievalResponse -> Bool

type Rep CancelRetrievalResponse

Defined in Amazonka.StorageGateway.CancelRetrieval

type Rep CancelRetrievalResponse = D1 ('MetaData "CancelRetrievalResponse" "Amazonka.StorageGateway.CancelRetrieval" "amazonka-storagegateway-2.0-A8x7b0LCNm33wkCZlwgcSL" 'False) (C1 ('MetaCons "CancelRetrievalResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "tapeARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCancelRetrievalResponse

Arguments

:: Int

$sel:httpStatus:CancelRetrievalResponse'

-> CancelRetrievalResponse

Create a value of CancelRetrievalResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CancelRetrieval, cancelRetrievalResponse_tapeARN - The Amazon Resource Name (ARN) of the virtual tape for which retrieval was canceled.

$sel:httpStatus:CancelRetrievalResponse', cancelRetrievalResponse_httpStatus - The response's http status code.

Response Lenses

cancelRetrievalResponse_tapeARN :: Lens' CancelRetrievalResponse (Maybe Text)

The Amazon Resource Name (ARN) of the virtual tape for which retrieval was canceled.

cancelRetrievalResponse_httpStatus :: Lens' CancelRetrievalResponse Int

The response's http status code.