glacier_delete_vault: This operation deletes a vault

Description Usage Arguments Value Request syntax Examples

View source: R/glacier_operations.R

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

Usage

1
glacier_delete_vault(accountId, vaultName)

Arguments

accountId

[required] 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

[required] The name of the vault.

Value

An empty list.

Request syntax

1
2
3
4
svc$delete_vault(
  accountId = "string",
  vaultName = "string"
)

Examples

1
2
3
4
5
6
7
8
## Not run: 
# The example deletes a vault named my-vault:
svc$delete_vault(
  accountId = "-",
  vaultName = "my-vault"
)

## End(Not run)

paws.storage documentation built on Aug. 23, 2021, 1:06 a.m.