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

Description

Deletes the specified virtual tape. This operation is only supported in the tape gateway type.

Synopsis

Creating a Request

data DeleteTape Source #

DeleteTapeInput

See: newDeleteTape smart constructor.

Constructors

DeleteTape' 

Fields

  • bypassGovernanceRetention :: Maybe Bool

    Set to TRUE to delete an archived tape that belongs to a custom pool with tape retention lock. Only archived tapes with tape retention lock set to governance can be deleted. Archived tapes with tape retention lock set to compliance can't be deleted.

  • gatewayARN :: Text

    The unique Amazon Resource Name (ARN) of the gateway that the virtual tape to delete is associated with. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

  • tapeARN :: Text

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

Instances

Instances details
Eq DeleteTape Source # 
Instance details

Defined in Amazonka.StorageGateway.DeleteTape

Read DeleteTape Source # 
Instance details

Defined in Amazonka.StorageGateway.DeleteTape

Show DeleteTape Source # 
Instance details

Defined in Amazonka.StorageGateway.DeleteTape

Generic DeleteTape Source # 
Instance details

Defined in Amazonka.StorageGateway.DeleteTape

Associated Types

type Rep DeleteTape :: Type -> Type #

NFData DeleteTape Source # 
Instance details

Defined in Amazonka.StorageGateway.DeleteTape

Methods

rnf :: DeleteTape -> () #

Hashable DeleteTape Source # 
Instance details

Defined in Amazonka.StorageGateway.DeleteTape

ToJSON DeleteTape Source # 
Instance details

Defined in Amazonka.StorageGateway.DeleteTape

AWSRequest DeleteTape Source # 
Instance details

Defined in Amazonka.StorageGateway.DeleteTape

Associated Types

type AWSResponse DeleteTape #

ToHeaders DeleteTape Source # 
Instance details

Defined in Amazonka.StorageGateway.DeleteTape

Methods

toHeaders :: DeleteTape -> [Header] #

ToPath DeleteTape Source # 
Instance details

Defined in Amazonka.StorageGateway.DeleteTape

ToQuery DeleteTape Source # 
Instance details

Defined in Amazonka.StorageGateway.DeleteTape

type Rep DeleteTape Source # 
Instance details

Defined in Amazonka.StorageGateway.DeleteTape

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

Defined in Amazonka.StorageGateway.DeleteTape

newDeleteTape Source #

Create a value of DeleteTape 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:bypassGovernanceRetention:DeleteTape', deleteTape_bypassGovernanceRetention - Set to TRUE to delete an archived tape that belongs to a custom pool with tape retention lock. Only archived tapes with tape retention lock set to governance can be deleted. Archived tapes with tape retention lock set to compliance can't be deleted.

$sel:gatewayARN:DeleteTape', deleteTape_gatewayARN - The unique Amazon Resource Name (ARN) of the gateway that the virtual tape to delete is associated with. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

$sel:tapeARN:DeleteTape', deleteTape_tapeARN - The Amazon Resource Name (ARN) of the virtual tape to delete.

Request Lenses

deleteTape_bypassGovernanceRetention :: Lens' DeleteTape (Maybe Bool) Source #

Set to TRUE to delete an archived tape that belongs to a custom pool with tape retention lock. Only archived tapes with tape retention lock set to governance can be deleted. Archived tapes with tape retention lock set to compliance can't be deleted.

deleteTape_gatewayARN :: Lens' DeleteTape Text Source #

The unique Amazon Resource Name (ARN) of the gateway that the virtual tape to delete is associated with. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

deleteTape_tapeARN :: Lens' DeleteTape Text Source #

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

Destructuring the Response

data DeleteTapeResponse Source #

DeleteTapeOutput

See: newDeleteTapeResponse smart constructor.

Constructors

DeleteTapeResponse' 

Fields

Instances

Instances details
Eq DeleteTapeResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.DeleteTape

Read DeleteTapeResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.DeleteTape

Show DeleteTapeResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.DeleteTape

Generic DeleteTapeResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.DeleteTape

Associated Types

type Rep DeleteTapeResponse :: Type -> Type #

NFData DeleteTapeResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.DeleteTape

Methods

rnf :: DeleteTapeResponse -> () #

type Rep DeleteTapeResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.DeleteTape

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

newDeleteTapeResponse Source #

Create a value of DeleteTapeResponse 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:DeleteTape', deleteTapeResponse_tapeARN - The Amazon Resource Name (ARN) of the deleted virtual tape.

$sel:httpStatus:DeleteTapeResponse', deleteTapeResponse_httpStatus - The response's http status code.

Response Lenses

deleteTapeResponse_tapeARN :: Lens' DeleteTapeResponse (Maybe Text) Source #

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