vault_locks

Creates, updates, deletes, gets or lists a vault_locks resource.

Overview

Name	vault_locks
Type	Resource
Id	aws.glacier.vault_locks

Fields

The following fields are returned by SELECT queries:

get_vault_lock

Name	Datatype	Description
creation_date	string	The UTC date and time at which the vault lock was put into the InProgress state.
expiration_date	string	The UTC date and time at which the lock ID expires. This value can be null if the vault lock is in a Locked state.
policy	string	The vault lock policy as a JSON string, which uses "" as an escape character.
state	string	The state of the vault lock. InProgress or Locked.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_vault_lock	select	account_id, vault_name, region		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 InitiateVaultLock. A vault lock is put into the Locked state by calling CompleteVaultLock. You can abort the vault locking process by calling AbortVaultLock. 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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
account_id	string	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.
region	string	AWS region (default: us-east-1)
vault_name	string	The name of the vault.

SELECT examples

get_vault_lock

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 InitiateVaultLock. A vault lock is put into the Locked state by calling CompleteVaultLock. You can abort the vault locking process by calling AbortVaultLock. 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.

SELECT
creation_date,
expiration_date,
policy,
state
FROM aws.glacier.vault_locks
WHERE account_id = '{{ account_id }}' -- required
AND vault_name = '{{ vault_name }}' -- required
AND region = '{{ region }}' -- required
;