Skip to content

This operation retrieves the following attributes from the lock-policy subresource set on the specified vault:

Description

This operation retrieves the following attributes from the lock-policy subresource set on the specified vault:

  • The vault lock policy set on the vault.
  • The state of the vault lock, which is either InProgess or Locked.
  • When the lock ID expires. The lock ID is used to complete the vault locking process.
  • When the vault lock was initiated and put into the InProgress state.

A vault lock is put into the InProgress state by calling initiate_vault_lock. A vault lock is put into the Locked state by calling complete_vault_lock. You can abort the vault locking process by calling abort_vault_lock. For more information about the vault locking process, Amazon Glacier Vault Lock.

If there is no vault lock policy set on the vault, the operation returns a 404 Not found error. For more information about vault lock policies, Amazon Glacier Access Control with Vault Lock Policies.

Usage

glacier_get_vault_lock(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 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

A list with the following syntax:

list(
  Policy = "string",
  State = "string",
  ExpirationDate = "string",
  CreationDate = "string"
)

Request syntax

svc$get_vault_lock(
  accountId = "string",
  vaultName = "string"
)

Examples

# The example retrieves the attributes from the lock-policy subresource
# set on the vault named examplevault.
svc$get_vault_lock(
  accountId = "-",
  vaultName = "examplevault"
)