You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.Glacier

Inherits:
AWS.Service show all
Identifier:
glacier
API Version:
2012-06-01
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Amazon S3 Glacier (Glacier) is a storage solution for "cold data."

Glacier is an extremely low-cost storage service that provides secure, durable, and easy-to-use storage for data backup and archival. With Glacier, customers can store their data cost effectively for months, years, or decades. Glacier also enables customers to offload the administrative burdens of operating and scaling storage to AWS, so they don't have to worry about capacity planning, hardware provisioning, data replication, hardware failure and recovery, or time-consuming hardware migrations.

Glacier is a great storage choice when low storage cost is paramount and your data is rarely retrieved. If your application requires fast or frequent access to your data, consider using Amazon S3. For more information, see Amazon Simple Storage Service (Amazon S3).

You can store any kind of data in any format. There is no maximum limit on the total amount of data you can store in Glacier.

If you are a first-time user of Glacier, we recommend that you begin by reading the following sections in the Amazon S3 Glacier Developer Guide:

  • What is Amazon S3 Glacier - This section of the Developer Guide describes the underlying data model, the operations it supports, and the AWS SDKs that you can use to interact with the service.

  • Getting Started with Amazon S3 Glacier - The Getting Started section walks you through the process of creating a vault, uploading archives, creating jobs to download archives, retrieving the job output, and deleting archives.

Sending a Request Using Glacier

var glacier = new AWS.Glacier();
glacier.abortMultipartUpload(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the Glacier object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var glacier = new AWS.Glacier({apiVersion: '2012-06-01'});

You can also set the API version globally in AWS.config.apiVersions using the glacier service identifier:

AWS.config.apiVersions = {
  glacier: '2012-06-01',
  // other service API versions
};

var glacier = new AWS.Glacier();

Version:

  • 2012-06-01

Waiter Resource States

This service supports a list of resource states that can be polled using the waitFor() method. The resource states are:

vaultExists, vaultNotExists

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Computing Checksums collapse

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, defineService

Constructor Details

new AWS.Glacier(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a Glacier object

var glacier = new AWS.Glacier({apiVersion: '2012-06-01'});

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain) —

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String) —

    the region to send service requests to. See AWS.Glacier.region for more information.

  • maxRetries (Integer) —

    the maximum amount of retries to attempt with a request. See AWS.Glacier.maxRetries for more information.

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.Glacier.maxRedirects for more information.

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean) —

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean) —

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean) —

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean) —

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional') —

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean) —

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map) —

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map) —

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date) —

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>) —

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log) —

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number) —

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String) —

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean) —

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean) —

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined) —

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional') —

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

abortMultipartUpload(params = {}, callback) ⇒ AWS.Request

This operation aborts a multipart upload identified by the upload ID.

After the Abort Multipart Upload request succeeds, you cannot upload any more parts to the multipart upload or complete the multipart upload. Aborting a completed upload fails. However, aborting an already-aborted upload will succeed, for a short time. For more information about uploading a part and completing a multipart upload, see UploadMultipartPart and CompleteMultipartUpload.

This operation is idempotent.

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 Working with Archives in Amazon S3 Glacier and Abort Multipart Upload in the Amazon Glacier Developer Guide.

Service Reference:

Examples:

To abort a multipart upload identified by the upload ID


/* The example deletes an in-progress multipart upload to a vault named my-vault: */

 var params = {
  accountId: "-", 
  uploadId: "19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ", 
  vaultName: "my-vault"
 };
 glacier.abortMultipartUpload(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the abortMultipartUpload operation

var params = {
  accountId: 'STRING_VALUE', /* required */
  uploadId: 'STRING_VALUE', /* required */
  vaultName: 'STRING_VALUE' /* required */
};
glacier.abortMultipartUpload(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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.

    • vaultName — (String)

      The name of the vault.

    • uploadId — (String)

      The upload ID of the multipart upload to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

abortVaultLock(params = {}, callback) ⇒ AWS.Request

This operation aborts the vault locking process if the vault lock is not in the Locked state. If the vault lock is in the Locked state when this operation is requested, the operation returns an AccessDeniedException error. Aborting the vault locking process removes the vault lock policy from the specified vault.

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 get the state of a vault lock by calling GetVaultLock. For more information about the vault locking process, see Amazon Glacier Vault Lock. For more information about vault lock policies, see Amazon Glacier Access Control with Vault Lock Policies.

This operation is idempotent. You can successfully invoke this operation multiple times, if the vault lock is in the InProgress state or if there is no policy associated with the vault.

Service Reference:

Examples:

To abort a vault lock


/* The example aborts the vault locking process if the vault lock is not in the Locked state for the vault named examplevault. */

 var params = {
  accountId: "-", 
  vaultName: "examplevault"
 };
 glacier.abortVaultLock(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the abortVaultLock operation

var params = {
  accountId: 'STRING_VALUE', /* required */
  vaultName: 'STRING_VALUE' /* required */
};
glacier.abortVaultLock(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • accountId — (String)

      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 — (String)

      The name of the vault.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

addTagsToVault(params = {}, callback) ⇒ AWS.Request

This operation adds the specified tags to a vault. Each tag is composed of a key and a value. Each vault can have up to 10 tags. If your request would cause the tag limit for the vault to be exceeded, the operation throws the LimitExceededException error. If a tag already exists on the vault under a specified key, the existing key value will be overwritten. For more information about tags, see Tagging Amazon S3 Glacier Resources.

Service Reference:

Examples:

To add tags to a vault


/* The example adds two tags to a my-vault. */

 var params = {
  Tags: {
   "examplekey1": "examplevalue1", 
   "examplekey2": "examplevalue2"
  }, 
  accountId: "-", 
  vaultName: "my-vault"
 };
 glacier.addTagsToVault(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the addTagsToVault operation

var params = {
  accountId: 'STRING_VALUE', /* required */
  vaultName: 'STRING_VALUE', /* required */
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
glacier.addTagsToVault(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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.

    • vaultName — (String)

      The name of the vault.

    • Tags — (map<String>)

      The tags to add to the vault. Each tag is composed of a key and a value. The value can be an empty string.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

completeMultipartUpload(params = {}, callback) ⇒ AWS.Request

You call this operation to inform Amazon S3 Glacier (Glacier) that all the archive parts have been uploaded and that Glacier can now assemble the archive from the uploaded parts. After assembling and saving the archive to the vault, Glacier returns the URI path of the newly created archive resource. Using the URI path, you can then access the archive. After you upload an archive, you should save the archive ID returned to retrieve the archive at a later point. You can also get the vault inventory to obtain a list of archive IDs in a vault. For more information, see InitiateJob.

In the request, you must include the computed SHA256 tree hash of the entire archive you have uploaded. For information about computing a SHA256 tree hash, see Computing Checksums. On the server side, Glacier also constructs the SHA256 tree hash of the assembled archive. If the values match, Glacier saves the archive to the vault; otherwise, it returns an error, and the operation fails. The ListParts operation returns a list of parts uploaded for a specific multipart upload. It includes checksum information for each uploaded part that can be used to debug a bad checksum issue.

Additionally, Glacier also checks for any missing content ranges when assembling the archive, if missing content ranges are found, Glacier returns an error and the operation fails.

Complete Multipart Upload is an idempotent operation. After your first successful complete multipart upload, if you call the operation again within a short period, the operation will succeed and return the same archive ID. This is useful in the event you experience a network issue that causes an aborted connection or receive a 500 server error, in which case you can repeat your Complete Multipart Upload request and get the same archive ID without creating duplicate archives. Note, however, that after the multipart upload completes, you cannot call the List Parts operation and the multipart upload will not appear in List Multipart Uploads response, even if idempotent complete is possible.

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 Uploading Large Archives in Parts (Multipart Upload) and Complete Multipart Upload in the Amazon Glacier Developer Guide.

Service Reference:

Examples:

To complete a multipart upload


/* The example completes a multipart upload for a 3 MiB archive. */

 var params = {
  accountId: "-", 
  archiveSize: "3145728", 
  checksum: "9628195fcdbcbbe76cdde456d4646fa7de5f219fb39823836d81f0cc0e18aa67", 
  uploadId: "19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ", 
  vaultName: "my-vault"
 };
 glacier.completeMultipartUpload(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    archiveId: "NkbByEejwEggmBz2fTHgJrg0XBoDfjP4q6iu87-TjhqG6eGoOY9Z8i1_AUyUsuhPAdTqLHy8pTl5nfCFJmDl2yEZONi5L26Omw12vcs01MNGntHEQL8MBfGlqrEXAMPLEArchiveId", 
    checksum: "9628195fcdbcbbe76cdde456d4646fa7de5f219fb39823836d81f0cc0e18aa67", 
    location: "/111122223333/vaults/my-vault/archives/NkbByEejwEggmBz2fTHgJrg0XBoDfjP4q6iu87-TjhqG6eGoOY9Z8i1_AUyUsuhPAdTqLHy8pTl5nfCFJmDl2yEZONi5L26Omw12vcs01MNGntHEQL8MBfGlqrEXAMPLEArchiveId"
   }
   */
 });

Calling the completeMultipartUpload operation

var params = {
  accountId: 'STRING_VALUE', /* required */
  uploadId: 'STRING_VALUE', /* required */
  vaultName: 'STRING_VALUE', /* required */
  archiveSize: 'STRING_VALUE',
  checksum: 'STRING_VALUE'
};
glacier.completeMultipartUpload(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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.

    • vaultName — (String)

      The name of the vault.

    • uploadId — (String)

      The upload ID of the multipart upload.

    • archiveSize — (String)

      The total size, in bytes, of the entire archive. This value should be the sum of all the sizes of the individual parts that you uploaded.

    • checksum — (String)

      The SHA256 tree hash of the entire archive. It is the tree hash of SHA256 tree hash of the individual parts. If the value you specify in the request does not match the SHA256 tree hash of the final assembled archive as computed by Amazon S3 Glacier (Glacier), Glacier returns an error and the request fails.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • location — (String)

        The relative URI path of the newly added archive resource.

      • checksum — (String)

        The checksum of the archive computed by Amazon S3 Glacier.

      • archiveId — (String)

        The ID of the archive. This value is also included as part of the location.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

completeVaultLock(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

To complete a vault lock


/* The example completes the vault locking process by transitioning the vault lock from the InProgress state to the Locked state. */

 var params = {
  accountId: "-", 
  lockId: "AE863rKkWZU53SLW5be4DUcW", 
  vaultName: "example-vault"
 };
 glacier.completeVaultLock(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the completeVaultLock operation

var params = {
  accountId: 'STRING_VALUE', /* required */
  lockId: 'STRING_VALUE', /* required */
  vaultName: 'STRING_VALUE' /* required */
};
glacier.completeVaultLock(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • accountId — (String)

      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 — (String)

      The name of the vault.

    • lockId — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

computeChecksums(data) ⇒ map<linearHash:String,treeHash:String>

Computes the SHA-256 linear and tree hash checksums for a given block of Buffer data. Pass the tree hash of the computed checksums as the checksum input to the completeMultipartUpload() when performing a multi-part upload.

Examples:

Calculate checksum of 5.5MB data chunk

var glacier = new AWS.Glacier();
var data = Buffer.alloc(5.5 * 1024 * 1024);
data.fill('0'); // fill with zeros
var results = glacier.computeChecksums(data);
// Result: { linearHash: '68aff0c5a9...', treeHash: '154e26c78f...' }

Parameters:

  • data (Buffer, String) —

    data to calculate the checksum for

Returns:

  • (map<linearHash:String,treeHash:String>) —

    a map containing the linearHash and treeHash properties representing hex based digests of the respective checksums.

See Also:

createVault(params = {}, callback) ⇒ AWS.Request

This operation creates a new vault with the specified name. The name of the vault must be unique within a region for an AWS account. You can create up to 1,000 vaults per account. If you need to create more vaults, contact Amazon S3 Glacier.

You must use the following guidelines when naming a vault.

  • Names can be between 1 and 255 characters long.

  • Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), and '.' (period).

This operation is idempotent.

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 Creating a Vault in Amazon Glacier and Create Vault in the Amazon Glacier Developer Guide.

Service Reference:

Examples:

To create a new vault


/* The following example creates a new vault named my-vault. */

 var params = {
  accountId: "-", 
  vaultName: "my-vault"
 };
 glacier.createVault(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    location: "/111122223333/vaults/my-vault"
   }
   */
 });

Calling the createVault operation

var params = {
  accountId: 'STRING_VALUE', /* required */
  vaultName: 'STRING_VALUE' /* required */
};
glacier.createVault(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • accountId — (String)

      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 S3 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 — (String)

      The name of the vault.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • location — (String)

        The URI of the vault that was created.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteArchive(params = {}, callback) ⇒ AWS.Request

This operation deletes an archive from a vault. Subsequent requests to initiate a retrieval of this archive will fail. Archive retrievals that are in progress for this archive ID may or may not succeed according to the following scenarios:

  • If the archive retrieval job is actively preparing the data for download when Amazon S3 Glacier receives the delete archive request, the archival retrieval operation might fail.

  • If the archive retrieval job has successfully prepared the archive for download when Amazon S3 Glacier receives the delete archive request, you will be able to download the output.

This operation is idempotent. Attempting to delete an already-deleted archive does not result in an error.

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 Deleting an Archive in Amazon Glacier and Delete Archive in the Amazon Glacier Developer Guide.

Service Reference:

Examples:

To delete an archive


/* The example deletes the archive specified by the archive ID. */

 var params = {
  accountId: "-", 
  archiveId: "NkbByEejwEggmBz2fTHgJrg0XBoDfjP4q6iu87-TjhqG6eGoOY9Z8i1_AUyUsuhPAdTqLHy8pTl5nfCFJmDl2yEZONi5L26Omw12vcs01MNGntHEQL8MBfGlqrEXAMPLEArchiveId", 
  vaultName: "examplevault"
 };
 glacier.deleteArchive(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the deleteArchive operation

var params = {
  accountId: 'STRING_VALUE', /* required */
  archiveId: 'STRING_VALUE', /* required */
  vaultName: 'STRING_VALUE' /* required */
};
glacier.deleteArchive(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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.

    • vaultName — (String)

      The name of the vault.

    • archiveId — (String)

      The ID of the archive to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteVault(params = {}, callback) ⇒ AWS.Request

This operation deletes a vault. Amazon S3 Glacier will delete a vault only if there are no archives in the vault as of the last inventory and there have been no writes to the vault since the last inventory. If either of these conditions is not satisfied, the vault deletion fails (that is, the vault is not removed) and Amazon S3 Glacier returns an error. You can use DescribeVault to return the number of archives in a vault, and you can use Initiate a Job (POST jobs) to initiate a new inventory retrieval for a vault. The inventory contains the archive IDs you use to delete archives using Delete Archive (DELETE archive).

This operation is idempotent.

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 Deleting a Vault in Amazon Glacier and Delete Vault in the Amazon S3 Glacier Developer Guide.

Service Reference:

Examples:

To delete a vault


/* The example deletes a vault named my-vault: */

 var params = {
  accountId: "-", 
  vaultName: "my-vault"
 };
 glacier.deleteVault(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the deleteVault operation

var params = {
  accountId: 'STRING_VALUE', /* required */
  vaultName: 'STRING_VALUE' /* required */
};
glacier.deleteVault(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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.

    • vaultName — (String)

      The name of the vault.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteVaultAccessPolicy(params = {}, callback) ⇒ AWS.Request

This operation deletes the access policy associated with the specified vault. The operation is eventually consistent; that is, it might take some time for Amazon S3 Glacier to completely remove the access policy, and you might still see the effect of the policy for a short time after you send the delete request.

This operation is idempotent. You can invoke delete multiple times, even if there is no policy associated with the vault. For more information about vault access policies, see Amazon Glacier Access Control with Vault Access Policies.

Service Reference:

Examples:

To delete the vault access policy


/* The example deletes the access policy associated with the vault named examplevault. */

 var params = {
  accountId: "-", 
  vaultName: "examplevault"
 };
 glacier.deleteVaultAccessPolicy(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the deleteVaultAccessPolicy operation

var params = {
  accountId: 'STRING_VALUE', /* required */
  vaultName: 'STRING_VALUE' /* required */
};
glacier.deleteVaultAccessPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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.

    • vaultName — (String)

      The name of the vault.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteVaultNotifications(params = {}, callback) ⇒ AWS.Request

This operation deletes the notification configuration set for a vault. The operation is eventually consistent; that is, it might take some time for Amazon S3 Glacier to completely disable the notifications and you might still receive some notifications for a short time after you send the delete request.

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 Configuring Vault Notifications in Amazon S3 Glacier and Delete Vault Notification Configuration in the Amazon S3 Glacier Developer Guide.

Service Reference:

Examples:

To delete the notification configuration set for a vault


/* The example deletes the notification configuration set for the vault named examplevault. */

 var params = {
  accountId: "-", 
  vaultName: "examplevault"
 };
 glacier.deleteVaultNotifications(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the deleteVaultNotifications operation

var params = {
  accountId: 'STRING_VALUE', /* required */
  vaultName: 'STRING_VALUE' /* required */
};
glacier.deleteVaultNotifications(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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.

    • vaultName — (String)

      The name of the vault.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeJob(params = {}, callback) ⇒ AWS.Request

This operation returns information about a job you previously initiated, including the job initiation date, the user who initiated the job, the job status code/message and the Amazon SNS topic to notify after Amazon S3 Glacier (Glacier) completes the job. For more information about initiating a job, see InitiateJob.

Note: This operation enables you to check the status of your job. However, it is strongly recommended that you set up an Amazon SNS topic and specify it in your initiate job request so that Glacier can notify the topic after it completes the job.

A job ID will not expire for at least 24 hours after Glacier completes the job.

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 more information about using this operation, see the documentation for the underlying REST API Describe Job in the Amazon Glacier Developer Guide.

Service Reference:

Examples:

To get information about a previously initiated job


/* The example returns information about the previously initiated job specified by the job ID. */

 var params = {
  accountId: "-", 
  jobId: "zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4Cn", 
  vaultName: "my-vault"
 };
 glacier.describeJob(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Action: "InventoryRetrieval", 
    Completed: false, 
    CreationDate: "2015-07-17T20:23:41.616Z", 
    InventoryRetrievalParameters: {
     Format: "JSON"
    }, 
    JobId: "zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4CnMW", 
    StatusCode: "InProgress", 
    VaultARN: "arn:aws:glacier:us-west-2:0123456789012:vaults/my-vault"
   }
   */
 });

Calling the describeJob operation

var params = {
  accountId: 'STRING_VALUE', /* required */
  jobId: 'STRING_VALUE', /* required */
  vaultName: 'STRING_VALUE' /* required */
};
glacier.describeJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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.

    • vaultName — (String)

      The name of the vault.

    • jobId — (String)

      The ID of the job to describe.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • JobId — (String)

        An opaque string that identifies an Amazon S3 Glacier job.

      • JobDescription — (String)

        The job description provided when initiating the job.

      • Action — (String)

        The job type. This value is either ArchiveRetrieval, InventoryRetrieval, or Select.

        Possible values include:
        • "ArchiveRetrieval"
        • "InventoryRetrieval"
        • "Select"
      • ArchiveId — (String)

        The archive ID requested for a select job or archive retrieval. Otherwise, this field is null.

      • VaultARN — (String)

        The Amazon Resource Name (ARN) of the vault from which an archive retrieval was requested.

      • CreationDate — (String)

        The UTC date when the job was created. This value is a string representation of ISO 8601 date format, for example "2012-03-20T17:03:43.221Z".

      • Completed — (Boolean)

        The job status. When a job is completed, you get the job's output using Get Job Output (GET output).

      • StatusCode — (String)

        The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.

        Possible values include:
        • "InProgress"
        • "Succeeded"
        • "Failed"
      • StatusMessage — (String)

        A friendly message that describes the job status.

      • ArchiveSizeInBytes — (Integer)

        For an archive retrieval job, this value is the size in bytes of the archive being requested for download. For an inventory retrieval or select job, this value is null.

      • InventorySizeInBytes — (Integer)

        For an inventory retrieval job, this value is the size in bytes of the inventory requested for download. For an archive retrieval or select job, this value is null.

      • SNSTopic — (String)

        An Amazon SNS topic that receives notification.

      • CompletionDate — (String)

        The UTC time that the job request completed. While the job is in progress, the value is null.

      • SHA256TreeHash — (String)

        For an archive retrieval job, this value is the checksum of the archive. Otherwise, this value is null.

        The SHA256 tree hash value for the requested range of an archive. If the InitiateJob request for an archive specified a tree-hash aligned range, then this field returns a value.

        If the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash value.

        This field is null for the following:

        • Archive retrieval jobs that specify a range that is not tree-hash aligned

        • Archival jobs that specify a range that is equal to the whole archive, when the job status is InProgress

        • Inventory jobs

        • Select jobs

      • ArchiveSHA256TreeHash — (String)

        The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval or select jobs, this field is null.

      • RetrievalByteRange — (String)

        The retrieved byte range for archive retrieval jobs in the form StartByteValue-EndByteValue. If no range was specified in the archive retrieval, then the whole archive is retrieved. In this case, StartByteValue equals 0 and EndByteValue equals the size of the archive minus 1. For inventory retrieval or select jobs, this field is null.

      • Tier — (String)

        The tier to use for a select or an archive retrieval. Valid values are Expedited, Standard, or Bulk. Standard is the default.

      • InventoryRetrievalParameters — (map)

        Parameters used for range inventory retrieval.

        • Format — (String)

          The output format for the vault inventory list, which is set by the InitiateJob request when initiating a job to retrieve a vault inventory. Valid values are CSV and JSON.

        • StartDate — (String)

          The start of the date range in Universal Coordinated Time (UTC) for vault inventory retrieval that includes archives created on or after this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z.

        • EndDate — (String)

          The end of the date range in UTC for vault inventory retrieval that includes archives created before this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z.

        • Limit — (String)

          The maximum number of inventory items returned per vault inventory retrieval request. This limit is set when initiating the job with the a InitiateJob request.

        • Marker — (String)

          An opaque string that represents where to continue pagination of the vault inventory retrieval results. You use the marker in a new InitiateJob request to obtain additional inventory items. If there are no more inventory items, this value is null. For more information, see Range Inventory Retrieval.

      • JobOutputPath — (String)

        Contains the job output location.

      • SelectParameters — (map)

        Contains the parameters used for a select.

        • InputSerialization — (map)

          Describes the serialization format of the object.

          • csv — (map)

            Describes the serialization of a CSV-encoded object.

            • FileHeaderInfo — (String)

              Describes the first line of input. Valid values are None, Ignore, and Use.

              Possible values include:
              • "USE"
              • "IGNORE"
              • "NONE"
            • Comments — (String)

              A single character used to indicate that a row should be ignored when the character is present at the start of that row.

            • QuoteEscapeCharacter — (String)

              A single character used for escaping the quotation-mark character inside an already escaped value.

            • RecordDelimiter — (String)

              A value used to separate individual records from each other.

            • FieldDelimiter — (String)

              A value used to separate individual fields from each other within a record.

            • QuoteCharacter — (String)

              A value used as an escape character where the field delimiter is part of the value.

        • ExpressionType — (String)

          The type of the provided expression, for example SQL.

          Possible values include:
          • "SQL"
        • Expression — (String)

          The expression that is used to select the object.

        • OutputSerialization — (map)

          Describes how the results of the select job are serialized.

          • csv — (map)

            Describes the serialization of CSV-encoded query results.

            • QuoteFields — (String)

              A value that indicates whether all output fields should be contained within quotation marks.

              Possible values include:
              • "ALWAYS"
              • "ASNEEDED"
            • QuoteEscapeCharacter — (String)

              A single character used for escaping the quotation-mark character inside an already escaped value.

            • RecordDelimiter — (String)

              A value used to separate individual records from each other.

            • FieldDelimiter — (String)

              A value used to separate individual fields from each other within a record.

            • QuoteCharacter — (String)

              A value used as an escape character where the field delimiter is part of the value.

      • OutputLocation — (map)

        Contains the location where the data from the select job is stored.

        • S3 — (map)

          Describes an S3 location that will receive the results of the job request.

          • BucketName — (String)

            The name of the Amazon S3 bucket where the job results are stored.

          • Prefix — (String)

            The prefix that is prepended to the results for this request.

          • Encryption — (map)

            Contains information about the encryption used to store the job results in Amazon S3.

            • EncryptionType — (String)

              The server-side encryption algorithm used when storing job results in Amazon S3, for example AES256 or aws:kms.

              Possible values include:
              • "aws:kms"
              • "AES256"
            • KMSKeyId — (String)

              The AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS fail if not made by using Secure Sockets Layer (SSL) or Signature Version 4.

            • KMSContext — (String)

              Optional. If the encryption type is aws:kms, you can use this value to specify the encryption context for the job results.

          • CannedACL — (String)

            The canned access control list (ACL) to apply to the job results.

            Possible values include:
            • "private"
            • "public-read"
            • "public-read-write"
            • "aws-exec-read"
            • "authenticated-read"
            • "bucket-owner-read"
            • "bucket-owner-full-control"
          • AccessControlList — (Array<map>)

            A list of grants that control access to the staged results.

            • Grantee — (map)

              The grantee.

              • Type — required — (String)

                Type of grantee

                Possible values include:
                • "AmazonCustomerByEmail"
                • "CanonicalUser"
                • "Group"
              • DisplayName — (String)

                Screen name of the grantee.

              • URI — (String)

                URI of the grantee group.

              • ID — (String)

                The canonical user ID of the grantee.

              • EmailAddress — (String)

                Email address of the grantee.

            • Permission — (String)

              Specifies the permission given to the grantee.

              Possible values include:
              • "FULL_CONTROL"
              • "WRITE"
              • "WRITE_ACP"
              • "READ"
              • "READ_ACP"
          • Tagging — (map<String>)

            The tag-set that is applied to the job results.

          • UserMetadata — (map<String>)

            A map of metadata to store with the job results in Amazon S3.

          • StorageClass — (String)

            The storage class used to store the job results.

            Possible values include:
            • "STANDARD"
            • "REDUCED_REDUNDANCY"
            • "STANDARD_IA"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeVault(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

To retrieve information about a vault


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

 var params = {
  accountId: "-", 
  vaultName: "my-vault"
 };
 glacier.describeVault(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    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"
   }
   */
 });

Calling the describeVault operation

var params = {
  accountId: 'STRING_VALUE', /* required */
  vaultName: 'STRING_VALUE' /* required */
};
glacier.describeVault(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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.

    • vaultName — (String)

      The name of the vault.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

getDataRetrievalPolicy(params = {}, callback) ⇒ AWS.Request

This operation returns the current data retrieval policy for the account and region specified in the GET request. For more information about data retrieval policies, see Amazon Glacier Data Retrieval Policies.

Service Reference:

Examples:

To get the current data retrieval policy for an account


/* The example returns the current data retrieval policy for the account. */

 var params = {
  accountId: "-"
 };
 glacier.getDataRetrievalPolicy(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Policy: {
     Rules: [
        {
       BytesPerHour: 10737418240, 
       Strategy: "BytesPerHour"
      }
     ]
    }
   }
   */
 });

Calling the getDataRetrievalPolicy operation

var params = {
  accountId: 'STRING_VALUE' /* required */
};
glacier.getDataRetrievalPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • accountId — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Policy — (map)

        Contains the returned data retrieval policy in JSON format.

        • Rules — (Array<map>)

          The policy rule. Although this is a list type, currently there must be only one rule, which contains a Strategy field and optionally a BytesPerHour field.

          • Strategy — (String)

            The type of data retrieval policy to set.

            Valid values: BytesPerHour|FreeTier|None

          • BytesPerHour — (Integer)

            The maximum number of bytes that can be retrieved in an hour.

            This field is required only if the value of the Strategy field is BytesPerHour. Your PUT operation will be rejected if the Strategy field is not set to BytesPerHour and you set this field.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getJobOutput(params = {}, callback) ⇒ AWS.Request

This operation downloads the output of the job you initiated using InitiateJob. Depending on the job type you specified when you initiated the job, the output will be either the content of an archive or a vault inventory.

You can download all the job output or download a portion of the output by specifying a byte range. In the case of an archive retrieval job, depending on the byte range you specify, Amazon S3 Glacier (Glacier) returns the checksum for the portion of the data. You can compute the checksum on the client and verify that the values match to ensure the portion you downloaded is the correct data.

A job ID will not expire for at least 24 hours after Glacier completes the job. That a byte range. For both archive and inventory retrieval jobs, you should verify the downloaded size against the size returned in the headers from the Get Job Output response.

For archive retrieval jobs, you should also verify that the size is what you expected. If you download a portion of the output, the expected size is based on the range of bytes you specified. For example, if you specify a range of bytes=0-1048575, you should verify your download size is 1,048,576 bytes. If you download an entire archive, the expected size is the size of the archive when you uploaded it to Amazon S3 Glacier The expected size is also returned in the headers from the Get Job Output response.

In the case of an archive retrieval job, depending on the byte range you specify, Glacier returns the checksum for the portion of the data. To ensure the portion you downloaded is the correct data, compute the checksum on the client, verify that the values match, and verify that the size is what you expected.

A job ID does not expire for at least 24 hours after Glacier completes the job. That is, you can download the job output within the 24 hours period after Amazon Glacier completes the job.

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 the underlying REST API, see Downloading a Vault Inventory, Downloading an Archive, and Get Job Output

Service Reference:

Examples:

To get the output of a previously initiated job


/* The example downloads the output of a previously initiated inventory retrieval job that is identified by the job ID. */

 var params = {
  accountId: "-", 
  jobId: "zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4CnMW", 
  range: "", 
  vaultName: "my-vaul"
 };
 glacier.getJobOutput(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    acceptRanges: "bytes", 
    body: <Binary String>, 
    contentType: "application/json", 
    status: 200
   }
   */
 });

Calling the getJobOutput operation

var params = {
  accountId: 'STRING_VALUE', /* required */
  jobId: 'STRING_VALUE', /* required */
  vaultName: 'STRING_VALUE', /* required */
  range: 'STRING_VALUE'
};
glacier.getJobOutput(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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.

    • vaultName — (String)

      The name of the vault.

    • jobId — (String)

      The job ID whose data is downloaded.

    • range — (String)

      The range of bytes to retrieve from the output. For example, if you want to download the first 1,048,576 bytes, specify the range as bytes=0-1048575. By default, this operation downloads the entire output.

      If the job output is large, then you can use a range to retrieve a portion of the output. This allows you to download the entire output in smaller chunks of bytes. For example, suppose you have 1 GB of job output you want to download and you decide to download 128 MB chunks of data at a time, which is a total of eight Get Job Output requests. You use the following process to download the job output:

      1. Download a 128 MB chunk of output by specifying the appropriate byte range. Verify that all 128 MB of data was received.

      2. Along with the data, the response includes a SHA256 tree hash of the payload. You compute the checksum of the payload on the client and compare it with the checksum you received in the response to ensure you received all the expected data.

      3. Repeat steps 1 and 2 for all the eight 128 MB chunks of output data, each time specifying the appropriate byte range.

      4. After downloading all the parts of the job output, you have a list of eight checksum values. Compute the tree hash of these values to find the checksum of the entire output. Using the DescribeJob API, obtain job information of the job that provided you the output. The response includes the checksum of the entire archive stored in Amazon S3 Glacier. You compare this value with the checksum you computed to ensure you have downloaded the entire archive content with no errors.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • body — (Buffer(Node.js), Typed Array(Browser), ReadableStream)

        The job data, either archive data or inventory data.

      • checksum — (String)

        The checksum of the data in the response. This header is returned only when retrieving the output for an archive retrieval job. Furthermore, this header appears only under the following conditions:

        • You get the entire range of the archive.

        • You request a range to return of the archive that starts and ends on a multiple of 1 MB. For example, if you have an 3.1 MB archive and you specify a range to return that starts at 1 MB and ends at 2 MB, then the x-amz-sha256-tree-hash is returned as a response header.

        • You request a range of the archive to return that starts on a multiple of 1 MB and goes to the end of the archive. For example, if you have a 3.1 MB archive and you specify a range that starts at 2 MB and ends at 3.1 MB (the end of the archive), then the x-amz-sha256-tree-hash is returned as a response header.

      • status — (Integer)

        The HTTP response code for a job output request. The value depends on whether a range was specified in the request.

      • contentRange — (String)

        The range of bytes returned by Amazon S3 Glacier. If only partial output is downloaded, the response provides the range of bytes Amazon S3 Glacier returned. For example, bytes 0-1048575/8388608 returns the first 1 MB from 8 MB.

      • acceptRanges — (String)

        Indicates the range units accepted. For more information, see RFC2616.

      • contentType — (String)

        The Content-Type depends on whether the job output is an archive or a vault inventory. For archive data, the Content-Type is application/octet-stream. For vault inventory, if you requested CSV format when you initiated the job, the Content-Type is text/csv. Otherwise, by default, vault inventory is returned as JSON, and the Content-Type is application/json.

      • archiveDescription — (String)

        The description of an archive.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getVaultAccessPolicy(params = {}, callback) ⇒ AWS.Request

This operation retrieves the access-policy subresource set on the vault; for more information on setting this subresource, see Set Vault Access Policy (PUT access-policy). If there is no access policy set on the vault, the operation returns a 404 Not found error. For more information about vault access policies, see Amazon Glacier Access Control with Vault Access Policies.

Service Reference:

Examples:

To get the access-policy set on the vault


/* The example retrieves the access-policy set on the vault named example-vault. */

 var params = {
  accountId: "-", 
  vaultName: "example-vault"
 };
 glacier.getVaultAccessPolicy(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    policy: {
     Policy: "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"Define-owner-access-rights\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::999999999999:root\"},\"Action\":\"glacier:DeleteArchive\",\"Resource\":\"arn:aws:glacier:us-west-2:999999999999:vaults/examplevault\"}]}"
    }
   }
   */
 });

Calling the getVaultAccessPolicy operation

var params = {
  accountId: 'STRING_VALUE', /* required */
  vaultName: 'STRING_VALUE' /* required */
};
glacier.getVaultAccessPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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.

    • vaultName — (String)

      The name of the vault.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • policy — (map)

        Contains the returned vault access policy as a JSON string.

        • Policy — (String)

          The vault access policy.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getVaultLock(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

To retrieve vault lock-policy related attributes that are set on a vault


/* The example retrieves the attributes from the lock-policy subresource set on the vault named examplevault. */

 var params = {
  accountId: "-", 
  vaultName: "examplevault"
 };
 glacier.getVaultLock(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    CreationDate: "exampledate", 
    ExpirationDate: "exampledate", 
    Policy: "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"Define-vault-lock\",\"Effect\":\"Deny\",\"Principal\":{\"AWS\":\"arn:aws:iam::999999999999:root\"},\"Action\":\"glacier:DeleteArchive\",\"Resource\":\"arn:aws:glacier:us-west-2:999999999999:vaults/examplevault\",\"Condition\":{\"NumericLessThanEquals\":{\"glacier:ArchiveAgeinDays\":\"365\"}}}]}", 
    State: "InProgress"
   }
   */
 });

Calling the getVaultLock operation

var params = {
  accountId: 'STRING_VALUE', /* required */
  vaultName: 'STRING_VALUE' /* required */
};
glacier.getVaultLock(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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.

    • vaultName — (String)

      The name of the vault.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Policy — (String)

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

      • State — (String)

        The state of the vault lock. InProgress or Locked.

      • ExpirationDate — (String)

        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.

      • CreationDate — (String)

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getVaultNotifications(params = {}, callback) ⇒ AWS.Request

This operation retrieves the notification-configuration subresource of the specified vault.

For information about setting a notification configuration on a vault, see SetVaultNotifications. If a notification configuration for a vault is not set, the operation returns a 404 Not Found error. For more information about vault notifications, see Configuring Vault Notifications 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 Configuring Vault Notifications in Amazon S3 Glacier and Get Vault Notification Configuration in the Amazon Glacier Developer Guide.

Service Reference:

Examples:

To get the notification-configuration for the specified vault


/* The example retrieves the notification-configuration for the vault named my-vault. */

 var params = {
  accountId: "-", 
  vaultName: "my-vault"
 };
 glacier.getVaultNotifications(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    vaultNotificationConfig: {
     Events: [
        "InventoryRetrievalCompleted", 
        "ArchiveRetrievalCompleted"
     ], 
     SNSTopic: "arn:aws:sns:us-west-2:0123456789012:my-vault"
    }
   }
   */
 });

Calling the getVaultNotifications operation

var params = {
  accountId: 'STRING_VALUE', /* required */
  vaultName: 'STRING_VALUE' /* required */
};
glacier.getVaultNotifications(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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.

    • vaultName — (String)

      The name of the vault.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • vaultNotificationConfig — (map)

        Returns the notification configuration set on the vault.

        • SNSTopic — (String)

          The Amazon Simple Notification Service (Amazon SNS) topic Amazon Resource Name (ARN).

        • Events — (Array<String>)

          A list of one or more events for which Amazon S3 Glacier will send a notification to the specified Amazon SNS topic.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

initiateJob(params = {}, callback) ⇒ AWS.Request

This operation initiates a job of the specified type, which can be a select, an archival retrieval, or a vault retrieval. For more information about using this operation, see the documentation for the underlying REST API Initiate a Job.

Service Reference:

Examples:

To initiate an inventory-retrieval job


/* The example initiates an inventory-retrieval job for the vault named examplevault. */

 var params = {
  accountId: "-", 
  jobParameters: {
   Description: "My inventory job", 
   Format: "CSV", 
   SNSTopic: "arn:aws:sns:us-west-2:111111111111:Glacier-InventoryRetrieval-topic-Example", 
   Type: "inventory-retrieval"
  }, 
  vaultName: "examplevault"
 };
 glacier.initiateJob(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    jobId: " HkF9p6o7yjhFx-K3CGl6fuSm6VzW9T7esGQfco8nUXVYwS0jlb5gq1JZ55yHgt5vP54ZShjoQzQVVh7vEXAMPLEjobID", 
    location: "/111122223333/vaults/examplevault/jobs/HkF9p6o7yjhFx-K3CGl6fuSm6VzW9T7esGQfco8nUXVYwS0jlb5gq1JZ55yHgt5vP54ZShjoQzQVVh7vEXAMPLEjobID"
   }
   */
 });

Calling the initiateJob operation

var params = {
  accountId: 'STRING_VALUE', /* required */
  vaultName: 'STRING_VALUE', /* required */
  jobParameters: {
    ArchiveId: 'STRING_VALUE',
    Description: 'STRING_VALUE',
    Format: 'STRING_VALUE',
    InventoryRetrievalParameters: {
      EndDate: 'STRING_VALUE',
      Limit: 'STRING_VALUE',
      Marker: 'STRING_VALUE',
      StartDate: 'STRING_VALUE'
    },
    OutputLocation: {
      S3: {
        AccessControlList: [
          {
            Grantee: {
              Type: AmazonCustomerByEmail | CanonicalUser | Group, /* required */
              DisplayName: 'STRING_VALUE',
              EmailAddress: 'STRING_VALUE',
              ID: 'STRING_VALUE',
              URI: 'STRING_VALUE'
            },
            Permission: FULL_CONTROL | WRITE | WRITE_ACP | READ | READ_ACP
          },
          /* more items */
        ],
        BucketName: 'STRING_VALUE',
        CannedACL: private | public-read | public-read-write | aws-exec-read | authenticated-read | bucket-owner-read | bucket-owner-full-control,
        Encryption: {
          EncryptionType: aws:kms | AES256,
          KMSContext: 'STRING_VALUE',
          KMSKeyId: 'STRING_VALUE'
        },
        Prefix: 'STRING_VALUE',
        StorageClass: STANDARD | REDUCED_REDUNDANCY | STANDARD_IA,
        Tagging: {
          '<string>': 'STRING_VALUE',
          /* '<string>': ... */
        },
        UserMetadata: {
          '<string>': 'STRING_VALUE',
          /* '<string>': ... */
        }
      }
    },
    RetrievalByteRange: 'STRING_VALUE',
    SNSTopic: 'STRING_VALUE',
    SelectParameters: {
      Expression: 'STRING_VALUE',
      ExpressionType: SQL,
      InputSerialization: {
        csv: {
          Comments: 'STRING_VALUE',
          FieldDelimiter: 'STRING_VALUE',
          FileHeaderInfo: USE | IGNORE | NONE,
          QuoteCharacter: 'STRING_VALUE',
          QuoteEscapeCharacter: 'STRING_VALUE',
          RecordDelimiter: 'STRING_VALUE'
        }
      },
      OutputSerialization: {
        csv: {
          FieldDelimiter: 'STRING_VALUE',
          QuoteCharacter: 'STRING_VALUE',
          QuoteEscapeCharacter: 'STRING_VALUE',
          QuoteFields: ALWAYS | ASNEEDED,
          RecordDelimiter: 'STRING_VALUE'
        }
      }
    },
    Tier: 'STRING_VALUE',
    Type: 'STRING_VALUE'
  }
};
glacier.initiateJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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.

    • vaultName — (String)

      The name of the vault.

    • jobParameters — (map)

      Provides options for specifying job information.

      • Format — (String)

        When initiating a job to retrieve a vault inventory, you can optionally add this parameter to your request to specify the output format. If you are initiating an inventory job and do not specify a Format field, JSON is the default format. Valid values are "CSV" and "JSON".

      • Type — (String)

        The job type. You can initiate a job to perform a select query on an archive, retrieve an archive, or get an inventory of a vault. Valid values are "select", "archive-retrieval" and "inventory-retrieval".

      • ArchiveId — (String)

        The ID of the archive that you want to retrieve. This field is required only if Type is set to select or archive-retrievalcode>. An error occurs if you specify this request parameter for an inventory retrieval job request.

      • Description — (String)

        The optional description for the job. The description must be less than or equal to 1,024 bytes. The allowable characters are 7-bit ASCII without control codes-specifically, ASCII values 32-126 decimal or 0x20-0x7E hexadecimal.

      • SNSTopic — (String)

        The Amazon SNS topic ARN to which Amazon S3 Glacier sends a notification when the job is completed and the output is ready for you to download. The specified topic publishes the notification to its subscribers. The SNS topic must exist.

      • RetrievalByteRange — (String)

        The byte range to retrieve for an archive retrieval. in the form "StartByteValue-EndByteValue" If not specified, the whole archive is retrieved. If specified, the byte range must be megabyte (1024*1024) aligned which means that StartByteValue must be divisible by 1 MB and EndByteValue plus 1 must be divisible by 1 MB or be the end of the archive specified as the archive byte size value minus 1. If RetrievalByteRange is not megabyte aligned, this operation returns a 400 response.

        An error occurs if you specify this field for an inventory retrieval job request.

      • Tier — (String)

        The tier to use for a select or an archive retrieval job. Valid values are Expedited, Standard, or Bulk. Standard is the default.

      • InventoryRetrievalParameters — (map)

        Input parameters used for range inventory retrieval.

        • StartDate — (String)

          The start of the date range in UTC for vault inventory retrieval that includes archives created on or after this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z.

        • EndDate — (String)

          The end of the date range in UTC for vault inventory retrieval that includes archives created before this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z.

        • Limit — (String)

          Specifies the maximum number of inventory items returned per vault inventory retrieval request. Valid values are greater than or equal to 1.

        • Marker — (String)

          An opaque string that represents where to continue pagination of the vault inventory retrieval results. You use the marker in a new InitiateJob request to obtain additional inventory items. If there are no more inventory items, this value is null.

      • SelectParameters — (map)

        Contains the parameters that define a job.

        • InputSerialization — (map)

          Describes the serialization format of the object.

          • csv — (map)

            Describes the serialization of a CSV-encoded object.

            • FileHeaderInfo — (String)

              Describes the first line of input. Valid values are None, Ignore, and Use.

              Possible values include:
              • "USE"
              • "IGNORE"
              • "NONE"
            • Comments — (String)

              A single character used to indicate that a row should be ignored when the character is present at the start of that row.

            • QuoteEscapeCharacter — (String)

              A single character used for escaping the quotation-mark character inside an already escaped value.

            • RecordDelimiter — (String)

              A value used to separate individual records from each other.

            • FieldDelimiter — (String)

              A value used to separate individual fields from each other within a record.

            • QuoteCharacter — (String)

              A value used as an escape character where the field delimiter is part of the value.

        • ExpressionType — (String)

          The type of the provided expression, for example SQL.

          Possible values include:
          • "SQL"
        • Expression — (String)

          The expression that is used to select the object.

        • OutputSerialization — (map)

          Describes how the results of the select job are serialized.

          • csv — (map)

            Describes the serialization of CSV-encoded query results.

            • QuoteFields — (String)

              A value that indicates whether all output fields should be contained within quotation marks.

              Possible values include:
              • "ALWAYS"
              • "ASNEEDED"
            • QuoteEscapeCharacter — (String)

              A single character used for escaping the quotation-mark character inside an already escaped value.

            • RecordDelimiter — (String)

              A value used to separate individual records from each other.

            • FieldDelimiter — (String)

              A value used to separate individual fields from each other within a record.

            • QuoteCharacter — (String)

              A value used as an escape character where the field delimiter is part of the value.

      • OutputLocation — (map)

        Contains information about the location where the select job results are stored.

        • S3 — (map)

          Describes an S3 location that will receive the results of the job request.

          • BucketName — (String)

            The name of the Amazon S3 bucket where the job results are stored.

          • Prefix — (String)

            The prefix that is prepended to the results for this request.

          • Encryption — (map)

            Contains information about the encryption used to store the job results in Amazon S3.

            • EncryptionType — (String)

              The server-side encryption algorithm used when storing job results in Amazon S3, for example AES256 or aws:kms.

              Possible values include:
              • "aws:kms"
              • "AES256"
            • KMSKeyId — (String)

              The AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS fail if not made by using Secure Sockets Layer (SSL) or Signature Version 4.

            • KMSContext — (String)

              Optional. If the encryption type is aws:kms, you can use this value to specify the encryption context for the job results.

          • CannedACL — (String)

            The canned access control list (ACL) to apply to the job results.

            Possible values include:
            • "private"
            • "public-read"
            • "public-read-write"
            • "aws-exec-read"
            • "authenticated-read"
            • "bucket-owner-read"
            • "bucket-owner-full-control"
          • AccessControlList — (Array<map>)

            A list of grants that control access to the staged results.

            • Grantee — (map)

              The grantee.

              • Type — required — (String)

                Type of grantee

                Possible values include:
                • "AmazonCustomerByEmail"
                • "CanonicalUser"
                • "Group"
              • DisplayName — (String)

                Screen name of the grantee.

              • URI — (String)

                URI of the grantee group.

              • ID — (String)

                The canonical user ID of the grantee.

              • EmailAddress — (String)

                Email address of the grantee.

            • Permission — (String)

              Specifies the permission given to the grantee.

              Possible values include:
              • "FULL_CONTROL"
              • "WRITE"
              • "WRITE_ACP"
              • "READ"
              • "READ_ACP"
          • Tagging — (map<String>)

            The tag-set that is applied to the job results.

          • UserMetadata — (map<String>)

            A map of metadata to store with the job results in Amazon S3.

          • StorageClass — (String)

            The storage class used to store the job results.

            Possible values include:
            • "STANDARD"
            • "REDUCED_REDUNDANCY"
            • "STANDARD_IA"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • location — (String)

        The relative URI path of the job.

      • jobId — (String)

        The ID of the job.

      • jobOutputPath — (String)

        The path to the location of where the select results are stored.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

initiateMultipartUpload(params = {}, callback) ⇒ AWS.Request

This operation initiates a multipart upload. Amazon S3 Glacier creates a multipart upload resource and returns its ID in the response. The multipart upload ID is used in subsequent requests to upload parts of an archive (see UploadMultipartPart).

When you initiate a multipart upload, you specify the part size in number of bytes. The part size must be a megabyte (1024 KB) multiplied by a power of 2-for example, 1048576 (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable part size is 1 MB, and the maximum is 4 GB.

Every part you upload to this resource (see UploadMultipartPart), except the last one, must have the same size. The last one can be the same size or smaller. For example, suppose you want to upload a 16.2 MB file. If you initiate the multipart upload with a part size of 4 MB, you will upload four parts of 4 MB each and one part of 0.2 MB.

Note: You don't need to know the size of the archive when you start a multipart upload because Amazon S3 Glacier does not require you to specify the overall archive size.

After you complete the multipart upload, Amazon S3 Glacier (Glacier) removes the multipart upload resource referenced by the ID. Glacier also removes the multipart upload resource if you cancel the multipart upload or it may be removed if there is no activity for a period of 24 hours.

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 Uploading Large Archives in Parts (Multipart Upload) and Initiate Multipart Upload in the Amazon Glacier Developer Guide.

Service Reference:

Examples:

To initiate a multipart upload


/* The example initiates a multipart upload to a vault named my-vault with a part size of 1 MiB (1024 x 1024 bytes) per file. */

 var params = {
  accountId: "-", 
  partSize: "1048576", 
  vaultName: "my-vault"
 };
 glacier.initiateMultipartUpload(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    location: "/111122223333/vaults/my-vault/multipart-uploads/19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ", 
    uploadId: "19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ"
   }
   */
 });

Calling the initiateMultipartUpload operation

var params = {
  accountId: 'STRING_VALUE', /* required */
  vaultName: 'STRING_VALUE', /* required */
  archiveDescription: 'STRING_VALUE',
  partSize: 'STRING_VALUE'
};
glacier.initiateMultipartUpload(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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.

    • vaultName — (String)

      The name of the vault.

    • archiveDescription — (String)

      The archive description that you are uploading in parts.

      The part size must be a megabyte (1024 KB) multiplied by a power of 2, for example 1048576 (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable part size is 1 MB, and the maximum is 4 GB (4096 MB).

    • partSize — (String)

      The size of each part except the last, in bytes. The last part can be smaller than this part size.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • location — (String)

        The relative URI path of the multipart upload ID Amazon S3 Glacier created.

      • uploadId — (String)

        The ID of the multipart upload. This value is also included as part of the location.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

initiateVaultLock(params = {}, callback) ⇒ AWS.Request

This operation initiates the vault locking process by doing the following:

  • Installing a vault lock policy on the specified vault.

  • Setting the lock state of vault lock to InProgress.

  • Returning a lock ID, which is used to complete the vault locking process.

You can set one vault lock policy for each vault and this policy can be up to 20 KB in size. For more information about vault lock policies, see Amazon Glacier Access Control with Vault Lock Policies.

You must complete the vault locking process within 24 hours after the vault lock enters the InProgress state. After the 24 hour window ends, the lock ID expires, the vault automatically exits the InProgress state, and the vault lock policy is removed from the vault. You call CompleteVaultLock to complete the vault locking process by setting the state of the vault lock to Locked.

After a vault lock is in the Locked state, you cannot initiate a new vault lock for the vault.

You can abort the vault locking process by calling AbortVaultLock. You can get the state of the vault lock by calling GetVaultLock. For more information about the vault locking process, Amazon Glacier Vault Lock.

If this operation is called when the vault lock is in the InProgress state, the operation returns an AccessDeniedException error. When the vault lock is in the InProgress state you must call AbortVaultLock before you can initiate a new vault lock policy.

Service Reference:

Examples:

To initiate the vault locking process


/* The example initiates the vault locking process for the vault named my-vault. */

 var params = {
  accountId: "-", 
  policy: {
   Policy: "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"Define-vault-lock\",\"Effect\":\"Deny\",\"Principal\":{\"AWS\":\"arn:aws:iam::999999999999:root\"},\"Action\":\"glacier:DeleteArchive\",\"Resource\":\"arn:aws:glacier:us-west-2:999999999999:vaults/examplevault\",\"Condition\":{\"NumericLessThanEquals\":{\"glacier:ArchiveAgeinDays\":\"365\"}}}]}"
  }, 
  vaultName: "my-vault"
 };
 glacier.initiateVaultLock(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    lockId: "AE863rKkWZU53SLW5be4DUcW"
   }
   */
 });

Calling the initiateVaultLock operation

var params = {
  accountId: 'STRING_VALUE', /* required */
  vaultName: 'STRING_VALUE', /* required */
  policy: {
    Policy: 'STRING_VALUE'
  }
};
glacier.initiateVaultLock(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • accountId — (String)

      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 — (String)

      The name of the vault.

    • policy — (map)

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

      • Policy — (String)

        The vault lock policy.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • lockId — (String)

        The lock ID, which is used to complete the vault locking process.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listJobs(params = {}, callback) ⇒ AWS.Request

This operation lists jobs for a vault, including jobs that are in-progress and jobs that have recently finished. The List Job operation returns a list of these jobs sorted by job initiation time.

Note: Amazon Glacier retains recently completed jobs for a period before deleting them; however, it eventually removes completed jobs. The output of completed jobs can be retrieved. Retaining completed jobs for a period of time after they have completed enables you to get a job output in the event you miss the job completion notification or your first attempt to download it fails. For example, suppose you start an archive retrieval job to download an archive. After the job completes, you start to download the archive but encounter a network error. In this scenario, you can retry and download the archive while the job exists.

The List Jobs operation supports pagination. You should always check the response Marker field. If there are no more jobs to list, the Marker field is set to null. If there are more jobs to list, the Marker field is set to a non-null value, which you can use to continue the pagination of the list. To return a list of jobs that begins at a specific job, set the marker request parameter to the Marker value for that job that you obtained from a previous List Jobs request.

You can set a maximum limit for the number of jobs returned in the response by specifying the limit parameter in the request. The default limit is 50. The number of jobs returned might be fewer than the limit, but the number of returned jobs never exceeds the limit.

Additionally, you can filter the jobs list returned by specifying the optional statuscode parameter or completed parameter, or both. Using the statuscode parameter, you can specify to return only jobs that match either the InProgress, Succeeded, or Failed status. Using the completed parameter, you can specify to return only jobs that were completed (true) or jobs that were not completed (false).

For more information about using this operation, see the documentation for the underlying REST API List Jobs.

Service Reference:

Examples:

To list jobs for a vault


/* The example lists jobs for the vault named my-vault. */

 var params = {
  accountId: "-", 
  vaultName: "my-vault"
 };
 glacier.listJobs(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    JobList: [
       {
      Action: "ArchiveRetrieval", 
      ArchiveId: "kKB7ymWJVpPSwhGP6ycSOAekp9ZYe_--zM_mw6k76ZFGEIWQX-ybtRDvc2VkPSDtfKmQrj0IRQLSGsNuDp-AJVlu2ccmDSyDUmZwKbwbpAdGATGDiB3hHO0bjbGehXTcApVud_wyDw", 
      ArchiveSHA256TreeHash: "9628195fcdbcbbe76cdde932d4646fa7de5f219fb39823836d81f0cc0e18aa67", 
      ArchiveSizeInBytes: 3145728, 
      Completed: false, 
      CreationDate: "2015-07-17T21:16:13.840Z", 
      JobDescription: "Retrieve archive on 2015-07-17", 
      JobId: "l7IL5-EkXyEY9Ws95fClzIbk2O5uLYaFdAYOi-azsX_Z8V6NH4yERHzars8wTKYQMX6nBDI9cMNHzyZJO59-8N9aHWav", 
      RetrievalByteRange: "0-3145727", 
      SHA256TreeHash: "9628195fcdbcbbe76cdde932d4646fa7de5f219fb39823836d81f0cc0e18aa67", 
      SNSTopic: "arn:aws:sns:us-west-2:0123456789012:my-vault", 
      StatusCode: "InProgress", 
      VaultARN: "arn:aws:glacier:us-west-2:0123456789012:vaults/my-vault"
     }, 
       {
      Action: "InventoryRetrieval", 
      Completed: false, 
      CreationDate: "2015-07-17T20:23:41.616Z", 
      InventoryRetrievalParameters: {
       Format: "JSON"
      }, 
      JobId: "zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4CnMW", 
      StatusCode: "InProgress", 
      VaultARN: "arn:aws:glacier:us-west-2:0123456789012:vaults/my-vault"
     }
    ]
   }
   */
 });

Calling the listJobs operation

var params = {
  accountId: 'STRING_VALUE', /* required */
  vaultName: 'STRING_VALUE', /* required */
  completed: 'STRING_VALUE',
  limit: 'STRING_VALUE',
  marker: 'STRING_VALUE',
  statuscode: 'STRING_VALUE'
};
glacier.listJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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.

    • vaultName — (String)

      The name of the vault.

    • limit — (String)

      The maximum number of jobs to be returned. The default limit is 50. The number of jobs returned might be fewer than the specified limit, but the number of returned jobs never exceeds the limit.

    • marker — (String)

      An opaque string used for pagination. This value specifies the job at which the listing of jobs should begin. Get the marker value from a previous List Jobs response. You only need to include the marker if you are continuing the pagination of results started in a previous List Jobs request.

    • statuscode — (String)

      The type of job status to return. You can specify the following values: InProgress, Succeeded, or Failed.

    • completed — (String)

      The state of the jobs to return. You can specify true or false.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • JobList — (Array<map>)

        A list of job objects. Each job object contains metadata describing the job.

        • JobId — (String)

          An opaque string that identifies an Amazon S3 Glacier job.

        • JobDescription — (String)

          The job description provided when initiating the job.

        • Action — (String)

          The job type. This value is either ArchiveRetrieval, InventoryRetrieval, or Select.

          Possible values include:
          • "ArchiveRetrieval"
          • "InventoryRetrieval"
          • "Select"
        • ArchiveId — (String)

          The archive ID requested for a select job or archive retrieval. Otherwise, this field is null.

        • VaultARN — (String)

          The Amazon Resource Name (ARN) of the vault from which an archive retrieval was requested.

        • CreationDate — (String)

          The UTC date when the job was created. This value is a string representation of ISO 8601 date format, for example "2012-03-20T17:03:43.221Z".

        • Completed — (Boolean)

          The job status. When a job is completed, you get the job's output using Get Job Output (GET output).

        • StatusCode — (String)

          The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.

          Possible values include:
          • "InProgress"
          • "Succeeded"
          • "Failed"
        • StatusMessage — (String)

          A friendly message that describes the job status.

        • ArchiveSizeInBytes — (Integer)

          For an archive retrieval job, this value is the size in bytes of the archive being requested for download. For an inventory retrieval or select job, this value is null.

        • InventorySizeInBytes — (Integer)

          For an inventory retrieval job, this value is the size in bytes of the inventory requested for download. For an archive retrieval or select job, this value is null.

        • SNSTopic — (String)

          An Amazon SNS topic that receives notification.

        • CompletionDate — (String)

          The UTC time that the job request completed. While the job is in progress, the value is null.

        • SHA256TreeHash — (String)

          For an archive retrieval job, this value is the checksum of the archive. Otherwise, this value is null.

          The SHA256 tree hash value for the requested range of an archive. If the InitiateJob request for an archive specified a tree-hash aligned range, then this field returns a value.

          If the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash value.

          This field is null for the following:

          • Archive retrieval jobs that specify a range that is not tree-hash aligned

          • Archival jobs that specify a range that is equal to the whole archive, when the job status is InProgress

          • Inventory jobs

          • Select jobs

        • ArchiveSHA256TreeHash — (String)

          The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval or select jobs, this field is null.

        • RetrievalByteRange — (String)

          The retrieved byte range for archive retrieval jobs in the form StartByteValue-EndByteValue. If no range was specified in the archive retrieval, then the whole archive is retrieved. In this case, StartByteValue equals 0 and EndByteValue equals the size of the archive minus 1. For inventory retrieval or select jobs, this field is null.

        • Tier — (String)

          The tier to use for a select or an archive retrieval. Valid values are Expedited, Standard, or Bulk. Standard is the default.

        • InventoryRetrievalParameters — (map)

          Parameters used for range inventory retrieval.

          • Format — (String)

            The output format for the vault inventory list, which is set by the InitiateJob request when initiating a job to retrieve a vault inventory. Valid values are CSV and JSON.

          • StartDate — (String)

            The start of the date range in Universal Coordinated Time (UTC) for vault inventory retrieval that includes archives created on or after this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z.

          • EndDate — (String)

            The end of the date range in UTC for vault inventory retrieval that includes archives created before this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z.

          • Limit — (String)

            The maximum number of inventory items returned per vault inventory retrieval request. This limit is set when initiating the job with the a InitiateJob request.

          • Marker — (String)

            An opaque string that represents where to continue pagination of the vault inventory retrieval results. You use the marker in a new InitiateJob request to obtain additional inventory items. If there are no more inventory items, this value is null. For more information, see Range Inventory Retrieval.

        • JobOutputPath — (String)

          Contains the job output location.

        • SelectParameters — (map)

          Contains the parameters used for a select.

          • InputSerialization — (map)

            Describes the serialization format of the object.

            • csv — (map)

              Describes the serialization of a CSV-encoded object.

              • FileHeaderInfo — (String)

                Describes the first line of input. Valid values are None, Ignore, and Use.

                Possible values include:
                • "USE"
                • "IGNORE"
                • "NONE"
              • Comments — (String)

                A single character used to indicate that a row should be ignored when the character is present at the start of that row.

              • QuoteEscapeCharacter — (String)

                A single character used for escaping the quotation-mark character inside an already escaped value.

              • RecordDelimiter — (String)

                A value used to separate individual records from each other.

              • FieldDelimiter — (String)

                A value used to separate individual fields from each other within a record.

              • QuoteCharacter — (String)

                A value used as an escape character where the field delimiter is part of the value.

          • ExpressionType — (String)

            The type of the provided expression, for example SQL.

            Possible values include:
            • "SQL"
          • Expression — (String)

            The expression that is used to select the object.

          • OutputSerialization — (map)

            Describes how the results of the select job are serialized.

            • csv — (map)

              Describes the serialization of CSV-encoded query results.

              • QuoteFields — (String)

                A value that indicates whether all output fields should be contained within quotation marks.

                Possible values include:
                • "ALWAYS"
                • "ASNEEDED"
              • QuoteEscapeCharacter — (String)

                A single character used for escaping the quotation-mark character inside an already escaped value.

              • RecordDelimiter — (String)

                A value used to separate individual records from each other.

              • FieldDelimiter — (String)

                A value used to separate individual fields from each other within a record.

              • QuoteCharacter — (String)

                A value used as an escape character where the field delimiter is part of the value.

        • OutputLocation — (map)

          Contains the location where the data from the select job is stored.

          • S3 — (map)

            Describes an S3 location that will receive the results of the job request.

            • BucketName — (String)

              The name of the Amazon S3 bucket where the job results are stored.

            • Prefix — (String)

              The prefix that is prepended to the results for this request.

            • Encryption — (map)

              Contains information about the encryption used to store the job results in Amazon S3.

              • EncryptionType — (String)

                The server-side encryption algorithm used when storing job results in Amazon S3, for example AES256 or aws:kms.

                Possible values include:
                • "aws:kms"
                • "AES256"
              • KMSKeyId — (String)

                The AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS fail if not made by using Secure Sockets Layer (SSL) or Signature Version 4.

              • KMSContext — (String)

                Optional. If the encryption type is aws:kms, you can use this value to specify the encryption context for the job results.

            • CannedACL — (String)

              The canned access control list (ACL) to apply to the job results.

              Possible values include:
              • "private"
              • "public-read"
              • "public-read-write"
              • "aws-exec-read"
              • "authenticated-read"
              • "bucket-owner-read"
              • "bucket-owner-full-control"
            • AccessControlList — (Array<map>)

              A list of grants that control access to the staged results.

              • Grantee — (map)

                The grantee.

                • Type — required — (String)

                  Type of grantee

                  Possible values include:
                  • "AmazonCustomerByEmail"
                  • "CanonicalUser"
                  • "Group"
                • DisplayName — (String)

                  Screen name of the grantee.

                • URI — (String)

                  URI of the grantee group.

                • ID — (String)

                  The canonical user ID of the grantee.

                • EmailAddress — (String)

                  Email address of the grantee.

              • Permission — (String)

                Specifies the permission given to the grantee.

                Possible values include:
                • "FULL_CONTROL"
                • "WRITE"
                • "WRITE_ACP"
                • "READ"
                • "READ_ACP"
            • Tagging — (map<String>)

              The tag-set that is applied to the job results.

            • UserMetadata — (map<String>)

              A map of metadata to store with the job results in Amazon S3.

            • StorageClass — (String)

              The storage class used to store the job results.

              Possible values include:
              • "STANDARD"
              • "REDUCED_REDUNDANCY"
              • "STANDARD_IA"
      • Marker — (String)

        An opaque string used for pagination that specifies the job at which the listing of jobs should begin. You get the marker value from a previous List Jobs response. You only need to include the marker if you are continuing the pagination of the results started in a previous List Jobs request.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listMultipartUploads(params = {}, callback) ⇒ AWS.Request

This operation lists in-progress multipart uploads for the specified vault. An in-progress multipart upload is a multipart upload that has been initiated by an InitiateMultipartUpload request, but has not yet been completed or aborted. The list returned in the List Multipart Upload response has no guaranteed order.

The List Multipart Uploads operation supports pagination. By default, this operation returns up to 50 multipart uploads in the response. You should always check the response for a marker at which to continue the list; if there are no more items the marker is null. To return a list of multipart uploads that begins at a specific upload, set the marker request parameter to the value you obtained from a previous List Multipart Upload request. You can also limit the number of uploads returned in the response by specifying the limit parameter in the request.

Note the difference between this operation and listing parts (ListParts). The List Multipart Uploads operation lists all multipart uploads for a vault and does not require a multipart upload ID. The List Parts operation requires a multipart upload ID since parts are associated with a single upload.

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 the underlying REST API, see Working with Archives in Amazon S3 Glacier and List Multipart Uploads in the Amazon Glacier Developer Guide.

Service Reference:

Examples:

To list all the in-progress multipart uploads for a vault


/* The example lists all the in-progress multipart uploads for the vault named examplevault. */

 var params = {
  accountId: "-", 
  vaultName: "examplevault"
 };
 glacier.listMultipartUploads(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Marker: "null", 
    UploadsList: [
       {
      ArchiveDescription: "archive 1", 
      CreationDate: "2012-03-19T23:20:59.130Z", 
      MultipartUploadId: "xsQdFIRsfJr20CW2AbZBKpRZAFTZSJIMtL2hYf8mvp8dM0m4RUzlaqoEye6g3h3ecqB_zqwB7zLDMeSWhwo65re4C4Ev", 
      PartSizeInBytes: 4194304, 
      VaultARN: "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault"
     }, 
       {
      ArchiveDescription: "archive 2", 
      CreationDate: "2012-04-01T15:00:00.000Z", 
      MultipartUploadId: "nPyGOnyFcx67qqX7E-0tSGiRi88hHMOwOxR-_jNyM6RjVMFfV29lFqZ3rNsSaWBugg6OP92pRtufeHdQH7ClIpSF6uJc", 
      PartSizeInBytes: 4194304, 
      VaultARN: "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault"
     }, 
       {
      ArchiveDescription: "archive 3", 
      CreationDate: "2012-03-20T17:03:43.221Z", 
      MultipartUploadId: "qt-RBst_7yO8gVIonIBsAxr2t-db0pE4s8MNeGjKjGdNpuU-cdSAcqG62guwV9r5jh5mLyFPzFEitTpNE7iQfHiu1XoV", 
      PartSizeInBytes: 4194304, 
      VaultARN: "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault"
     }
    ]
   }
   */
 });

Calling the listMultipartUploads operation

var params = {
  accountId: 'STRING_VALUE', /* required */
  vaultName: 'STRING_VALUE', /* required */
  limit: 'STRING_VALUE',
  marker: 'STRING_VALUE'
};
glacier.listMultipartUploads(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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.

    • vaultName — (String)

      The name of the vault.

    • marker — (String)

      An opaque string used for pagination. This value specifies the upload at which the listing of uploads should begin. Get the marker value from a previous List Uploads response. You need only include the marker if you are continuing the pagination of results started in a previous List Uploads request.

    • limit — (String)

      Specifies the maximum number of uploads returned in the response body. If this value is not specified, the List Uploads operation returns up to 50 uploads.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • UploadsList — (Array<map>)

        A list of in-progress multipart uploads.

        • MultipartUploadId — (String)

          The ID of a multipart upload.

        • VaultARN — (String)

          The Amazon Resource Name (ARN) of the vault that contains the archive.

        • ArchiveDescription — (String)

          The description of the archive that was specified in the Initiate Multipart Upload request.

        • PartSizeInBytes — (Integer)

          The part size, in bytes, specified in the Initiate Multipart Upload request. This is the size of all the parts in the upload except the last part, which may be smaller than this size.

        • CreationDate — (String)

          The UTC time at which the multipart upload was initiated.

      • Marker — (String)

        An opaque string that represents where to continue pagination of the results. You use the marker in a new List Multipart Uploads request to obtain more uploads in the list. If there are no more uploads, this value is null.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listParts(params = {}, callback) ⇒ AWS.Request

This operation lists the parts of an archive that have been uploaded in a specific multipart upload. You can make this request at any time during an in-progress multipart upload before you complete the upload (see CompleteMultipartUpload. List Parts returns an error for completed uploads. The list returned in the List Parts response is sorted by part range.

The List Parts operation supports pagination. By default, this operation returns up to 50 uploaded parts in the response. You should always check the response for a marker at which to continue the list; if there are no more items the marker is null. To return a list of parts that begins at a specific part, set the marker request parameter to the value you obtained from a previous List Parts request. You can also limit the number of parts returned in the response by specifying the limit parameter in the request.

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 the underlying REST API, see Working with Archives in Amazon S3 Glacier and List Parts in the Amazon Glacier Developer Guide.

Service Reference:

Examples:

To list the parts of an archive that have been uploaded in a multipart upload


/* The example lists all the parts of a multipart upload. */

 var params = {
  accountId: "-", 
  uploadId: "OW2fM5iVylEpFEMM9_HpKowRapC3vn5sSL39_396UW9zLFUWVrnRHaPjUJddQ5OxSHVXjYtrN47NBZ-khxOjyEXAMPLE", 
  vaultName: "examplevault"
 };
 glacier.listParts(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ArchiveDescription: "archive description", 
    CreationDate: "2012-03-20T17:03:43.221Z", 
    Marker: "null", 
    MultipartUploadId: "OW2fM5iVylEpFEMM9_HpKowRapC3vn5sSL39_396UW9zLFUWVrnRHaPjUJddQ5OxSHVXjYtrN47NBZ-khxOjyEXAMPLE", 
    PartSizeInBytes: 4194304, 
    Parts: [
       {
      RangeInBytes: "0-4194303", 
      SHA256TreeHash: "01d34dabf7be316472c93b1ef80721f5d4"
     }, 
       {
      RangeInBytes: "4194304-8388607", 
      SHA256TreeHash: "0195875365afda349fc21c84c099987164"
     }
    ], 
    VaultARN: "arn:aws:glacier:us-west-2:012345678901:vaults/demo1-vault"
   }
   */
 });

Calling the listParts operation

var params = {
  accountId: 'STRING_VALUE', /* required */
  uploadId: 'STRING_VALUE', /* required */
  vaultName: 'STRING_VALUE', /* required */
  limit: 'STRING_VALUE',
  marker: 'STRING_VALUE'
};
glacier.listParts(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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.

    • vaultName — (String)

      The name of the vault.

    • uploadId — (String)

      The upload ID of the multipart upload.

    • marker — (String)

      An opaque string used for pagination. This value specifies the part at which the listing of parts should begin. Get the marker value from the response of a previous List Parts response. You need only include the marker if you are continuing the pagination of results started in a previous List Parts request.

    • limit — (String)

      The maximum number of parts to be returned. The default limit is 50. The number of parts returned might be fewer than the specified limit, but the number of returned parts never exceeds the limit.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • MultipartUploadId — (String)

        The ID of the upload to which the parts are associated.

      • VaultARN — (String)

        The Amazon Resource Name (ARN) of the vault to which the multipart upload was initiated.

      • ArchiveDescription — (String)

        The description of the archive that was specified in the Initiate Multipart Upload request.

      • PartSizeInBytes — (Integer)

        The part size in bytes. This is the same value that you specified in the Initiate Multipart Upload request.

      • CreationDate — (String)

        The UTC time at which the multipart upload was initiated.

      • Parts — (Array<map>)

        A list of the part sizes of the multipart upload. Each object in the array contains a RangeBytes and sha256-tree-hash name/value pair.

        • RangeInBytes — (String)

          The byte range of a part, inclusive of the upper value of the range.

        • SHA256TreeHash — (String)

          The SHA256 tree hash value that Amazon S3 Glacier calculated for the part. This field is never null.

      • Marker — (String)

        An opaque string that represents where to continue pagination of the results. You use the marker in a new List Parts request to obtain more jobs in the list. If there are no more parts, this value is null.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listProvisionedCapacity(params = {}, callback) ⇒ AWS.Request

This operation lists the provisioned capacity units for the specified AWS account.

Service Reference:

Examples:

To list the provisioned capacity units for an account


/* The example lists the provisioned capacity units for an account. */

 var params = {
  accountId: "-"
 };
 glacier.listProvisionedCapacity(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ProvisionedCapacityList: [
       {
      CapacityId: "zSaq7NzHFQDANTfQkDen4V7z", 
      ExpirationDate: "2016-12-12T00:00:00.000Z", 
      StartDate: "2016-11-11T20:11:51.095Z"
     }, 
       {
      CapacityId: "yXaq7NzHFQNADTfQkDen4V7z", 
      ExpirationDate: "2017-01-15T00:00:00.000Z", 
      StartDate: "2016-12-13T20:11:51.095Z"
     }
    ]
   }
   */
 });

Calling the listProvisionedCapacity operation

var params = {
  accountId: 'STRING_VALUE' /* required */
};
glacier.listProvisionedCapacity(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • accountId — (String)

      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, don't include any hyphens ('-') in the ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ProvisionedCapacityList — (Array<map>)

        The response body contains the following JSON fields.

        • CapacityId — (String)

          The ID that identifies the provisioned capacity unit.

        • StartDate — (String)

          The date that the provisioned capacity unit was purchased, in Universal Coordinated Time (UTC).

        • ExpirationDate — (String)

          The date that the provisioned capacity unit expires, in Universal Coordinated Time (UTC).

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listTagsForVault(params = {}, callback) ⇒ AWS.Request

This operation lists all the tags attached to a vault. The operation returns an empty map if there are no tags. For more information about tags, see Tagging Amazon S3 Glacier Resources.

Service Reference:

Examples:

To list the tags for a vault


/* The example lists all the tags attached to the vault examplevault. */

 var params = {
  accountId: "-", 
  vaultName: "examplevault"
 };
 glacier.listTagsForVault(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Tags: {
     "date": "july2015", 
     "id": "1234"
    }
   }
   */
 });

Calling the listTagsForVault operation

var params = {
  accountId: 'STRING_VALUE', /* required */
  vaultName: 'STRING_VALUE' /* required */
};
glacier.listTagsForVault(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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.

    • vaultName — (String)

      The name of the vault.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Tags — (map<String>)

        The tags attached to the vault. Each tag is composed of a key and a value.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listVaults(params = {}, callback) ⇒ AWS.Request

This operation lists all vaults owned by the calling user's account. The list returned in the response is ASCII-sorted by vault name.

By default, this operation returns up to 10 items. If there are more vaults to list, the response marker field contains the vault Amazon Resource Name (ARN) at which to continue the list with a new List Vaults request; otherwise, the marker field is null. To return a list of vaults that begins at a specific vault, set the marker request parameter to the vault ARN you obtained from a previous List Vaults request. You can also limit the number of vaults returned in the response by specifying the limit parameter in the request.

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 List Vaults in the Amazon Glacier Developer Guide.

Service Reference:

Examples:

To list all vaults owned by the calling user's account


/* The example lists all vaults owned by the specified AWS account. */

 var params = {
  accountId: "-", 
  limit: "", 
  marker: ""
 };
 glacier.listVaults(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    VaultList: [
       {
      CreationDate: "2015-04-06T21:23:45.708Z", 
      LastInventoryDate: "2015-04-07T00:26:19.028Z", 
      NumberOfArchives: 1, 
      SizeInBytes: 3178496, 
      VaultARN: "arn:aws:glacier:us-west-2:0123456789012:vaults/my-vault", 
      VaultName: "my-vault"
     }
    ]
   }
   */
 });

Calling the listVaults operation

var params = {
  accountId: 'STRING_VALUE', /* required */
  limit: 'STRING_VALUE',
  marker: 'STRING_VALUE'
};
glacier.listVaults(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • accountId — (String)

      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.

    • marker — (String)

      A string used for pagination. The marker specifies the vault ARN after which the listing of vaults should begin.

    • limit — (String)

      The maximum number of vaults to be returned. The default limit is 10. The number of vaults returned might be fewer than the specified limit, but the number of returned vaults never exceeds the limit.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • VaultList — (Array<map>)

        List of vaults.

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

      • Marker — (String)

        The vault ARN at which to continue pagination of the results. You use the marker in another List Vaults request to obtain more vaults in the list.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

purchaseProvisionedCapacity(params = {}, callback) ⇒ AWS.Request

This operation purchases a provisioned capacity unit for an AWS account.

Service Reference:

Examples:

To purchases a provisioned capacity unit for an AWS account


/* The example purchases provisioned capacity unit for an AWS account. */

 var params = {
  accountId: "-"
 };
 glacier.purchaseProvisionedCapacity(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    capacityId: "zSaq7NzHFQDANTfQkDen4V7z"
   }
   */
 });

Calling the purchaseProvisionedCapacity operation

var params = {
  accountId: 'STRING_VALUE' /* required */
};
glacier.purchaseProvisionedCapacity(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • accountId — (String)

      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, don't include any hyphens ('-') in the ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • capacityId — (String)

        The ID that identifies the provisioned capacity unit.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

removeTagsFromVault(params = {}, callback) ⇒ AWS.Request

This operation removes one or more tags from the set of tags attached to a vault. For more information about tags, see Tagging Amazon S3 Glacier Resources. This operation is idempotent. The operation will be successful, even if there are no tags attached to the vault.

Service Reference:

Examples:

To remove tags from a vault


/* The example removes two tags from the vault named examplevault. */

 var params = {
  TagKeys: [
     "examplekey1", 
     "examplekey2"
  ], 
  accountId: "-", 
  vaultName: "examplevault"
 };
 glacier.removeTagsFromVault(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the removeTagsFromVault operation

var params = {
  accountId: 'STRING_VALUE', /* required */
  vaultName: 'STRING_VALUE', /* required */
  TagKeys: [
    'STRING_VALUE',
    /* more items */
  ]
};
glacier.removeTagsFromVault(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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.

    • vaultName — (String)

      The name of the vault.

    • TagKeys — (Array<String>)

      A list of tag keys. Each corresponding tag is removed from the vault.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

setDataRetrievalPolicy(params = {}, callback) ⇒ AWS.Request

This operation sets and then enacts a data retrieval policy in the region specified in the PUT request. You can set one policy per region for an AWS account. The policy is enacted within a few minutes of a successful PUT operation.

The set policy operation does not affect retrieval jobs that were in progress before the policy was enacted. For more information about data retrieval policies, see Amazon Glacier Data Retrieval Policies.

Service Reference:

Examples:

To set and then enact a data retrieval policy


/* The example sets and then enacts a data retrieval policy. */

 var params = {
  Policy: {
   Rules: [
      {
     BytesPerHour: 10737418240, 
     Strategy: "BytesPerHour"
    }
   ]
  }, 
  accountId: "-"
 };
 glacier.setDataRetrievalPolicy(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the setDataRetrievalPolicy operation

var params = {
  accountId: 'STRING_VALUE', /* required */
  Policy: {
    Rules: [
      {
        BytesPerHour: 'NUMBER_VALUE',
        Strategy: 'STRING_VALUE'
      },
      /* more items */
    ]
  }
};
glacier.setDataRetrievalPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • accountId — (String)

      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.

    • Policy — (map)

      The data retrieval policy in JSON format.

      • Rules — (Array<map>)

        The policy rule. Although this is a list type, currently there must be only one rule, which contains a Strategy field and optionally a BytesPerHour field.

        • Strategy — (String)

          The type of data retrieval policy to set.

          Valid values: BytesPerHour|FreeTier|None

        • BytesPerHour — (Integer)

          The maximum number of bytes that can be retrieved in an hour.

          This field is required only if the value of the Strategy field is BytesPerHour. Your PUT operation will be rejected if the Strategy field is not set to BytesPerHour and you set this field.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

setVaultAccessPolicy(params = {}, callback) ⇒ AWS.Request

This operation configures an access policy for a vault and will overwrite an existing policy. To configure a vault access policy, send a PUT request to the access-policy subresource of the vault. An access policy is specific to a vault and is also called a vault subresource. You can set one access policy per vault and the policy can be up to 20 KB in size. For more information about vault access policies, see Amazon Glacier Access Control with Vault Access Policies.

Service Reference:

Examples:

To set the access-policy on a vault


/* The example configures an access policy for the vault named examplevault. */

 var params = {
  accountId: "-", 
  policy: {
   Policy: "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"Define-owner-access-rights\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::999999999999:root\"},\"Action\":\"glacier:DeleteArchive\",\"Resource\":\"arn:aws:glacier:us-west-2:999999999999:vaults/examplevault\"}]}"
  }, 
  vaultName: "examplevault"
 };
 glacier.setVaultAccessPolicy(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the setVaultAccessPolicy operation

var params = {
  accountId: 'STRING_VALUE', /* required */
  vaultName: 'STRING_VALUE', /* required */
  policy: {
    Policy: 'STRING_VALUE'
  }
};
glacier.setVaultAccessPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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.

    • vaultName — (String)

      The name of the vault.

    • policy — (map)

      The vault access policy as a JSON string.

      • Policy — (String)

        The vault access policy.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

setVaultNotifications(params = {}, callback) ⇒ AWS.Request

This operation configures notifications that will be sent when specific events happen to a vault. By default, you don't get any notifications.

To configure vault notifications, send a PUT request to the notification-configuration subresource of the vault. The request should include a JSON document that provides an Amazon SNS topic and specific events for which you want Amazon S3 Glacier to send notifications to the topic.

Amazon SNS topics must grant permission to the vault to be allowed to publish notifications to the topic. You can configure a vault to publish a notification for the following vault events:

  • ArchiveRetrievalCompleted This event occurs when a job that was initiated for an archive retrieval is completed (InitiateJob). The status of the completed job can be "Succeeded" or "Failed". The notification sent to the SNS topic is the same output as returned from DescribeJob.

  • InventoryRetrievalCompleted This event occurs when a job that was initiated for an inventory retrieval is completed (InitiateJob). The status of the completed job can be "Succeeded" or "Failed". The notification sent to the SNS topic is the same output as returned from DescribeJob.

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 Configuring Vault Notifications in Amazon S3 Glacier and Set Vault Notification Configuration in the Amazon Glacier Developer Guide.

Service Reference:

Examples:

To configure a vault to post a message to an Amazon SNS topic when jobs complete


/* The example sets the examplevault notification configuration. */

 var params = {
  accountId: "-", 
  vaultName: "examplevault", 
  vaultNotificationConfig: {
   Events: [
      "ArchiveRetrievalCompleted", 
      "InventoryRetrievalCompleted"
   ], 
   SNSTopic: "arn:aws:sns:us-west-2:012345678901:mytopic"
  }
 };
 glacier.setVaultNotifications(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the setVaultNotifications operation

var params = {
  accountId: 'STRING_VALUE', /* required */
  vaultName: 'STRING_VALUE', /* required */
  vaultNotificationConfig: {
    Events: [
      'STRING_VALUE',
      /* more items */
    ],
    SNSTopic: 'STRING_VALUE'
  }
};
glacier.setVaultNotifications(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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.

    • vaultName — (String)

      The name of the vault.

    • vaultNotificationConfig — (map)

      Provides options for specifying notification configuration.

      • SNSTopic — (String)

        The Amazon Simple Notification Service (Amazon SNS) topic Amazon Resource Name (ARN).

      • Events — (Array<String>)

        A list of one or more events for which Amazon S3 Glacier will send a notification to the specified Amazon SNS topic.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

uploadArchive(params = {}, callback) ⇒ AWS.Request

This operation adds an archive to a vault. This is a synchronous operation, and for a successful upload, your data is durably persisted. Amazon S3 Glacier returns the archive ID in the x-amz-archive-id header of the response.

You must use the archive ID to access your data in Amazon S3 Glacier. After you upload an archive, you should save the archive ID returned so that you can retrieve or delete the archive later. Besides saving the archive ID, you can also index it and give it a friendly name to allow for better searching. You can also use the optional archive description field to specify how the archive is referred to in an external index of archives, such as you might create in Amazon DynamoDB. You can also get the vault inventory to obtain a list of archive IDs in a vault. For more information, see InitiateJob.

You must provide a SHA256 tree hash of the data you are uploading. For information about computing a SHA256 tree hash, see Computing Checksums.

You can optionally specify an archive description of up to 1,024 printable ASCII characters. You can get the archive description when you either retrieve the archive or get the vault inventory. For more information, see InitiateJob. Amazon Glacier does not interpret the description in any way. An archive description does not need to be unique. You cannot use the description to retrieve or sort the archive list.

Archives are immutable. After you upload an archive, you cannot edit the archive or its description.

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 Uploading an Archive in Amazon Glacier and Upload Archive in the Amazon Glacier Developer Guide.

Service Reference:

Examples:

To upload an archive


/* The example adds an archive to a vault. */

 var params = {
  accountId: "-", 
  archiveDescription: "", 
  body: <Binary String>, 
  checksum: "", 
  vaultName: "my-vault"
 };
 glacier.uploadArchive(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    archiveId: "kKB7ymWJVpPSwhGP6ycSOAekp9ZYe_--zM_mw6k76ZFGEIWQX-ybtRDvc2VkPSDtfKmQrj0IRQLSGsNuDp-AJVlu2ccmDSyDUmZwKbwbpAdGATGDiB3hHO0bjbGehXTcApVud_wyDw", 
    checksum: "969fb39823836d81f0cc028195fcdbcbbe76cdde932d4646fa7de5f21e18aa67", 
    location: "/0123456789012/vaults/my-vault/archives/kKB7ymWJVpPSwhGP6ycSOAekp9ZYe_--zM_mw6k76ZFGEIWQX-ybtRDvc2VkPSDtfKmQrj0IRQLSGsNuDp-AJVlu2ccmDSyDUmZwKbwbpAdGATGDiB3hHO0bjbGehXTcApVud_wyDw"
   }
   */
 });

Calling the uploadArchive operation

var params = {
  accountId: 'STRING_VALUE', /* required */
  vaultName: 'STRING_VALUE', /* required */
  archiveDescription: 'STRING_VALUE',
  body: Buffer.from('...') || 'STRING_VALUE' || streamObject,
  checksum: 'STRING_VALUE'
};
glacier.uploadArchive(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • vaultName — (String)

      The name of the vault.

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

    • archiveDescription — (String)

      The optional description of the archive you are uploading.

    • checksum — (String)

      The SHA256 tree hash of the data being uploaded.

    • body — (Buffer, Typed Array, Blob, String, ReadableStream)

      The data to upload.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • location — (String)

        The relative URI path of the newly added archive resource.

      • checksum — (String)

        The checksum of the archive computed by Amazon S3 Glacier.

      • archiveId — (String)

        The ID of the archive. This value is also included as part of the location.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

uploadMultipartPart(params = {}, callback) ⇒ AWS.Request

This operation uploads a part of an archive. You can upload archive parts in any order. You can also upload them in parallel. You can upload up to 10,000 parts for a multipart upload.

Amazon Glacier rejects your upload part request if any of the following conditions is true:

  • SHA256 tree hash does not matchTo ensure that part data is not corrupted in transmission, you compute a SHA256 tree hash of the part and include it in your request. Upon receiving the part data, Amazon S3 Glacier also computes a SHA256 tree hash. If these hash values don't match, the operation fails. For information about computing a SHA256 tree hash, see Computing Checksums.

  • Part size does not matchThe size of each part except the last must match the size specified in the corresponding InitiateMultipartUpload request. The size of the last part must be the same size as, or smaller than, the specified size.

    Note: If you upload a part whose size is smaller than the part size you specified in your initiate multipart upload request and that part is not the last part, then the upload part request will succeed. However, the subsequent Complete Multipart Upload request will fail.

  • Range does not alignThe byte range value in the request does not align with the part size specified in the corresponding initiate request. For example, if you specify a part size of 4194304 bytes (4 MB), then 0 to 4194303 bytes (4 MB - 1) and 4194304 (4 MB) to 8388607 (8 MB - 1) are valid part ranges. However, if you set a range value of 2 MB to 6 MB, the range does not align with the part size and the upload will fail.

This operation is idempotent. If you upload the same part multiple times, the data included in the most recent request overwrites the previously uploaded data.

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 Uploading Large Archives in Parts (Multipart Upload) and Upload Part in the Amazon Glacier Developer Guide.

Service Reference:

Examples:

To upload the first part of an archive


/* The example uploads the first 1 MiB (1024 x 1024 bytes) part of an archive. */

 var params = {
  accountId: "-", 
  body: <Binary String>, 
  checksum: "c06f7cd4baacb087002a99a5f48bf953", 
  range: "bytes 0-1048575/*", 
  uploadId: "19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ", 
  vaultName: "examplevault"
 };
 glacier.uploadMultipartPart(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    checksum: "c06f7cd4baacb087002a99a5f48bf953"
   }
   */
 });

Calling the uploadMultipartPart operation

var params = {
  accountId: 'STRING_VALUE', /* required */
  uploadId: 'STRING_VALUE', /* required */
  vaultName: 'STRING_VALUE', /* required */
  body: Buffer.from('...') || 'STRING_VALUE' || streamObject,
  checksum: 'STRING_VALUE',
  range: 'STRING_VALUE'
};
glacier.uploadMultipartPart(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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.

    • vaultName — (String)

      The name of the vault.

    • uploadId — (String)

      The upload ID of the multipart upload.

    • checksum — (String)

      The SHA256 tree hash of the data being uploaded.

    • range — (String)

      Identifies the range of bytes in the assembled archive that will be uploaded in this part. Amazon S3 Glacier uses this information to assemble the archive in the proper sequence. The format of this header follows RFC 2616. An example header is Content-Range:bytes 0-4194303/*.

    • body — (Buffer, Typed Array, Blob, String, ReadableStream)

      The data to upload.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • checksum — (String)

        The SHA256 tree hash that Amazon S3 Glacier computed for the uploaded part.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

waitFor(state, params = {}, callback) ⇒ AWS.Request

Waits for a given Glacier resource. The final callback or 'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.

Examples:

Waiting for the vaultExists state

var params = {
  accountId: 'STRING_VALUE', /* required */
  vaultName: 'STRING_VALUE' /* required */
};
glacier.waitFor('vaultExists', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • state (String) —

    the resource state to wait for. Available states for this service are listed in "Waiter Resource States" below.

  • params (map) (defaults to: {}) —

    a list of parameters for the given state. See each waiter resource state for required parameters.

Callback (callback):

  • function(err, data) { ... }

    Callback containing error and data information. See the respective resource state for the expected error or data information.

    If the waiter times out its requests, it will return a ResourceNotReady error.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

Waiter Resource Details

glacier.waitFor('vaultExists', params = {}, [callback]) ⇒ AWS.Request

Waits for the vaultExists state by periodically calling the underlying Glacier.describeVault() operation every 3 seconds (at most 15 times).

Examples:

Waiting for the vaultExists state

var params = {
  accountId: 'STRING_VALUE', /* required */
  vaultName: 'STRING_VALUE' /* required */
};
glacier.waitFor('vaultExists', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) —
    • 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.

    • vaultName — (String)

      The name of the vault.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

See Also:

glacier.waitFor('vaultNotExists', params = {}, [callback]) ⇒ AWS.Request

Waits for the vaultNotExists state by periodically calling the underlying Glacier.describeVault() operation every 3 seconds (at most 15 times).

Examples:

Waiting for the vaultNotExists state

var params = {
  accountId: 'STRING_VALUE', /* required */
  vaultName: 'STRING_VALUE' /* required */
};
glacier.waitFor('vaultNotExists', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) —
    • 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.

    • vaultName — (String)

      The name of the vault.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

See Also: