amazonka-glacier-1.5.0: Amazon Glacier SDK.

Copyright(c) 2013-2017 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.GetVaultLock

Contents

Description

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 .

Synopsis

Creating a Request

getVaultLock Source #

Creates a value of GetVaultLock with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • gvlAccountId - 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 '- ' (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 (-) in the ID.
  • gvlVaultName - The name of the vault.

data GetVaultLock Source #

The input values for GetVaultLock .

See: getVaultLock smart constructor.

Instances

Eq GetVaultLock Source # 
Data GetVaultLock Source # 

Methods

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

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

toConstr :: GetVaultLock -> Constr #

dataTypeOf :: GetVaultLock -> DataType #

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

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

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

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

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

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

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

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

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

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

Read GetVaultLock Source # 
Show GetVaultLock Source # 
Generic GetVaultLock Source # 

Associated Types

type Rep GetVaultLock :: * -> * #

Hashable GetVaultLock Source # 
NFData GetVaultLock Source # 

Methods

rnf :: GetVaultLock -> () #

AWSRequest GetVaultLock Source # 
ToQuery GetVaultLock Source # 
ToPath GetVaultLock Source # 
ToHeaders GetVaultLock Source # 
type Rep GetVaultLock Source # 
type Rep GetVaultLock = D1 (MetaData "GetVaultLock" "Network.AWS.Glacier.GetVaultLock" "amazonka-glacier-1.5.0-AWAt53IVogG613fTETHcMP" False) (C1 (MetaCons "GetVaultLock'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_gvlAccountId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_gvlVaultName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))
type Rs GetVaultLock Source # 

Request Lenses

gvlAccountId :: Lens' GetVaultLock Text Source #

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

gvlVaultName :: Lens' GetVaultLock Text Source #

The name of the vault.

Destructuring the Response

getVaultLockResponse Source #

Creates a value of GetVaultLockResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • gvlrsState - The state of the vault lock. InProgress or Locked .
  • gvlrsExpirationDate - 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.
  • gvlrsCreationDate - The UTC date and time at which the vault lock was put into the InProgress state.
  • gvlrsPolicy - The vault lock policy as a JSON string, which uses "" as an escape character.
  • gvlrsResponseStatus - -- | The response status code.

data GetVaultLockResponse Source #

Contains the Amazon Glacier response to your request.

See: getVaultLockResponse smart constructor.

Instances

Eq GetVaultLockResponse Source # 
Data GetVaultLockResponse Source # 

Methods

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

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

toConstr :: GetVaultLockResponse -> Constr #

dataTypeOf :: GetVaultLockResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read GetVaultLockResponse Source # 
Show GetVaultLockResponse Source # 
Generic GetVaultLockResponse Source # 
NFData GetVaultLockResponse Source # 

Methods

rnf :: GetVaultLockResponse -> () #

type Rep GetVaultLockResponse Source # 
type Rep GetVaultLockResponse = D1 (MetaData "GetVaultLockResponse" "Network.AWS.Glacier.GetVaultLock" "amazonka-glacier-1.5.0-AWAt53IVogG613fTETHcMP" False) (C1 (MetaCons "GetVaultLockResponse'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_gvlrsState") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_gvlrsExpirationDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_gvlrsCreationDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_gvlrsPolicy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_gvlrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))))

Response Lenses

gvlrsState :: Lens' GetVaultLockResponse (Maybe Text) Source #

The state of the vault lock. InProgress or Locked .

gvlrsExpirationDate :: Lens' GetVaultLockResponse (Maybe Text) Source #

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.

gvlrsCreationDate :: Lens' GetVaultLockResponse (Maybe Text) Source #

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

gvlrsPolicy :: Lens' GetVaultLockResponse (Maybe Text) Source #

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

gvlrsResponseStatus :: Lens' GetVaultLockResponse Int Source #

  • - | The response status code.