Amazon Glacier

This operation completes the vault locking process by transitioning the vault lock from the InProgress state to the Locked state, which causes the vault lock policy to become unchangeable. A vault lock is put into the InProgress state by calling InitiateVaultLock. You can obtain the state of the vault lock by calling GetVaultLock. For more information about the vault locking process, Amazon Glacier Vault Lock.

This operation is idempotent. This request is always successful if the vault lock is in the Locked state and the provided lock ID matches the lock ID originally used to lock the vault.

If an invalid lock ID is passed in the request when the vault lock is in the Locked state, the operation returns an AccessDeniedException error. If an invalid lock ID is passed in the request when the vault lock is in the InProgress state, the operation throws an InvalidParameter error.

Request Syntax

client.complete_vault_lock(
    accountId='string',
    vaultName='string',
    lockId='string'
)

type accountId:

string

param accountId:

[REQUIRED]

The AccountId value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single apos ``-``apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens (apos-apos) in the ID.

type vaultName:

string

param vaultName:

[REQUIRED]

The name of the vault.

type lockId:

string

param lockId:

[REQUIRED]

The lockId value is the lock ID obtained from a InitiateVaultLock request.

returns:

None

This operation aborts the vault locking process if the vault lock is not in the Locked state. If the vault lock is in the Locked state when this operation is requested, the operation returns an AccessDeniedException error. Aborting the vault locking process removes the vault lock policy from the specified vault.

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 get the state of a vault lock by calling GetVaultLock. For more information about the vault locking process, see Amazon Glacier Vault Lock. For more information about vault lock policies, see Amazon Glacier Access Control with Vault Lock Policies.

This operation is idempotent. You can successfully invoke this operation multiple times, if the vault lock is in the InProgress state or if there is no policy associated with the vault.

Request Syntax

client.abort_vault_lock(
    accountId='string',
    vaultName='string'
)

type accountId:

string

param accountId:

[REQUIRED]

The AccountId value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single apos ``-``apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens (apos-apos) in the ID.

type vaultName:

string

param vaultName:

[REQUIRED]

The name of the vault.

returns:

None

This operation initiates the vault locking process by doing the following:

• Installing a vault lock policy on the specified vault.

• Setting the lock state of vault lock to InProgress.

• Returning a lock ID, which is used to complete the vault locking process.

You can set one vault lock policy for each vault and this policy can be up to 20 KB in size. For more information about vault lock policies, see Amazon Glacier Access Control with Vault Lock Policies.

You must complete the vault locking process within 24 hours after the vault lock enters the InProgress state. After the 24 hour window ends, the lock ID expires, the vault automatically exits the InProgress state, and the vault lock policy is removed from the vault. You call CompleteVaultLock to complete the vault locking process by setting the state of the vault lock to Locked.

After a vault lock is in the Locked state, you cannot initiate a new vault lock for the vault.

You can abort the vault locking process by calling AbortVaultLock. You can get the state of the vault lock by calling GetVaultLock. For more information about the vault locking process, Amazon Glacier Vault Lock.

If this operation is called when the vault lock is in the InProgress state, the operation returns an AccessDeniedException error. When the vault lock is in the InProgress state you must call AbortVaultLock before you can initiate a new vault lock policy.

Request Syntax

client.initiate_vault_lock(
    accountId='string',
    vaultName='string',
    policy={
        'Policy': 'string'
    }
)

type accountId:

string

param accountId:

[REQUIRED]

The AccountId value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single apos ``-``apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens (apos-apos) in the ID.

type vaultName:

string

param vaultName:

[REQUIRED]

The name of the vault.

type policy:

dict

param policy:

The vault lock policy as a JSON string, which uses "" as an escape character.

• Policy (string) --

  The vault lock policy.

rtype:

dict

returns:

Response Syntax

{
    'lockId': 'string'
}

Response Structure

• (dict) --

  Contains the Amazon Glacier response to your request.

  • lockId (string) --

    The lock ID, which is used to complete the vault locking process.

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.

Request Syntax

client.get_vault_lock(
    accountId='string',
    vaultName='string'
)

type accountId:

string

param 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 apos ``-``apos (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 (apos-apos) in the ID.

type vaultName:

string

param vaultName:

[REQUIRED]

The name of the vault.

rtype:

dict

returns:

Response Syntax

{
    'Policy': 'string',
    'State': 'string',
    'ExpirationDate': 'string',
    'CreationDate': 'string'
}

Response Structure

• (dict) --

  Contains the Amazon Glacier response to your request.

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

  • ExpirationDate (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.

  • CreationDate (string) --

    The UTC date and time at which the vault lock was put into the InProgress state.