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.RetrieveTapeArchive

Description

Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a tape gateway. Virtual tapes archived in the VTS are not associated with any gateway. However after a tape is retrieved, it is associated with a gateway, even though it is also listed in the VTS, that is, archive. This operation is only supported in the tape gateway type.

Once a tape is successfully retrieved to a gateway, it cannot be retrieved again to another gateway. You must archive the tape again before you can retrieve it to another gateway. This operation is only supported in the tape gateway type.

Synopsis

Creating a Request

data RetrieveTapeArchive Source #

RetrieveTapeArchiveInput

See: newRetrieveTapeArchive smart constructor.

Constructors

RetrieveTapeArchive' 

Fields

  • tapeARN :: Text

    The Amazon Resource Name (ARN) of the virtual tape you want to retrieve from the virtual tape shelf (VTS).

  • gatewayARN :: Text

    The Amazon Resource Name (ARN) of the gateway you want to retrieve the virtual tape to. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    You retrieve archived virtual tapes to only one gateway and the gateway must be a tape gateway.

Instances

Instances details
Eq RetrieveTapeArchive Source # 
Instance details

Defined in Amazonka.StorageGateway.RetrieveTapeArchive

Methods

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

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

Read RetrieveTapeArchive Source # 
Instance details

Defined in Amazonka.StorageGateway.RetrieveTapeArchive

Methods

readsPrec :: Int -> ReadS RetrieveTapeArchive #

readList :: ReadS [RetrieveTapeArchive] #

readPrec :: ReadPrec RetrieveTapeArchive #

readListPrec :: ReadPrec [RetrieveTapeArchive] #

Show RetrieveTapeArchive Source # 
Instance details

Defined in Amazonka.StorageGateway.RetrieveTapeArchive

Methods

showsPrec :: Int -> RetrieveTapeArchive -> ShowS #

show :: RetrieveTapeArchive -> String #

showList :: [RetrieveTapeArchive] -> ShowS #

Generic RetrieveTapeArchive Source # 
Instance details

Defined in Amazonka.StorageGateway.RetrieveTapeArchive

Associated Types

type Rep RetrieveTapeArchive :: Type -> Type #

Methods

from :: RetrieveTapeArchive -> Rep RetrieveTapeArchive x #

to :: Rep RetrieveTapeArchive x -> RetrieveTapeArchive #

NFData RetrieveTapeArchive Source # 
Instance details

Defined in Amazonka.StorageGateway.RetrieveTapeArchive

Methods

rnf :: RetrieveTapeArchive -> () #

Hashable RetrieveTapeArchive Source # 
Instance details

Defined in Amazonka.StorageGateway.RetrieveTapeArchive

Methods

hashWithSalt :: Int -> RetrieveTapeArchive -> Int #

hash :: RetrieveTapeArchive -> Int #

ToJSON RetrieveTapeArchive Source # 
Instance details

Defined in Amazonka.StorageGateway.RetrieveTapeArchive

Methods

toJSON :: RetrieveTapeArchive -> Value #

toEncoding :: RetrieveTapeArchive -> Encoding #

toJSONList :: [RetrieveTapeArchive] -> Value #

toEncodingList :: [RetrieveTapeArchive] -> Encoding #

AWSRequest RetrieveTapeArchive Source # 
Instance details

Defined in Amazonka.StorageGateway.RetrieveTapeArchive

Associated Types

type AWSResponse RetrieveTapeArchive #

Methods

request :: RetrieveTapeArchive -> Request RetrieveTapeArchive #

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

ToHeaders RetrieveTapeArchive Source # 
Instance details

Defined in Amazonka.StorageGateway.RetrieveTapeArchive

Methods

toHeaders :: RetrieveTapeArchive -> [Header] #

ToPath RetrieveTapeArchive Source # 
Instance details

Defined in Amazonka.StorageGateway.RetrieveTapeArchive

Methods

toPath :: RetrieveTapeArchive -> ByteString #

ToQuery RetrieveTapeArchive Source # 
Instance details

Defined in Amazonka.StorageGateway.RetrieveTapeArchive

Methods

toQuery :: RetrieveTapeArchive -> QueryString #

type Rep RetrieveTapeArchive Source # 
Instance details

Defined in Amazonka.StorageGateway.RetrieveTapeArchive

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

Defined in Amazonka.StorageGateway.RetrieveTapeArchive

type AWSResponse RetrieveTapeArchive = RetrieveTapeArchiveResponse

newRetrieveTapeArchive Source #

Arguments

:: Text

$sel:tapeARN:RetrieveTapeArchive'

-> Text

$sel:gatewayARN:RetrieveTapeArchive'

-> RetrieveTapeArchive 

Create a value of RetrieveTapeArchive 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:RetrieveTapeArchive', retrieveTapeArchive_tapeARN - The Amazon Resource Name (ARN) of the virtual tape you want to retrieve from the virtual tape shelf (VTS).

$sel:gatewayARN:RetrieveTapeArchive', retrieveTapeArchive_gatewayARN - The Amazon Resource Name (ARN) of the gateway you want to retrieve the virtual tape to. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

You retrieve archived virtual tapes to only one gateway and the gateway must be a tape gateway.

Request Lenses

retrieveTapeArchive_tapeARN :: Lens' RetrieveTapeArchive Text Source #

The Amazon Resource Name (ARN) of the virtual tape you want to retrieve from the virtual tape shelf (VTS).

retrieveTapeArchive_gatewayARN :: Lens' RetrieveTapeArchive Text Source #

The Amazon Resource Name (ARN) of the gateway you want to retrieve the virtual tape to. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

You retrieve archived virtual tapes to only one gateway and the gateway must be a tape gateway.

Destructuring the Response

data RetrieveTapeArchiveResponse Source #

RetrieveTapeArchiveOutput

See: newRetrieveTapeArchiveResponse smart constructor.

Constructors

RetrieveTapeArchiveResponse' 

Fields

Instances

Instances details
Eq RetrieveTapeArchiveResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.RetrieveTapeArchive

Methods

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

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

Read RetrieveTapeArchiveResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.RetrieveTapeArchive

Methods

readsPrec :: Int -> ReadS RetrieveTapeArchiveResponse #

readList :: ReadS [RetrieveTapeArchiveResponse] #

readPrec :: ReadPrec RetrieveTapeArchiveResponse #

readListPrec :: ReadPrec [RetrieveTapeArchiveResponse] #

Show RetrieveTapeArchiveResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.RetrieveTapeArchive

Methods

showsPrec :: Int -> RetrieveTapeArchiveResponse -> ShowS #

show :: RetrieveTapeArchiveResponse -> String #

showList :: [RetrieveTapeArchiveResponse] -> ShowS #

Generic RetrieveTapeArchiveResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.RetrieveTapeArchive

Associated Types

type Rep RetrieveTapeArchiveResponse :: Type -> Type #

Methods

from :: RetrieveTapeArchiveResponse -> Rep RetrieveTapeArchiveResponse x #

to :: Rep RetrieveTapeArchiveResponse x -> RetrieveTapeArchiveResponse #

NFData RetrieveTapeArchiveResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.RetrieveTapeArchive

Methods

rnf :: RetrieveTapeArchiveResponse -> () #

type Rep RetrieveTapeArchiveResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.RetrieveTapeArchive

type Rep RetrieveTapeArchiveResponse = D1 ('MetaData "RetrieveTapeArchiveResponse" "Amazonka.StorageGateway.RetrieveTapeArchive" "libZSservicesZSamazonka-storagegatewayZSamazonka-storagegateway" 'False) (C1 ('MetaCons "RetrieveTapeArchiveResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "tapeARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newRetrieveTapeArchiveResponse Source #

Arguments

:: Int

$sel:httpStatus:RetrieveTapeArchiveResponse'

-> RetrieveTapeArchiveResponse 

Create a value of RetrieveTapeArchiveResponse 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:RetrieveTapeArchive', retrieveTapeArchiveResponse_tapeARN - The Amazon Resource Name (ARN) of the retrieved virtual tape.

$sel:httpStatus:RetrieveTapeArchiveResponse', retrieveTapeArchiveResponse_httpStatus - The response's http status code.

Response Lenses

retrieveTapeArchiveResponse_tapeARN :: Lens' RetrieveTapeArchiveResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the retrieved virtual tape.

retrieveTapeArchiveResponse_httpStatus :: Lens' RetrieveTapeArchiveResponse Int Source #

The response's http status code.