Glacier / Client / abort_vault_lock

abort_vault_lock

Glacier.Client.abort_vault_lock(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.abort_vault_lock(
    vaultName='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.

Returns:

None

Exceptions

• Glacier.Client.exceptions.ResourceNotFoundException

• Glacier.Client.exceptions.InvalidParameterValueException

• Glacier.Client.exceptions.MissingParameterValueException

• Glacier.Client.exceptions.ServiceUnavailableException

Examples

The example aborts the vault locking process if the vault lock is not in the Locked state for the vault named examplevault.

response = client.abort_vault_lock(
    accountId='-',
    vaultName='examplevault',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}