@aws-sdk/client-glacier 3.775.0 → 3.777.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.
- package/dist-types/commands/AbortMultipartUploadCommand.d.ts +9 -6
- package/dist-types/commands/AbortVaultLockCommand.d.ts +8 -5
- package/dist-types/commands/AddTagsToVaultCommand.d.ts +11 -8
- package/dist-types/commands/CompleteMultipartUploadCommand.d.ts +11 -11
- package/dist-types/commands/CompleteVaultLockCommand.d.ts +9 -6
- package/dist-types/commands/CreateVaultCommand.d.ts +6 -6
- package/dist-types/commands/DeleteArchiveCommand.d.ts +9 -6
- package/dist-types/commands/DeleteVaultAccessPolicyCommand.d.ts +8 -5
- package/dist-types/commands/DeleteVaultCommand.d.ts +8 -5
- package/dist-types/commands/DeleteVaultNotificationsCommand.d.ts +8 -5
- package/dist-types/commands/DescribeJobCommand.d.ts +14 -14
- package/dist-types/commands/DescribeVaultCommand.d.ts +10 -10
- package/dist-types/commands/GetDataRetrievalPolicyCommand.d.ts +8 -8
- package/dist-types/commands/GetJobOutputCommand.d.ts +21 -11
- package/dist-types/commands/GetVaultAccessPolicyCommand.d.ts +7 -7
- package/dist-types/commands/GetVaultLockCommand.d.ts +9 -9
- package/dist-types/commands/GetVaultNotificationsCommand.d.ts +8 -8
- package/dist-types/commands/InitiateJobCommand.d.ts +12 -12
- package/dist-types/commands/InitiateMultipartUploadCommand.d.ts +8 -8
- package/dist-types/commands/InitiateVaultLockCommand.d.ts +8 -8
- package/dist-types/commands/ListJobsCommand.d.ts +27 -27
- package/dist-types/commands/ListMultipartUploadsCommand.d.ts +22 -22
- package/dist-types/commands/ListPartsCommand.d.ts +17 -17
- package/dist-types/commands/ListProvisionedCapacityCommand.d.ts +11 -11
- package/dist-types/commands/ListTagsForVaultCommand.d.ts +8 -8
- package/dist-types/commands/ListVaultsCommand.d.ts +1 -27
- package/dist-types/commands/PurchaseProvisionedCapacityCommand.d.ts +5 -5
- package/dist-types/commands/RemoveTagsFromVaultCommand.d.ts +9 -6
- package/dist-types/commands/SetDataRetrievalPolicyCommand.d.ts +11 -8
- package/dist-types/commands/SetVaultAccessPolicyCommand.d.ts +10 -7
- package/dist-types/commands/SetVaultNotificationsCommand.d.ts +11 -8
- package/dist-types/commands/UploadArchiveCommand.d.ts +11 -11
- package/dist-types/commands/UploadMultipartPartCommand.d.ts +10 -10
- package/package.json +2 -2
|
@@ -152,31 +152,31 @@ declare const InitiateJobCommand_base: {
|
|
|
152
152
|
* @throws {@link GlacierServiceException}
|
|
153
153
|
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
154
154
|
*
|
|
155
|
-
*
|
|
155
|
+
*
|
|
156
156
|
* @example To initiate an inventory-retrieval job
|
|
157
157
|
* ```javascript
|
|
158
158
|
* // The example initiates an inventory-retrieval job for the vault named examplevault.
|
|
159
159
|
* const input = {
|
|
160
|
-
*
|
|
161
|
-
*
|
|
162
|
-
*
|
|
163
|
-
*
|
|
164
|
-
*
|
|
165
|
-
*
|
|
160
|
+
* accountId: "-",
|
|
161
|
+
* jobParameters: {
|
|
162
|
+
* Description: "My inventory job",
|
|
163
|
+
* Format: "CSV",
|
|
164
|
+
* SNSTopic: "arn:aws:sns:us-west-2:111111111111:Glacier-InventoryRetrieval-topic-Example",
|
|
165
|
+
* Type: "inventory-retrieval"
|
|
166
166
|
* },
|
|
167
|
-
*
|
|
167
|
+
* vaultName: "examplevault"
|
|
168
168
|
* };
|
|
169
169
|
* const command = new InitiateJobCommand(input);
|
|
170
170
|
* const response = await client.send(command);
|
|
171
|
-
* /* response
|
|
171
|
+
* /* response is
|
|
172
172
|
* {
|
|
173
|
-
*
|
|
174
|
-
*
|
|
173
|
+
* jobId: " HkF9p6o7yjhFx-K3CGl6fuSm6VzW9T7esGQfco8nUXVYwS0jlb5gq1JZ55yHgt5vP54ZShjoQzQVVh7vEXAMPLEjobID",
|
|
174
|
+
* location: "/111122223333/vaults/examplevault/jobs/HkF9p6o7yjhFx-K3CGl6fuSm6VzW9T7esGQfco8nUXVYwS0jlb5gq1JZ55yHgt5vP54ZShjoQzQVVh7vEXAMPLEjobID"
|
|
175
175
|
* }
|
|
176
176
|
* *\/
|
|
177
|
-
* // example id: to-initiate-an-inventory-retrieval-job-1482186883826
|
|
178
177
|
* ```
|
|
179
178
|
*
|
|
179
|
+
* @public
|
|
180
180
|
*/
|
|
181
181
|
export declare class InitiateJobCommand extends InitiateJobCommand_base {
|
|
182
182
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -104,26 +104,26 @@ declare const InitiateMultipartUploadCommand_base: {
|
|
|
104
104
|
* @throws {@link GlacierServiceException}
|
|
105
105
|
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
106
106
|
*
|
|
107
|
-
*
|
|
107
|
+
*
|
|
108
108
|
* @example To initiate a multipart upload
|
|
109
109
|
* ```javascript
|
|
110
110
|
* // The example initiates a multipart upload to a vault named my-vault with a part size of 1 MiB (1024 x 1024 bytes) per file.
|
|
111
111
|
* const input = {
|
|
112
|
-
*
|
|
113
|
-
*
|
|
114
|
-
*
|
|
112
|
+
* accountId: "-",
|
|
113
|
+
* partSize: "1048576",
|
|
114
|
+
* vaultName: "my-vault"
|
|
115
115
|
* };
|
|
116
116
|
* const command = new InitiateMultipartUploadCommand(input);
|
|
117
117
|
* const response = await client.send(command);
|
|
118
|
-
* /* response
|
|
118
|
+
* /* response is
|
|
119
119
|
* {
|
|
120
|
-
*
|
|
121
|
-
*
|
|
120
|
+
* location: "/111122223333/vaults/my-vault/multipart-uploads/19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ",
|
|
121
|
+
* uploadId: "19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ"
|
|
122
122
|
* }
|
|
123
123
|
* *\/
|
|
124
|
-
* // example id: 72f2db19-3d93-4c74-b2ed-38703baacf49
|
|
125
124
|
* ```
|
|
126
125
|
*
|
|
126
|
+
* @public
|
|
127
127
|
*/
|
|
128
128
|
export declare class InitiateMultipartUploadCommand extends InitiateMultipartUploadCommand_base {
|
|
129
129
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -105,27 +105,27 @@ declare const InitiateVaultLockCommand_base: {
|
|
|
105
105
|
* @throws {@link GlacierServiceException}
|
|
106
106
|
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
107
107
|
*
|
|
108
|
-
*
|
|
108
|
+
*
|
|
109
109
|
* @example To initiate the vault locking process
|
|
110
110
|
* ```javascript
|
|
111
111
|
* // The example initiates the vault locking process for the vault named my-vault.
|
|
112
112
|
* const input = {
|
|
113
|
-
*
|
|
114
|
-
*
|
|
115
|
-
*
|
|
113
|
+
* accountId: "-",
|
|
114
|
+
* policy: {
|
|
115
|
+
* Policy: `{"Version":"2012-10-17","Statement":[{"Sid":"Define-vault-lock","Effect":"Deny","Principal":{"AWS":"arn:aws:iam::999999999999:root"},"Action":"glacier:DeleteArchive","Resource":"arn:aws:glacier:us-west-2:999999999999:vaults/examplevault","Condition":{"NumericLessThanEquals":{"glacier:ArchiveAgeinDays":"365"}}}]}`
|
|
116
116
|
* },
|
|
117
|
-
*
|
|
117
|
+
* vaultName: "my-vault"
|
|
118
118
|
* };
|
|
119
119
|
* const command = new InitiateVaultLockCommand(input);
|
|
120
120
|
* const response = await client.send(command);
|
|
121
|
-
* /* response
|
|
121
|
+
* /* response is
|
|
122
122
|
* {
|
|
123
|
-
*
|
|
123
|
+
* lockId: "AE863rKkWZU53SLW5be4DUcW"
|
|
124
124
|
* }
|
|
125
125
|
* *\/
|
|
126
|
-
* // example id: to-initiate-the-vault-locking-process-1481919693394
|
|
127
126
|
* ```
|
|
128
127
|
*
|
|
128
|
+
* @public
|
|
129
129
|
*/
|
|
130
130
|
export declare class InitiateVaultLockCommand extends InitiateVaultLockCommand_base {
|
|
131
131
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -190,51 +190,51 @@ declare const ListJobsCommand_base: {
|
|
|
190
190
|
* @throws {@link GlacierServiceException}
|
|
191
191
|
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
192
192
|
*
|
|
193
|
-
*
|
|
193
|
+
*
|
|
194
194
|
* @example To list jobs for a vault
|
|
195
195
|
* ```javascript
|
|
196
196
|
* // The example lists jobs for the vault named my-vault.
|
|
197
197
|
* const input = {
|
|
198
|
-
*
|
|
199
|
-
*
|
|
198
|
+
* accountId: "-",
|
|
199
|
+
* vaultName: "my-vault"
|
|
200
200
|
* };
|
|
201
201
|
* const command = new ListJobsCommand(input);
|
|
202
202
|
* const response = await client.send(command);
|
|
203
|
-
* /* response
|
|
203
|
+
* /* response is
|
|
204
204
|
* {
|
|
205
|
-
*
|
|
205
|
+
* JobList: [
|
|
206
206
|
* {
|
|
207
|
-
*
|
|
208
|
-
*
|
|
209
|
-
*
|
|
210
|
-
*
|
|
211
|
-
*
|
|
212
|
-
*
|
|
213
|
-
*
|
|
214
|
-
*
|
|
215
|
-
*
|
|
216
|
-
*
|
|
217
|
-
*
|
|
218
|
-
*
|
|
219
|
-
*
|
|
207
|
+
* Action: "ArchiveRetrieval",
|
|
208
|
+
* ArchiveId: "kKB7ymWJVpPSwhGP6ycSOAekp9ZYe_--zM_mw6k76ZFGEIWQX-ybtRDvc2VkPSDtfKmQrj0IRQLSGsNuDp-AJVlu2ccmDSyDUmZwKbwbpAdGATGDiB3hHO0bjbGehXTcApVud_wyDw",
|
|
209
|
+
* ArchiveSHA256TreeHash: "9628195fcdbcbbe76cdde932d4646fa7de5f219fb39823836d81f0cc0e18aa67",
|
|
210
|
+
* ArchiveSizeInBytes: 3145728,
|
|
211
|
+
* Completed: false,
|
|
212
|
+
* CreationDate: "2015-07-17T21:16:13.840Z",
|
|
213
|
+
* JobDescription: "Retrieve archive on 2015-07-17",
|
|
214
|
+
* JobId: "l7IL5-EkXyEY9Ws95fClzIbk2O5uLYaFdAYOi-azsX_Z8V6NH4yERHzars8wTKYQMX6nBDI9cMNHzyZJO59-8N9aHWav",
|
|
215
|
+
* RetrievalByteRange: "0-3145727",
|
|
216
|
+
* SHA256TreeHash: "9628195fcdbcbbe76cdde932d4646fa7de5f219fb39823836d81f0cc0e18aa67",
|
|
217
|
+
* SNSTopic: "arn:aws:sns:us-west-2:0123456789012:my-vault",
|
|
218
|
+
* StatusCode: "InProgress",
|
|
219
|
+
* VaultARN: "arn:aws:glacier:us-west-2:0123456789012:vaults/my-vault"
|
|
220
220
|
* },
|
|
221
221
|
* {
|
|
222
|
-
*
|
|
223
|
-
*
|
|
224
|
-
*
|
|
225
|
-
*
|
|
226
|
-
*
|
|
222
|
+
* Action: "InventoryRetrieval",
|
|
223
|
+
* Completed: false,
|
|
224
|
+
* CreationDate: "2015-07-17T20:23:41.616Z",
|
|
225
|
+
* InventoryRetrievalParameters: {
|
|
226
|
+
* Format: "JSON"
|
|
227
227
|
* },
|
|
228
|
-
*
|
|
229
|
-
*
|
|
230
|
-
*
|
|
228
|
+
* JobId: "zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4CnMW",
|
|
229
|
+
* StatusCode: "InProgress",
|
|
230
|
+
* VaultARN: "arn:aws:glacier:us-west-2:0123456789012:vaults/my-vault"
|
|
231
231
|
* }
|
|
232
232
|
* ]
|
|
233
233
|
* }
|
|
234
234
|
* *\/
|
|
235
|
-
* // example id: to-list-jobs-for-a-vault-1481920530537
|
|
236
235
|
* ```
|
|
237
236
|
*
|
|
237
|
+
* @public
|
|
238
238
|
*/
|
|
239
239
|
export declare class ListJobsCommand extends ListJobsCommand_base {
|
|
240
240
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -104,47 +104,47 @@ declare const ListMultipartUploadsCommand_base: {
|
|
|
104
104
|
* @throws {@link GlacierServiceException}
|
|
105
105
|
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
106
106
|
*
|
|
107
|
-
*
|
|
107
|
+
*
|
|
108
108
|
* @example To list all the in-progress multipart uploads for a vault
|
|
109
109
|
* ```javascript
|
|
110
110
|
* // The example lists all the in-progress multipart uploads for the vault named examplevault.
|
|
111
111
|
* const input = {
|
|
112
|
-
*
|
|
113
|
-
*
|
|
112
|
+
* accountId: "-",
|
|
113
|
+
* vaultName: "examplevault"
|
|
114
114
|
* };
|
|
115
115
|
* const command = new ListMultipartUploadsCommand(input);
|
|
116
116
|
* const response = await client.send(command);
|
|
117
|
-
* /* response
|
|
117
|
+
* /* response is
|
|
118
118
|
* {
|
|
119
|
-
*
|
|
120
|
-
*
|
|
119
|
+
* Marker: "null",
|
|
120
|
+
* UploadsList: [
|
|
121
121
|
* {
|
|
122
|
-
*
|
|
123
|
-
*
|
|
124
|
-
*
|
|
125
|
-
*
|
|
126
|
-
*
|
|
122
|
+
* ArchiveDescription: "archive 1",
|
|
123
|
+
* CreationDate: "2012-03-19T23:20:59.130Z",
|
|
124
|
+
* MultipartUploadId: "xsQdFIRsfJr20CW2AbZBKpRZAFTZSJIMtL2hYf8mvp8dM0m4RUzlaqoEye6g3h3ecqB_zqwB7zLDMeSWhwo65re4C4Ev",
|
|
125
|
+
* PartSizeInBytes: 4194304,
|
|
126
|
+
* VaultARN: "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault"
|
|
127
127
|
* },
|
|
128
128
|
* {
|
|
129
|
-
*
|
|
130
|
-
*
|
|
131
|
-
*
|
|
132
|
-
*
|
|
133
|
-
*
|
|
129
|
+
* ArchiveDescription: "archive 2",
|
|
130
|
+
* CreationDate: "2012-04-01T15:00:00.000Z",
|
|
131
|
+
* MultipartUploadId: "nPyGOnyFcx67qqX7E-0tSGiRi88hHMOwOxR-_jNyM6RjVMFfV29lFqZ3rNsSaWBugg6OP92pRtufeHdQH7ClIpSF6uJc",
|
|
132
|
+
* PartSizeInBytes: 4194304,
|
|
133
|
+
* VaultARN: "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault"
|
|
134
134
|
* },
|
|
135
135
|
* {
|
|
136
|
-
*
|
|
137
|
-
*
|
|
138
|
-
*
|
|
139
|
-
*
|
|
140
|
-
*
|
|
136
|
+
* ArchiveDescription: "archive 3",
|
|
137
|
+
* CreationDate: "2012-03-20T17:03:43.221Z",
|
|
138
|
+
* MultipartUploadId: "qt-RBst_7yO8gVIonIBsAxr2t-db0pE4s8MNeGjKjGdNpuU-cdSAcqG62guwV9r5jh5mLyFPzFEitTpNE7iQfHiu1XoV",
|
|
139
|
+
* PartSizeInBytes: 4194304,
|
|
140
|
+
* VaultARN: "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault"
|
|
141
141
|
* }
|
|
142
142
|
* ]
|
|
143
143
|
* }
|
|
144
144
|
* *\/
|
|
145
|
-
* // example id: to-list-all-the-in-progress-multipart-uploads-for-a-vault-1481935250590
|
|
146
145
|
* ```
|
|
147
146
|
*
|
|
147
|
+
* @public
|
|
148
148
|
*/
|
|
149
149
|
export declare class ListMultipartUploadsCommand extends ListMultipartUploadsCommand_base {
|
|
150
150
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -103,40 +103,40 @@ declare const ListPartsCommand_base: {
|
|
|
103
103
|
* @throws {@link GlacierServiceException}
|
|
104
104
|
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
105
105
|
*
|
|
106
|
-
*
|
|
106
|
+
*
|
|
107
107
|
* @example To list the parts of an archive that have been uploaded in a multipart upload
|
|
108
108
|
* ```javascript
|
|
109
109
|
* // The example lists all the parts of a multipart upload.
|
|
110
110
|
* const input = {
|
|
111
|
-
*
|
|
112
|
-
*
|
|
113
|
-
*
|
|
111
|
+
* accountId: "-",
|
|
112
|
+
* uploadId: "OW2fM5iVylEpFEMM9_HpKowRapC3vn5sSL39_396UW9zLFUWVrnRHaPjUJddQ5OxSHVXjYtrN47NBZ-khxOjyEXAMPLE",
|
|
113
|
+
* vaultName: "examplevault"
|
|
114
114
|
* };
|
|
115
115
|
* const command = new ListPartsCommand(input);
|
|
116
116
|
* const response = await client.send(command);
|
|
117
|
-
* /* response
|
|
117
|
+
* /* response is
|
|
118
118
|
* {
|
|
119
|
-
*
|
|
120
|
-
*
|
|
121
|
-
*
|
|
122
|
-
*
|
|
123
|
-
*
|
|
124
|
-
*
|
|
119
|
+
* ArchiveDescription: "archive description",
|
|
120
|
+
* CreationDate: "2012-03-20T17:03:43.221Z",
|
|
121
|
+
* Marker: "null",
|
|
122
|
+
* MultipartUploadId: "OW2fM5iVylEpFEMM9_HpKowRapC3vn5sSL39_396UW9zLFUWVrnRHaPjUJddQ5OxSHVXjYtrN47NBZ-khxOjyEXAMPLE",
|
|
123
|
+
* PartSizeInBytes: 4194304,
|
|
124
|
+
* Parts: [
|
|
125
125
|
* {
|
|
126
|
-
*
|
|
127
|
-
*
|
|
126
|
+
* RangeInBytes: "0-4194303",
|
|
127
|
+
* SHA256TreeHash: "01d34dabf7be316472c93b1ef80721f5d4"
|
|
128
128
|
* },
|
|
129
129
|
* {
|
|
130
|
-
*
|
|
131
|
-
*
|
|
130
|
+
* RangeInBytes: "4194304-8388607",
|
|
131
|
+
* SHA256TreeHash: "0195875365afda349fc21c84c099987164"
|
|
132
132
|
* }
|
|
133
133
|
* ],
|
|
134
|
-
*
|
|
134
|
+
* VaultARN: "arn:aws:glacier:us-west-2:012345678901:vaults/demo1-vault"
|
|
135
135
|
* }
|
|
136
136
|
* *\/
|
|
137
|
-
* // example id: to-list-the-parts-of-an-archive-that-have-been-uploaded-in-a-multipart-upload-1481921767590
|
|
138
137
|
* ```
|
|
139
138
|
*
|
|
139
|
+
* @public
|
|
140
140
|
*/
|
|
141
141
|
export declare class ListPartsCommand extends ListPartsCommand_base {
|
|
142
142
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -70,34 +70,34 @@ declare const ListProvisionedCapacityCommand_base: {
|
|
|
70
70
|
* @throws {@link GlacierServiceException}
|
|
71
71
|
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
72
72
|
*
|
|
73
|
-
*
|
|
73
|
+
*
|
|
74
74
|
* @example To list the provisioned capacity units for an account
|
|
75
75
|
* ```javascript
|
|
76
76
|
* // The example lists the provisioned capacity units for an account.
|
|
77
77
|
* const input = {
|
|
78
|
-
*
|
|
78
|
+
* accountId: "-"
|
|
79
79
|
* };
|
|
80
80
|
* const command = new ListProvisionedCapacityCommand(input);
|
|
81
81
|
* const response = await client.send(command);
|
|
82
|
-
* /* response
|
|
82
|
+
* /* response is
|
|
83
83
|
* {
|
|
84
|
-
*
|
|
84
|
+
* ProvisionedCapacityList: [
|
|
85
85
|
* {
|
|
86
|
-
*
|
|
87
|
-
*
|
|
88
|
-
*
|
|
86
|
+
* CapacityId: "zSaq7NzHFQDANTfQkDen4V7z",
|
|
87
|
+
* ExpirationDate: "2016-12-12T00:00:00.000Z",
|
|
88
|
+
* StartDate: "2016-11-11T20:11:51.095Z"
|
|
89
89
|
* },
|
|
90
90
|
* {
|
|
91
|
-
*
|
|
92
|
-
*
|
|
93
|
-
*
|
|
91
|
+
* CapacityId: "yXaq7NzHFQNADTfQkDen4V7z",
|
|
92
|
+
* ExpirationDate: "2017-01-15T00:00:00.000Z",
|
|
93
|
+
* StartDate: "2016-12-13T20:11:51.095Z"
|
|
94
94
|
* }
|
|
95
95
|
* ]
|
|
96
96
|
* }
|
|
97
97
|
* *\/
|
|
98
|
-
* // example id: to-list-the-provisioned-capacity-units-for-an-account-1481923656130
|
|
99
98
|
* ```
|
|
100
99
|
*
|
|
100
|
+
* @public
|
|
101
101
|
*/
|
|
102
102
|
export declare class ListProvisionedCapacityCommand extends ListProvisionedCapacityCommand_base {
|
|
103
103
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -72,27 +72,27 @@ declare const ListTagsForVaultCommand_base: {
|
|
|
72
72
|
* @throws {@link GlacierServiceException}
|
|
73
73
|
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
74
74
|
*
|
|
75
|
-
*
|
|
75
|
+
*
|
|
76
76
|
* @example To list the tags for a vault
|
|
77
77
|
* ```javascript
|
|
78
78
|
* // The example lists all the tags attached to the vault examplevault.
|
|
79
79
|
* const input = {
|
|
80
|
-
*
|
|
81
|
-
*
|
|
80
|
+
* accountId: "-",
|
|
81
|
+
* vaultName: "examplevault"
|
|
82
82
|
* };
|
|
83
83
|
* const command = new ListTagsForVaultCommand(input);
|
|
84
84
|
* const response = await client.send(command);
|
|
85
|
-
* /* response
|
|
85
|
+
* /* response is
|
|
86
86
|
* {
|
|
87
|
-
*
|
|
88
|
-
*
|
|
89
|
-
*
|
|
87
|
+
* Tags: {
|
|
88
|
+
* date: "july2015",
|
|
89
|
+
* id: "1234"
|
|
90
90
|
* }
|
|
91
91
|
* }
|
|
92
92
|
* *\/
|
|
93
|
-
* // example id: list-tags-for-vault-1481755839720
|
|
94
93
|
* ```
|
|
95
94
|
*
|
|
95
|
+
* @public
|
|
96
96
|
*/
|
|
97
97
|
export declare class ListTagsForVaultCommand extends ListTagsForVaultCommand_base {
|
|
98
98
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -97,34 +97,8 @@ declare const ListVaultsCommand_base: {
|
|
|
97
97
|
* @throws {@link GlacierServiceException}
|
|
98
98
|
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
99
99
|
*
|
|
100
|
-
* @public
|
|
101
|
-
* @example To list all vaults owned by the calling user's account
|
|
102
|
-
* ```javascript
|
|
103
|
-
* // The example lists all vaults owned by the specified AWS account.
|
|
104
|
-
* const input = {
|
|
105
|
-
* "accountId": "-",
|
|
106
|
-
* "limit": "",
|
|
107
|
-
* "marker": ""
|
|
108
|
-
* };
|
|
109
|
-
* const command = new ListVaultsCommand(input);
|
|
110
|
-
* const response = await client.send(command);
|
|
111
|
-
* /* response ==
|
|
112
|
-
* {
|
|
113
|
-
* "VaultList": [
|
|
114
|
-
* {
|
|
115
|
-
* "CreationDate": "2015-04-06T21:23:45.708Z",
|
|
116
|
-
* "LastInventoryDate": "2015-04-07T00:26:19.028Z",
|
|
117
|
-
* "NumberOfArchives": 1,
|
|
118
|
-
* "SizeInBytes": 3178496,
|
|
119
|
-
* "VaultARN": "arn:aws:glacier:us-west-2:0123456789012:vaults/my-vault",
|
|
120
|
-
* "VaultName": "my-vault"
|
|
121
|
-
* }
|
|
122
|
-
* ]
|
|
123
|
-
* }
|
|
124
|
-
* *\/
|
|
125
|
-
* // example id: list-vaults-1481753006990
|
|
126
|
-
* ```
|
|
127
100
|
*
|
|
101
|
+
* @public
|
|
128
102
|
*/
|
|
129
103
|
export declare class ListVaultsCommand extends ListVaultsCommand_base {
|
|
130
104
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -66,23 +66,23 @@ declare const PurchaseProvisionedCapacityCommand_base: {
|
|
|
66
66
|
* @throws {@link GlacierServiceException}
|
|
67
67
|
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
68
68
|
*
|
|
69
|
-
*
|
|
69
|
+
*
|
|
70
70
|
* @example To purchases a provisioned capacity unit for an AWS account
|
|
71
71
|
* ```javascript
|
|
72
72
|
* // The example purchases provisioned capacity unit for an AWS account.
|
|
73
73
|
* const input = {
|
|
74
|
-
*
|
|
74
|
+
* accountId: "-"
|
|
75
75
|
* };
|
|
76
76
|
* const command = new PurchaseProvisionedCapacityCommand(input);
|
|
77
77
|
* const response = await client.send(command);
|
|
78
|
-
* /* response
|
|
78
|
+
* /* response is
|
|
79
79
|
* {
|
|
80
|
-
*
|
|
80
|
+
* capacityId: "zSaq7NzHFQDANTfQkDen4V7z"
|
|
81
81
|
* }
|
|
82
82
|
* *\/
|
|
83
|
-
* // example id: to-purchases-a-provisioned-capacity-unit-for-an-aws-account-1481927446662
|
|
84
83
|
* ```
|
|
85
84
|
*
|
|
85
|
+
* @public
|
|
86
86
|
*/
|
|
87
87
|
export declare class PurchaseProvisionedCapacityCommand extends PurchaseProvisionedCapacityCommand_base {
|
|
88
88
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -72,23 +72,26 @@ declare const RemoveTagsFromVaultCommand_base: {
|
|
|
72
72
|
* @throws {@link GlacierServiceException}
|
|
73
73
|
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
74
74
|
*
|
|
75
|
-
*
|
|
75
|
+
*
|
|
76
76
|
* @example To remove tags from a vault
|
|
77
77
|
* ```javascript
|
|
78
78
|
* // The example removes two tags from the vault named examplevault.
|
|
79
79
|
* const input = {
|
|
80
|
-
*
|
|
80
|
+
* TagKeys: [
|
|
81
81
|
* "examplekey1",
|
|
82
82
|
* "examplekey2"
|
|
83
83
|
* ],
|
|
84
|
-
*
|
|
85
|
-
*
|
|
84
|
+
* accountId: "-",
|
|
85
|
+
* vaultName: "examplevault"
|
|
86
86
|
* };
|
|
87
87
|
* const command = new RemoveTagsFromVaultCommand(input);
|
|
88
|
-
* await client.send(command);
|
|
89
|
-
*
|
|
88
|
+
* const response = await client.send(command);
|
|
89
|
+
* /* response is
|
|
90
|
+
* { /* metadata only *\/ }
|
|
91
|
+
* *\/
|
|
90
92
|
* ```
|
|
91
93
|
*
|
|
94
|
+
* @public
|
|
92
95
|
*/
|
|
93
96
|
export declare class RemoveTagsFromVaultCommand extends RemoveTagsFromVaultCommand_base {
|
|
94
97
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -74,26 +74,29 @@ declare const SetDataRetrievalPolicyCommand_base: {
|
|
|
74
74
|
* @throws {@link GlacierServiceException}
|
|
75
75
|
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
76
76
|
*
|
|
77
|
-
*
|
|
77
|
+
*
|
|
78
78
|
* @example To set and then enact a data retrieval policy
|
|
79
79
|
* ```javascript
|
|
80
80
|
* // The example sets and then enacts a data retrieval policy.
|
|
81
81
|
* const input = {
|
|
82
|
-
*
|
|
83
|
-
*
|
|
82
|
+
* Policy: {
|
|
83
|
+
* Rules: [
|
|
84
84
|
* {
|
|
85
|
-
*
|
|
86
|
-
*
|
|
85
|
+
* BytesPerHour: 10737418240,
|
|
86
|
+
* Strategy: "BytesPerHour"
|
|
87
87
|
* }
|
|
88
88
|
* ]
|
|
89
89
|
* },
|
|
90
|
-
*
|
|
90
|
+
* accountId: "-"
|
|
91
91
|
* };
|
|
92
92
|
* const command = new SetDataRetrievalPolicyCommand(input);
|
|
93
|
-
* await client.send(command);
|
|
94
|
-
*
|
|
93
|
+
* const response = await client.send(command);
|
|
94
|
+
* /* response is
|
|
95
|
+
* { /* metadata only *\/ }
|
|
96
|
+
* *\/
|
|
95
97
|
* ```
|
|
96
98
|
*
|
|
99
|
+
* @public
|
|
97
100
|
*/
|
|
98
101
|
export declare class SetDataRetrievalPolicyCommand extends SetDataRetrievalPolicyCommand_base {
|
|
99
102
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -74,22 +74,25 @@ declare const SetVaultAccessPolicyCommand_base: {
|
|
|
74
74
|
* @throws {@link GlacierServiceException}
|
|
75
75
|
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
76
76
|
*
|
|
77
|
-
*
|
|
77
|
+
*
|
|
78
78
|
* @example To set the access-policy on a vault
|
|
79
79
|
* ```javascript
|
|
80
80
|
* // The example configures an access policy for the vault named examplevault.
|
|
81
81
|
* const input = {
|
|
82
|
-
*
|
|
83
|
-
*
|
|
84
|
-
*
|
|
82
|
+
* accountId: "-",
|
|
83
|
+
* policy: {
|
|
84
|
+
* Policy: `{"Version":"2012-10-17","Statement":[{"Sid":"Define-owner-access-rights","Effect":"Allow","Principal":{"AWS":"arn:aws:iam::999999999999:root"},"Action":"glacier:DeleteArchive","Resource":"arn:aws:glacier:us-west-2:999999999999:vaults/examplevault"}]}`
|
|
85
85
|
* },
|
|
86
|
-
*
|
|
86
|
+
* vaultName: "examplevault"
|
|
87
87
|
* };
|
|
88
88
|
* const command = new SetVaultAccessPolicyCommand(input);
|
|
89
|
-
* await client.send(command);
|
|
90
|
-
*
|
|
89
|
+
* const response = await client.send(command);
|
|
90
|
+
* /* response is
|
|
91
|
+
* { /* metadata only *\/ }
|
|
92
|
+
* *\/
|
|
91
93
|
* ```
|
|
92
94
|
*
|
|
95
|
+
* @public
|
|
93
96
|
*/
|
|
94
97
|
export declare class SetVaultAccessPolicyCommand extends SetVaultAccessPolicyCommand_base {
|
|
95
98
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -109,26 +109,29 @@ declare const SetVaultNotificationsCommand_base: {
|
|
|
109
109
|
* @throws {@link GlacierServiceException}
|
|
110
110
|
* <p>Base exception class for all service exceptions from Glacier service.</p>
|
|
111
111
|
*
|
|
112
|
-
*
|
|
112
|
+
*
|
|
113
113
|
* @example To configure a vault to post a message to an Amazon SNS topic when jobs complete
|
|
114
114
|
* ```javascript
|
|
115
115
|
* // The example sets the examplevault notification configuration.
|
|
116
116
|
* const input = {
|
|
117
|
-
*
|
|
118
|
-
*
|
|
119
|
-
*
|
|
120
|
-
*
|
|
117
|
+
* accountId: "-",
|
|
118
|
+
* vaultName: "examplevault",
|
|
119
|
+
* vaultNotificationConfig: {
|
|
120
|
+
* Events: [
|
|
121
121
|
* "ArchiveRetrievalCompleted",
|
|
122
122
|
* "InventoryRetrievalCompleted"
|
|
123
123
|
* ],
|
|
124
|
-
*
|
|
124
|
+
* SNSTopic: "arn:aws:sns:us-west-2:012345678901:mytopic"
|
|
125
125
|
* }
|
|
126
126
|
* };
|
|
127
127
|
* const command = new SetVaultNotificationsCommand(input);
|
|
128
|
-
* await client.send(command);
|
|
129
|
-
*
|
|
128
|
+
* const response = await client.send(command);
|
|
129
|
+
* /* response is
|
|
130
|
+
* { /* metadata only *\/ }
|
|
131
|
+
* *\/
|
|
130
132
|
* ```
|
|
131
133
|
*
|
|
134
|
+
* @public
|
|
132
135
|
*/
|
|
133
136
|
export declare class SetVaultNotificationsCommand extends SetVaultNotificationsCommand_base {
|
|
134
137
|
/** @internal type navigation helper, not in runtime. */
|