Copyright | (c) 2013-2017 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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.
- initiateVaultLock :: Text -> Text -> InitiateVaultLock
- data InitiateVaultLock
- ivlPolicy :: Lens' InitiateVaultLock (Maybe VaultLockPolicy)
- ivlAccountId :: Lens' InitiateVaultLock Text
- ivlVaultName :: Lens' InitiateVaultLock Text
- initiateVaultLockResponse :: Int -> InitiateVaultLockResponse
- data InitiateVaultLockResponse
- ivlrsLockId :: Lens' InitiateVaultLockResponse (Maybe Text)
- ivlrsResponseStatus :: Lens' InitiateVaultLockResponse Int
Creating a Request
Creates a value of InitiateVaultLock
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ivlPolicy
- The vault lock policy as a JSON string, which uses "" as an escape character.ivlAccountId
- TheAccountId
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.ivlVaultName
- The name of the vault.
data InitiateVaultLock Source #
The input values for InitiateVaultLock
.
See: initiateVaultLock
smart constructor.
Request Lenses
ivlPolicy :: Lens' InitiateVaultLock (Maybe VaultLockPolicy) Source #
The vault lock policy as a JSON string, which uses "" as an escape character.
ivlAccountId :: Lens' InitiateVaultLock Text Source #
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.
ivlVaultName :: Lens' InitiateVaultLock Text Source #
The name of the vault.
Destructuring the Response
initiateVaultLockResponse Source #
Creates a value of InitiateVaultLockResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ivlrsLockId
- The lock ID, which is used to complete the vault locking process.ivlrsResponseStatus
- -- | The response status code.
data InitiateVaultLockResponse Source #
Contains the Amazon Glacier response to your request.
See: initiateVaultLockResponse
smart constructor.
Response Lenses
ivlrsLockId :: Lens' InitiateVaultLockResponse (Maybe Text) Source #
The lock ID, which is used to complete the vault locking process.
ivlrsResponseStatus :: Lens' InitiateVaultLockResponse Int Source #
- - | The response status code.