@aws-sdk/client-glacier 3.948.0 → 3.952.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 (46) hide show
  1. package/README.md +4 -4
  2. package/dist-cjs/index.js +27 -0
  3. package/dist-es/models/errors.js +16 -0
  4. package/dist-es/schemas/schemas_0.js +11 -1
  5. package/dist-types/Glacier.d.ts +4 -4
  6. package/dist-types/GlacierClient.d.ts +4 -4
  7. package/dist-types/commands/AbortMultipartUploadCommand.d.ts +3 -1
  8. package/dist-types/commands/AbortVaultLockCommand.d.ts +2 -0
  9. package/dist-types/commands/AddTagsToVaultCommand.d.ts +3 -1
  10. package/dist-types/commands/CompleteMultipartUploadCommand.d.ts +3 -1
  11. package/dist-types/commands/CompleteVaultLockCommand.d.ts +2 -0
  12. package/dist-types/commands/CreateVaultCommand.d.ts +3 -1
  13. package/dist-types/commands/DeleteArchiveCommand.d.ts +4 -2
  14. package/dist-types/commands/DeleteVaultAccessPolicyCommand.d.ts +3 -1
  15. package/dist-types/commands/DeleteVaultCommand.d.ts +5 -3
  16. package/dist-types/commands/DeleteVaultNotificationsCommand.d.ts +5 -3
  17. package/dist-types/commands/DescribeJobCommand.d.ts +3 -1
  18. package/dist-types/commands/DescribeVaultCommand.d.ts +5 -3
  19. package/dist-types/commands/GetDataRetrievalPolicyCommand.d.ts +2 -0
  20. package/dist-types/commands/GetJobOutputCommand.d.ts +4 -2
  21. package/dist-types/commands/GetVaultAccessPolicyCommand.d.ts +2 -0
  22. package/dist-types/commands/GetVaultLockCommand.d.ts +2 -0
  23. package/dist-types/commands/GetVaultNotificationsCommand.d.ts +4 -2
  24. package/dist-types/commands/InitiateJobCommand.d.ts +2 -0
  25. package/dist-types/commands/InitiateMultipartUploadCommand.d.ts +5 -3
  26. package/dist-types/commands/InitiateVaultLockCommand.d.ts +2 -0
  27. package/dist-types/commands/ListJobsCommand.d.ts +2 -0
  28. package/dist-types/commands/ListMultipartUploadsCommand.d.ts +3 -1
  29. package/dist-types/commands/ListPartsCommand.d.ts +3 -1
  30. package/dist-types/commands/ListProvisionedCapacityCommand.d.ts +2 -0
  31. package/dist-types/commands/ListTagsForVaultCommand.d.ts +3 -1
  32. package/dist-types/commands/ListVaultsCommand.d.ts +28 -1
  33. package/dist-types/commands/PurchaseProvisionedCapacityCommand.d.ts +2 -0
  34. package/dist-types/commands/RemoveTagsFromVaultCommand.d.ts +3 -1
  35. package/dist-types/commands/SetDataRetrievalPolicyCommand.d.ts +2 -0
  36. package/dist-types/commands/SetVaultAccessPolicyCommand.d.ts +2 -0
  37. package/dist-types/commands/SetVaultNotificationsCommand.d.ts +4 -2
  38. package/dist-types/commands/UploadArchiveCommand.d.ts +5 -3
  39. package/dist-types/commands/UploadMultipartPartCommand.d.ts +4 -2
  40. package/dist-types/index.d.ts +4 -4
  41. package/dist-types/models/errors.d.ts +14 -1
  42. package/dist-types/models/models_0.d.ts +63 -63
  43. package/dist-types/schemas/schemas_0.d.ts +1 -0
  44. package/dist-types/ts3.4/models/errors.d.ts +9 -0
  45. package/dist-types/ts3.4/schemas/schemas_0.d.ts +1 -0
  46. package/package.json +2 -2
@@ -51,7 +51,7 @@ declare const ListMultipartUploadsCommand_base: {
51
51
  * AWS Identity and Access Management (IAM)</a>.</p>
52
52
  *
53
53
  * <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
54
- * 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
54
+ * with Archives in Amazon Glacier</a> and <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-list-uploads.html">List Multipart Uploads
55
55
  * </a> in the <i>Amazon Glacier Developer Guide</i>.</p>
56
56
  * @example
57
57
  * Use a bare-bones client and the command you need to make an API call.
@@ -96,6 +96,8 @@ declare const ListMultipartUploadsCommand_base: {
96
96
  * @throws {@link MissingParameterValueException} (client fault)
97
97
  * <p>Returned if a required header or parameter is missing from the request.</p>
98
98
  *
99
+ * @throws {@link NoLongerSupportedException} (client fault)
100
+ *
99
101
  * @throws {@link ResourceNotFoundException} (client fault)
100
102
  * <p>Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't
101
103
  * exist.</p>
@@ -47,7 +47,7 @@ declare const ListPartsCommand_base: {
47
47
  * <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using
48
48
  * AWS Identity and Access Management (IAM)</a>.</p>
49
49
  * <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
50
- * 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
50
+ * with Archives in Amazon Glacier</a> and <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-list-parts.html">List Parts</a> in the
51
51
  * <i>Amazon Glacier Developer Guide</i>.</p>
52
52
  * @example
53
53
  * Use a bare-bones client and the command you need to make an API call.
@@ -95,6 +95,8 @@ declare const ListPartsCommand_base: {
95
95
  * @throws {@link MissingParameterValueException} (client fault)
96
96
  * <p>Returned if a required header or parameter is missing from the request.</p>
97
97
  *
98
+ * @throws {@link NoLongerSupportedException} (client fault)
99
+ *
98
100
  * @throws {@link ResourceNotFoundException} (client fault)
99
101
  * <p>Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't
100
102
  * exist.</p>
@@ -66,6 +66,8 @@ declare const ListProvisionedCapacityCommand_base: {
66
66
  * @throws {@link MissingParameterValueException} (client fault)
67
67
  * <p>Returned if a required header or parameter is missing from the request.</p>
68
68
  *
69
+ * @throws {@link NoLongerSupportedException} (client fault)
70
+ *
69
71
  * @throws {@link ServiceUnavailableException} (server fault)
70
72
  * <p>Returned if the service cannot complete the request.</p>
71
73
  *
@@ -28,7 +28,7 @@ declare const ListTagsForVaultCommand_base: {
28
28
  };
29
29
  /**
30
30
  * <p>This operation lists all the tags attached to a vault. The operation returns an empty
31
- * 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
31
+ * 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 Glacier
32
32
  * Resources</a>.</p>
33
33
  * @example
34
34
  * Use a bare-bones client and the command you need to make an API call.
@@ -64,6 +64,8 @@ declare const ListTagsForVaultCommand_base: {
64
64
  * @throws {@link MissingParameterValueException} (client fault)
65
65
  * <p>Returned if a required header or parameter is missing from the request.</p>
66
66
  *
67
+ * @throws {@link NoLongerSupportedException} (client fault)
68
+ *
67
69
  * @throws {@link ResourceNotFoundException} (client fault)
68
70
  * <p>Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't
69
71
  * exist.</p>
@@ -44,7 +44,7 @@ declare const ListVaultsCommand_base: {
44
44
  * <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using
45
45
  * AWS Identity and Access Management (IAM)</a>.</p>
46
46
  * <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
47
- * Amazon S3 Glacier</a> and <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/api-vaults-get.html">List Vaults </a> in the
47
+ * Amazon Glacier</a> and <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/api-vaults-get.html">List Vaults </a> in the
48
48
  * <i>Amazon Glacier Developer Guide</i>. </p>
49
49
  * @example
50
50
  * Use a bare-bones client and the command you need to make an API call.
@@ -89,6 +89,8 @@ declare const ListVaultsCommand_base: {
89
89
  * @throws {@link MissingParameterValueException} (client fault)
90
90
  * <p>Returned if a required header or parameter is missing from the request.</p>
91
91
  *
92
+ * @throws {@link NoLongerSupportedException} (client fault)
93
+ *
92
94
  * @throws {@link ResourceNotFoundException} (client fault)
93
95
  * <p>Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't
94
96
  * exist.</p>
@@ -100,6 +102,31 @@ declare const ListVaultsCommand_base: {
100
102
  * <p>Base exception class for all service exceptions from Glacier service.</p>
101
103
  *
102
104
  *
105
+ * @example To list all vaults owned by the calling user's account
106
+ * ```javascript
107
+ * // The example lists all vaults owned by the specified AWS account.
108
+ * const input = {
109
+ * accountId: "-",
110
+ * marker: ""
111
+ * };
112
+ * const command = new ListVaultsCommand(input);
113
+ * const response = await client.send(command);
114
+ * /* response is
115
+ * {
116
+ * VaultList: [
117
+ * {
118
+ * CreationDate: "2015-04-06T21:23:45.708Z",
119
+ * LastInventoryDate: "2015-04-07T00:26:19.028Z",
120
+ * NumberOfArchives: 1,
121
+ * SizeInBytes: 3178496,
122
+ * VaultARN: "arn:aws:glacier:us-west-2:0123456789012:vaults/my-vault",
123
+ * VaultName: "my-vault"
124
+ * }
125
+ * ]
126
+ * }
127
+ * *\/
128
+ * ```
129
+ *
103
130
  * @public
104
131
  */
105
132
  export declare class ListVaultsCommand extends ListVaultsCommand_base {
@@ -62,6 +62,8 @@ declare const PurchaseProvisionedCapacityCommand_base: {
62
62
  * @throws {@link MissingParameterValueException} (client fault)
63
63
  * <p>Returned if a required header or parameter is missing from the request.</p>
64
64
  *
65
+ * @throws {@link NoLongerSupportedException} (client fault)
66
+ *
65
67
  * @throws {@link ServiceUnavailableException} (server fault)
66
68
  * <p>Returned if the service cannot complete the request.</p>
67
69
  *
@@ -28,7 +28,7 @@ declare const RemoveTagsFromVaultCommand_base: {
28
28
  };
29
29
  /**
30
30
  * <p>This operation removes one or more tags from the set of tags attached to a vault. For
31
- * more information about tags, see <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/tagging.html">Tagging Amazon S3 Glacier Resources</a>.
31
+ * more information about tags, see <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/tagging.html">Tagging Amazon Glacier Resources</a>.
32
32
  * This operation is idempotent. The operation will be successful, even if there are no tags
33
33
  * attached to the vault. </p>
34
34
  * @example
@@ -64,6 +64,8 @@ declare const RemoveTagsFromVaultCommand_base: {
64
64
  * @throws {@link MissingParameterValueException} (client fault)
65
65
  * <p>Returned if a required header or parameter is missing from the request.</p>
66
66
  *
67
+ * @throws {@link NoLongerSupportedException} (client fault)
68
+ *
67
69
  * @throws {@link ResourceNotFoundException} (client fault)
68
70
  * <p>Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't
69
71
  * exist.</p>
@@ -70,6 +70,8 @@ declare const SetDataRetrievalPolicyCommand_base: {
70
70
  * @throws {@link MissingParameterValueException} (client fault)
71
71
  * <p>Returned if a required header or parameter is missing from the request.</p>
72
72
  *
73
+ * @throws {@link NoLongerSupportedException} (client fault)
74
+ *
73
75
  * @throws {@link ServiceUnavailableException} (server fault)
74
76
  * <p>Returned if the service cannot complete the request.</p>
75
77
  *
@@ -66,6 +66,8 @@ declare const SetVaultAccessPolicyCommand_base: {
66
66
  * @throws {@link MissingParameterValueException} (client fault)
67
67
  * <p>Returned if a required header or parameter is missing from the request.</p>
68
68
  *
69
+ * @throws {@link NoLongerSupportedException} (client fault)
70
+ *
69
71
  * @throws {@link ResourceNotFoundException} (client fault)
70
72
  * <p>Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't
71
73
  * exist.</p>
@@ -33,7 +33,7 @@ declare const SetVaultNotificationsCommand_base: {
33
33
  * <p>To configure vault notifications, send a PUT request to the
34
34
  * <code>notification-configuration</code> subresource of the vault. The request should
35
35
  * include a JSON document that provides an Amazon SNS topic and specific events for which you
36
- * want Amazon S3 Glacier to send notifications to the topic.</p>
36
+ * want Amazon Glacier to send notifications to the topic.</p>
37
37
  *
38
38
  * <p>Amazon SNS topics must grant permission to the vault to be allowed to publish
39
39
  * notifications to the topic. You can configure a vault to publish a notification for the
@@ -63,7 +63,7 @@ declare const SetVaultNotificationsCommand_base: {
63
63
  * <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html">Access Control Using
64
64
  * AWS Identity and Access Management (IAM)</a>.</p>
65
65
  * <p>For conceptual information and underlying REST API, see <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/configuring-notifications.html">Configuring Vault
66
- * 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
66
+ * Notifications in Amazon Glacier</a> and <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-notifications-put.html">Set Vault Notification
67
67
  * Configuration </a> in the <i>Amazon Glacier Developer Guide</i>. </p>
68
68
  * @example
69
69
  * Use a bare-bones client and the command you need to make an API call.
@@ -101,6 +101,8 @@ declare const SetVaultNotificationsCommand_base: {
101
101
  * @throws {@link MissingParameterValueException} (client fault)
102
102
  * <p>Returned if a required header or parameter is missing from the request.</p>
103
103
  *
104
+ * @throws {@link NoLongerSupportedException} (client fault)
105
+ *
104
106
  * @throws {@link ResourceNotFoundException} (client fault)
105
107
  * <p>Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't
106
108
  * exist.</p>
@@ -29,10 +29,10 @@ declare const UploadArchiveCommand_base: {
29
29
  };
30
30
  /**
31
31
  * <p>This operation adds an archive to a vault. This is a synchronous operation, and for a
32
- * successful upload, your data is durably persisted. Amazon S3 Glacier returns the archive ID in
32
+ * successful upload, your data is durably persisted. Amazon Glacier returns the archive ID in
33
33
  * the <code>x-amz-archive-id</code> header of the response. </p>
34
34
  *
35
- * <p>You must use the archive ID to access your data in Amazon S3 Glacier. After you upload
35
+ * <p>You must use the archive ID to access your data in Amazon Glacier. After you upload
36
36
  * an archive, you should save the archive ID returned so that you can retrieve or delete the
37
37
  * archive later. Besides saving the archive ID, you can also index it and give it a friendly
38
38
  * name to allow for better searching. You can also use the optional archive description field
@@ -97,8 +97,10 @@ declare const UploadArchiveCommand_base: {
97
97
  * @throws {@link MissingParameterValueException} (client fault)
98
98
  * <p>Returned if a required header or parameter is missing from the request.</p>
99
99
  *
100
+ * @throws {@link NoLongerSupportedException} (client fault)
101
+ *
100
102
  * @throws {@link RequestTimeoutException} (client fault)
101
- * <p>Returned if, when uploading an archive, Amazon S3 Glacier times out while receiving the
103
+ * <p>Returned if, when uploading an archive, Amazon Glacier times out while receiving the
102
104
  * upload.</p>
103
105
  *
104
106
  * @throws {@link ResourceNotFoundException} (client fault)
@@ -40,7 +40,7 @@ declare const UploadMultipartPartCommand_base: {
40
40
  * <p>
41
41
  * <b>SHA256 tree hash does not match</b>To ensure that part
42
42
  * data is not corrupted in transmission, you compute a SHA256 tree hash of the part and
43
- * include it in your request. Upon receiving the part data, Amazon S3 Glacier also
43
+ * include it in your request. Upon receiving the part data, Amazon Glacier also
44
44
  * computes a SHA256 tree hash. If these hash values don't match, the operation fails.
45
45
  * For information about computing a SHA256 tree hash, see <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/checksum-calculations.html">Computing
46
46
  * Checksums</a>.</p>
@@ -115,8 +115,10 @@ declare const UploadMultipartPartCommand_base: {
115
115
  * @throws {@link MissingParameterValueException} (client fault)
116
116
  * <p>Returned if a required header or parameter is missing from the request.</p>
117
117
  *
118
+ * @throws {@link NoLongerSupportedException} (client fault)
119
+ *
118
120
  * @throws {@link RequestTimeoutException} (client fault)
119
- * <p>Returned if, when uploading an archive, Amazon S3 Glacier times out while receiving the
121
+ * <p>Returned if, when uploading an archive, Amazon Glacier times out while receiving the
120
122
  * upload.</p>
121
123
  *
122
124
  * @throws {@link ResourceNotFoundException} (client fault)
@@ -1,5 +1,5 @@
1
1
  /**
2
- * <p> Amazon S3 Glacier (Glacier) is a storage solution for "cold data."</p>
2
+ * <p> Amazon Glacier (Glacier) is a storage solution for "cold data."</p>
3
3
  *
4
4
  * <p>Glacier is an extremely low-cost storage service that provides secure,
5
5
  * durable, and easy-to-use storage for data backup and archival. With Glacier,
@@ -19,20 +19,20 @@
19
19
  * amount of data you can store in Glacier.</p>
20
20
  *
21
21
  * <p>If you are a first-time user of Glacier, we recommend that you begin by
22
- * reading the following sections in the <i>Amazon S3 Glacier Developer
22
+ * reading the following sections in the <i>Amazon Glacier Developer
23
23
  * Guide</i>:</p>
24
24
  * <ul>
25
25
  * <li>
26
26
  * <p>
27
27
  * <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/introduction.html">What is
28
- * Amazon S3 Glacier</a> - This section of the Developer Guide describes the
28
+ * Amazon Glacier</a> - This section of the Developer Guide describes the
29
29
  * underlying data model, the operations it supports, and the AWS SDKs that you can use
30
30
  * to interact with the service.</p>
31
31
  * </li>
32
32
  * <li>
33
33
  * <p>
34
34
  * <a href="https://docs.aws.amazon.com/amazonglacier/latest/dev/amazon-glacier-getting-started.html">Getting Started
35
- * with Amazon S3 Glacier</a> - The Getting Started section walks you through the
35
+ * with Amazon Glacier</a> - The Getting Started section walks you through the
36
36
  * process of creating a vault, uploading archives, creating jobs to download archives,
37
37
  * retrieving the job output, and deleting archives.</p>
38
38
  * </li>
@@ -44,6 +44,19 @@ export declare class MissingParameterValueException extends __BaseException {
44
44
  */
45
45
  constructor(opts: __ExceptionOptionType<MissingParameterValueException, __BaseException>);
46
46
  }
47
+ /**
48
+ * @public
49
+ */
50
+ export declare class NoLongerSupportedException extends __BaseException {
51
+ readonly name: "NoLongerSupportedException";
52
+ readonly $fault: "client";
53
+ type?: string | undefined;
54
+ code?: string | undefined;
55
+ /**
56
+ * @internal
57
+ */
58
+ constructor(opts: __ExceptionOptionType<NoLongerSupportedException, __BaseException>);
59
+ }
47
60
  /**
48
61
  * <p>Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't
49
62
  * exist.</p>
@@ -151,7 +164,7 @@ export declare class PolicyEnforcedException extends __BaseException {
151
164
  constructor(opts: __ExceptionOptionType<PolicyEnforcedException, __BaseException>);
152
165
  }
153
166
  /**
154
- * <p>Returned if, when uploading an archive, Amazon S3 Glacier times out while receiving the
167
+ * <p>Returned if, when uploading an archive, Amazon Glacier times out while receiving the
155
168
  * upload.</p>
156
169
  * @public
157
170
  */