amazonka-glacier-1.6.1: Amazon Glacier SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.Glacier.InitiateVaultLock

Contents

Description

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.

Synopsis

Creating a Request

initiateVaultLock Source #

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 - 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 - The name of the vault.

data InitiateVaultLock Source #

The input values for InitiateVaultLock .

See: initiateVaultLock smart constructor.

Instances
Eq InitiateVaultLock Source # 
Instance details

Defined in Network.AWS.Glacier.InitiateVaultLock

Data InitiateVaultLock Source # 
Instance details

Defined in Network.AWS.Glacier.InitiateVaultLock

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> InitiateVaultLock -> c InitiateVaultLock #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c InitiateVaultLock #

toConstr :: InitiateVaultLock -> Constr #

dataTypeOf :: InitiateVaultLock -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c InitiateVaultLock) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c InitiateVaultLock) #

gmapT :: (forall b. Data b => b -> b) -> InitiateVaultLock -> InitiateVaultLock #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> InitiateVaultLock -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> InitiateVaultLock -> r #

gmapQ :: (forall d. Data d => d -> u) -> InitiateVaultLock -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> InitiateVaultLock -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> InitiateVaultLock -> m InitiateVaultLock #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> InitiateVaultLock -> m InitiateVaultLock #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> InitiateVaultLock -> m InitiateVaultLock #

Read InitiateVaultLock Source # 
Instance details

Defined in Network.AWS.Glacier.InitiateVaultLock

Show InitiateVaultLock Source # 
Instance details

Defined in Network.AWS.Glacier.InitiateVaultLock

Generic InitiateVaultLock Source # 
Instance details

Defined in Network.AWS.Glacier.InitiateVaultLock

Associated Types

type Rep InitiateVaultLock :: Type -> Type #

Hashable InitiateVaultLock Source # 
Instance details

Defined in Network.AWS.Glacier.InitiateVaultLock

ToJSON InitiateVaultLock Source # 
Instance details

Defined in Network.AWS.Glacier.InitiateVaultLock

AWSRequest InitiateVaultLock Source # 
Instance details

Defined in Network.AWS.Glacier.InitiateVaultLock

Associated Types

type Rs InitiateVaultLock :: Type #

ToHeaders InitiateVaultLock Source # 
Instance details

Defined in Network.AWS.Glacier.InitiateVaultLock

ToPath InitiateVaultLock Source # 
Instance details

Defined in Network.AWS.Glacier.InitiateVaultLock

ToQuery InitiateVaultLock Source # 
Instance details

Defined in Network.AWS.Glacier.InitiateVaultLock

NFData InitiateVaultLock Source # 
Instance details

Defined in Network.AWS.Glacier.InitiateVaultLock

Methods

rnf :: InitiateVaultLock -> () #

type Rep InitiateVaultLock Source # 
Instance details

Defined in Network.AWS.Glacier.InitiateVaultLock

type Rep InitiateVaultLock = D1 (MetaData "InitiateVaultLock" "Network.AWS.Glacier.InitiateVaultLock" "amazonka-glacier-1.6.1-1jk94OYE8nZKrGhzWrcb8m" False) (C1 (MetaCons "InitiateVaultLock'" PrefixI True) (S1 (MetaSel (Just "_ivlPolicy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe VaultLockPolicy)) :*: (S1 (MetaSel (Just "_ivlAccountId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_ivlVaultName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))
type Rs InitiateVaultLock Source # 
Instance details

Defined in Network.AWS.Glacier.InitiateVaultLock

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:

data InitiateVaultLockResponse Source #

Contains the Amazon Glacier response to your request.

See: initiateVaultLockResponse smart constructor.

Instances
Eq InitiateVaultLockResponse Source # 
Instance details

Defined in Network.AWS.Glacier.InitiateVaultLock

Data InitiateVaultLockResponse Source # 
Instance details

Defined in Network.AWS.Glacier.InitiateVaultLock

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> InitiateVaultLockResponse -> c InitiateVaultLockResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c InitiateVaultLockResponse #

toConstr :: InitiateVaultLockResponse -> Constr #

dataTypeOf :: InitiateVaultLockResponse -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c InitiateVaultLockResponse) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c InitiateVaultLockResponse) #

gmapT :: (forall b. Data b => b -> b) -> InitiateVaultLockResponse -> InitiateVaultLockResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> InitiateVaultLockResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> InitiateVaultLockResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> InitiateVaultLockResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> InitiateVaultLockResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> InitiateVaultLockResponse -> m InitiateVaultLockResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> InitiateVaultLockResponse -> m InitiateVaultLockResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> InitiateVaultLockResponse -> m InitiateVaultLockResponse #

Read InitiateVaultLockResponse Source # 
Instance details

Defined in Network.AWS.Glacier.InitiateVaultLock

Show InitiateVaultLockResponse Source # 
Instance details

Defined in Network.AWS.Glacier.InitiateVaultLock

Generic InitiateVaultLockResponse Source # 
Instance details

Defined in Network.AWS.Glacier.InitiateVaultLock

Associated Types

type Rep InitiateVaultLockResponse :: Type -> Type #

NFData InitiateVaultLockResponse Source # 
Instance details

Defined in Network.AWS.Glacier.InitiateVaultLock

type Rep InitiateVaultLockResponse Source # 
Instance details

Defined in Network.AWS.Glacier.InitiateVaultLock

type Rep InitiateVaultLockResponse = D1 (MetaData "InitiateVaultLockResponse" "Network.AWS.Glacier.InitiateVaultLock" "amazonka-glacier-1.6.1-1jk94OYE8nZKrGhzWrcb8m" False) (C1 (MetaCons "InitiateVaultLockResponse'" PrefixI True) (S1 (MetaSel (Just "_ivlrsLockId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ivlrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

ivlrsLockId :: Lens' InitiateVaultLockResponse (Maybe Text) Source #

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