Amazonka.Glacier.GetVaultLock

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.

Creating a Request

data GetVaultLock

The input values for GetVaultLock.

See: newGetVaultLock smart constructor.

Constructors

GetVaultLock'

Fields

• accountId :: Text

  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 S3 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.

• vaultName :: Text

  The name of the vault.

Instances

ToHeaders GetVaultLock

Defined in Amazonka.Glacier.GetVaultLock

Methods

toHeaders :: GetVaultLock -> [Header]

ToPath GetVaultLock

Defined in Amazonka.Glacier.GetVaultLock

Methods

toPath :: GetVaultLock -> ByteString

ToQuery GetVaultLock

Defined in Amazonka.Glacier.GetVaultLock

Methods

toQuery :: GetVaultLock -> QueryString

AWSRequest GetVaultLock

Defined in Amazonka.Glacier.GetVaultLock

Associated Types

type AWSResponse GetVaultLock

Methods

request :: (Service -> Service) -> GetVaultLock -> Request GetVaultLock

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetVaultLock -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetVaultLock)))

Generic GetVaultLock

Defined in Amazonka.Glacier.GetVaultLock

Associated Types

type Rep GetVaultLock :: Type -> Type

Methods

from :: GetVaultLock -> Rep GetVaultLock x

to :: Rep GetVaultLock x -> GetVaultLock

Read GetVaultLock

Defined in Amazonka.Glacier.GetVaultLock

Methods

readsPrec :: Int -> ReadS GetVaultLock

readList :: ReadS [GetVaultLock]

readPrec :: ReadPrec GetVaultLock

readListPrec :: ReadPrec [GetVaultLock]

Show GetVaultLock

Defined in Amazonka.Glacier.GetVaultLock

Methods

showsPrec :: Int -> GetVaultLock -> ShowS

show :: GetVaultLock -> String

showList :: [GetVaultLock] -> ShowS

NFData GetVaultLock

Defined in Amazonka.Glacier.GetVaultLock

Methods

rnf :: GetVaultLock -> ()

Eq GetVaultLock

Defined in Amazonka.Glacier.GetVaultLock

Methods

(==) :: GetVaultLock -> GetVaultLock -> Bool

(/=) :: GetVaultLock -> GetVaultLock -> Bool

Hashable GetVaultLock

Defined in Amazonka.Glacier.GetVaultLock

Methods

hashWithSalt :: Int -> GetVaultLock -> Int

hash :: GetVaultLock -> Int

type AWSResponse GetVaultLock

Defined in Amazonka.Glacier.GetVaultLock

type AWSResponse GetVaultLock = GetVaultLockResponse

type Rep GetVaultLock

Defined in Amazonka.Glacier.GetVaultLock

type Rep GetVaultLock = D1 ('MetaData "GetVaultLock" "Amazonka.Glacier.GetVaultLock" "amazonka-glacier-2.0-17Kmjv8nUJeKOtbrjLyy76" 'False) (C1 ('MetaCons "GetVaultLock'" 'PrefixI 'True) (S1 ('MetaSel ('Just "accountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "vaultName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetVaultLock

Arguments

:: Text

$sel:accountId:GetVaultLock'

-> Text

GetVaultLock

-> GetVaultLock

Create a value of GetVaultLock 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:GetVaultLock', getVaultLock_accountId - 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 S3 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.

GetVaultLock, getVaultLock_vaultName - The name of the vault.

Request Lenses

getVaultLock_accountId :: Lens' GetVaultLock Text

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 S3 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.

getVaultLock_vaultName :: Lens' GetVaultLock Text

The name of the vault.

Destructuring the Response

data GetVaultLockResponse

Contains the Amazon S3 Glacier response to your request.

See: newGetVaultLockResponse smart constructor.

Constructors

GetVaultLockResponse'

Fields

• creationDate :: Maybe Text

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

• expirationDate :: Maybe Text

  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.

• policy :: Maybe Text

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

• state :: Maybe Text

  The state of the vault lock. InProgress or Locked.

• httpStatus :: Int

  The response's http status code.

Instances

Generic GetVaultLockResponse

Defined in Amazonka.Glacier.GetVaultLock

Associated Types

type Rep GetVaultLockResponse :: Type -> Type

Methods

from :: GetVaultLockResponse -> Rep GetVaultLockResponse x

to :: Rep GetVaultLockResponse x -> GetVaultLockResponse

Read GetVaultLockResponse

Defined in Amazonka.Glacier.GetVaultLock

Methods

readsPrec :: Int -> ReadS GetVaultLockResponse

readList :: ReadS [GetVaultLockResponse]

readPrec :: ReadPrec GetVaultLockResponse

readListPrec :: ReadPrec [GetVaultLockResponse]

Show GetVaultLockResponse

Defined in Amazonka.Glacier.GetVaultLock

Methods

showsPrec :: Int -> GetVaultLockResponse -> ShowS

show :: GetVaultLockResponse -> String

showList :: [GetVaultLockResponse] -> ShowS

NFData GetVaultLockResponse

Defined in Amazonka.Glacier.GetVaultLock

Methods

rnf :: GetVaultLockResponse -> ()

Eq GetVaultLockResponse

Defined in Amazonka.Glacier.GetVaultLock

Methods

(==) :: GetVaultLockResponse -> GetVaultLockResponse -> Bool

(/=) :: GetVaultLockResponse -> GetVaultLockResponse -> Bool

type Rep GetVaultLockResponse

Defined in Amazonka.Glacier.GetVaultLock

type Rep GetVaultLockResponse = D1 ('MetaData "GetVaultLockResponse" "Amazonka.Glacier.GetVaultLock" "amazonka-glacier-2.0-17Kmjv8nUJeKOtbrjLyy76" 'False) (C1 ('MetaCons "GetVaultLockResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "expirationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "policy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newGetVaultLockResponse

Arguments

:: Int

$sel:httpStatus:GetVaultLockResponse'

-> GetVaultLockResponse

Create a value of GetVaultLockResponse 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:

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

GetVaultLockResponse, getVaultLockResponse_expirationDate - 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.

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

$sel:state:GetVaultLockResponse', getVaultLockResponse_state - The state of the vault lock. InProgress or Locked.

$sel:httpStatus:GetVaultLockResponse', getVaultLockResponse_httpStatus - The response's http status code.

Response Lenses

getVaultLockResponse_creationDate :: Lens' GetVaultLockResponse (Maybe Text)

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

getVaultLockResponse_expirationDate :: Lens' GetVaultLockResponse (Maybe Text)

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.

getVaultLockResponse_policy :: Lens' GetVaultLockResponse (Maybe Text)

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

getVaultLockResponse_state :: Lens' GetVaultLockResponse (Maybe Text)

The state of the vault lock. InProgress or Locked.

getVaultLockResponse_httpStatus :: Lens' GetVaultLockResponse Int

The response's http status code.