AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
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 S3 Glacier generates vault inventories approximately daily. For more information, see Downloading a Vault Inventory in Amazon S3 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 Identity and Access Management (IAM).
For conceptual information and underlying REST API, see Retrieving Vault Metadata in Amazon S3 Glacier and Describe Vault in the Amazon Glacier Developer Guide.
For .NET Core this operation is only available in asynchronous form. Please refer to DescribeVaultAsync.
Namespace: Amazon.Glacier
Assembly: AWSSDK.Glacier.dll
Version: 3.x.y.z
public virtual DescribeVaultResponse DescribeVault( DescribeVaultRequest request )
Container for the necessary parameters to execute the DescribeVault service method.
| Exception | Condition |
|---|---|
| InvalidParameterValueException | Returned if a parameter of the request is incorrectly specified. |
| MissingParameterValueException | Returned if a required header or parameter is missing from the request. |
| ResourceNotFoundException | Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist. |
| ServiceUnavailableException | Returned if the service cannot complete the request. |
The example retrieves data about a vault named my-vault.
var client = new AmazonGlacierClient();
var response = client.DescribeVault(new DescribeVaultRequest
{
AccountId = "-",
VaultName = "my-vault"
});
string creationDate = response.CreationDate;
long numberOfArchives = response.NumberOfArchives;
long sizeInBytes = response.SizeInBytes;
string vaultARN = response.VaultARN;
string vaultName = response.VaultName;
.NET Framework:
Supported in: 4.5 and newer, 3.5