libZSservicesZSamazonka-storagegatewayZSamazonka-storagegateway
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.StorageGateway.CancelRetrieval

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.

Synopsis

Creating a Request

data CancelRetrieval Source #

CancelRetrievalInput

See: newCancelRetrieval smart constructor.

Constructors

CancelRetrieval' 

Fields

Instances

Instances details
Eq CancelRetrieval Source # 
Instance details

Defined in Amazonka.StorageGateway.CancelRetrieval

Methods

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

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

Read CancelRetrieval Source # 
Instance details

Defined in Amazonka.StorageGateway.CancelRetrieval

Methods

readsPrec :: Int -> ReadS CancelRetrieval #

readList :: ReadS [CancelRetrieval] #

readPrec :: ReadPrec CancelRetrieval #

readListPrec :: ReadPrec [CancelRetrieval] #

Show CancelRetrieval Source # 
Instance details

Defined in Amazonka.StorageGateway.CancelRetrieval

Methods

showsPrec :: Int -> CancelRetrieval -> ShowS #

show :: CancelRetrieval -> String #

showList :: [CancelRetrieval] -> ShowS #

Generic CancelRetrieval Source # 
Instance details

Defined in Amazonka.StorageGateway.CancelRetrieval

Associated Types

type Rep CancelRetrieval :: Type -> Type #

Methods

from :: CancelRetrieval -> Rep CancelRetrieval x #

to :: Rep CancelRetrieval x -> CancelRetrieval #

NFData CancelRetrieval Source # 
Instance details

Defined in Amazonka.StorageGateway.CancelRetrieval

Methods

rnf :: CancelRetrieval -> () #

Hashable CancelRetrieval Source # 
Instance details

Defined in Amazonka.StorageGateway.CancelRetrieval

Methods

hashWithSalt :: Int -> CancelRetrieval -> Int #

hash :: CancelRetrieval -> Int #

ToJSON CancelRetrieval Source # 
Instance details

Defined in Amazonka.StorageGateway.CancelRetrieval

Methods

toJSON :: CancelRetrieval -> Value #

toEncoding :: CancelRetrieval -> Encoding #

toJSONList :: [CancelRetrieval] -> Value #

toEncodingList :: [CancelRetrieval] -> Encoding #

AWSRequest CancelRetrieval Source # 
Instance details

Defined in Amazonka.StorageGateway.CancelRetrieval

Associated Types

type AWSResponse CancelRetrieval #

Methods

request :: CancelRetrieval -> Request CancelRetrieval #

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

ToHeaders CancelRetrieval Source # 
Instance details

Defined in Amazonka.StorageGateway.CancelRetrieval

Methods

toHeaders :: CancelRetrieval -> [Header] #

ToPath CancelRetrieval Source # 
Instance details

Defined in Amazonka.StorageGateway.CancelRetrieval

Methods

toPath :: CancelRetrieval -> ByteString #

ToQuery CancelRetrieval Source # 
Instance details

Defined in Amazonka.StorageGateway.CancelRetrieval

Methods

toQuery :: CancelRetrieval -> QueryString #

type Rep CancelRetrieval Source # 
Instance details

Defined in Amazonka.StorageGateway.CancelRetrieval

type Rep CancelRetrieval = D1 ('MetaData "CancelRetrieval" "Amazonka.StorageGateway.CancelRetrieval" "libZSservicesZSamazonka-storagegatewayZSamazonka-storagegateway" 'False) (C1 ('MetaCons "CancelRetrieval'" 'PrefixI 'True) (S1 ('MetaSel ('Just "gatewayARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "tapeARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse CancelRetrieval Source # 
Instance details

Defined in Amazonka.StorageGateway.CancelRetrieval

type AWSResponse CancelRetrieval = CancelRetrievalResponse

newCancelRetrieval Source #

Arguments

:: Text

$sel:gatewayARN:CancelRetrieval'

-> Text

$sel:tapeARN: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:

$sel:gatewayARN:CancelRetrieval', cancelRetrieval_gatewayARN - Undocumented member.

$sel:tapeARN: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 Source #

Undocumented member.

cancelRetrieval_tapeARN :: Lens' CancelRetrieval Text Source #

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

Destructuring the Response

data CancelRetrievalResponse Source #

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

Instances details
Eq CancelRetrievalResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.CancelRetrieval

Methods

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

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

Read CancelRetrievalResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.CancelRetrieval

Methods

readsPrec :: Int -> ReadS CancelRetrievalResponse #

readList :: ReadS [CancelRetrievalResponse] #

readPrec :: ReadPrec CancelRetrievalResponse #

readListPrec :: ReadPrec [CancelRetrievalResponse] #

Show CancelRetrievalResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.CancelRetrieval

Methods

showsPrec :: Int -> CancelRetrievalResponse -> ShowS #

show :: CancelRetrievalResponse -> String #

showList :: [CancelRetrievalResponse] -> ShowS #

Generic CancelRetrievalResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.CancelRetrieval

Associated Types

type Rep CancelRetrievalResponse :: Type -> Type #

Methods

from :: CancelRetrievalResponse -> Rep CancelRetrievalResponse x #

to :: Rep CancelRetrievalResponse x -> CancelRetrievalResponse #

NFData CancelRetrievalResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.CancelRetrieval

Methods

rnf :: CancelRetrievalResponse -> () #

type Rep CancelRetrievalResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.CancelRetrieval

type Rep CancelRetrievalResponse = D1 ('MetaData "CancelRetrievalResponse" "Amazonka.StorageGateway.CancelRetrieval" "libZSservicesZSamazonka-storagegatewayZSamazonka-storagegateway" '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 Source #

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:

$sel:tapeARN: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) Source #

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

cancelRetrievalResponse_httpStatus :: Lens' CancelRetrievalResponse Int Source #

The response's http status code.