describe_vault¶

describe_vault(**kwargs)¶

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 .

See also: AWS API Documentation

Request Syntax

response = client.describe_vault(
    vaultName='string'
)

Parameters

accountId (string) --
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.

Note: this parameter is set to "-" bydefault if no value is not specified.
vaultName (string) --
[REQUIRED]

The name of the vault.

Return type

dict

Returns

Response Syntax

{
    'VaultARN': 'string',
    'VaultName': 'string',
    'CreationDate': 'string',
    'LastInventoryDate': 'string',
    'NumberOfArchives': 123,
    'SizeInBytes': 123
}

Response Structure

(dict) --

Contains the Amazon S3 Glacier response to your request.
- VaultARN (string) --
  
  The Amazon Resource Name (ARN) of the vault.
- VaultName (string) --
  
  The name of the vault.
- CreationDate (string) --
  
  The Universal Coordinated Time (UTC) date when the vault was created. This value should be a string in the ISO 8601 date format, for example 2012-03-20T17:03:43.221Z .
- LastInventoryDate (string) --
  
  The Universal Coordinated Time (UTC) date when Amazon S3 Glacier completed the last vault inventory. This value should be a string in the ISO 8601 date format, for example 2012-03-20T17:03:43.221Z .
- NumberOfArchives (integer) --
  
  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.
- SizeInBytes (integer) --
  
  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.

Exceptions

Glacier.Client.exceptions.ResourceNotFoundException
Glacier.Client.exceptions.InvalidParameterValueException
Glacier.Client.exceptions.MissingParameterValueException
Glacier.Client.exceptions.ServiceUnavailableException

Examples

The example retrieves data about a vault named my-vault.

response = client.describe_vault(
    accountId='-',
    vaultName='my-vault',
)

print(response)

Expected Output:

{
    'CreationDate': '2016-09-23T19:27:18.665Z',
    'NumberOfArchives': 0,
    'SizeInBytes': 0,
    'VaultARN': 'arn:aws:glacier:us-west-2:111122223333:vaults/my-vault',
    'VaultName': 'my-vault',
    'ResponseMetadata': {
        '...': '...',
    },
}

Table Of Contents

describe_vault¶