Amazonka.Glacier.DeleteArchive

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

Creating a Request

data DeleteArchive

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

See: newDeleteArchive smart constructor.

Constructors

DeleteArchive'

Fields

• accountId :: Text

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

• vaultName :: Text

  The name of the vault.

• archiveId :: Text

  The ID of the archive to delete.

Instances

ToHeaders DeleteArchive

Defined in Amazonka.Glacier.DeleteArchive

Methods

toHeaders :: DeleteArchive -> [Header]

ToPath DeleteArchive

Defined in Amazonka.Glacier.DeleteArchive

Methods

toPath :: DeleteArchive -> ByteString

ToQuery DeleteArchive

Defined in Amazonka.Glacier.DeleteArchive

Methods

toQuery :: DeleteArchive -> QueryString

AWSRequest DeleteArchive

Defined in Amazonka.Glacier.DeleteArchive

Associated Types

type AWSResponse DeleteArchive

Methods

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

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

Generic DeleteArchive

Defined in Amazonka.Glacier.DeleteArchive

Associated Types

type Rep DeleteArchive :: Type -> Type

Methods

from :: DeleteArchive -> Rep DeleteArchive x

to :: Rep DeleteArchive x -> DeleteArchive

Read DeleteArchive

Defined in Amazonka.Glacier.DeleteArchive

Methods

readsPrec :: Int -> ReadS DeleteArchive

readList :: ReadS [DeleteArchive]

readPrec :: ReadPrec DeleteArchive

readListPrec :: ReadPrec [DeleteArchive]

Show DeleteArchive

Defined in Amazonka.Glacier.DeleteArchive

Methods

showsPrec :: Int -> DeleteArchive -> ShowS

show :: DeleteArchive -> String

showList :: [DeleteArchive] -> ShowS

NFData DeleteArchive

Defined in Amazonka.Glacier.DeleteArchive

Methods

rnf :: DeleteArchive -> ()

Eq DeleteArchive

Defined in Amazonka.Glacier.DeleteArchive

Methods

(==) :: DeleteArchive -> DeleteArchive -> Bool

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

Hashable DeleteArchive

Defined in Amazonka.Glacier.DeleteArchive

Methods

hashWithSalt :: Int -> DeleteArchive -> Int

hash :: DeleteArchive -> Int

type AWSResponse DeleteArchive

Defined in Amazonka.Glacier.DeleteArchive

type AWSResponse DeleteArchive = DeleteArchiveResponse

type Rep DeleteArchive

Defined in Amazonka.Glacier.DeleteArchive

type Rep DeleteArchive = D1 ('MetaData "DeleteArchive" "Amazonka.Glacier.DeleteArchive" "amazonka-glacier-2.0-17Kmjv8nUJeKOtbrjLyy76" 'False) (C1 ('MetaCons "DeleteArchive'" 'PrefixI 'True) (S1 ('MetaSel ('Just "accountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "vaultName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "archiveId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDeleteArchive

Arguments

:: Text

$sel:accountId:DeleteArchive'

-> Text

DeleteArchive

-> Text

DeleteArchive

-> DeleteArchive

Create a value of DeleteArchive 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:accountId:DeleteArchive', deleteArchive_accountId - 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 S3 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.

DeleteArchive, deleteArchive_vaultName - The name of the vault.

DeleteArchive, deleteArchive_archiveId - The ID of the archive to delete.

Request Lenses

deleteArchive_accountId :: Lens' DeleteArchive Text

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

deleteArchive_vaultName :: Lens' DeleteArchive Text

The name of the vault.

deleteArchive_archiveId :: Lens' DeleteArchive Text

The ID of the archive to delete.

Destructuring the Response

data DeleteArchiveResponse

See: newDeleteArchiveResponse smart constructor.

Constructors

DeleteArchiveResponse'

Instances

Generic DeleteArchiveResponse

Defined in Amazonka.Glacier.DeleteArchive

Associated Types

type Rep DeleteArchiveResponse :: Type -> Type

Methods

from :: DeleteArchiveResponse -> Rep DeleteArchiveResponse x

to :: Rep DeleteArchiveResponse x -> DeleteArchiveResponse

Read DeleteArchiveResponse

Defined in Amazonka.Glacier.DeleteArchive

Methods

readsPrec :: Int -> ReadS DeleteArchiveResponse

readList :: ReadS [DeleteArchiveResponse]

readPrec :: ReadPrec DeleteArchiveResponse

readListPrec :: ReadPrec [DeleteArchiveResponse]

Show DeleteArchiveResponse

Defined in Amazonka.Glacier.DeleteArchive

Methods

showsPrec :: Int -> DeleteArchiveResponse -> ShowS

show :: DeleteArchiveResponse -> String

showList :: [DeleteArchiveResponse] -> ShowS

NFData DeleteArchiveResponse

Defined in Amazonka.Glacier.DeleteArchive

Methods

rnf :: DeleteArchiveResponse -> ()

Eq DeleteArchiveResponse

Defined in Amazonka.Glacier.DeleteArchive

Methods

(==) :: DeleteArchiveResponse -> DeleteArchiveResponse -> Bool

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

type Rep DeleteArchiveResponse

Defined in Amazonka.Glacier.DeleteArchive

type Rep DeleteArchiveResponse = D1 ('MetaData "DeleteArchiveResponse" "Amazonka.Glacier.DeleteArchive" "amazonka-glacier-2.0-17Kmjv8nUJeKOtbrjLyy76" 'False) (C1 ('MetaCons "DeleteArchiveResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteArchiveResponse :: DeleteArchiveResponse

Create a value of DeleteArchiveResponse with all optional fields omitted.

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