Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Glacier.DeleteVault

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

This operation deletes a vault. Amazon S3 Glacier will delete a vault only if there are no archives in the vault as of the last inventory and there have been no writes to the vault since the last inventory. If either of these conditions is not satisfied, the vault deletion fails (that is, the vault is not removed) and Amazon S3 Glacier returns an error. You can use DescribeVault to return the number of archives in a vault, and you can use Initiate a Job (POST jobs) to initiate a new inventory retrieval for a vault. The inventory contains the archive IDs you use to delete archives using Delete Archive (DELETE archive).

This operation is idempotent.

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 a Vault in Amazon Glacier and Delete Vault in the Amazon S3 Glacier Developer Guide.

Synopsis

data DeleteVault = DeleteVault' {
- accountId :: Text
- vaultName :: Text
}
newDeleteVault :: Text -> Text -> DeleteVault
deleteVault_accountId :: Lens' DeleteVault Text
deleteVault_vaultName :: Lens' DeleteVault Text
data DeleteVaultResponse = DeleteVaultResponse' {
}
newDeleteVaultResponse :: DeleteVaultResponse

Creating a Request

data DeleteVault Source #

Provides options for deleting a vault from Amazon S3 Glacier.

See: newDeleteVault smart constructor.

Constructors

DeleteVault'

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.

Instances

Instances details

Eq DeleteVault Source #
Instance details Defined in Amazonka.Glacier.DeleteVault Methods (==) :: DeleteVault -> DeleteVault -> Bool # (/=) :: DeleteVault -> DeleteVault -> Bool #
Read DeleteVault Source #
Instance details Defined in Amazonka.Glacier.DeleteVault Methods readsPrec :: Int -> ReadS DeleteVault # readList :: ReadS [DeleteVault] # readPrec :: ReadPrec DeleteVault # readListPrec :: ReadPrec [DeleteVault] #
Show DeleteVault Source #
Instance details Defined in Amazonka.Glacier.DeleteVault Methods showsPrec :: Int -> DeleteVault -> ShowS # show :: DeleteVault -> String # showList :: [DeleteVault] -> ShowS #
Generic DeleteVault Source #
Instance details Defined in Amazonka.Glacier.DeleteVault Associated Types type Rep DeleteVault :: Type -> Type # Methods from :: DeleteVault -> Rep DeleteVault x # to :: Rep DeleteVault x -> DeleteVault #
NFData DeleteVault Source #
Instance details Defined in Amazonka.Glacier.DeleteVault Methods rnf :: DeleteVault -> () #
Hashable DeleteVault Source #
Instance details Defined in Amazonka.Glacier.DeleteVault Methods hashWithSalt :: Int -> DeleteVault -> Int # hash :: DeleteVault -> Int #
AWSRequest DeleteVault Source #
Instance details Defined in Amazonka.Glacier.DeleteVault Associated Types type AWSResponse DeleteVault # Methods request :: DeleteVault -> Request DeleteVault # response :: MonadResource m => Logger -> Service -> Proxy DeleteVault -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteVault))) #
ToHeaders DeleteVault Source #
Instance details Defined in Amazonka.Glacier.DeleteVault Methods toHeaders :: DeleteVault -> [Header] #
ToPath DeleteVault Source #
Instance details Defined in Amazonka.Glacier.DeleteVault Methods toPath :: DeleteVault -> ByteString #
ToQuery DeleteVault Source #
Instance details Defined in Amazonka.Glacier.DeleteVault Methods toQuery :: DeleteVault -> QueryString #
type Rep DeleteVault Source #
Instance details Defined in Amazonka.Glacier.DeleteVault type Rep DeleteVault = D1 ('MetaData "DeleteVault" "Amazonka.Glacier.DeleteVault" "libZSservicesZSamazonka-glacierZSamazonka-glacier" 'False) (C1 ('MetaCons "DeleteVault'" 'PrefixI 'True) (S1 ('MetaSel ('Just "accountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "vaultName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DeleteVault Source #
Instance details Defined in Amazonka.Glacier.DeleteVault type AWSResponse DeleteVault = DeleteVaultResponse

newDeleteVault Source #

Arguments

:: Text	`$sel:accountId:DeleteVault'`
-> Text	`$sel:vaultName:DeleteVault'`
-> DeleteVault

Create a value of DeleteVault 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:DeleteVault', deleteVault_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.

$sel:vaultName:DeleteVault', deleteVault_vaultName - The name of the vault.

Request Lenses

deleteVault_accountId :: Lens' DeleteVault 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 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.

deleteVault_vaultName :: Lens' DeleteVault Text Source #

The name of the vault.

Destructuring the Response

data DeleteVaultResponse Source #

See: newDeleteVaultResponse smart constructor.

Constructors

DeleteVaultResponse'

Instances

Instances details

Eq DeleteVaultResponse Source #
Instance details Defined in Amazonka.Glacier.DeleteVault Methods (==) :: DeleteVaultResponse -> DeleteVaultResponse -> Bool # (/=) :: DeleteVaultResponse -> DeleteVaultResponse -> Bool #
Read DeleteVaultResponse Source #
Instance details Defined in Amazonka.Glacier.DeleteVault Methods readsPrec :: Int -> ReadS DeleteVaultResponse # readList :: ReadS [DeleteVaultResponse] # readPrec :: ReadPrec DeleteVaultResponse # readListPrec :: ReadPrec [DeleteVaultResponse] #
Show DeleteVaultResponse Source #
Instance details Defined in Amazonka.Glacier.DeleteVault Methods showsPrec :: Int -> DeleteVaultResponse -> ShowS # show :: DeleteVaultResponse -> String # showList :: [DeleteVaultResponse] -> ShowS #
Generic DeleteVaultResponse Source #
Instance details Defined in Amazonka.Glacier.DeleteVault Associated Types type Rep DeleteVaultResponse :: Type -> Type # Methods from :: DeleteVaultResponse -> Rep DeleteVaultResponse x # to :: Rep DeleteVaultResponse x -> DeleteVaultResponse #
NFData DeleteVaultResponse Source #
Instance details Defined in Amazonka.Glacier.DeleteVault Methods rnf :: DeleteVaultResponse -> () #
type Rep DeleteVaultResponse Source #
Instance details Defined in Amazonka.Glacier.DeleteVault type Rep DeleteVaultResponse = D1 ('MetaData "DeleteVaultResponse" "Amazonka.Glacier.DeleteVault" "libZSservicesZSamazonka-glacierZSamazonka-glacier" 'False) (C1 ('MetaCons "DeleteVaultResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteVaultResponse :: DeleteVaultResponse Source #

Create a value of DeleteVaultResponse with all optional fields omitted.

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