Safe Haskell | None |
---|---|
Language | Haskell2010 |
This operation returns information about a vault, including the vault's
Amazon Resource Name (ARN), the date the vault was created, the number of
archives it contains, and the total size of all the archives in the vault.
The number of archives and their total size are as of the last inventory
generation. This means that if you add or remove an archive from a vault, and
then immediately use Describe Vault, the change in contents will not be
immediately reflected. If you want to retrieve the latest inventory of the
vault, use InitiateJob
. Amazon Glacier generates vault inventories
approximately daily. For more information, see Downloading a Vault Inventoryin Amazon Glacier.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identityand Access Management (IAM).
For conceptual information and underlying REST API, go to Retrieving VaultMetadata in Amazon Glacier and Describe Vault in the Amazon GlacierDeveloper Guide.
http://docs.aws.amazon.com/amazonglacier/latest/dev/api-DescribeVault.html
- data DescribeVault
- describeVault :: Text -> Text -> DescribeVault
- dvAccountId :: Lens' DescribeVault Text
- dvVaultName :: Lens' DescribeVault Text
- data DescribeVaultResponse
- describeVaultResponse :: DescribeVaultResponse
- dvrCreationDate :: Lens' DescribeVaultResponse (Maybe Text)
- dvrLastInventoryDate :: Lens' DescribeVaultResponse (Maybe Text)
- dvrNumberOfArchives :: Lens' DescribeVaultResponse (Maybe Integer)
- dvrSizeInBytes :: Lens' DescribeVaultResponse (Maybe Integer)
- dvrVaultARN :: Lens' DescribeVaultResponse (Maybe Text)
- dvrVaultName :: Lens' DescribeVaultResponse (Maybe Text)
Request
data DescribeVault Source
Eq DescribeVault | |
Ord DescribeVault | |
Read DescribeVault | |
Show DescribeVault | |
AWSRequest DescribeVault | |
ToQuery DescribeVault | |
ToPath DescribeVault | |
ToHeaders DescribeVault | |
ToJSON DescribeVault | |
type Sv DescribeVault = Glacier | |
type Rs DescribeVault = DescribeVaultResponse |
Request constructor
:: Text | |
-> Text | |
-> DescribeVault |
DescribeVault
constructor.
The fields accessible through corresponding lenses are:
dvAccountId
::
Text
dvVaultName
::
Text
Request lenses
dvAccountId :: Lens' DescribeVault Text Source
The AccountId
is the AWS Account ID. You can specify either the AWS Account
ID or optionally a -
, 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 hyphens in it.
dvVaultName :: Lens' DescribeVault Text Source
The name of the vault.
Response
Response constructor
describeVaultResponse :: DescribeVaultResponse Source
DescribeVaultResponse
constructor.
The fields accessible through corresponding lenses are:
dvrCreationDate
::
Maybe
Text
dvrLastInventoryDate
::
Maybe
Text
dvrNumberOfArchives
::
Maybe
Integer
dvrSizeInBytes
::
Maybe
Integer
dvrVaultARN
::
Maybe
Text
dvrVaultName
::
Maybe
Text
Response lenses
dvrCreationDate :: Lens' DescribeVaultResponse (Maybe Text) Source
The UTC date when the vault was created. A string representation of ISO 8601 date format, for example, "2012-03-20T17:03:43.221Z".
dvrLastInventoryDate :: Lens' DescribeVaultResponse (Maybe Text) Source
The UTC date when Amazon Glacier completed the last vault inventory. A string representation of ISO 8601 date format, for example, "2012-03-20T17:03:43.221Z".
dvrNumberOfArchives :: Lens' DescribeVaultResponse (Maybe Integer) Source
The number of archives in the vault as of the last inventory date. This field
will return null
if an inventory has not yet run on the vault, for example,
if you just created the vault.
dvrSizeInBytes :: Lens' DescribeVaultResponse (Maybe Integer) Source
Total size, in bytes, of the archives in the vault as of the last inventory date. This field will return null if an inventory has not yet run on the vault, for example, if you just created the vault.
dvrVaultARN :: Lens' DescribeVaultResponse (Maybe Text) Source
The Amazon Resource Name (ARN) of the vault.
dvrVaultName :: Lens' DescribeVaultResponse (Maybe Text) Source
The name of the vault.