@aws-sdk/client-glacier 3.288.0 → 3.289.0

package/dist-types/commands/AbortMultipartUploadCommand.d.ts

@@ -46,6 +46,19 @@ export interface AbortMultipartUploadCommandOutput extends __MetadataBearer {
  * @see {@link AbortMultipartUploadCommandOutput} for command's `response` shape.
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
  *
+ * @example To abort a multipart upload identified by the upload ID
+ * ```javascript
+ * // The example deletes an in-progress multipart upload to a vault named my-vault:
+ * const input = {
+ *   "accountId": "-",
+ *   "uploadId": "19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ",
+ *   "vaultName": "my-vault"
+ * };
+ * const command = new AbortMultipartUploadCommand(input);
+ * await client.send(command);
+ * // example id: f3d907f6-e71c-420c-8f71-502346a2c48a
+ * ```
+ *
  */
 export declare class AbortMultipartUploadCommand extends $Command<AbortMultipartUploadCommandInput, AbortMultipartUploadCommandOutput, GlacierClientResolvedConfig> {
     readonly input: AbortMultipartUploadCommandInput;

package/dist-types/commands/AbortVaultLockCommand.d.ts

@@ -42,6 +42,18 @@ export interface AbortVaultLockCommandOutput extends __MetadataBearer {
  * @see {@link AbortVaultLockCommandOutput} for command's `response` shape.
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
  *
+ * @example To abort a vault lock
+ * ```javascript
+ * // The example aborts the vault locking process if the vault lock is not in the Locked state for the vault named examplevault.
+ * const input = {
+ *   "accountId": "-",
+ *   "vaultName": "examplevault"
+ * };
+ * const command = new AbortVaultLockCommand(input);
+ * await client.send(command);
+ * // example id: to-abort-a-vault-lock-1481839357947
+ * ```
+ *
  */
 export declare class AbortVaultLockCommand extends $Command<AbortVaultLockCommandInput, AbortVaultLockCommandOutput, GlacierClientResolvedConfig> {
     readonly input: AbortVaultLockCommandInput;

package/dist-types/commands/AddTagsToVaultCommand.d.ts

@@ -34,6 +34,22 @@ export interface AddTagsToVaultCommandOutput extends __MetadataBearer {
  * @see {@link AddTagsToVaultCommandOutput} for command's `response` shape.
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
  *
+ * @example To add tags to a vault
+ * ```javascript
+ * // The example adds two tags to a my-vault.
+ * const input = {
+ *   "Tags": {
+ *     "examplekey1": "examplevalue1",
+ *     "examplekey2": "examplevalue2"
+ *   },
+ *   "accountId": "-",
+ *   "vaultName": "my-vault"
+ * };
+ * const command = new AddTagsToVaultCommand(input);
+ * await client.send(command);
+ * // example id: add-tags-to-vault-post-tags-add-1481663457694
+ * ```
+ *
  */
 export declare class AddTagsToVaultCommand extends $Command<AddTagsToVaultCommandInput, AddTagsToVaultCommandOutput, GlacierClientResolvedConfig> {
     readonly input: AddTagsToVaultCommandInput;

package/dist-types/commands/CompleteMultipartUploadCommand.d.ts

@@ -66,6 +66,28 @@ export interface CompleteMultipartUploadCommandOutput extends ArchiveCreationOut
  * @see {@link CompleteMultipartUploadCommandOutput} for command's `response` shape.
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
  *
+ * @example To complete a multipart upload
+ * ```javascript
+ * // The example completes a multipart upload for a 3 MiB archive.
+ * const input = {
+ *   "accountId": "-",
+ *   "archiveSize": "3145728",
+ *   "checksum": "9628195fcdbcbbe76cdde456d4646fa7de5f219fb39823836d81f0cc0e18aa67",
+ *   "uploadId": "19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ",
+ *   "vaultName": "my-vault"
+ * };
+ * const command = new CompleteMultipartUploadCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "archiveId": "NkbByEejwEggmBz2fTHgJrg0XBoDfjP4q6iu87-TjhqG6eGoOY9Z8i1_AUyUsuhPAdTqLHy8pTl5nfCFJmDl2yEZONi5L26Omw12vcs01MNGntHEQL8MBfGlqrEXAMPLEArchiveId",
+ *   "checksum": "9628195fcdbcbbe76cdde456d4646fa7de5f219fb39823836d81f0cc0e18aa67",
+ *   "location": "/111122223333/vaults/my-vault/archives/NkbByEejwEggmBz2fTHgJrg0XBoDfjP4q6iu87-TjhqG6eGoOY9Z8i1_AUyUsuhPAdTqLHy8pTl5nfCFJmDl2yEZONi5L26Omw12vcs01MNGntHEQL8MBfGlqrEXAMPLEArchiveId"
+ * }
+ * *\/
+ * // example id: 272aa0b8-e44c-4a64-add2-ad905a37984d
+ * ```
+ *
  */
 export declare class CompleteMultipartUploadCommand extends $Command<CompleteMultipartUploadCommandInput, CompleteMultipartUploadCommandOutput, GlacierClientResolvedConfig> {
     readonly input: CompleteMultipartUploadCommandInput;

package/dist-types/commands/CompleteVaultLockCommand.d.ts

@@ -42,6 +42,19 @@ export interface CompleteVaultLockCommandOutput extends __MetadataBearer {
  * @see {@link CompleteVaultLockCommandOutput} for command's `response` shape.
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
  *
+ * @example To complete a vault lock
+ * ```javascript
+ * // The example completes the vault locking process by transitioning the vault lock from the InProgress state to the Locked state.
+ * const input = {
+ *   "accountId": "-",
+ *   "lockId": "AE863rKkWZU53SLW5be4DUcW",
+ *   "vaultName": "example-vault"
+ * };
+ * const command = new CompleteVaultLockCommand(input);
+ * await client.send(command);
+ * // example id: to-complete-a-vault-lock-1481839721312
+ * ```
+ *
  */
 export declare class CompleteVaultLockCommand extends $Command<CompleteVaultLockCommandInput, CompleteVaultLockCommandOutput, GlacierClientResolvedConfig> {
     readonly input: CompleteVaultLockCommandInput;

package/dist-types/commands/CreateVaultCommand.d.ts

@@ -52,6 +52,23 @@ export interface CreateVaultCommandOutput extends CreateVaultOutput, __MetadataB
  * @see {@link CreateVaultCommandOutput} for command's `response` shape.
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
  *
+ * @example To create a new vault
+ * ```javascript
+ * // The following example creates a new vault named my-vault.
+ * const input = {
+ *   "accountId": "-",
+ *   "vaultName": "my-vault"
+ * };
+ * const command = new CreateVaultCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "location": "/111122223333/vaults/my-vault"
+ * }
+ * *\/
+ * // example id: 1dc0313d-ace1-4e6c-9d13-1ec7813b14b7
+ * ```
+ *
  */
 export declare class CreateVaultCommand extends $Command<CreateVaultCommandInput, CreateVaultCommandOutput, GlacierClientResolvedConfig> {
     readonly input: CreateVaultCommandInput;

package/dist-types/commands/DeleteArchiveCommand.d.ts

@@ -55,6 +55,19 @@ export interface DeleteArchiveCommandOutput extends __MetadataBearer {
  * @see {@link DeleteArchiveCommandOutput} for command's `response` shape.
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
  *
+ * @example To delete an archive
+ * ```javascript
+ * // The example deletes the archive specified by the archive ID.
+ * const input = {
+ *   "accountId": "-",
+ *   "archiveId": "NkbByEejwEggmBz2fTHgJrg0XBoDfjP4q6iu87-TjhqG6eGoOY9Z8i1_AUyUsuhPAdTqLHy8pTl5nfCFJmDl2yEZONi5L26Omw12vcs01MNGntHEQL8MBfGlqrEXAMPLEArchiveId",
+ *   "vaultName": "examplevault"
+ * };
+ * const command = new DeleteArchiveCommand(input);
+ * await client.send(command);
+ * // example id: delete-archive-1481667809463
+ * ```
+ *
  */
 export declare class DeleteArchiveCommand extends $Command<DeleteArchiveCommandInput, DeleteArchiveCommandOutput, GlacierClientResolvedConfig> {
     readonly input: DeleteArchiveCommandInput;

package/dist-types/commands/DeleteVaultAccessPolicyCommand.d.ts

@@ -35,6 +35,18 @@ export interface DeleteVaultAccessPolicyCommandOutput extends __MetadataBearer {
  * @see {@link DeleteVaultAccessPolicyCommandOutput} for command's `response` shape.
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
  *
+ * @example To delete the vault access policy
+ * ```javascript
+ * // The example deletes the access policy associated with the vault named examplevault.
+ * const input = {
+ *   "accountId": "-",
+ *   "vaultName": "examplevault"
+ * };
+ * const command = new DeleteVaultAccessPolicyCommand(input);
+ * await client.send(command);
+ * // example id: to-delete-the-vault-access-policy-1481840424677
+ * ```
+ *
  */
 export declare class DeleteVaultAccessPolicyCommand extends $Command<DeleteVaultAccessPolicyCommandInput, DeleteVaultAccessPolicyCommandOutput, GlacierClientResolvedConfig> {
     readonly input: DeleteVaultAccessPolicyCommandInput;

package/dist-types/commands/DeleteVaultCommand.d.ts

@@ -48,6 +48,18 @@ export interface DeleteVaultCommandOutput extends __MetadataBearer {
  * @see {@link DeleteVaultCommandOutput} for command's `response` shape.
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
  *
+ * @example To delete a vault
+ * ```javascript
+ * // The example deletes a vault named my-vault:
+ * const input = {
+ *   "accountId": "-",
+ *   "vaultName": "my-vault"
+ * };
+ * const command = new DeleteVaultCommand(input);
+ * await client.send(command);
+ * // example id: 7f7f000b-4bdb-40d2-91e6-7c902f60f60f
+ * ```
+ *
  */
 export declare class DeleteVaultCommand extends $Command<DeleteVaultCommandInput, DeleteVaultCommandOutput, GlacierClientResolvedConfig> {
     readonly input: DeleteVaultCommandInput;

package/dist-types/commands/DeleteVaultNotificationsCommand.d.ts

@@ -41,6 +41,18 @@ export interface DeleteVaultNotificationsCommandOutput extends __MetadataBearer
  * @see {@link DeleteVaultNotificationsCommandOutput} for command's `response` shape.
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
  *
+ * @example To delete the notification configuration set for a vault
+ * ```javascript
+ * // The example deletes the notification configuration set for the vault named examplevault.
+ * const input = {
+ *   "accountId": "-",
+ *   "vaultName": "examplevault"
+ * };
+ * const command = new DeleteVaultNotificationsCommand(input);
+ * await client.send(command);
+ * // example id: to-delete-the-notification-configuration-set-for-a-vault-1481840646090
+ * ```
+ *
  */
 export declare class DeleteVaultNotificationsCommand extends $Command<DeleteVaultNotificationsCommandInput, DeleteVaultNotificationsCommandOutput, GlacierClientResolvedConfig> {
     readonly input: DeleteVaultNotificationsCommandInput;

package/dist-types/commands/DescribeJobCommand.d.ts

@@ -52,6 +52,32 @@ export interface DescribeJobCommandOutput extends GlacierJobDescription, __Metad
  * @see {@link DescribeJobCommandOutput} for command's `response` shape.
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
  *
+ * @example To get information about a previously initiated job
+ * ```javascript
+ * // The example returns information about the previously initiated job specified by the job ID.
+ * const input = {
+ *   "accountId": "-",
+ *   "jobId": "zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4Cn",
+ *   "vaultName": "my-vault"
+ * };
+ * const command = new DescribeJobCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "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"
+ * }
+ * *\/
+ * // example id: to-get-information-about-a-job-you-previously-initiated-1481840928592
+ * ```
+ *
  */
 export declare class DescribeJobCommand extends $Command<DescribeJobCommandInput, DescribeJobCommandOutput, GlacierClientResolvedConfig> {
     readonly input: DescribeJobCommandInput;

package/dist-types/commands/DescribeVaultCommand.d.ts

@@ -46,6 +46,27 @@ export interface DescribeVaultCommandOutput extends DescribeVaultOutput, __Metad
  * @see {@link DescribeVaultCommandOutput} for command's `response` shape.
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
  *
+ * @example To retrieve information about a vault
+ * ```javascript
+ * // The example retrieves data about a vault named my-vault.
+ * const input = {
+ *   "accountId": "-",
+ *   "vaultName": "my-vault"
+ * };
+ * const command = new DescribeVaultCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "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"
+ * }
+ * *\/
+ * // example id: 3c1c6e9d-f5a2-427a-aa6a-f439eacfc05f
+ * ```
+ *
  */
 export declare class DescribeVaultCommand extends $Command<DescribeVaultCommandInput, DescribeVaultCommandOutput, GlacierClientResolvedConfig> {
     readonly input: DescribeVaultCommandInput;

package/dist-types/commands/GetDataRetrievalPolicyCommand.d.ts

@@ -31,6 +31,29 @@ export interface GetDataRetrievalPolicyCommandOutput extends GetDataRetrievalPol
  * @see {@link GetDataRetrievalPolicyCommandOutput} for command's `response` shape.
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
  *
+ * @example To get the current data retrieval policy for an account
+ * ```javascript
+ * // The example returns the current data retrieval policy for the account.
+ * const input = {
+ *   "accountId": "-"
+ * };
+ * const command = new GetDataRetrievalPolicyCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Policy": {
+ *     "Rules": [
+ *       {
+ *         "BytesPerHour": 10737418240,
+ *         "Strategy": "BytesPerHour"
+ *       }
+ *     ]
+ *   }
+ * }
+ * *\/
+ * // example id: to-get-the-current-data-retrieval-policy-for-the-account-1481851580439
+ * ```
+ *
  */
 export declare class GetDataRetrievalPolicyCommand extends $Command<GetDataRetrievalPolicyCommandInput, GetDataRetrievalPolicyCommandOutput, GlacierClientResolvedConfig> {
     readonly input: GetDataRetrievalPolicyCommandInput;

package/dist-types/commands/GetJobOutputCommand.d.ts

@@ -65,6 +65,28 @@ export interface GetJobOutputCommandOutput extends __WithSdkStreamMixin<GetJobOu
  * @see {@link GetJobOutputCommandOutput} for command's `response` shape.
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
  *
+ * @example To get the output of a previously initiated job
+ * ```javascript
+ * // The example downloads the output of a previously initiated inventory retrieval job that is identified by the job ID.
+ * const input = {
+ *   "accountId": "-",
+ *   "jobId": "zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4CnMW",
+ *   "range": "",
+ *   "vaultName": "my-vaul"
+ * };
+ * const command = new GetJobOutputCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "acceptRanges": "bytes",
+ *   "body": "inventory-data",
+ *   "contentType": "application/json",
+ *   "status": 200
+ * }
+ * *\/
+ * // example id: to-get-the-output-of-a-previously-initiated-job-1481848550859
+ * ```
+ *
  */
 export declare class GetJobOutputCommand extends $Command<GetJobOutputCommandInput, GetJobOutputCommandOutput, GlacierClientResolvedConfig> {
     readonly input: GetJobOutputCommandInput;

package/dist-types/commands/GetVaultAccessPolicyCommand.d.ts

@@ -34,6 +34,25 @@ export interface GetVaultAccessPolicyCommandOutput extends GetVaultAccessPolicyO
  * @see {@link GetVaultAccessPolicyCommandOutput} for command's `response` shape.
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
  *
+ * @example To  get the access-policy set on the vault
+ * ```javascript
+ * // The example retrieves the access-policy set on the vault named example-vault.
+ * const input = {
+ *   "accountId": "-",
+ *   "vaultName": "example-vault"
+ * };
+ * const command = new GetVaultAccessPolicyCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "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\"}]}"
+ *   }
+ * }
+ * *\/
+ * // example id: to--get-the-access-policy-set-on-the-vault-1481936004590
+ * ```
+ *
  */
 export declare class GetVaultAccessPolicyCommand extends $Command<GetVaultAccessPolicyCommandInput, GetVaultAccessPolicyCommandOutput, GlacierClientResolvedConfig> {
     readonly input: GetVaultAccessPolicyCommandInput;

package/dist-types/commands/GetVaultLockCommand.d.ts

@@ -56,6 +56,26 @@ export interface GetVaultLockCommandOutput extends GetVaultLockOutput, __Metadat
  * @see {@link GetVaultLockCommandOutput} for command's `response` shape.
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
  *
+ * @example To retrieve vault lock-policy related attributes that are set on a vault
+ * ```javascript
+ * // The example retrieves the attributes from the lock-policy subresource set on the vault named examplevault.
+ * const input = {
+ *   "accountId": "-",
+ *   "vaultName": "examplevault"
+ * };
+ * const command = new GetVaultLockCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "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"
+ * }
+ * *\/
+ * // example id: to-retrieve-vault-lock-policy-related-attributes-that-are-set-on-a-vault-1481851363097
+ * ```
+ *
  */
 export declare class GetVaultLockCommand extends $Command<GetVaultLockCommandInput, GetVaultLockCommandOutput, GlacierClientResolvedConfig> {
     readonly input: GetVaultLockCommandInput;

package/dist-types/commands/GetVaultNotificationsCommand.d.ts

@@ -44,6 +44,29 @@ export interface GetVaultNotificationsCommandOutput extends GetVaultNotification
  * @see {@link GetVaultNotificationsCommandOutput} for command's `response` shape.
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
  *
+ * @example To get the notification-configuration for the specified vault
+ * ```javascript
+ * // The example retrieves the notification-configuration for the vault named my-vault.
+ * const input = {
+ *   "accountId": "-",
+ *   "vaultName": "my-vault"
+ * };
+ * const command = new GetVaultNotificationsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "vaultNotificationConfig": {
+ *     "Events": [
+ *       "InventoryRetrievalCompleted",
+ *       "ArchiveRetrievalCompleted"
+ *     ],
+ *     "SNSTopic": "arn:aws:sns:us-west-2:0123456789012:my-vault"
+ *   }
+ * }
+ * *\/
+ * // example id: to-get-the-notification-configuration-for-the-specified-vault-1481918746677
+ * ```
+ *
  */
 export declare class GetVaultNotificationsCommand extends $Command<GetVaultNotificationsCommandInput, GetVaultNotificationsCommandOutput, GlacierClientResolvedConfig> {
     readonly input: GetVaultNotificationsCommandInput;

package/dist-types/commands/InitiateJobCommand.d.ts

@@ -33,6 +33,30 @@ export interface InitiateJobCommandOutput extends InitiateJobOutput, __MetadataB
  * @see {@link InitiateJobCommandOutput} for command's `response` shape.
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
  *
+ * @example To initiate an inventory-retrieval job
+ * ```javascript
+ * // The example initiates an inventory-retrieval job for the vault named examplevault.
+ * const input = {
+ *   "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"
+ * };
+ * const command = new InitiateJobCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "jobId": " HkF9p6o7yjhFx-K3CGl6fuSm6VzW9T7esGQfco8nUXVYwS0jlb5gq1JZ55yHgt5vP54ZShjoQzQVVh7vEXAMPLEjobID",
+ *   "location": "/111122223333/vaults/examplevault/jobs/HkF9p6o7yjhFx-K3CGl6fuSm6VzW9T7esGQfco8nUXVYwS0jlb5gq1JZ55yHgt5vP54ZShjoQzQVVh7vEXAMPLEjobID"
+ * }
+ * *\/
+ * // example id: to-initiate-an-inventory-retrieval-job-1482186883826
+ * ```
+ *
  */
 export declare class InitiateJobCommand extends $Command<InitiateJobCommandInput, InitiateJobCommandOutput, GlacierClientResolvedConfig> {
     readonly input: InitiateJobCommandInput;

package/dist-types/commands/InitiateMultipartUploadCommand.d.ts

@@ -62,6 +62,25 @@ export interface InitiateMultipartUploadCommandOutput extends InitiateMultipartU
  * @see {@link InitiateMultipartUploadCommandOutput} for command's `response` shape.
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
  *
+ * @example To initiate a multipart upload
+ * ```javascript
+ * // 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.
+ * const input = {
+ *   "accountId": "-",
+ *   "partSize": "1048576",
+ *   "vaultName": "my-vault"
+ * };
+ * const command = new InitiateMultipartUploadCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "location": "/111122223333/vaults/my-vault/multipart-uploads/19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ",
+ *   "uploadId": "19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ"
+ * }
+ * *\/
+ * // example id: 72f2db19-3d93-4c74-b2ed-38703baacf49
+ * ```
+ *
  */
 export declare class InitiateMultipartUploadCommand extends $Command<InitiateMultipartUploadCommandInput, InitiateMultipartUploadCommandOutput, GlacierClientResolvedConfig> {
     readonly input: InitiateMultipartUploadCommandInput;

package/dist-types/commands/InitiateVaultLockCommand.d.ts

@@ -63,6 +63,26 @@ export interface InitiateVaultLockCommandOutput extends InitiateVaultLockOutput,
  * @see {@link InitiateVaultLockCommandOutput} for command's `response` shape.
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
  *
+ * @example To initiate the vault locking process
+ * ```javascript
+ * // The example initiates the vault locking process for the vault named my-vault.
+ * const input = {
+ *   "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"
+ * };
+ * const command = new InitiateVaultLockCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "lockId": "AE863rKkWZU53SLW5be4DUcW"
+ * }
+ * *\/
+ * // example id: to-initiate-the-vault-locking-process-1481919693394
+ * ```
+ *
  */
 export declare class InitiateVaultLockCommand extends $Command<InitiateVaultLockCommandInput, InitiateVaultLockCommandOutput, GlacierClientResolvedConfig> {
     readonly input: InitiateVaultLockCommandInput;

package/dist-types/commands/ListJobsCommand.d.ts

@@ -64,6 +64,50 @@ export interface ListJobsCommandOutput extends ListJobsOutput, __MetadataBearer
  * @see {@link ListJobsCommandOutput} for command's `response` shape.
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
  *
+ * @example To list jobs for a vault
+ * ```javascript
+ * // The example lists jobs for the vault named my-vault.
+ * const input = {
+ *   "accountId": "-",
+ *   "vaultName": "my-vault"
+ * };
+ * const command = new ListJobsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "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"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-list-jobs-for-a-vault-1481920530537
+ * ```
+ *
  */
 export declare class ListJobsCommand extends $Command<ListJobsCommandInput, ListJobsCommandOutput, GlacierClientResolvedConfig> {
     readonly input: ListJobsCommandInput;

package/dist-types/commands/ListMultipartUploadsCommand.d.ts

@@ -54,6 +54,46 @@ export interface ListMultipartUploadsCommandOutput extends ListMultipartUploadsO
  * @see {@link ListMultipartUploadsCommandOutput} for command's `response` shape.
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
  *
+ * @example To list all the in-progress multipart uploads for a vault
+ * ```javascript
+ * // The example lists all the in-progress multipart uploads for the vault named examplevault.
+ * const input = {
+ *   "accountId": "-",
+ *   "vaultName": "examplevault"
+ * };
+ * const command = new ListMultipartUploadsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "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"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-list-all-the-in-progress-multipart-uploads-for-a-vault-1481935250590
+ * ```
+ *
  */
 export declare class ListMultipartUploadsCommand extends $Command<ListMultipartUploadsCommandInput, ListMultipartUploadsCommandOutput, GlacierClientResolvedConfig> {
     readonly input: ListMultipartUploadsCommandInput;

package/dist-types/commands/ListPartsCommand.d.ts

@@ -50,6 +50,39 @@ export interface ListPartsCommandOutput extends ListPartsOutput, __MetadataBeare
  * @see {@link ListPartsCommandOutput} for command's `response` shape.
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
  *
+ * @example To list the parts of an archive that have been uploaded in a multipart upload
+ * ```javascript
+ * // The example lists all the parts of a multipart upload.
+ * const input = {
+ *   "accountId": "-",
+ *   "uploadId": "OW2fM5iVylEpFEMM9_HpKowRapC3vn5sSL39_396UW9zLFUWVrnRHaPjUJddQ5OxSHVXjYtrN47NBZ-khxOjyEXAMPLE",
+ *   "vaultName": "examplevault"
+ * };
+ * const command = new ListPartsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "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"
+ * }
+ * *\/
+ * // example id: to-list-the-parts-of-an-archive-that-have-been-uploaded-in-a-multipart-upload-1481921767590
+ * ```
+ *
  */
 export declare class ListPartsCommand extends $Command<ListPartsCommandInput, ListPartsCommandOutput, GlacierClientResolvedConfig> {
     readonly input: ListPartsCommandInput;

package/dist-types/commands/ListProvisionedCapacityCommand.d.ts

@@ -30,6 +30,33 @@ export interface ListProvisionedCapacityCommandOutput extends ListProvisionedCap
  * @see {@link ListProvisionedCapacityCommandOutput} for command's `response` shape.
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
  *
+ * @example To list the provisioned capacity units for an account
+ * ```javascript
+ * // The example lists the provisioned capacity units for an account.
+ * const input = {
+ *   "accountId": "-"
+ * };
+ * const command = new ListProvisionedCapacityCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "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"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-list-the-provisioned-capacity-units-for-an-account-1481923656130
+ * ```
+ *
  */
 export declare class ListProvisionedCapacityCommand extends $Command<ListProvisionedCapacityCommandInput, ListProvisionedCapacityCommandOutput, GlacierClientResolvedConfig> {
     readonly input: ListProvisionedCapacityCommandInput;

package/dist-types/commands/ListTagsForVaultCommand.d.ts

@@ -31,6 +31,26 @@ export interface ListTagsForVaultCommandOutput extends ListTagsForVaultOutput, _
  * @see {@link ListTagsForVaultCommandOutput} for command's `response` shape.
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
  *
+ * @example To list the tags for a vault
+ * ```javascript
+ * // The example lists all the tags attached to the vault examplevault.
+ * const input = {
+ *   "accountId": "-",
+ *   "vaultName": "examplevault"
+ * };
+ * const command = new ListTagsForVaultCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Tags": {
+ *     "date": "july2015",
+ *     "id": "1234"
+ *   }
+ * }
+ * *\/
+ * // example id: list-tags-for-vault-1481755839720
+ * ```
+ *
  */
 export declare class ListTagsForVaultCommand extends $Command<ListTagsForVaultCommandInput, ListTagsForVaultCommandOutput, GlacierClientResolvedConfig> {
     readonly input: ListTagsForVaultCommandInput;

package/dist-types/commands/ListVaultsCommand.d.ts

@@ -47,6 +47,33 @@ export interface ListVaultsCommandOutput extends ListVaultsOutput, __MetadataBea
  * @see {@link ListVaultsCommandOutput} for command's `response` shape.
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
  *
+ * @example To list all vaults owned by the calling user's account
+ * ```javascript
+ * // The example lists all vaults owned by the specified AWS account.
+ * const input = {
+ *   "accountId": "-",
+ *   "limit": "",
+ *   "marker": ""
+ * };
+ * const command = new ListVaultsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "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"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: list-vaults-1481753006990
+ * ```
+ *
  */
 export declare class ListVaultsCommand extends $Command<ListVaultsCommandInput, ListVaultsCommandOutput, GlacierClientResolvedConfig> {
     readonly input: ListVaultsCommandInput;

package/dist-types/commands/PurchaseProvisionedCapacityCommand.d.ts

@@ -29,6 +29,22 @@ export interface PurchaseProvisionedCapacityCommandOutput extends PurchaseProvis
  * @see {@link PurchaseProvisionedCapacityCommandOutput} for command's `response` shape.
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
  *
+ * @example To purchases a provisioned capacity unit for an AWS account
+ * ```javascript
+ * // The example purchases provisioned capacity unit for an AWS account.
+ * const input = {
+ *   "accountId": "-"
+ * };
+ * const command = new PurchaseProvisionedCapacityCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "capacityId": "zSaq7NzHFQDANTfQkDen4V7z"
+ * }
+ * *\/
+ * // example id: to-purchases-a-provisioned-capacity-unit-for-an-aws-account-1481927446662
+ * ```
+ *
  */
 export declare class PurchaseProvisionedCapacityCommand extends $Command<PurchaseProvisionedCapacityCommandInput, PurchaseProvisionedCapacityCommandOutput, GlacierClientResolvedConfig> {
     readonly input: PurchaseProvisionedCapacityCommandInput;

package/dist-types/commands/RemoveTagsFromVaultCommand.d.ts

@@ -32,6 +32,22 @@ export interface RemoveTagsFromVaultCommandOutput extends __MetadataBearer {
  * @see {@link RemoveTagsFromVaultCommandOutput} for command's `response` shape.
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
  *
+ * @example To remove tags from a vault
+ * ```javascript
+ * // The example removes two tags from the vault named examplevault.
+ * const input = {
+ *   "TagKeys": [
+ *     "examplekey1",
+ *     "examplekey2"
+ *   ],
+ *   "accountId": "-",
+ *   "vaultName": "examplevault"
+ * };
+ * const command = new RemoveTagsFromVaultCommand(input);
+ * await client.send(command);
+ * // example id: remove-tags-from-vault-1481754998801
+ * ```
+ *
  */
 export declare class RemoveTagsFromVaultCommand extends $Command<RemoveTagsFromVaultCommandInput, RemoveTagsFromVaultCommandOutput, GlacierClientResolvedConfig> {
     readonly input: RemoveTagsFromVaultCommandInput;

package/dist-types/commands/SetDataRetrievalPolicyCommand.d.ts

@@ -34,6 +34,25 @@ export interface SetDataRetrievalPolicyCommandOutput extends __MetadataBearer {
  * @see {@link SetDataRetrievalPolicyCommandOutput} for command's `response` shape.
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
  *
+ * @example To set and then enact a data retrieval policy
+ * ```javascript
+ * // The example sets and then enacts a data retrieval policy.
+ * const input = {
+ *   "Policy": {
+ *     "Rules": [
+ *       {
+ *         "BytesPerHour": 10737418240,
+ *         "Strategy": "BytesPerHour"
+ *       }
+ *     ]
+ *   },
+ *   "accountId": "-"
+ * };
+ * const command = new SetDataRetrievalPolicyCommand(input);
+ * await client.send(command);
+ * // example id: to-set-and-then-enact-a-data-retrieval-policy--1481928352408
+ * ```
+ *
  */
 export declare class SetDataRetrievalPolicyCommand extends $Command<SetDataRetrievalPolicyCommandInput, SetDataRetrievalPolicyCommandOutput, GlacierClientResolvedConfig> {
     readonly input: SetDataRetrievalPolicyCommandInput;

package/dist-types/commands/SetVaultAccessPolicyCommand.d.ts

@@ -34,6 +34,21 @@ export interface SetVaultAccessPolicyCommandOutput extends __MetadataBearer {
  * @see {@link SetVaultAccessPolicyCommandOutput} for command's `response` shape.
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
  *
+ * @example To set the access-policy on a vault
+ * ```javascript
+ * // The example configures an access policy for the vault named examplevault.
+ * const input = {
+ *   "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"
+ * };
+ * const command = new SetVaultAccessPolicyCommand(input);
+ * await client.send(command);
+ * // example id: to--set-the-access-policy-on-a-vault-1482185872517
+ * ```
+ *
  */
 export declare class SetVaultAccessPolicyCommand extends $Command<SetVaultAccessPolicyCommandInput, SetVaultAccessPolicyCommandOutput, GlacierClientResolvedConfig> {
     readonly input: SetVaultAccessPolicyCommandInput;

package/dist-types/commands/SetVaultNotificationsCommand.d.ts

@@ -66,6 +66,25 @@ export interface SetVaultNotificationsCommandOutput extends __MetadataBearer {
  * @see {@link SetVaultNotificationsCommandOutput} for command's `response` shape.
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
  *
+ * @example To configure a vault to post a message to an Amazon SNS topic when jobs complete
+ * ```javascript
+ * // The example sets the examplevault notification configuration.
+ * const input = {
+ *   "accountId": "-",
+ *   "vaultName": "examplevault",
+ *   "vaultNotificationConfig": {
+ *     "Events": [
+ *       "ArchiveRetrievalCompleted",
+ *       "InventoryRetrievalCompleted"
+ *     ],
+ *     "SNSTopic": "arn:aws:sns:us-west-2:012345678901:mytopic"
+ *   }
+ * };
+ * const command = new SetVaultNotificationsCommand(input);
+ * await client.send(command);
+ * // example id: to-configure-a-vault-to-post-a-message-to-an-amazon-simple-notification-service-amazon-sns-topic-when-jobs-complete-1482186397475
+ * ```
+ *
  */
 export declare class SetVaultNotificationsCommand extends $Command<SetVaultNotificationsCommandInput, SetVaultNotificationsCommandOutput, GlacierClientResolvedConfig> {
     readonly input: SetVaultNotificationsCommandInput;

package/dist-types/commands/UploadArchiveCommand.d.ts

@@ -70,6 +70,28 @@ export interface UploadArchiveCommandOutput extends ArchiveCreationOutput, __Met
  * @see {@link UploadArchiveCommandOutput} for command's `response` shape.
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
  *
+ * @example To upload an archive
+ * ```javascript
+ * // The example adds an archive to a vault.
+ * const input = {
+ *   "accountId": "-",
+ *   "archiveDescription": "",
+ *   "body": "example-data-to-upload",
+ *   "checksum": "",
+ *   "vaultName": "my-vault"
+ * };
+ * const command = new UploadArchiveCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "archiveId": "kKB7ymWJVpPSwhGP6ycSOAekp9ZYe_--zM_mw6k76ZFGEIWQX-ybtRDvc2VkPSDtfKmQrj0IRQLSGsNuDp-AJVlu2ccmDSyDUmZwKbwbpAdGATGDiB3hHO0bjbGehXTcApVud_wyDw",
+ *   "checksum": "969fb39823836d81f0cc028195fcdbcbbe76cdde932d4646fa7de5f21e18aa67",
+ *   "location": "/0123456789012/vaults/my-vault/archives/kKB7ymWJVpPSwhGP6ycSOAekp9ZYe_--zM_mw6k76ZFGEIWQX-ybtRDvc2VkPSDtfKmQrj0IRQLSGsNuDp-AJVlu2ccmDSyDUmZwKbwbpAdGATGDiB3hHO0bjbGehXTcApVud_wyDw"
+ * }
+ * *\/
+ * // example id: upload-archive-1481668510494
+ * ```
+ *
  */
 export declare class UploadArchiveCommand extends $Command<UploadArchiveCommandInput, UploadArchiveCommandOutput, GlacierClientResolvedConfig> {
     readonly input: UploadArchiveCommandInput;

package/dist-types/commands/UploadMultipartPartCommand.d.ts

@@ -89,6 +89,27 @@ export interface UploadMultipartPartCommandOutput extends UploadMultipartPartOut
  * @see {@link UploadMultipartPartCommandOutput} for command's `response` shape.
  * @see {@link GlacierClientResolvedConfig | config} for GlacierClient's `config` shape.
  *
+ * @example To upload the first part of an archive
+ * ```javascript
+ * // The example uploads the first 1 MiB (1024 x 1024 bytes) part of an archive.
+ * const input = {
+ *   "accountId": "-",
+ *   "body": "part1",
+ *   "checksum": "c06f7cd4baacb087002a99a5f48bf953",
+ *   "range": "bytes 0-1048575/*",
+ *   "uploadId": "19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ",
+ *   "vaultName": "examplevault"
+ * };
+ * const command = new UploadMultipartPartCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "checksum": "c06f7cd4baacb087002a99a5f48bf953"
+ * }
+ * *\/
+ * // example id: to-upload-the-first-part-of-an-archive-1481835899519
+ * ```
+ *
  */
 export declare class UploadMultipartPartCommand extends $Command<UploadMultipartPartCommandInput, UploadMultipartPartCommandOutput, GlacierClientResolvedConfig> {
     readonly input: UploadMultipartPartCommandInput;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-glacier",
   "description": "AWS SDK for JavaScript Glacier Client for Node.js, Browser and React Native",
-  "version": "3.288.0",
+  "version": "3.289.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,44 +20,44 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/body-checksum-browser": "3.282.0",
-    "@aws-sdk/body-checksum-node": "3.282.0",
-    "@aws-sdk/client-sts": "3.288.0",
-    "@aws-sdk/config-resolver": "3.287.0",
-    "@aws-sdk/credential-provider-node": "3.288.0",
-    "@aws-sdk/fetch-http-handler": "3.282.0",
-    "@aws-sdk/hash-node": "3.272.0",
-    "@aws-sdk/invalid-dependency": "3.272.0",
-    "@aws-sdk/middleware-content-length": "3.282.0",
-    "@aws-sdk/middleware-endpoint": "3.282.0",
-    "@aws-sdk/middleware-host-header": "3.282.0",
-    "@aws-sdk/middleware-logger": "3.288.0",
-    "@aws-sdk/middleware-recursion-detection": "3.282.0",
-    "@aws-sdk/middleware-retry": "3.287.0",
-    "@aws-sdk/middleware-sdk-glacier": "3.282.0",
-    "@aws-sdk/middleware-serde": "3.272.0",
-    "@aws-sdk/middleware-signing": "3.282.0",
-    "@aws-sdk/middleware-stack": "3.272.0",
-    "@aws-sdk/middleware-user-agent": "3.282.0",
-    "@aws-sdk/node-config-provider": "3.287.0",
-    "@aws-sdk/node-http-handler": "3.282.0",
-    "@aws-sdk/protocol-http": "3.282.0",
-    "@aws-sdk/smithy-client": "3.279.0",
-    "@aws-sdk/types": "3.272.0",
-    "@aws-sdk/url-parser": "3.272.0",
+    "@aws-sdk/body-checksum-browser": "3.289.0",
+    "@aws-sdk/body-checksum-node": "3.289.0",
+    "@aws-sdk/client-sts": "3.289.0",
+    "@aws-sdk/config-resolver": "3.289.0",
+    "@aws-sdk/credential-provider-node": "3.289.0",
+    "@aws-sdk/fetch-http-handler": "3.289.0",
+    "@aws-sdk/hash-node": "3.289.0",
+    "@aws-sdk/invalid-dependency": "3.289.0",
+    "@aws-sdk/middleware-content-length": "3.289.0",
+    "@aws-sdk/middleware-endpoint": "3.289.0",
+    "@aws-sdk/middleware-host-header": "3.289.0",
+    "@aws-sdk/middleware-logger": "3.289.0",
+    "@aws-sdk/middleware-recursion-detection": "3.289.0",
+    "@aws-sdk/middleware-retry": "3.289.0",
+    "@aws-sdk/middleware-sdk-glacier": "3.289.0",
+    "@aws-sdk/middleware-serde": "3.289.0",
+    "@aws-sdk/middleware-signing": "3.289.0",
+    "@aws-sdk/middleware-stack": "3.289.0",
+    "@aws-sdk/middleware-user-agent": "3.289.0",
+    "@aws-sdk/node-config-provider": "3.289.0",
+    "@aws-sdk/node-http-handler": "3.289.0",
+    "@aws-sdk/protocol-http": "3.289.0",
+    "@aws-sdk/smithy-client": "3.289.0",
+    "@aws-sdk/types": "3.289.0",
+    "@aws-sdk/url-parser": "3.289.0",
     "@aws-sdk/util-base64": "3.208.0",
     "@aws-sdk/util-body-length-browser": "3.188.0",
     "@aws-sdk/util-body-length-node": "3.208.0",
-    "@aws-sdk/util-defaults-mode-browser": "3.279.0",
-    "@aws-sdk/util-defaults-mode-node": "3.287.0",
-    "@aws-sdk/util-endpoints": "3.272.0",
-    "@aws-sdk/util-retry": "3.272.0",
-    "@aws-sdk/util-stream-browser": "3.282.0",
-    "@aws-sdk/util-stream-node": "3.282.0",
-    "@aws-sdk/util-user-agent-browser": "3.282.0",
-    "@aws-sdk/util-user-agent-node": "3.287.0",
+    "@aws-sdk/util-defaults-mode-browser": "3.289.0",
+    "@aws-sdk/util-defaults-mode-node": "3.289.0",
+    "@aws-sdk/util-endpoints": "3.289.0",
+    "@aws-sdk/util-retry": "3.289.0",
+    "@aws-sdk/util-stream-browser": "3.289.0",
+    "@aws-sdk/util-stream-node": "3.289.0",
+    "@aws-sdk/util-user-agent-browser": "3.289.0",
+    "@aws-sdk/util-user-agent-node": "3.289.0",
     "@aws-sdk/util-utf8": "3.254.0",
-    "@aws-sdk/util-waiter": "3.272.0",
+    "@aws-sdk/util-waiter": "3.289.0",
     "tslib": "^2.3.1"
   },
   "devDependencies": {