@aws-sdk/client-glacier 3.315.0 → 3.319.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/dist-cjs/Glacier.js +37 -462
  2. package/dist-es/Glacier.js +37 -462
  3. package/dist-types/Glacier.d.ts +78 -709
  4. package/dist-types/ts3.4/Glacier.d.ts +2 -1
  5. package/package.json +8 -8
package/dist-types/Glacier.d.ts CHANGED
@@ -33,877 +33,246 @@ import { SetVaultNotificationsCommandInput, SetVaultNotificationsCommandOutput }
33
33
  import { UploadArchiveCommandInput, UploadArchiveCommandOutput } from "./commands/UploadArchiveCommand";
34
34
  import { UploadMultipartPartCommandInput, UploadMultipartPartCommandOutput } from "./commands/UploadMultipartPartCommand";
35
35
  import { GlacierClient } from "./GlacierClient";
36
- /**
37
- * @public
38
- * <p> Amazon S3 Glacier (Glacier) is a storage solution for "cold data."</p>
39
- *
40
- * <p>Glacier is an extremely low-cost storage service that provides secure,
41
- * durable, and easy-to-use storage for data backup and archival. With Glacier,
42
- * customers can store their data cost effectively for months, years, or decades.
43
- * Glacier also enables customers to offload the administrative burdens of operating and
44
- * scaling storage to AWS, so they don't have to worry about capacity planning, hardware
45
- * provisioning, data replication, hardware failure and recovery, or time-consuming hardware
46
- * migrations.</p>
47
- *
48
- * <p>Glacier is a great storage choice when low storage cost is paramount and your
49
- * data is rarely retrieved. If your
50
- * application requires fast or frequent access to your data, consider using Amazon S3. For
51
- * more information, see <a href="http://aws.amazon.com/s3/">Amazon Simple Storage Service
52
- * (Amazon S3)</a>.</p>
53
- *
54
- * <p>You can store any kind of data in any format. There is no maximum limit on the total
55
- * amount of data you can store in Glacier.</p>
56
- *
57
- * <p>If you are a first-time user of Glacier, we recommend that you begin by
58
- * reading the following sections in the <i>Amazon S3 Glacier Developer
59
- * Guide</i>:</p>
60
- * <ul>
61
- * <li>
62
- * <p>
63
- * <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/introduction.html">What is
64
- * Amazon S3 Glacier</a> - This section of the Developer Guide describes the
65
- * underlying data model, the operations it supports, and the AWS SDKs that you can use
66
- * to interact with the service.</p>
67
- * </li>
68
- * <li>
69
- * <p>
70
- * <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/amazon-glacier-getting-started.html">Getting Started
71
- * with Amazon S3 Glacier</a> - The Getting Started section walks you through the
72
- * process of creating a vault, uploading archives, creating jobs to download archives,
73
- * retrieving the job output, and deleting archives.</p>
74
- * </li>
75
- * </ul>
76
- */
77
- export declare class Glacier extends GlacierClient {
78
- /**
79
- * @public
80
- * <p>This operation aborts a multipart upload identified by the upload ID.</p>
81
- *
82
- *
83
- * <p>After the Abort Multipart Upload request succeeds, you cannot upload any more parts
84
- * to the multipart upload or complete the multipart upload. Aborting a completed upload
85
- * fails. However, aborting an already-aborted upload will succeed, for a short time. For more
86
- * information about uploading a part and completing a multipart upload, see <a>UploadMultipartPart</a> and <a>CompleteMultipartUpload</a>.</p>
87
- *
88
- * <p>This operation is idempotent.</p>
89
- *
90
- * <p>An AWS account has full permission to perform all operations (actions). However, AWS
91
- * Identity and Access Management (IAM) users don't have any permissions by default. You must
92
- * grant them explicit permission to perform specific actions. For more information, see
93
- * <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using
94
- * AWS Identity and Access Management (IAM)</a>.</p>
95
- * <p> For conceptual information and underlying REST API, see <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html">Working with Archives in
96
- * Amazon S3 Glacier</a> and <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-abort-upload.html">Abort Multipart
97
- * Upload</a> in the <i>Amazon Glacier Developer Guide</i>. </p>
36
+ export interface Glacier {
37
+ /**
38
+ * @see {@link AbortMultipartUploadCommand}
98
39
  */
99
40
  abortMultipartUpload(args: AbortMultipartUploadCommandInput, options?: __HttpHandlerOptions): Promise<AbortMultipartUploadCommandOutput>;
100
41
  abortMultipartUpload(args: AbortMultipartUploadCommandInput, cb: (err: any, data?: AbortMultipartUploadCommandOutput) => void): void;
101
42
  abortMultipartUpload(args: AbortMultipartUploadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AbortMultipartUploadCommandOutput) => void): void;
102
43
  /**
103
- * @public
104
- * <p>This operation aborts the vault locking process if the vault lock is not in the
105
- * <code>Locked</code> state. If the vault lock is in the <code>Locked</code> state when
106
- * this operation is requested, the operation returns an <code>AccessDeniedException</code>
107
- * error. Aborting the vault locking process removes the vault lock policy from the specified
108
- * vault. </p>
109
- * <p>A vault lock is put into the <code>InProgress</code> state by calling <a>InitiateVaultLock</a>. A vault lock is put into the <code>Locked</code> state by
110
- * calling <a>CompleteVaultLock</a>. You can get the state of a vault lock by
111
- * calling <a>GetVaultLock</a>. For more information about the vault locking
112
- * process, see <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-lock.html">Amazon Glacier Vault Lock</a>. For more information about vault lock policies, see
113
- * <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-lock-policy.html">Amazon
114
- * Glacier Access Control with Vault Lock Policies</a>. </p>
115
- * <p>This operation is idempotent. You can successfully invoke this operation multiple
116
- * times, if the vault lock is in the <code>InProgress</code> state or if there is no policy
117
- * associated with the vault.</p>
44
+ * @see {@link AbortVaultLockCommand}
118
45
  */
119
46
  abortVaultLock(args: AbortVaultLockCommandInput, options?: __HttpHandlerOptions): Promise<AbortVaultLockCommandOutput>;
120
47
  abortVaultLock(args: AbortVaultLockCommandInput, cb: (err: any, data?: AbortVaultLockCommandOutput) => void): void;
121
48
  abortVaultLock(args: AbortVaultLockCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AbortVaultLockCommandOutput) => void): void;
122
49
  /**
123
- * @public
124
- * <p>This operation adds the specified tags to a vault. Each tag is composed of a key and
125
- * a value. Each vault can have up to 10 tags. If your request would cause the tag limit for
126
- * the vault to be exceeded, the operation throws the <code>LimitExceededException</code>
127
- * error. If a tag already exists on the vault under a specified key, the existing key value
128
- * will be overwritten. For more information about tags, see <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/tagging.html">Tagging Amazon S3 Glacier Resources</a>.
129
- * </p>
50
+ * @see {@link AddTagsToVaultCommand}
130
51
  */
131
52
  addTagsToVault(args: AddTagsToVaultCommandInput, options?: __HttpHandlerOptions): Promise<AddTagsToVaultCommandOutput>;
132
53
  addTagsToVault(args: AddTagsToVaultCommandInput, cb: (err: any, data?: AddTagsToVaultCommandOutput) => void): void;
133
54
  addTagsToVault(args: AddTagsToVaultCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddTagsToVaultCommandOutput) => void): void;
134
55
  /**
135
- * @public
136
- * <p>You call this operation to inform Amazon S3 Glacier (Glacier) that all the archive parts have been
137
- * uploaded and that Glacier can now assemble the archive from the uploaded parts.
138
- * After assembling and saving the archive to the vault, Glacier returns the URI path
139
- * of the newly created archive resource. Using the URI path, you can then access the archive.
140
- * After you upload an archive, you should save the archive ID returned to retrieve the
141
- * archive at a later point. You can also get the vault inventory to obtain a list of archive
142
- * IDs in a vault. For more information, see <a>InitiateJob</a>.</p>
143
- *
144
- * <p>In the request, you must include the computed SHA256 tree hash of the entire archive
145
- * you have uploaded. For information about computing a SHA256 tree hash, see <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/checksum-calculations.html">Computing
146
- * Checksums</a>. On the server side, Glacier also constructs the SHA256 tree
147
- * hash of the assembled archive. If the values match, Glacier saves the archive to the
148
- * vault; otherwise, it returns an error, and the operation fails. The <a>ListParts</a> operation returns a list of parts uploaded for a specific
149
- * multipart upload. It includes checksum information for each uploaded part that can be used
150
- * to debug a bad checksum issue.</p>
151
- *
152
- * <p>Additionally, Glacier also checks for any missing content ranges when
153
- * assembling the archive, if missing content ranges are found, Glacier returns an
154
- * error and the operation fails.</p>
155
- *
156
- * <p>Complete Multipart Upload is an idempotent operation. After your first successful
157
- * complete multipart upload, if you call the operation again within a short period, the
158
- * operation will succeed and return the same archive ID. This is useful in the event you
159
- * experience a network issue that causes an aborted connection or receive a 500 server error,
160
- * in which case you can repeat your Complete Multipart Upload request and get the same
161
- * archive ID without creating duplicate archives. Note, however, that after the multipart
162
- * upload completes, you cannot call the List Parts operation and the multipart upload will
163
- * not appear in List Multipart Uploads response, even if idempotent complete is
164
- * possible.</p>
165
- *
166
- * <p>An AWS account has full permission to perform all operations (actions). However, AWS
167
- * Identity and Access Management (IAM) users don't have any permissions by default. You must
168
- * grant them explicit permission to perform specific actions. For more information, see
169
- * <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using
170
- * AWS Identity and Access Management (IAM)</a>.</p>
171
- * <p> For conceptual information and underlying REST API, see <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/uploading-archive-mpu.html">Uploading Large Archives in
172
- * Parts (Multipart Upload)</a> and <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-complete-upload.html">Complete Multipart
173
- * Upload</a> in the <i>Amazon Glacier Developer Guide</i>. </p>
56
+ * @see {@link CompleteMultipartUploadCommand}
174
57
  */
175
58
  completeMultipartUpload(args: CompleteMultipartUploadCommandInput, options?: __HttpHandlerOptions): Promise<CompleteMultipartUploadCommandOutput>;
176
59
  completeMultipartUpload(args: CompleteMultipartUploadCommandInput, cb: (err: any, data?: CompleteMultipartUploadCommandOutput) => void): void;
177
60
  completeMultipartUpload(args: CompleteMultipartUploadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CompleteMultipartUploadCommandOutput) => void): void;
178
61
  /**
179
- * @public
180
- * <p>This operation completes the vault locking process by transitioning the vault lock
181
- * from the <code>InProgress</code> state to the <code>Locked</code> state, which causes the
182
- * vault lock policy to become unchangeable. A vault lock is put into the
183
- * <code>InProgress</code> state by calling <a>InitiateVaultLock</a>. You can
184
- * obtain the state of the vault lock by calling <a>GetVaultLock</a>. For more
185
- * information about the vault locking process, <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-lock.html">Amazon Glacier Vault Lock</a>. </p>
186
- * <p>This operation is idempotent. This request is always successful if the vault lock is
187
- * in the <code>Locked</code> state and the provided lock ID matches the lock ID originally
188
- * used to lock the vault.</p>
189
- * <p>If an invalid lock ID is passed in the request when the vault lock is in the
190
- * <code>Locked</code> state, the operation returns an <code>AccessDeniedException</code>
191
- * error. If an invalid lock ID is passed in the request when the vault lock is in the
192
- * <code>InProgress</code> state, the operation throws an <code>InvalidParameter</code>
193
- * error.</p>
62
+ * @see {@link CompleteVaultLockCommand}
194
63
  */
195
64
  completeVaultLock(args: CompleteVaultLockCommandInput, options?: __HttpHandlerOptions): Promise<CompleteVaultLockCommandOutput>;
196
65
  completeVaultLock(args: CompleteVaultLockCommandInput, cb: (err: any, data?: CompleteVaultLockCommandOutput) => void): void;
197
66
  completeVaultLock(args: CompleteVaultLockCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CompleteVaultLockCommandOutput) => void): void;
198
67
  /**
199
- * @public
200
- * <p>This operation creates a new vault with the specified name. The name of the vault
201
- * must be unique within a region for an AWS account. You can create up to 1,000 vaults per
202
- * account. If you need to create more vaults, contact Amazon S3 Glacier.</p>
203
- * <p>You must use the following guidelines when naming a vault.</p>
204
- * <ul>
205
- * <li>
206
- * <p>Names can be between 1 and 255 characters long.</p>
207
- * </li>
208
- * <li>
209
- * <p>Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), and '.'
210
- * (period).</p>
211
- * </li>
212
- * </ul>
213
- *
214
- * <p>This operation is idempotent.</p>
215
- *
216
- * <p>An AWS account has full permission to perform all operations (actions). However, AWS
217
- * Identity and Access Management (IAM) users don't have any permissions by default. You must
218
- * grant them explicit permission to perform specific actions. For more information, see
219
- * <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using
220
- * AWS Identity and Access Management (IAM)</a>.</p>
221
- * <p> For conceptual information and underlying REST API, see <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/creating-vaults.html">Creating a Vault in Amazon
222
- * Glacier</a> and <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-put.html">Create Vault </a> in the
223
- * <i>Amazon Glacier Developer Guide</i>. </p>
68
+ * @see {@link CreateVaultCommand}
224
69
  */
225
70
  createVault(args: CreateVaultCommandInput, options?: __HttpHandlerOptions): Promise<CreateVaultCommandOutput>;
226
71
  createVault(args: CreateVaultCommandInput, cb: (err: any, data?: CreateVaultCommandOutput) => void): void;
227
72
  createVault(args: CreateVaultCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVaultCommandOutput) => void): void;
228
73
  /**
229
- * @public
230
- * <p>This operation deletes an archive from a vault. Subsequent requests to initiate a
231
- * retrieval of this archive will fail. Archive retrievals that are in progress for this
232
- * archive ID may or may not succeed according to the following scenarios:</p>
233
- * <ul>
234
- * <li>
235
- * <p>If the archive retrieval job is actively preparing the data for download when
236
- * Amazon S3 Glacier receives the delete archive request, the archival retrieval operation
237
- * might fail.</p>
238
- * </li>
239
- * <li>
240
- * <p>If the archive retrieval job has successfully prepared the archive for download
241
- * when Amazon S3 Glacier receives the delete archive request, you will be able to download
242
- * the output.</p>
243
- * </li>
244
- * </ul>
245
- *
246
- * <p>This operation is idempotent. Attempting to delete an already-deleted archive does
247
- * not result in an error.</p>
248
- *
249
- * <p>An AWS account has full permission to perform all operations (actions). However, AWS
250
- * Identity and Access Management (IAM) users don't have any permissions by default. You must
251
- * grant them explicit permission to perform specific actions. For more information, see
252
- * <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using
253
- * AWS Identity and Access Management (IAM)</a>.</p>
254
- * <p> For conceptual information and underlying REST API, see <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/deleting-an-archive.html">Deleting an Archive in Amazon
255
- * Glacier</a> and <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/api-archive-delete.html">Delete Archive</a> in the
256
- * <i>Amazon Glacier Developer Guide</i>. </p>
74
+ * @see {@link DeleteArchiveCommand}
257
75
  */
258
76
  deleteArchive(args: DeleteArchiveCommandInput, options?: __HttpHandlerOptions): Promise<DeleteArchiveCommandOutput>;
259
77
  deleteArchive(args: DeleteArchiveCommandInput, cb: (err: any, data?: DeleteArchiveCommandOutput) => void): void;
260
78
  deleteArchive(args: DeleteArchiveCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteArchiveCommandOutput) => void): void;
261
79
  /**
262
- * @public
263
- * <p>This operation deletes a vault. Amazon S3 Glacier will delete a vault only if there are
264
- * no archives in the vault as of the last inventory and there have been no writes to the
265
- * vault since the last inventory. If either of these conditions is not satisfied, the vault
266
- * deletion fails (that is, the vault is not removed) and Amazon S3 Glacier returns an error. You
267
- * can use <a>DescribeVault</a> to return the number of archives in a vault, and
268
- * you can use <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/api-initiate-job-post.html">Initiate a Job (POST
269
- * jobs)</a> to initiate a new inventory retrieval for a vault. The inventory contains
270
- * the archive IDs you use to delete archives using <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/api-archive-delete.html">Delete Archive (DELETE
271
- * archive)</a>.</p>
272
- *
273
- * <p>This operation is idempotent.</p>
274
- *
275
- * <p>An AWS account has full permission to perform all operations (actions). However, AWS
276
- * Identity and Access Management (IAM) users don't have any permissions by default. You must
277
- * grant them explicit permission to perform specific actions. For more information, see
278
- * <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using
279
- * AWS Identity and Access Management (IAM)</a>.</p>
280
- * <p> For conceptual information and underlying REST API, see <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/deleting-vaults.html">Deleting a Vault in Amazon
281
- * Glacier</a> and <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-delete.html">Delete Vault </a> in the
282
- * <i>Amazon S3 Glacier Developer Guide</i>. </p>
80
+ * @see {@link DeleteVaultCommand}
283
81
  */
284
82
  deleteVault(args: DeleteVaultCommandInput, options?: __HttpHandlerOptions): Promise<DeleteVaultCommandOutput>;
285
83
  deleteVault(args: DeleteVaultCommandInput, cb: (err: any, data?: DeleteVaultCommandOutput) => void): void;
286
84
  deleteVault(args: DeleteVaultCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVaultCommandOutput) => void): void;
287
85
  /**
288
- * @public
289
- * <p>This operation deletes the access policy associated with the specified vault. The
290
- * operation is eventually consistent; that is, it might take some time for Amazon S3 Glacier to
291
- * completely remove the access policy, and you might still see the effect of the policy for a
292
- * short time after you send the delete request.</p>
293
- * <p>This operation is idempotent. You can invoke delete multiple times, even if there is
294
- * no policy associated with the vault. For more information about vault access policies, see
295
- * <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-access-policy.html">Amazon Glacier Access Control with Vault Access Policies</a>. </p>
86
+ * @see {@link DeleteVaultAccessPolicyCommand}
296
87
  */
297
88
  deleteVaultAccessPolicy(args: DeleteVaultAccessPolicyCommandInput, options?: __HttpHandlerOptions): Promise<DeleteVaultAccessPolicyCommandOutput>;
298
89
  deleteVaultAccessPolicy(args: DeleteVaultAccessPolicyCommandInput, cb: (err: any, data?: DeleteVaultAccessPolicyCommandOutput) => void): void;
299
90
  deleteVaultAccessPolicy(args: DeleteVaultAccessPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVaultAccessPolicyCommandOutput) => void): void;
300
91
  /**
301
- * @public
302
- * <p>This operation deletes the notification configuration set for a vault. The operation
303
- * is eventually consistent; that is, it might take some time for Amazon S3 Glacier to completely
304
- * disable the notifications and you might still receive some notifications for a short time
305
- * after you send the delete request.</p>
306
- *
307
- * <p>An AWS account has full permission to perform all operations (actions). However, AWS
308
- * Identity and Access Management (IAM) users don't have any permissions by default. You must
309
- * grant them explicit permission to perform specific actions. For more information, see
310
- * <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access
311
- * Control Using AWS Identity and Access Management (IAM)</a>.</p>
312
- * <p> For conceptual information and underlying REST API, see <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/configuring-notifications.html">Configuring Vault
313
- * Notifications in Amazon S3 Glacier</a> and <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-notifications-delete.html">Delete Vault
314
- * Notification Configuration </a> in the Amazon S3 Glacier Developer Guide. </p>
92
+ * @see {@link DeleteVaultNotificationsCommand}
315
93
  */
316
94
  deleteVaultNotifications(args: DeleteVaultNotificationsCommandInput, options?: __HttpHandlerOptions): Promise<DeleteVaultNotificationsCommandOutput>;
317
95
  deleteVaultNotifications(args: DeleteVaultNotificationsCommandInput, cb: (err: any, data?: DeleteVaultNotificationsCommandOutput) => void): void;
318
96
  deleteVaultNotifications(args: DeleteVaultNotificationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVaultNotificationsCommandOutput) => void): void;
319
97
  /**
320
- * @public
321
- * <p>This operation returns information about a job you previously initiated, including
322
- * the job initiation date, the user who initiated the job, the job status code/message and
323
- * the Amazon SNS topic to notify after Amazon S3 Glacier (Glacier) completes the job. For more information
324
- * about initiating a job, see <a>InitiateJob</a>. </p>
325
- *
326
- * <note>
327
- * <p>This operation enables you to check the status of your job. However, it is
328
- * strongly recommended that you set up an Amazon SNS topic and specify it in your initiate
329
- * job request so that Glacier can notify the topic after it completes the
330
- * job.</p>
331
- * </note>
332
- *
333
- * <p>A job ID will not expire for at least 24 hours after Glacier completes the
334
- * job.</p>
335
- *
336
- * <p>An AWS account has full permission to perform all operations (actions). However, AWS
337
- * Identity and Access Management (IAM) users don't have any permissions by default. You must
338
- * grant them explicit permission to perform specific actions. For more information, see
339
- * <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using
340
- * AWS Identity and Access Management (IAM)</a>.</p>
341
- *
342
- * <p> For more information about using this operation,
343
- * see the documentation for the underlying REST API <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/api-describe-job-get.html">Describe Job</a>
344
- * in the <i>Amazon Glacier Developer Guide</i>. </p>
98
+ * @see {@link DescribeJobCommand}
345
99
  */
346
100
  describeJob(args: DescribeJobCommandInput, options?: __HttpHandlerOptions): Promise<DescribeJobCommandOutput>;
347
101
  describeJob(args: DescribeJobCommandInput, cb: (err: any, data?: DescribeJobCommandOutput) => void): void;
348
102
  describeJob(args: DescribeJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeJobCommandOutput) => void): void;
349
103
  /**
350
- * @public
351
- * <p>This operation returns information about a vault, including the vault's Amazon
352
- * Resource Name (ARN), the date the vault was created, the number of archives it contains,
353
- * and the total size of all the archives in the vault. The number of archives and their total
354
- * size are as of the last inventory generation. This means that if you add or remove an
355
- * archive from a vault, and then immediately use Describe Vault, the change in contents will
356
- * not be immediately reflected. If you want to retrieve the latest inventory of the vault,
357
- * use <a>InitiateJob</a>. Amazon S3 Glacier generates vault inventories approximately
358
- * daily. For more information, see <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-inventory.html">Downloading a Vault Inventory in
359
- * Amazon S3 Glacier</a>. </p>
360
- *
361
- * <p>An AWS account has full permission to perform all operations (actions). However, AWS
362
- * Identity and Access Management (IAM) users don't have any permissions by default. You must
363
- * grant them explicit permission to perform specific actions. For more information, see
364
- * <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using
365
- * AWS Identity and Access Management (IAM)</a>.</p>
366
- * <p>For conceptual information and underlying REST API, see <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/retrieving-vault-info.html">Retrieving Vault Metadata in
367
- * Amazon S3 Glacier</a> and <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-get.html">Describe Vault </a> in the
368
- * <i>Amazon Glacier Developer Guide</i>. </p>
104
+ * @see {@link DescribeVaultCommand}
369
105
  */
370
106
  describeVault(args: DescribeVaultCommandInput, options?: __HttpHandlerOptions): Promise<DescribeVaultCommandOutput>;
371
107
  describeVault(args: DescribeVaultCommandInput, cb: (err: any, data?: DescribeVaultCommandOutput) => void): void;
372
108
  describeVault(args: DescribeVaultCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeVaultCommandOutput) => void): void;
373
109
  /**
374
- * @public
375
- * <p>This operation returns the current data retrieval policy for the account and region
376
- * specified in the GET request. For more information about data retrieval policies, see
377
- * <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/data-retrieval-policy.html">Amazon Glacier Data Retrieval Policies</a>.</p>
110
+ * @see {@link GetDataRetrievalPolicyCommand}
378
111
  */
379
112
  getDataRetrievalPolicy(args: GetDataRetrievalPolicyCommandInput, options?: __HttpHandlerOptions): Promise<GetDataRetrievalPolicyCommandOutput>;
380
113
  getDataRetrievalPolicy(args: GetDataRetrievalPolicyCommandInput, cb: (err: any, data?: GetDataRetrievalPolicyCommandOutput) => void): void;
381
114
  getDataRetrievalPolicy(args: GetDataRetrievalPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDataRetrievalPolicyCommandOutput) => void): void;
382
115
  /**
383
- * @public
384
- * <p>This operation downloads the output of the job you initiated using <a>InitiateJob</a>. Depending on the job type you specified when you initiated the
385
- * job, the output will be either the content of an archive or a vault inventory.</p>
386
- *
387
- * <p>You can download all the job output or download a portion of the output by specifying
388
- * a byte range. In the case of an archive retrieval job, depending on the byte range you
389
- * specify, Amazon S3 Glacier (Glacier) returns the checksum for the portion of the data. You can compute the
390
- * checksum on the client and verify that the values match to ensure the portion you downloaded
391
- * is the correct data.</p>
392
- * <p>A job ID will not expire for at least 24 hours after Glacier completes the job. That
393
- * a byte range. For both archive and inventory retrieval jobs, you should verify the downloaded
394
- * size against the size returned in the headers from the
395
- * <b>Get Job Output</b> response.</p>
396
- * <p>For archive retrieval jobs, you should also verify that the size is what you expected. If
397
- * you download a portion of the output, the expected size is based on the range of bytes
398
- * you specified. For example, if you specify a range of <code>bytes=0-1048575</code>, you should
399
- * verify your download size is 1,048,576 bytes. If you download an entire archive, the
400
- * expected size is the size of the archive when you uploaded it to Amazon S3 Glacier
401
- * The expected size is also returned in the headers from the
402
- * <b>Get Job Output</b> response.</p>
403
- * <p>In the case of an archive retrieval job, depending on the byte range you
404
- * specify, Glacier returns the checksum for the portion of the data. To ensure the portion you downloaded
405
- * is the correct data, compute the checksum on the client, verify that the values match,
406
- * and verify that the size is what you expected.</p>
407
- *
408
- * <p>A job ID does not expire for at least 24 hours after Glacier completes the
409
- * job. That is, you can download the job output within the 24 hours period after Amazon
410
- * Glacier completes the job.</p>
411
- *
412
- * <p>An AWS account has full permission to perform all operations (actions). However, AWS
413
- * Identity and Access Management (IAM) users don't have any permissions by default. You must
414
- * grant them explicit permission to perform specific actions. For more information, see
415
- * <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using
416
- * AWS Identity and Access Management (IAM)</a>.</p>
417
- * <p>For conceptual information and the underlying REST API, see <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-inventory.html">Downloading a
418
- * Vault Inventory</a>, <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/downloading-an-archive.html">Downloading an
419
- * Archive</a>, and <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/api-job-output-get.html">Get Job Output </a>
420
- * </p>
116
+ * @see {@link GetJobOutputCommand}
421
117
  */
422
118
  getJobOutput(args: GetJobOutputCommandInput, options?: __HttpHandlerOptions): Promise<GetJobOutputCommandOutput>;
423
119
  getJobOutput(args: GetJobOutputCommandInput, cb: (err: any, data?: GetJobOutputCommandOutput) => void): void;
424
120
  getJobOutput(args: GetJobOutputCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetJobOutputCommandOutput) => void): void;
425
121
  /**
426
- * @public
427
- * <p>This operation retrieves the <code>access-policy</code> subresource set on the vault;
428
- * for more information on setting this subresource, see <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/api-SetVaultAccessPolicy.html">Set Vault Access Policy
429
- * (PUT access-policy)</a>. If there is no access policy set on the vault, the
430
- * operation returns a <code>404 Not found</code> error. For more information about vault
431
- * access policies, see <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-access-policy.html">Amazon Glacier Access Control
432
- * with Vault Access Policies</a>.</p>
122
+ * @see {@link GetVaultAccessPolicyCommand}
433
123
  */
434
124
  getVaultAccessPolicy(args: GetVaultAccessPolicyCommandInput, options?: __HttpHandlerOptions): Promise<GetVaultAccessPolicyCommandOutput>;
435
125
  getVaultAccessPolicy(args: GetVaultAccessPolicyCommandInput, cb: (err: any, data?: GetVaultAccessPolicyCommandOutput) => void): void;
436
126
  getVaultAccessPolicy(args: GetVaultAccessPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVaultAccessPolicyCommandOutput) => void): void;
437
127
  /**
438
- * @public
439
- * <p>This operation retrieves the following attributes from the <code>lock-policy</code>
440
- * subresource set on the specified vault: </p>
441
- * <ul>
442
- * <li>
443
- * <p>The vault lock policy set on the vault.</p>
444
- * </li>
445
- * <li>
446
- * <p>The state of the vault lock, which is either <code>InProgess</code> or
447
- * <code>Locked</code>.</p>
448
- * </li>
449
- * <li>
450
- * <p>When the lock ID expires. The lock ID is used to complete the vault locking
451
- * process.</p>
452
- * </li>
453
- * <li>
454
- * <p>When the vault lock was initiated and put into the <code>InProgress</code>
455
- * state.</p>
456
- * </li>
457
- * </ul>
458
- *
459
- * <p>A vault lock is put into the <code>InProgress</code> state by calling <a>InitiateVaultLock</a>. A vault lock is put into the <code>Locked</code> state by
460
- * calling <a>CompleteVaultLock</a>. You can abort the vault locking process by
461
- * calling <a>AbortVaultLock</a>. For more information about the vault locking
462
- * process, <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-lock.html">Amazon
463
- * Glacier Vault Lock</a>. </p>
464
- * <p>If there is no vault lock policy set on the vault, the operation returns a <code>404
465
- * Not found</code> error. For more information about vault lock policies, <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-lock-policy.html">Amazon
466
- * Glacier Access Control with Vault Lock Policies</a>. </p>
128
+ * @see {@link GetVaultLockCommand}
467
129
  */
468
130
  getVaultLock(args: GetVaultLockCommandInput, options?: __HttpHandlerOptions): Promise<GetVaultLockCommandOutput>;
469
131
  getVaultLock(args: GetVaultLockCommandInput, cb: (err: any, data?: GetVaultLockCommandOutput) => void): void;
470
132
  getVaultLock(args: GetVaultLockCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVaultLockCommandOutput) => void): void;
471
133
  /**
472
- * @public
473
- * <p>This operation retrieves the <code>notification-configuration</code> subresource of
474
- * the specified vault.</p>
475
- *
476
- * <p>For information about setting a notification configuration on a vault, see <a>SetVaultNotifications</a>. If a notification configuration for a vault is not
477
- * set, the operation returns a <code>404 Not Found</code> error. For more information about
478
- * vault notifications, see <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/configuring-notifications.html">Configuring Vault
479
- * Notifications in Amazon S3 Glacier</a>. </p>
480
- *
481
- * <p>An AWS account has full permission to perform all operations (actions). However, AWS
482
- * Identity and Access Management (IAM) users don't have any permissions by default. You must
483
- * grant them explicit permission to perform specific actions. For more information, see
484
- * <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using
485
- * AWS Identity and Access Management (IAM)</a>.</p>
486
- * <p>For conceptual information and underlying REST API, see <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/configuring-notifications.html">Configuring Vault
487
- * Notifications in Amazon S3 Glacier</a> and <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-notifications-get.html">Get Vault Notification
488
- * Configuration </a> in the <i>Amazon Glacier Developer Guide</i>. </p>
134
+ * @see {@link GetVaultNotificationsCommand}
489
135
  */
490
136
  getVaultNotifications(args: GetVaultNotificationsCommandInput, options?: __HttpHandlerOptions): Promise<GetVaultNotificationsCommandOutput>;
491
137
  getVaultNotifications(args: GetVaultNotificationsCommandInput, cb: (err: any, data?: GetVaultNotificationsCommandOutput) => void): void;
492
138
  getVaultNotifications(args: GetVaultNotificationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVaultNotificationsCommandOutput) => void): void;
493
139
  /**
494
- * @public
495
- * <p>This operation initiates a job of the specified type, which can be a select, an archival retrieval,
496
- * or a vault retrieval. For more information about using this operation,
497
- * see the documentation for the underlying REST API <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/api-initiate-job-post.html">Initiate
498
- * a Job</a>.
499
- * </p>
140
+ * @see {@link InitiateJobCommand}
500
141
  */
501
142
  initiateJob(args: InitiateJobCommandInput, options?: __HttpHandlerOptions): Promise<InitiateJobCommandOutput>;
502
143
  initiateJob(args: InitiateJobCommandInput, cb: (err: any, data?: InitiateJobCommandOutput) => void): void;
503
144
  initiateJob(args: InitiateJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: InitiateJobCommandOutput) => void): void;
504
145
  /**
505
- * @public
506
- * <p>This operation initiates a multipart upload. Amazon S3 Glacier creates a multipart
507
- * upload resource and returns its ID in the response. The multipart upload ID is used in
508
- * subsequent requests to upload parts of an archive (see <a>UploadMultipartPart</a>).</p>
509
- *
510
- * <p>When you initiate a multipart upload, you specify the part size in number of bytes.
511
- * The part size must be a megabyte (1024 KB) multiplied by a power of 2-for example, 1048576
512
- * (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable
513
- * part size is 1 MB, and the maximum is 4 GB.</p>
514
- *
515
- * <p>Every part you upload to this resource (see <a>UploadMultipartPart</a>),
516
- * except the last one, must have the same size. The last one can be the same size or smaller.
517
- * For example, suppose you want to upload a 16.2 MB file. If you initiate the multipart
518
- * upload with a part size of 4 MB, you will upload four parts of 4 MB each and one part of
519
- * 0.2 MB. </p>
520
- *
521
- * <note>
522
- * <p>You don't need to know the size of the archive when you start a multipart upload
523
- * because Amazon S3 Glacier does not require you to specify the overall archive
524
- * size.</p>
525
- * </note>
526
- *
527
- * <p>After you complete the multipart upload, Amazon S3 Glacier (Glacier) removes the multipart upload
528
- * resource referenced by the ID. Glacier also removes the multipart upload resource if
529
- * you cancel the multipart upload or it may be removed if there is no activity for a period
530
- * of 24 hours.</p>
531
- *
532
- * <p>An AWS account has full permission to perform all operations (actions). However, AWS
533
- * Identity and Access Management (IAM) users don't have any permissions by default. You must
534
- * grant them explicit permission to perform specific actions. For more information, see
535
- * <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using
536
- * AWS Identity and Access Management (IAM)</a>.</p>
537
- * <p>For conceptual information and underlying REST API, see <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/uploading-archive-mpu.html">Uploading Large Archives in
538
- * Parts (Multipart Upload)</a> and <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-initiate-upload.html">Initiate Multipart
539
- * Upload</a> in the <i>Amazon Glacier Developer Guide</i>.</p>
146
+ * @see {@link InitiateMultipartUploadCommand}
540
147
  */
541
148
  initiateMultipartUpload(args: InitiateMultipartUploadCommandInput, options?: __HttpHandlerOptions): Promise<InitiateMultipartUploadCommandOutput>;
542
149
  initiateMultipartUpload(args: InitiateMultipartUploadCommandInput, cb: (err: any, data?: InitiateMultipartUploadCommandOutput) => void): void;
543
150
  initiateMultipartUpload(args: InitiateMultipartUploadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: InitiateMultipartUploadCommandOutput) => void): void;
544
151
  /**
545
- * @public
546
- * <p>This operation initiates the vault locking process by doing the following:</p>
547
- * <ul>
548
- * <li>
549
- * <p>Installing a vault lock policy on the specified vault.</p>
550
- * </li>
551
- * <li>
552
- * <p>Setting the lock state of vault lock to <code>InProgress</code>.</p>
553
- * </li>
554
- * <li>
555
- * <p>Returning a lock ID, which is used to complete the vault locking
556
- * process.</p>
557
- * </li>
558
- * </ul>
559
- *
560
- * <p>You can set one vault lock policy for each vault and this policy can be up to 20 KB
561
- * in size. For more information about vault lock policies, see <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-lock-policy.html">Amazon Glacier Access Control with
562
- * Vault Lock Policies</a>. </p>
563
- * <p>You must complete the vault locking process within 24 hours after the vault lock
564
- * enters the <code>InProgress</code> state. After the 24 hour window ends, the lock ID
565
- * expires, the vault automatically exits the <code>InProgress</code> state, and the vault
566
- * lock policy is removed from the vault. You call <a>CompleteVaultLock</a> to
567
- * complete the vault locking process by setting the state of the vault lock to
568
- * <code>Locked</code>. </p>
569
- * <p>After a vault lock is in the <code>Locked</code> state, you cannot initiate a new
570
- * vault lock for the vault.</p>
571
- *
572
- * <p>You can abort the vault locking process by calling <a>AbortVaultLock</a>.
573
- * You can get the state of the vault lock by calling <a>GetVaultLock</a>. For more
574
- * information about the vault locking process, <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-lock.html">Amazon Glacier Vault
575
- * Lock</a>.</p>
576
- *
577
- * <p>If this operation is called when the vault lock is in the <code>InProgress</code>
578
- * state, the operation returns an <code>AccessDeniedException</code> error. When the vault
579
- * lock is in the <code>InProgress</code> state you must call <a>AbortVaultLock</a>
580
- * before you can initiate a new vault lock policy. </p>
152
+ * @see {@link InitiateVaultLockCommand}
581
153
  */
582
154
  initiateVaultLock(args: InitiateVaultLockCommandInput, options?: __HttpHandlerOptions): Promise<InitiateVaultLockCommandOutput>;
583
155
  initiateVaultLock(args: InitiateVaultLockCommandInput, cb: (err: any, data?: InitiateVaultLockCommandOutput) => void): void;
584
156
  initiateVaultLock(args: InitiateVaultLockCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: InitiateVaultLockCommandOutput) => void): void;
585
157
  /**
586
- * @public
587
- * <p>This operation lists jobs for a vault, including jobs that are in-progress and jobs
588
- * that have recently finished. The List Job operation returns a list of these jobs sorted by job initiation
589
- * time.</p>
590
- *
591
- * <note>
592
- * <p>Amazon Glacier retains recently completed jobs for a period before deleting them;
593
- * however, it eventually removes completed jobs. The output of completed jobs can be
594
- * retrieved. Retaining completed jobs for a period of time after they have completed
595
- * enables you to get a job output in the event you miss the job completion notification or
596
- * your first attempt to download it fails. For example, suppose you start an archive
597
- * retrieval job to download an archive. After the job completes, you start to download the
598
- * archive but encounter a network error. In this scenario, you can retry and download the
599
- * archive while the job exists.</p>
600
- * </note>
601
- *
602
- * <p>The List Jobs operation supports pagination. You should always check the response <code>Marker</code> field.
603
- * If there are no more jobs to list, the <code>Marker</code> field is set to <code>null</code>. If there are more jobs to list,
604
- * the <code>Marker</code> field is set to a non-null value, which you can use to continue the pagination of the list.
605
- * To return a list of jobs that begins at a specific job,
606
- * set the marker request parameter to the <code>Marker</code> value for that job that you obtained from a previous List Jobs request.</p>
607
- *
608
- * <p>You can set a maximum limit for the number of jobs returned in the response by
609
- * specifying the <code>limit</code> parameter in the request. The default limit is 50. The
610
- * number of jobs returned might be fewer than the limit, but the number of returned jobs
611
- * never exceeds the limit.</p>
612
- *
613
- * <p>Additionally, you can filter the jobs list returned by specifying the optional
614
- * <code>statuscode</code> parameter or <code>completed</code> parameter, or both. Using
615
- * the <code>statuscode</code> parameter, you can specify to return only jobs that match
616
- * either the <code>InProgress</code>, <code>Succeeded</code>, or <code>Failed</code> status.
617
- * Using the <code>completed</code> parameter, you can specify to return only jobs that were
618
- * completed (<code>true</code>) or jobs that were not completed
619
- * (<code>false</code>).</p>
620
- *
621
- * <p>For more information about using this operation,
622
- * see the documentation for the underlying REST API <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/api-jobs-get.html">List Jobs</a>. </p>
158
+ * @see {@link ListJobsCommand}
623
159
  */
624
160
  listJobs(args: ListJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListJobsCommandOutput>;
625
161
  listJobs(args: ListJobsCommandInput, cb: (err: any, data?: ListJobsCommandOutput) => void): void;
626
162
  listJobs(args: ListJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListJobsCommandOutput) => void): void;
627
163
  /**
628
- * @public
629
- * <p>This operation lists in-progress multipart uploads for the specified vault. An
630
- * in-progress multipart upload is a multipart upload that has been initiated by an <a>InitiateMultipartUpload</a> request, but has not yet been completed or aborted.
631
- * The list returned in the List Multipart Upload response has no guaranteed order. </p>
632
- *
633
- * <p>The List Multipart Uploads operation supports pagination. By default, this operation
634
- * returns up to 50 multipart uploads in the response. You should always check the response
635
- * for a <code>marker</code> at which to continue the list; if there are no more items the
636
- * <code>marker</code> is <code>null</code>. To return a list of multipart uploads that
637
- * begins at a specific upload, set the <code>marker</code> request parameter to the value you
638
- * obtained from a previous List Multipart Upload request. You can also limit the number of
639
- * uploads returned in the response by specifying the <code>limit</code> parameter in the
640
- * request.</p>
641
- *
642
- * <p>Note the difference between this operation and listing parts (<a>ListParts</a>). The List Multipart Uploads operation lists all multipart uploads
643
- * for a vault and does not require a multipart upload ID. The List Parts operation requires a
644
- * multipart upload ID since parts are associated with a single upload.</p>
645
- *
646
- * <p>An AWS account has full permission to perform all operations (actions). However, AWS
647
- * Identity and Access Management (IAM) users don't have any permissions by default. You must
648
- * grant them explicit permission to perform specific actions. For more information, see
649
- * <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using
650
- * AWS Identity and Access Management (IAM)</a>.</p>
651
- *
652
- * <p>For conceptual information and the underlying REST API, see <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html">Working
653
- * with Archives in Amazon S3 Glacier</a> and <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-list-uploads.html">List Multipart Uploads
654
- * </a> in the <i>Amazon Glacier Developer Guide</i>.</p>
164
+ * @see {@link ListMultipartUploadsCommand}
655
165
  */
656
166
  listMultipartUploads(args: ListMultipartUploadsCommandInput, options?: __HttpHandlerOptions): Promise<ListMultipartUploadsCommandOutput>;
657
167
  listMultipartUploads(args: ListMultipartUploadsCommandInput, cb: (err: any, data?: ListMultipartUploadsCommandOutput) => void): void;
658
168
  listMultipartUploads(args: ListMultipartUploadsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMultipartUploadsCommandOutput) => void): void;
659
169
  /**
660
- * @public
661
- * <p>This operation lists the parts of an archive that have been uploaded in a specific
662
- * multipart upload. You can make this request at any time during an in-progress multipart
663
- * upload before you complete the upload (see <a>CompleteMultipartUpload</a>. List
664
- * Parts returns an error for completed uploads. The list returned in the List Parts response
665
- * is sorted by part range. </p>
666
- *
667
- * <p>The List Parts operation supports pagination. By default, this operation returns up
668
- * to 50 uploaded parts in the response. You should always check the response for a
669
- * <code>marker</code> at which to continue the list; if there are no more items the
670
- * <code>marker</code> is <code>null</code>. To return a list of parts that begins at a
671
- * specific part, set the <code>marker</code> request parameter to the value you obtained from
672
- * a previous List Parts request. You can also limit the number of parts returned in the
673
- * response by specifying the <code>limit</code> parameter in the request. </p>
674
- *
675
- * <p>An AWS account has full permission to perform all operations (actions). However, AWS
676
- * Identity and Access Management (IAM) users don't have any permissions by default. You must
677
- * grant them explicit permission to perform specific actions. For more information, see
678
- * <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using
679
- * AWS Identity and Access Management (IAM)</a>.</p>
680
- * <p>For conceptual information and the underlying REST API, see <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html">Working
681
- * with Archives in Amazon S3 Glacier</a> and <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-list-parts.html">List Parts</a> in the
682
- * <i>Amazon Glacier Developer Guide</i>.</p>
170
+ * @see {@link ListPartsCommand}
683
171
  */
684
172
  listParts(args: ListPartsCommandInput, options?: __HttpHandlerOptions): Promise<ListPartsCommandOutput>;
685
173
  listParts(args: ListPartsCommandInput, cb: (err: any, data?: ListPartsCommandOutput) => void): void;
686
174
  listParts(args: ListPartsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPartsCommandOutput) => void): void;
687
175
  /**
688
- * @public
689
- * <p>This operation lists the provisioned capacity units for the specified AWS
690
- * account.</p>
176
+ * @see {@link ListProvisionedCapacityCommand}
691
177
  */
692
178
  listProvisionedCapacity(args: ListProvisionedCapacityCommandInput, options?: __HttpHandlerOptions): Promise<ListProvisionedCapacityCommandOutput>;
693
179
  listProvisionedCapacity(args: ListProvisionedCapacityCommandInput, cb: (err: any, data?: ListProvisionedCapacityCommandOutput) => void): void;
694
180
  listProvisionedCapacity(args: ListProvisionedCapacityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProvisionedCapacityCommandOutput) => void): void;
695
181
  /**
696
- * @public
697
- * <p>This operation lists all the tags attached to a vault. The operation returns an empty
698
- * map if there are no tags. For more information about tags, see <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/tagging.html">Tagging Amazon S3 Glacier
699
- * Resources</a>.</p>
182
+ * @see {@link ListTagsForVaultCommand}
700
183
  */
701
184
  listTagsForVault(args: ListTagsForVaultCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForVaultCommandOutput>;
702
185
  listTagsForVault(args: ListTagsForVaultCommandInput, cb: (err: any, data?: ListTagsForVaultCommandOutput) => void): void;
703
186
  listTagsForVault(args: ListTagsForVaultCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForVaultCommandOutput) => void): void;
704
187
  /**
705
- * @public
706
- * <p>This operation lists all vaults owned by the calling user's account. The list
707
- * returned in the response is ASCII-sorted by vault name.</p>
708
- *
709
- * <p>By default, this operation returns up to 10 items. If there are more vaults to
710
- * list, the response <code>marker</code> field contains the vault Amazon Resource Name (ARN)
711
- * at which to continue the list with a new List Vaults request; otherwise, the
712
- * <code>marker</code> field is <code>null</code>. To return a list of vaults that begins
713
- * at a specific vault, set the <code>marker</code> request parameter to the vault ARN you
714
- * obtained from a previous List Vaults request. You can also limit the number of vaults
715
- * returned in the response by specifying the <code>limit</code> parameter in the request. </p>
716
- *
717
- * <p>An AWS account has full permission to perform all operations (actions). However, AWS
718
- * Identity and Access Management (IAM) users don't have any permissions by default. You must
719
- * grant them explicit permission to perform specific actions. For more information, see
720
- * <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using
721
- * AWS Identity and Access Management (IAM)</a>.</p>
722
- * <p>For conceptual information and underlying REST API, see <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/retrieving-vault-info.html">Retrieving Vault Metadata in
723
- * Amazon S3 Glacier</a> and <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/api-vaults-get.html">List Vaults </a> in the
724
- * <i>Amazon Glacier Developer Guide</i>. </p>
188
+ * @see {@link ListVaultsCommand}
725
189
  */
726
190
  listVaults(args: ListVaultsCommandInput, options?: __HttpHandlerOptions): Promise<ListVaultsCommandOutput>;
727
191
  listVaults(args: ListVaultsCommandInput, cb: (err: any, data?: ListVaultsCommandOutput) => void): void;
728
192
  listVaults(args: ListVaultsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVaultsCommandOutput) => void): void;
729
193
  /**
730
- * @public
731
- * <p>This operation purchases a provisioned capacity unit for an AWS account. </p>
194
+ * @see {@link PurchaseProvisionedCapacityCommand}
732
195
  */
733
196
  purchaseProvisionedCapacity(args: PurchaseProvisionedCapacityCommandInput, options?: __HttpHandlerOptions): Promise<PurchaseProvisionedCapacityCommandOutput>;
734
197
  purchaseProvisionedCapacity(args: PurchaseProvisionedCapacityCommandInput, cb: (err: any, data?: PurchaseProvisionedCapacityCommandOutput) => void): void;
735
198
  purchaseProvisionedCapacity(args: PurchaseProvisionedCapacityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PurchaseProvisionedCapacityCommandOutput) => void): void;
736
199
  /**
737
- * @public
738
- * <p>This operation removes one or more tags from the set of tags attached to a vault. For
739
- * more information about tags, see <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/tagging.html">Tagging Amazon S3 Glacier Resources</a>.
740
- * This operation is idempotent. The operation will be successful, even if there are no tags
741
- * attached to the vault. </p>
200
+ * @see {@link RemoveTagsFromVaultCommand}
742
201
  */
743
202
  removeTagsFromVault(args: RemoveTagsFromVaultCommandInput, options?: __HttpHandlerOptions): Promise<RemoveTagsFromVaultCommandOutput>;
744
203
  removeTagsFromVault(args: RemoveTagsFromVaultCommandInput, cb: (err: any, data?: RemoveTagsFromVaultCommandOutput) => void): void;
745
204
  removeTagsFromVault(args: RemoveTagsFromVaultCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveTagsFromVaultCommandOutput) => void): void;
746
205
  /**
747
- * @public
748
- * <p>This operation sets and then enacts a data retrieval policy in the region specified
749
- * in the PUT request. You can set one policy per region for an AWS account. The policy is
750
- * enacted within a few minutes of a successful PUT operation.</p>
751
- * <p>The set policy operation does not affect retrieval jobs that were in progress before
752
- * the policy was enacted. For more information about data retrieval policies, see <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/data-retrieval-policy.html">Amazon
753
- * Glacier Data Retrieval Policies</a>. </p>
206
+ * @see {@link SetDataRetrievalPolicyCommand}
754
207
  */
755
208
  setDataRetrievalPolicy(args: SetDataRetrievalPolicyCommandInput, options?: __HttpHandlerOptions): Promise<SetDataRetrievalPolicyCommandOutput>;
756
209
  setDataRetrievalPolicy(args: SetDataRetrievalPolicyCommandInput, cb: (err: any, data?: SetDataRetrievalPolicyCommandOutput) => void): void;
757
210
  setDataRetrievalPolicy(args: SetDataRetrievalPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetDataRetrievalPolicyCommandOutput) => void): void;
758
211
  /**
759
- * @public
760
- * <p>This operation configures an access policy for a vault and will overwrite an existing
761
- * policy. To configure a vault access policy, send a PUT request to the
762
- * <code>access-policy</code> subresource of the vault. An access policy is specific to a
763
- * vault and is also called a vault subresource. You can set one access policy per vault and
764
- * the policy can be up to 20 KB in size. For more information about vault access policies,
765
- * see <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-access-policy.html">Amazon Glacier Access Control with Vault Access Policies</a>. </p>
212
+ * @see {@link SetVaultAccessPolicyCommand}
766
213
  */
767
214
  setVaultAccessPolicy(args: SetVaultAccessPolicyCommandInput, options?: __HttpHandlerOptions): Promise<SetVaultAccessPolicyCommandOutput>;
768
215
  setVaultAccessPolicy(args: SetVaultAccessPolicyCommandInput, cb: (err: any, data?: SetVaultAccessPolicyCommandOutput) => void): void;
769
216
  setVaultAccessPolicy(args: SetVaultAccessPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetVaultAccessPolicyCommandOutput) => void): void;
770
217
  /**
771
- * @public
772
- * <p>This operation configures notifications that will be sent when specific events happen
773
- * to a vault. By default, you don't get any notifications.</p>
774
- *
775
- * <p>To configure vault notifications, send a PUT request to the
776
- * <code>notification-configuration</code> subresource of the vault. The request should
777
- * include a JSON document that provides an Amazon SNS topic and specific events for which you
778
- * want Amazon S3 Glacier to send notifications to the topic.</p>
779
- *
780
- * <p>Amazon SNS topics must grant permission to the vault to be allowed to publish
781
- * notifications to the topic. You can configure a vault to publish a notification for the
782
- * following vault events:</p>
783
- *
784
- * <ul>
785
- * <li>
786
- * <p>
787
- * <b>ArchiveRetrievalCompleted</b> This event occurs when a
788
- * job that was initiated for an archive retrieval is completed (<a>InitiateJob</a>). The status of the completed job can be "Succeeded" or
789
- * "Failed". The notification sent to the SNS topic is the same output as returned from
790
- * <a>DescribeJob</a>. </p>
791
- * </li>
792
- * <li>
793
- *
794
- * <p>
795
- * <b>InventoryRetrievalCompleted</b> This event occurs when a
796
- * job that was initiated for an inventory retrieval is completed (<a>InitiateJob</a>). The status of the completed job can be "Succeeded" or
797
- * "Failed". The notification sent to the SNS topic is the same output as returned from
798
- * <a>DescribeJob</a>. </p>
799
- * </li>
800
- * </ul>
801
- *
802
- * <p>An AWS account has full permission to perform all operations (actions). However, AWS
803
- * Identity and Access Management (IAM) users don't have any permissions by default. You must
804
- * grant them explicit permission to perform specific actions. For more information, see
805
- * <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using
806
- * AWS Identity and Access Management (IAM)</a>.</p>
807
- * <p>For conceptual information and underlying REST API, see <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/configuring-notifications.html">Configuring Vault
808
- * Notifications in Amazon S3 Glacier</a> and <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-notifications-put.html">Set Vault Notification
809
- * Configuration </a> in the <i>Amazon Glacier Developer Guide</i>. </p>
218
+ * @see {@link SetVaultNotificationsCommand}
810
219
  */
811
220
  setVaultNotifications(args: SetVaultNotificationsCommandInput, options?: __HttpHandlerOptions): Promise<SetVaultNotificationsCommandOutput>;
812
221
  setVaultNotifications(args: SetVaultNotificationsCommandInput, cb: (err: any, data?: SetVaultNotificationsCommandOutput) => void): void;
813
222
  setVaultNotifications(args: SetVaultNotificationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetVaultNotificationsCommandOutput) => void): void;
814
223
  /**
815
- * @public
816
- * <p>This operation adds an archive to a vault. This is a synchronous operation, and for a
817
- * successful upload, your data is durably persisted. Amazon S3 Glacier returns the archive ID in
818
- * the <code>x-amz-archive-id</code> header of the response. </p>
819
- *
820
- * <p>You must use the archive ID to access your data in Amazon S3 Glacier. After you upload
821
- * an archive, you should save the archive ID returned so that you can retrieve or delete the
822
- * archive later. Besides saving the archive ID, you can also index it and give it a friendly
823
- * name to allow for better searching. You can also use the optional archive description field
824
- * to specify how the archive is referred to in an external index of archives, such as you
825
- * might create in Amazon DynamoDB. You can also get the vault inventory to obtain a list of
826
- * archive IDs in a vault. For more information, see <a>InitiateJob</a>. </p>
827
- *
828
- * <p>You must provide a SHA256 tree hash of the data you are uploading. For information
829
- * about computing a SHA256 tree hash, see <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/checksum-calculations.html">Computing Checksums</a>. </p>
830
- *
831
- * <p>You can optionally specify an archive description of up to 1,024 printable ASCII
832
- * characters. You can get the archive description when you either retrieve the archive or get
833
- * the vault inventory. For more information, see <a>InitiateJob</a>. Amazon
834
- * Glacier does not interpret the description in any way. An archive description does not need
835
- * to be unique. You cannot use the description to retrieve or sort the archive list. </p>
836
- *
837
- * <p>Archives are immutable. After you upload an archive, you cannot edit the archive or
838
- * its description.</p>
839
- *
840
- * <p>An AWS account has full permission to perform all operations (actions). However, AWS
841
- * Identity and Access Management (IAM) users don't have any permissions by default. You must
842
- * grant them explicit permission to perform specific actions. For more information, see
843
- * <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using
844
- * AWS Identity and Access Management (IAM)</a>.</p>
845
- * <p> For conceptual information and underlying REST API, see <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/uploading-an-archive.html">Uploading an Archive in Amazon
846
- * Glacier</a> and <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/api-archive-post.html">Upload Archive</a> in the
847
- * <i>Amazon Glacier Developer Guide</i>. </p>
224
+ * @see {@link UploadArchiveCommand}
848
225
  */
849
226
  uploadArchive(args: UploadArchiveCommandInput, options?: __HttpHandlerOptions): Promise<UploadArchiveCommandOutput>;
850
227
  uploadArchive(args: UploadArchiveCommandInput, cb: (err: any, data?: UploadArchiveCommandOutput) => void): void;
851
228
  uploadArchive(args: UploadArchiveCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UploadArchiveCommandOutput) => void): void;
852
229
  /**
853
- * @public
854
- * <p>This operation uploads a part of an archive. You can upload archive parts in any
855
- * order. You can also upload them in parallel. You can upload up to 10,000 parts for a
856
- * multipart upload.</p>
857
- *
858
- * <p>Amazon Glacier rejects your upload part request if any of the following conditions is
859
- * true:</p>
860
- *
861
- * <ul>
862
- * <li>
863
- * <p>
864
- * <b>SHA256 tree hash does not match</b>To ensure that part
865
- * data is not corrupted in transmission, you compute a SHA256 tree hash of the part and
866
- * include it in your request. Upon receiving the part data, Amazon S3 Glacier also
867
- * computes a SHA256 tree hash. If these hash values don't match, the operation fails.
868
- * For information about computing a SHA256 tree hash, see <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/checksum-calculations.html">Computing
869
- * Checksums</a>.</p>
870
- * </li>
871
- * <li>
872
- * <p>
873
- * <b>Part size does not match</b>The size of each part except
874
- * the last must match the size specified in the corresponding <a>InitiateMultipartUpload</a> request. The size of the last part must be the
875
- * same size as, or smaller than, the specified size.</p>
876
- * <note>
877
- * <p>If you upload a part whose size is smaller than the part size you specified
878
- * in your initiate multipart upload request and that part is not the last part, then
879
- * the upload part request will succeed. However, the subsequent Complete Multipart
880
- * Upload request will fail.</p>
881
- * </note>
882
- * </li>
883
- * <li>
884
- * <p>
885
- * <b>Range does not align</b>The byte range value in the
886
- * request does not align with the part size specified in the corresponding initiate
887
- * request. For example, if you specify a part size of 4194304 bytes (4 MB), then 0 to
888
- * 4194303 bytes (4 MB - 1) and 4194304 (4 MB) to 8388607 (8 MB - 1) are valid part
889
- * ranges. However, if you set a range value of 2 MB to 6 MB, the range does not align
890
- * with the part size and the upload will fail. </p>
891
- * </li>
892
- * </ul>
893
- *
894
- * <p>This operation is idempotent. If you upload the same part multiple times, the data
895
- * included in the most recent request overwrites the previously uploaded data.</p>
896
- *
897
- * <p>An AWS account has full permission to perform all operations (actions). However, AWS
898
- * Identity and Access Management (IAM) users don't have any permissions by default. You must
899
- * grant them explicit permission to perform specific actions. For more information, see
900
- * <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using
901
- * AWS Identity and Access Management (IAM)</a>.</p>
902
- * <p> For conceptual information and underlying REST API, see <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/uploading-archive-mpu.html">Uploading Large Archives in
903
- * Parts (Multipart Upload)</a> and <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/api-upload-part.html">Upload Part </a> in the
904
- * <i>Amazon Glacier Developer Guide</i>.</p>
230
+ * @see {@link UploadMultipartPartCommand}
905
231
  */
906
232
  uploadMultipartPart(args: UploadMultipartPartCommandInput, options?: __HttpHandlerOptions): Promise<UploadMultipartPartCommandOutput>;
907
233
  uploadMultipartPart(args: UploadMultipartPartCommandInput, cb: (err: any, data?: UploadMultipartPartCommandOutput) => void): void;
908
234
  uploadMultipartPart(args: UploadMultipartPartCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UploadMultipartPartCommandOutput) => void): void;
909
235
  }
236
+ /**
237
+ * @public
238
+ * <p> Amazon S3 Glacier (Glacier) is a storage solution for "cold data."</p>
239
+ *
240
+ * <p>Glacier is an extremely low-cost storage service that provides secure,
241
+ * durable, and easy-to-use storage for data backup and archival. With Glacier,
242
+ * customers can store their data cost effectively for months, years, or decades.
243
+ * Glacier also enables customers to offload the administrative burdens of operating and
244
+ * scaling storage to AWS, so they don't have to worry about capacity planning, hardware
245
+ * provisioning, data replication, hardware failure and recovery, or time-consuming hardware
246
+ * migrations.</p>
247
+ *
248
+ * <p>Glacier is a great storage choice when low storage cost is paramount and your
249
+ * data is rarely retrieved. If your
250
+ * application requires fast or frequent access to your data, consider using Amazon S3. For
251
+ * more information, see <a href="http://aws.amazon.com/s3/">Amazon Simple Storage Service
252
+ * (Amazon S3)</a>.</p>
253
+ *
254
+ * <p>You can store any kind of data in any format. There is no maximum limit on the total
255
+ * amount of data you can store in Glacier.</p>
256
+ *
257
+ * <p>If you are a first-time user of Glacier, we recommend that you begin by
258
+ * reading the following sections in the <i>Amazon S3 Glacier Developer
259
+ * Guide</i>:</p>
260
+ * <ul>
261
+ * <li>
262
+ * <p>
263
+ * <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/introduction.html">What is
264
+ * Amazon S3 Glacier</a> - This section of the Developer Guide describes the
265
+ * underlying data model, the operations it supports, and the AWS SDKs that you can use
266
+ * to interact with the service.</p>
267
+ * </li>
268
+ * <li>
269
+ * <p>
270
+ * <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/amazon-glacier-getting-started.html">Getting Started
271
+ * with Amazon S3 Glacier</a> - The Getting Started section walks you through the
272
+ * process of creating a vault, uploading archives, creating jobs to download archives,
273
+ * retrieving the job output, and deleting archives.</p>
274
+ * </li>
275
+ * </ul>
276
+ */
277
+ export declare class Glacier extends GlacierClient implements Glacier {
278
+ }