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

Amazonka.Glacier.CompleteVaultLock

Description

This operation completes the vault locking process by transitioning the vault lock from the InProgress state to the Locked state, which causes the vault lock policy to become unchangeable. A vault lock is put into the InProgress state by calling InitiateVaultLock. You can obtain the state of the vault lock by calling GetVaultLock. For more information about the vault locking process, Amazon Glacier Vault Lock.

This operation is idempotent. This request is always successful if the vault lock is in the Locked state and the provided lock ID matches the lock ID originally used to lock the vault.

If an invalid lock ID is passed in the request when the vault lock is in the Locked state, the operation returns an AccessDeniedException error. If an invalid lock ID is passed in the request when the vault lock is in the InProgress state, the operation throws an InvalidParameter error.

Synopsis

Creating a Request

data CompleteVaultLock Source #

The input values for CompleteVaultLock.

See: newCompleteVaultLock smart constructor.

Constructors

CompleteVaultLock' 

Fields

  • accountId :: Text

    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.

  • vaultName :: Text

    The name of the vault.

  • lockId :: Text

    The lockId value is the lock ID obtained from a InitiateVaultLock request.

Instances

Instances details
Eq CompleteVaultLock Source # 
Instance details

Defined in Amazonka.Glacier.CompleteVaultLock

Read CompleteVaultLock Source # 
Instance details

Defined in Amazonka.Glacier.CompleteVaultLock

Show CompleteVaultLock Source # 
Instance details

Defined in Amazonka.Glacier.CompleteVaultLock

Generic CompleteVaultLock Source # 
Instance details

Defined in Amazonka.Glacier.CompleteVaultLock

Associated Types

type Rep CompleteVaultLock :: Type -> Type #

NFData CompleteVaultLock Source # 
Instance details

Defined in Amazonka.Glacier.CompleteVaultLock

Methods

rnf :: CompleteVaultLock -> () #

Hashable CompleteVaultLock Source # 
Instance details

Defined in Amazonka.Glacier.CompleteVaultLock

ToJSON CompleteVaultLock Source # 
Instance details

Defined in Amazonka.Glacier.CompleteVaultLock

AWSRequest CompleteVaultLock Source # 
Instance details

Defined in Amazonka.Glacier.CompleteVaultLock

Associated Types

type AWSResponse CompleteVaultLock #

ToHeaders CompleteVaultLock Source # 
Instance details

Defined in Amazonka.Glacier.CompleteVaultLock

ToPath CompleteVaultLock Source # 
Instance details

Defined in Amazonka.Glacier.CompleteVaultLock

ToQuery CompleteVaultLock Source # 
Instance details

Defined in Amazonka.Glacier.CompleteVaultLock

type Rep CompleteVaultLock Source # 
Instance details

Defined in Amazonka.Glacier.CompleteVaultLock

type Rep CompleteVaultLock = D1 ('MetaData "CompleteVaultLock" "Amazonka.Glacier.CompleteVaultLock" "libZSservicesZSamazonka-glacierZSamazonka-glacier" 'False) (C1 ('MetaCons "CompleteVaultLock'" 'PrefixI 'True) (S1 ('MetaSel ('Just "accountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "vaultName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "lockId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse CompleteVaultLock Source # 
Instance details

Defined in Amazonka.Glacier.CompleteVaultLock

newCompleteVaultLock Source #

Create a value of CompleteVaultLock with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:accountId:CompleteVaultLock', completeVaultLock_accountId - 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.

$sel:vaultName:CompleteVaultLock', completeVaultLock_vaultName - The name of the vault.

$sel:lockId:CompleteVaultLock', completeVaultLock_lockId - The lockId value is the lock ID obtained from a InitiateVaultLock request.

Request Lenses

completeVaultLock_accountId :: Lens' CompleteVaultLock 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.

completeVaultLock_lockId :: Lens' CompleteVaultLock Text Source #

The lockId value is the lock ID obtained from a InitiateVaultLock request.

Destructuring the Response

data CompleteVaultLockResponse Source #

See: newCompleteVaultLockResponse smart constructor.

Instances

Instances details
Eq CompleteVaultLockResponse Source # 
Instance details

Defined in Amazonka.Glacier.CompleteVaultLock

Read CompleteVaultLockResponse Source # 
Instance details

Defined in Amazonka.Glacier.CompleteVaultLock

Show CompleteVaultLockResponse Source # 
Instance details

Defined in Amazonka.Glacier.CompleteVaultLock

Generic CompleteVaultLockResponse Source # 
Instance details

Defined in Amazonka.Glacier.CompleteVaultLock

Associated Types

type Rep CompleteVaultLockResponse :: Type -> Type #

NFData CompleteVaultLockResponse Source # 
Instance details

Defined in Amazonka.Glacier.CompleteVaultLock

type Rep CompleteVaultLockResponse Source # 
Instance details

Defined in Amazonka.Glacier.CompleteVaultLock

type Rep CompleteVaultLockResponse = D1 ('MetaData "CompleteVaultLockResponse" "Amazonka.Glacier.CompleteVaultLock" "libZSservicesZSamazonka-glacierZSamazonka-glacier" 'False) (C1 ('MetaCons "CompleteVaultLockResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newCompleteVaultLockResponse :: CompleteVaultLockResponse Source #

Create a value of CompleteVaultLockResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.