amazonka-glacier-1.6.0: Amazon Glacier SDK.

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

Network.AWS.Glacier.DeleteArchive

Contents

Description

This operation deletes an archive from a vault. Subsequent requests to initiate a retrieval of this archive will fail. Archive retrievals that are in progress for this archive ID may or may not succeed according to the following scenarios:

  • If the archive retrieval job is actively preparing the data for download when Amazon Glacier receives the delete archive request, the archival retrieval operation might fail.
  • If the archive retrieval job has successfully prepared the archive for download when Amazon Glacier receives the delete archive request, you will be able to download the output.

This operation is idempotent. Attempting to delete an already-deleted archive does not result in an error.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM) .

For conceptual information and underlying REST API, see Deleting an Archive in Amazon Glacier and Delete Archive in the Amazon Glacier Developer Guide .

Synopsis

Creating a Request

deleteArchive Source #

Creates a value of DeleteArchive with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • daAccountId - The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '- ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (-) in the ID.
  • daVaultName - The name of the vault.
  • daArchiveId - The ID of the archive to delete.

data DeleteArchive Source #

Provides options for deleting an archive from an Amazon Glacier vault.

See: deleteArchive smart constructor.

Instances

Eq DeleteArchive Source # 
Data DeleteArchive Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DeleteArchive -> c DeleteArchive #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DeleteArchive #

toConstr :: DeleteArchive -> Constr #

dataTypeOf :: DeleteArchive -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DeleteArchive) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DeleteArchive) #

gmapT :: (forall b. Data b => b -> b) -> DeleteArchive -> DeleteArchive #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DeleteArchive -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DeleteArchive -> r #

gmapQ :: (forall d. Data d => d -> u) -> DeleteArchive -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DeleteArchive -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DeleteArchive -> m DeleteArchive #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteArchive -> m DeleteArchive #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteArchive -> m DeleteArchive #

Read DeleteArchive Source # 
Show DeleteArchive Source # 
Generic DeleteArchive Source # 

Associated Types

type Rep DeleteArchive :: * -> * #

Hashable DeleteArchive Source # 
NFData DeleteArchive Source # 

Methods

rnf :: DeleteArchive -> () #

AWSRequest DeleteArchive Source # 
ToHeaders DeleteArchive Source # 
ToPath DeleteArchive Source # 
ToQuery DeleteArchive Source # 
type Rep DeleteArchive Source # 
type Rep DeleteArchive = D1 * (MetaData "DeleteArchive" "Network.AWS.Glacier.DeleteArchive" "amazonka-glacier-1.6.0-KFcSJp5ylrGJYtfh8aD2JF" False) (C1 * (MetaCons "DeleteArchive'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_daAccountId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) ((:*:) * (S1 * (MetaSel (Just Symbol "_daVaultName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_daArchiveId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))))
type Rs DeleteArchive Source # 

Request Lenses

daAccountId :: Lens' DeleteArchive Text Source #

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '- ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (-) in the ID.

daVaultName :: Lens' DeleteArchive Text Source #

The name of the vault.

daArchiveId :: Lens' DeleteArchive Text Source #

The ID of the archive to delete.

Destructuring the Response

deleteArchiveResponse :: DeleteArchiveResponse Source #

Creates a value of DeleteArchiveResponse with the minimum fields required to make a request.

data DeleteArchiveResponse Source #

See: deleteArchiveResponse smart constructor.

Instances

Eq DeleteArchiveResponse Source # 
Data DeleteArchiveResponse Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DeleteArchiveResponse -> c DeleteArchiveResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DeleteArchiveResponse #

toConstr :: DeleteArchiveResponse -> Constr #

dataTypeOf :: DeleteArchiveResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DeleteArchiveResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DeleteArchiveResponse) #

gmapT :: (forall b. Data b => b -> b) -> DeleteArchiveResponse -> DeleteArchiveResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DeleteArchiveResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DeleteArchiveResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> DeleteArchiveResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DeleteArchiveResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DeleteArchiveResponse -> m DeleteArchiveResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteArchiveResponse -> m DeleteArchiveResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteArchiveResponse -> m DeleteArchiveResponse #

Read DeleteArchiveResponse Source # 
Show DeleteArchiveResponse Source # 
Generic DeleteArchiveResponse Source # 
NFData DeleteArchiveResponse Source # 

Methods

rnf :: DeleteArchiveResponse -> () #

type Rep DeleteArchiveResponse Source # 
type Rep DeleteArchiveResponse = D1 * (MetaData "DeleteArchiveResponse" "Network.AWS.Glacier.DeleteArchive" "amazonka-glacier-1.6.0-KFcSJp5ylrGJYtfh8aD2JF" False) (C1 * (MetaCons "DeleteArchiveResponse'" PrefixI False) (U1 *))