Glacier / Client / initiate_vault_lock

initiate_vault_lock#

Glacier.Client.initiate_vault_lock(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

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

  • accountId (string) –

    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 ‘ -’ (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 (‘-’) in the ID.

    Note: this parameter is set to “-” bydefault if no value is not specified.

  • vaultName (string) –

    [REQUIRED]

    The name of the vault.

  • policy (dict) –

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

    • Policy (string) –

      The vault lock policy.

Return type:

dict

Returns:

Response Syntax

{
    'lockId': 'string'
}

Response Structure

  • (dict) –

    Contains the Amazon S3 Glacier response to your request.

    • lockId (string) –

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

Exceptions

Examples

The example initiates the vault locking process for the vault named my-vault.

response = client.initiate_vault_lock(
    accountId='-',
    policy={
        'Policy': '{"Version":"2012-10-17","Statement":[{"Sid":"Define-vault-lock","Effect":"Deny","Principal":{"AWS":"arn:aws:iam::999999999999:root"},"Action":"glacier:DeleteArchive","Resource":"arn:aws:glacier:us-west-2:999999999999:vaults/examplevault","Condition":{"NumericLessThanEquals":{"glacier:ArchiveAgeinDays":"365"}}}]}',
    },
    vaultName='my-vault',
)

print(response)

Expected Output:

{
    'lockId': 'AE863rKkWZU53SLW5be4DUcW',
    'ResponseMetadata': {
        '...': '...',
    },
}