Class: AWS.Glacier

/* 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
 });

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.

/* 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
 });

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.

/* 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"
   }
   */
 });

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.

/* 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
 });

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.

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:

• completeMultipartUpload()

/* 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"
   }
   */
 });

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.

/* 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
 });

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.

/* 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
 });

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.

/* 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
 });

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.

/* 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
 });

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.

/* 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"
   }
   */
 });

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.

/* 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"
   }
   */
 });

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:

• vaultExists

• vaultNotExists

/* 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"
      }
     ]
    }
   }
   */
 });

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.

/* 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
   }
   */
 });

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.

/* 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\"}]}"
    }
   }
   */
 });

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.

/* 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"
   }
   */
 });

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.

/* 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"
    }
   }
   */
 });

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.

/* 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"
   }
   */
 });

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.

/* 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"
   }
   */
 });

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.

/* 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"
   }
   */
 });

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.

/* 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"
     }
    ]
   }
   */
 });

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.

/* 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"
     }
    ]
   }
   */
 });

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.

/* 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"
   }
   */
 });

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.

/* 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"
     }
    ]
   }
   */
 });

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.

/* 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"
    }
   }
   */
 });

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.

/* 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"
     }
    ]
   }
   */
 });

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.

/* 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"
   }
   */
 });

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.

/* 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
 });

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.

/* 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
 });

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.

/* 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
 });

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.

/* 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
 });

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.

/* 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"
   }
   */
 });

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.

/* 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"
   }
   */
 });

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.

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:

• vaultExists

• vaultNotExists