@aws-sdk/client-ebs 3.35.0 → 3.38.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 (129) hide show
  1. package/CHANGELOG.md +47 -0
  2. package/dist-cjs/EBS.js +0 -23
  3. package/dist-cjs/EBSClient.js +0 -28
  4. package/dist-cjs/commands/CompleteSnapshotCommand.js +0 -27
  5. package/dist-cjs/commands/GetSnapshotBlockCommand.js +0 -25
  6. package/dist-cjs/commands/ListChangedBlocksCommand.js +0 -26
  7. package/dist-cjs/commands/ListSnapshotBlocksCommand.js +0 -25
  8. package/dist-cjs/commands/PutSnapshotBlockCommand.js +0 -28
  9. package/dist-cjs/commands/StartSnapshotCommand.js +0 -28
  10. package/dist-cjs/commands/index.js +9 -0
  11. package/dist-cjs/endpoints.js +1 -2
  12. package/dist-cjs/index.js +4 -12
  13. package/dist-cjs/models/index.js +0 -1
  14. package/dist-cjs/models/models_0.js +0 -70
  15. package/dist-cjs/pagination/Interfaces.js +0 -1
  16. package/dist-cjs/pagination/ListChangedBlocksPaginator.js +0 -11
  17. package/dist-cjs/pagination/ListSnapshotBlocksPaginator.js +0 -11
  18. package/dist-cjs/pagination/index.js +6 -0
  19. package/dist-cjs/protocols/Aws_restJson1.js +0 -6
  20. package/dist-cjs/runtimeConfig.browser.js +1 -6
  21. package/dist-cjs/runtimeConfig.js +2 -7
  22. package/dist-cjs/runtimeConfig.native.js +0 -4
  23. package/dist-cjs/runtimeConfig.shared.js +0 -4
  24. package/dist-es/EBS.js +0 -1
  25. package/dist-es/EBSClient.js +0 -1
  26. package/dist-es/commands/CompleteSnapshotCommand.js +0 -1
  27. package/dist-es/commands/GetSnapshotBlockCommand.js +0 -1
  28. package/dist-es/commands/ListChangedBlocksCommand.js +0 -1
  29. package/dist-es/commands/ListSnapshotBlocksCommand.js +0 -1
  30. package/dist-es/commands/PutSnapshotBlockCommand.js +0 -1
  31. package/dist-es/commands/StartSnapshotCommand.js +0 -1
  32. package/dist-es/commands/index.js +6 -0
  33. package/dist-es/endpoints.js +1 -2
  34. package/dist-es/index.js +4 -12
  35. package/dist-es/models/index.js +0 -1
  36. package/dist-es/models/models_0.js +0 -1
  37. package/dist-es/pagination/Interfaces.js +0 -1
  38. package/dist-es/pagination/ListChangedBlocksPaginator.js +0 -1
  39. package/dist-es/pagination/ListSnapshotBlocksPaginator.js +0 -1
  40. package/dist-es/pagination/index.js +3 -0
  41. package/dist-es/protocols/Aws_restJson1.js +0 -1
  42. package/dist-es/runtimeConfig.browser.js +1 -2
  43. package/dist-es/runtimeConfig.js +2 -3
  44. package/dist-es/runtimeConfig.native.js +0 -1
  45. package/dist-es/runtimeConfig.shared.js +0 -1
  46. package/dist-types/commands/index.d.ts +6 -0
  47. package/dist-types/index.d.ts +4 -11
  48. package/dist-types/pagination/index.d.ts +3 -0
  49. package/dist-types/ts3.4/EBS.d.ts +7 -49
  50. package/dist-types/ts3.4/EBSClient.d.ts +24 -108
  51. package/dist-types/ts3.4/commands/CompleteSnapshotCommand.d.ts +2 -22
  52. package/dist-types/ts3.4/commands/GetSnapshotBlockCommand.d.ts +2 -20
  53. package/dist-types/ts3.4/commands/ListChangedBlocksCommand.d.ts +2 -21
  54. package/dist-types/ts3.4/commands/ListSnapshotBlocksCommand.d.ts +2 -20
  55. package/dist-types/ts3.4/commands/PutSnapshotBlockCommand.d.ts +5 -30
  56. package/dist-types/ts3.4/commands/StartSnapshotCommand.d.ts +2 -23
  57. package/dist-types/ts3.4/commands/index.d.ts +6 -0
  58. package/dist-types/ts3.4/index.d.ts +4 -11
  59. package/dist-types/ts3.4/models/models_0.d.ts +106 -416
  60. package/dist-types/ts3.4/pagination/index.d.ts +3 -0
  61. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -3
  62. package/dist-types/ts3.4/runtimeConfig.d.ts +1 -3
  63. package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -3
  64. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +1 -3
  65. package/package.json +33 -30
  66. package/dist-cjs/EBS.js.map +0 -1
  67. package/dist-cjs/EBSClient.js.map +0 -1
  68. package/dist-cjs/commands/CompleteSnapshotCommand.js.map +0 -1
  69. package/dist-cjs/commands/GetSnapshotBlockCommand.js.map +0 -1
  70. package/dist-cjs/commands/ListChangedBlocksCommand.js.map +0 -1
  71. package/dist-cjs/commands/ListSnapshotBlocksCommand.js.map +0 -1
  72. package/dist-cjs/commands/PutSnapshotBlockCommand.js.map +0 -1
  73. package/dist-cjs/commands/StartSnapshotCommand.js.map +0 -1
  74. package/dist-cjs/endpoints.js.map +0 -1
  75. package/dist-cjs/index.js.map +0 -1
  76. package/dist-cjs/models/index.js.map +0 -1
  77. package/dist-cjs/models/models_0.js.map +0 -1
  78. package/dist-cjs/pagination/Interfaces.js.map +0 -1
  79. package/dist-cjs/pagination/ListChangedBlocksPaginator.js.map +0 -1
  80. package/dist-cjs/pagination/ListSnapshotBlocksPaginator.js.map +0 -1
  81. package/dist-cjs/protocols/Aws_restJson1.js.map +0 -1
  82. package/dist-cjs/runtimeConfig.browser.js.map +0 -1
  83. package/dist-cjs/runtimeConfig.js.map +0 -1
  84. package/dist-cjs/runtimeConfig.native.js.map +0 -1
  85. package/dist-cjs/runtimeConfig.shared.js.map +0 -1
  86. package/dist-es/EBS.js.map +0 -1
  87. package/dist-es/EBSClient.js.map +0 -1
  88. package/dist-es/commands/CompleteSnapshotCommand.js.map +0 -1
  89. package/dist-es/commands/GetSnapshotBlockCommand.js.map +0 -1
  90. package/dist-es/commands/ListChangedBlocksCommand.js.map +0 -1
  91. package/dist-es/commands/ListSnapshotBlocksCommand.js.map +0 -1
  92. package/dist-es/commands/PutSnapshotBlockCommand.js.map +0 -1
  93. package/dist-es/commands/StartSnapshotCommand.js.map +0 -1
  94. package/dist-es/endpoints.js.map +0 -1
  95. package/dist-es/index.js.map +0 -1
  96. package/dist-es/models/index.js.map +0 -1
  97. package/dist-es/models/models_0.js.map +0 -1
  98. package/dist-es/pagination/Interfaces.js.map +0 -1
  99. package/dist-es/pagination/ListChangedBlocksPaginator.js.map +0 -1
  100. package/dist-es/pagination/ListSnapshotBlocksPaginator.js.map +0 -1
  101. package/dist-es/protocols/Aws_restJson1.js.map +0 -1
  102. package/dist-es/runtimeConfig.browser.js.map +0 -1
  103. package/dist-es/runtimeConfig.js.map +0 -1
  104. package/dist-es/runtimeConfig.native.js.map +0 -1
  105. package/dist-es/runtimeConfig.shared.js.map +0 -1
  106. package/jest.config.js +0 -4
  107. package/src/EBS.ts +0 -258
  108. package/src/EBSClient.ts +0 -273
  109. package/src/commands/CompleteSnapshotCommand.ts +0 -97
  110. package/src/commands/GetSnapshotBlockCommand.ts +0 -95
  111. package/src/commands/ListChangedBlocksCommand.ts +0 -96
  112. package/src/commands/ListSnapshotBlocksCommand.ts +0 -95
  113. package/src/commands/PutSnapshotBlockCommand.ts +0 -107
  114. package/src/commands/StartSnapshotCommand.ts +0 -98
  115. package/src/endpoints.ts +0 -83
  116. package/src/index.ts +0 -12
  117. package/src/models/index.ts +0 -1
  118. package/src/models/models_0.ts +0 -824
  119. package/src/pagination/Interfaces.ts +0 -8
  120. package/src/pagination/ListChangedBlocksPaginator.ts +0 -59
  121. package/src/pagination/ListSnapshotBlocksPaginator.ts +0 -59
  122. package/src/protocols/Aws_restJson1.ts +0 -1238
  123. package/src/runtimeConfig.browser.ts +0 -41
  124. package/src/runtimeConfig.native.ts +0 -17
  125. package/src/runtimeConfig.shared.ts +0 -17
  126. package/src/runtimeConfig.ts +0 -46
  127. package/tsconfig.es.json +0 -10
  128. package/tsconfig.json +0 -33
  129. package/tsconfig.types.json +0 -9
@@ -1,824 +0,0 @@
1
- import { SENSITIVE_STRING } from "@aws-sdk/smithy-client";
2
- import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
3
- import { Readable } from "stream";
4
-
5
- export enum AccessDeniedExceptionReason {
6
- DEPENDENCY_ACCESS_DENIED = "DEPENDENCY_ACCESS_DENIED",
7
- UNAUTHORIZED_ACCOUNT = "UNAUTHORIZED_ACCOUNT",
8
- }
9
-
10
- /**
11
- * <p>You do not have sufficient access to perform this action.</p>
12
- */
13
- export interface AccessDeniedException extends __SmithyException, $MetadataBearer {
14
- name: "AccessDeniedException";
15
- $fault: "client";
16
- Message?: string;
17
- /**
18
- * <p>The reason for the exception.</p>
19
- */
20
- Reason: AccessDeniedExceptionReason | string | undefined;
21
- }
22
-
23
- export namespace AccessDeniedException {
24
- /**
25
- * @internal
26
- */
27
- export const filterSensitiveLog = (obj: AccessDeniedException): any => ({
28
- ...obj,
29
- });
30
- }
31
-
32
- /**
33
- * <p>A block of data in an Amazon Elastic Block Store snapshot.</p>
34
- */
35
- export interface Block {
36
- /**
37
- * <p>The block index.</p>
38
- */
39
- BlockIndex?: number;
40
-
41
- /**
42
- * <p>The block token for the block index.</p>
43
- */
44
- BlockToken?: string;
45
- }
46
-
47
- export namespace Block {
48
- /**
49
- * @internal
50
- */
51
- export const filterSensitiveLog = (obj: Block): any => ({
52
- ...obj,
53
- });
54
- }
55
-
56
- /**
57
- * <p>A block of data in an Amazon Elastic Block Store snapshot that is different from another snapshot of
58
- * the same volume/snapshot lineage.</p>
59
- */
60
- export interface ChangedBlock {
61
- /**
62
- * <p>The block index.</p>
63
- */
64
- BlockIndex?: number;
65
-
66
- /**
67
- * <p>The block token for the block index of the <code>FirstSnapshotId</code> specified in
68
- * the <code>ListChangedBlocks</code> operation. This value is absent if the first snapshot
69
- * does not have the changed block that is on the second snapshot.</p>
70
- */
71
- FirstBlockToken?: string;
72
-
73
- /**
74
- * <p>The block token for the block index of the <code>SecondSnapshotId</code> specified in
75
- * the <code>ListChangedBlocks</code> operation.</p>
76
- */
77
- SecondBlockToken?: string;
78
- }
79
-
80
- export namespace ChangedBlock {
81
- /**
82
- * @internal
83
- */
84
- export const filterSensitiveLog = (obj: ChangedBlock): any => ({
85
- ...obj,
86
- });
87
- }
88
-
89
- export enum ChecksumAggregationMethod {
90
- CHECKSUM_AGGREGATION_LINEAR = "LINEAR",
91
- }
92
-
93
- export enum ChecksumAlgorithm {
94
- CHECKSUM_ALGORITHM_SHA256 = "SHA256",
95
- }
96
-
97
- export interface CompleteSnapshotRequest {
98
- /**
99
- * <p>The ID of the snapshot.</p>
100
- */
101
- SnapshotId: string | undefined;
102
-
103
- /**
104
- * <p>The number of blocks that were written to the snapshot.</p>
105
- */
106
- ChangedBlocksCount: number | undefined;
107
-
108
- /**
109
- * <p>An aggregated Base-64 SHA256 checksum based on the checksums of each written
110
- * block.</p>
111
- * <p>To generate the aggregated checksum using the linear aggregation method, arrange the
112
- * checksums for each written block in ascending order of their block index, concatenate
113
- * them to form a single string, and then generate the checksum on the entire string using
114
- * the SHA256 algorithm.</p>
115
- */
116
- Checksum?: string;
117
-
118
- /**
119
- * <p>The algorithm used to generate the checksum. Currently, the only supported algorithm
120
- * is <code>SHA256</code>.</p>
121
- */
122
- ChecksumAlgorithm?: ChecksumAlgorithm | string;
123
-
124
- /**
125
- * <p>The aggregation method used to generate the checksum. Currently, the only supported
126
- * aggregation method is <code>LINEAR</code>.</p>
127
- */
128
- ChecksumAggregationMethod?: ChecksumAggregationMethod | string;
129
- }
130
-
131
- export namespace CompleteSnapshotRequest {
132
- /**
133
- * @internal
134
- */
135
- export const filterSensitiveLog = (obj: CompleteSnapshotRequest): any => ({
136
- ...obj,
137
- });
138
- }
139
-
140
- export enum Status {
141
- COMPLETED = "completed",
142
- ERROR = "error",
143
- PENDING = "pending",
144
- }
145
-
146
- export interface CompleteSnapshotResponse {
147
- /**
148
- * <p>The status of the snapshot.</p>
149
- */
150
- Status?: Status | string;
151
- }
152
-
153
- export namespace CompleteSnapshotResponse {
154
- /**
155
- * @internal
156
- */
157
- export const filterSensitiveLog = (obj: CompleteSnapshotResponse): any => ({
158
- ...obj,
159
- });
160
- }
161
-
162
- /**
163
- * <p>An internal error has occurred.</p>
164
- */
165
- export interface InternalServerException extends __SmithyException, $MetadataBearer {
166
- name: "InternalServerException";
167
- $fault: "server";
168
- Message?: string;
169
- }
170
-
171
- export namespace InternalServerException {
172
- /**
173
- * @internal
174
- */
175
- export const filterSensitiveLog = (obj: InternalServerException): any => ({
176
- ...obj,
177
- });
178
- }
179
-
180
- export enum RequestThrottledExceptionReason {
181
- ACCOUNT_THROTTLED = "ACCOUNT_THROTTLED",
182
- DEPENDENCY_REQUEST_THROTTLED = "DEPENDENCY_REQUEST_THROTTLED",
183
- }
184
-
185
- /**
186
- * <p>The number of API requests has exceed the maximum allowed API request throttling
187
- * limit.</p>
188
- */
189
- export interface RequestThrottledException extends __SmithyException, $MetadataBearer {
190
- name: "RequestThrottledException";
191
- $fault: "client";
192
- Message?: string;
193
- /**
194
- * <p>The reason for the exception.</p>
195
- */
196
- Reason?: RequestThrottledExceptionReason | string;
197
- }
198
-
199
- export namespace RequestThrottledException {
200
- /**
201
- * @internal
202
- */
203
- export const filterSensitiveLog = (obj: RequestThrottledException): any => ({
204
- ...obj,
205
- });
206
- }
207
-
208
- export enum ResourceNotFoundExceptionReason {
209
- DEPENDENCY_RESOURCE_NOT_FOUND = "DEPENDENCY_RESOURCE_NOT_FOUND",
210
- SNAPSHOT_NOT_FOUND = "SNAPSHOT_NOT_FOUND",
211
- }
212
-
213
- /**
214
- * <p>The specified resource does not exist.</p>
215
- */
216
- export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer {
217
- name: "ResourceNotFoundException";
218
- $fault: "client";
219
- Message?: string;
220
- /**
221
- * <p>The reason for the exception.</p>
222
- */
223
- Reason?: ResourceNotFoundExceptionReason | string;
224
- }
225
-
226
- export namespace ResourceNotFoundException {
227
- /**
228
- * @internal
229
- */
230
- export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({
231
- ...obj,
232
- });
233
- }
234
-
235
- export enum ServiceQuotaExceededExceptionReason {
236
- DEPENDENCY_SERVICE_QUOTA_EXCEEDED = "DEPENDENCY_SERVICE_QUOTA_EXCEEDED",
237
- }
238
-
239
- /**
240
- * <p>Your current service quotas do not allow you to perform this action.</p>
241
- */
242
- export interface ServiceQuotaExceededException extends __SmithyException, $MetadataBearer {
243
- name: "ServiceQuotaExceededException";
244
- $fault: "client";
245
- Message?: string;
246
- /**
247
- * <p>The reason for the exception.</p>
248
- */
249
- Reason?: ServiceQuotaExceededExceptionReason | string;
250
- }
251
-
252
- export namespace ServiceQuotaExceededException {
253
- /**
254
- * @internal
255
- */
256
- export const filterSensitiveLog = (obj: ServiceQuotaExceededException): any => ({
257
- ...obj,
258
- });
259
- }
260
-
261
- export enum ValidationExceptionReason {
262
- INVALID_BLOCK = "INVALID_BLOCK",
263
- INVALID_BLOCK_TOKEN = "INVALID_BLOCK_TOKEN",
264
- INVALID_CONTENT_ENCODING = "INVALID_CONTENT_ENCODING",
265
- INVALID_CUSTOMER_KEY = "INVALID_CUSTOMER_KEY",
266
- INVALID_DEPENDENCY_REQUEST = "INVALID_DEPENDENCY_REQUEST",
267
- INVALID_PAGE_TOKEN = "INVALID_PAGE_TOKEN",
268
- INVALID_PARAMETER_VALUE = "INVALID_PARAMETER_VALUE",
269
- INVALID_SNAPSHOT_ID = "INVALID_SNAPSHOT_ID",
270
- INVALID_TAG = "INVALID_TAG",
271
- INVALID_VOLUME_SIZE = "INVALID_VOLUME_SIZE",
272
- UNRELATED_SNAPSHOTS = "UNRELATED_SNAPSHOTS",
273
- }
274
-
275
- /**
276
- * <p>The input fails to satisfy the constraints of the EBS direct APIs.</p>
277
- */
278
- export interface ValidationException extends __SmithyException, $MetadataBearer {
279
- name: "ValidationException";
280
- $fault: "client";
281
- Message?: string;
282
- /**
283
- * <p>The reason for the validation exception.</p>
284
- */
285
- Reason?: ValidationExceptionReason | string;
286
- }
287
-
288
- export namespace ValidationException {
289
- /**
290
- * @internal
291
- */
292
- export const filterSensitiveLog = (obj: ValidationException): any => ({
293
- ...obj,
294
- });
295
- }
296
-
297
- /**
298
- * <p>You have reached the limit for concurrent API requests. For more information, see
299
- * <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-accessing-snapshot.html#ebsapi-performance">Optimizing performance of the EBS direct APIs</a> in the <i>Amazon Elastic Compute Cloud
300
- * User Guide</i>.</p>
301
- */
302
- export interface ConcurrentLimitExceededException extends __SmithyException, $MetadataBearer {
303
- name: "ConcurrentLimitExceededException";
304
- $fault: "client";
305
- Message?: string;
306
- }
307
-
308
- export namespace ConcurrentLimitExceededException {
309
- /**
310
- * @internal
311
- */
312
- export const filterSensitiveLog = (obj: ConcurrentLimitExceededException): any => ({
313
- ...obj,
314
- });
315
- }
316
-
317
- /**
318
- * <p>The request uses the same client token as a previous, but non-identical
319
- * request.</p>
320
- */
321
- export interface ConflictException extends __SmithyException, $MetadataBearer {
322
- name: "ConflictException";
323
- $fault: "server";
324
- Message?: string;
325
- }
326
-
327
- export namespace ConflictException {
328
- /**
329
- * @internal
330
- */
331
- export const filterSensitiveLog = (obj: ConflictException): any => ({
332
- ...obj,
333
- });
334
- }
335
-
336
- export interface GetSnapshotBlockRequest {
337
- /**
338
- * <p>The ID of the snapshot containing the block from which to get data.</p>
339
- */
340
- SnapshotId: string | undefined;
341
-
342
- /**
343
- * <p>The block index of the block from which to get data.</p>
344
- *
345
- *
346
- * <p>Obtain the <code>BlockIndex</code> by running the <code>ListChangedBlocks</code> or
347
- * <code>ListSnapshotBlocks</code> operations.</p>
348
- */
349
- BlockIndex: number | undefined;
350
-
351
- /**
352
- * <p>The block token of the block from which to get data.</p>
353
- *
354
- *
355
- * <p>Obtain the <code>BlockToken</code> by running the <code>ListChangedBlocks</code> or
356
- * <code>ListSnapshotBlocks</code> operations.</p>
357
- */
358
- BlockToken: string | undefined;
359
- }
360
-
361
- export namespace GetSnapshotBlockRequest {
362
- /**
363
- * @internal
364
- */
365
- export const filterSensitiveLog = (obj: GetSnapshotBlockRequest): any => ({
366
- ...obj,
367
- });
368
- }
369
-
370
- export interface GetSnapshotBlockResponse {
371
- /**
372
- * <p>The size of the data in the block.</p>
373
- */
374
- DataLength?: number;
375
-
376
- /**
377
- * <p>The data content of the block.</p>
378
- */
379
- BlockData?: Readable | ReadableStream | Blob;
380
-
381
- /**
382
- * <p>The checksum generated for the block, which is Base64 encoded.</p>
383
- */
384
- Checksum?: string;
385
-
386
- /**
387
- * <p>The algorithm used to generate the checksum for the block, such as SHA256.</p>
388
- */
389
- ChecksumAlgorithm?: ChecksumAlgorithm | string;
390
- }
391
-
392
- export namespace GetSnapshotBlockResponse {
393
- /**
394
- * @internal
395
- */
396
- export const filterSensitiveLog = (obj: GetSnapshotBlockResponse): any => ({
397
- ...obj,
398
- ...(obj.BlockData && { BlockData: SENSITIVE_STRING }),
399
- });
400
- }
401
-
402
- export interface ListChangedBlocksRequest {
403
- /**
404
- * <p>The ID of the first snapshot to use for the comparison.</p>
405
- * <important>
406
- * <p>The <code>FirstSnapshotID</code> parameter must be specified with a
407
- * <code>SecondSnapshotId</code> parameter; otherwise, an error occurs.</p>
408
- * </important>
409
- */
410
- FirstSnapshotId?: string;
411
-
412
- /**
413
- * <p>The ID of the second snapshot to use for the comparison.</p>
414
- * <important>
415
- * <p>The <code>SecondSnapshotId</code> parameter must be specified with a
416
- * <code>FirstSnapshotID</code> parameter; otherwise, an error occurs.</p>
417
- * </important>
418
- */
419
- SecondSnapshotId: string | undefined;
420
-
421
- /**
422
- * <p>The token to request the next page of results.</p>
423
- */
424
- NextToken?: string;
425
-
426
- /**
427
- * <p>The number of results to return.</p>
428
- */
429
- MaxResults?: number;
430
-
431
- /**
432
- * <p>The block index from which the comparison should start.</p>
433
- * <p>The list in the response will start from this block index or the next valid block
434
- * index in the snapshots.</p>
435
- */
436
- StartingBlockIndex?: number;
437
- }
438
-
439
- export namespace ListChangedBlocksRequest {
440
- /**
441
- * @internal
442
- */
443
- export const filterSensitiveLog = (obj: ListChangedBlocksRequest): any => ({
444
- ...obj,
445
- });
446
- }
447
-
448
- export interface ListChangedBlocksResponse {
449
- /**
450
- * <p>An array of objects containing information about the changed blocks.</p>
451
- */
452
- ChangedBlocks?: ChangedBlock[];
453
-
454
- /**
455
- * <p>The time when the <code>BlockToken</code> expires.</p>
456
- */
457
- ExpiryTime?: Date;
458
-
459
- /**
460
- * <p>The size of the volume in GB.</p>
461
- */
462
- VolumeSize?: number;
463
-
464
- /**
465
- * <p>The size of the blocks in the snapshot, in bytes.</p>
466
- */
467
- BlockSize?: number;
468
-
469
- /**
470
- * <p>The token to use to retrieve the next page of results. This value is null when there
471
- * are no more results to return.</p>
472
- */
473
- NextToken?: string;
474
- }
475
-
476
- export namespace ListChangedBlocksResponse {
477
- /**
478
- * @internal
479
- */
480
- export const filterSensitiveLog = (obj: ListChangedBlocksResponse): any => ({
481
- ...obj,
482
- ...(obj.ChangedBlocks && { ChangedBlocks: SENSITIVE_STRING }),
483
- });
484
- }
485
-
486
- export interface ListSnapshotBlocksRequest {
487
- /**
488
- * <p>The ID of the snapshot from which to get block indexes and block tokens.</p>
489
- */
490
- SnapshotId: string | undefined;
491
-
492
- /**
493
- * <p>The token to request the next page of results.</p>
494
- */
495
- NextToken?: string;
496
-
497
- /**
498
- * <p>The number of results to return.</p>
499
- */
500
- MaxResults?: number;
501
-
502
- /**
503
- * <p>The block index from which the list should start. The list in the response will start
504
- * from this block index or the next valid block index in the snapshot.</p>
505
- */
506
- StartingBlockIndex?: number;
507
- }
508
-
509
- export namespace ListSnapshotBlocksRequest {
510
- /**
511
- * @internal
512
- */
513
- export const filterSensitiveLog = (obj: ListSnapshotBlocksRequest): any => ({
514
- ...obj,
515
- });
516
- }
517
-
518
- export interface ListSnapshotBlocksResponse {
519
- /**
520
- * <p>An array of objects containing information about the blocks.</p>
521
- */
522
- Blocks?: Block[];
523
-
524
- /**
525
- * <p>The time when the <code>BlockToken</code> expires.</p>
526
- */
527
- ExpiryTime?: Date;
528
-
529
- /**
530
- * <p>The size of the volume in GB.</p>
531
- */
532
- VolumeSize?: number;
533
-
534
- /**
535
- * <p>The size of the blocks in the snapshot, in bytes.</p>
536
- */
537
- BlockSize?: number;
538
-
539
- /**
540
- * <p>The token to use to retrieve the next page of results. This value is null when there
541
- * are no more results to return.</p>
542
- */
543
- NextToken?: string;
544
- }
545
-
546
- export namespace ListSnapshotBlocksResponse {
547
- /**
548
- * @internal
549
- */
550
- export const filterSensitiveLog = (obj: ListSnapshotBlocksResponse): any => ({
551
- ...obj,
552
- ...(obj.Blocks && { Blocks: SENSITIVE_STRING }),
553
- });
554
- }
555
-
556
- export interface PutSnapshotBlockRequest {
557
- /**
558
- * <p>The ID of the snapshot.</p>
559
- */
560
- SnapshotId: string | undefined;
561
-
562
- /**
563
- * <p>The block index of the block in which to write the data. A block index is a logical
564
- * index in units of <code>512</code> KiB blocks. To identify the block index, divide
565
- * the logical offset of the data in the logical volume by the block size (logical offset of
566
- * data/<code>524288</code>). The logical offset of the data must be <code>512</code>
567
- * KiB aligned.</p>
568
- */
569
- BlockIndex: number | undefined;
570
-
571
- /**
572
- * <p>The data to write to the block.</p>
573
- * <p>The block data is not signed as part of the Signature Version 4 signing process. As a
574
- * result, you must generate and provide a Base64-encoded SHA256 checksum for the block
575
- * data using the <b>x-amz-Checksum</b> header. Also, you
576
- * must specify the checksum algorithm using the <b>x-amz-Checksum-Algorithm</b>
577
- * header. The checksum that you provide is part of the Signature Version 4 signing process.
578
- * It is validated against a checksum generated by Amazon EBS to ensure the validity and authenticity
579
- * of the data. If the checksums do not correspond, the request fails. For more information,
580
- * see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-accessing-snapshot.html#ebsapis-using-checksums">
581
- * Using checksums with the EBS direct APIs</a> in the <i>Amazon Elastic Compute Cloud User
582
- * Guide</i>.</p>
583
- */
584
- BlockData: Readable | ReadableStream | Blob | undefined;
585
-
586
- /**
587
- * <p>The size of the data to write to the block, in bytes. Currently, the only supported
588
- * size is <code>524288</code> bytes.</p>
589
- * <p>Valid values: <code>524288</code>
590
- * </p>
591
- */
592
- DataLength: number | undefined;
593
-
594
- /**
595
- * <p>The progress of the write process, as a percentage.</p>
596
- */
597
- Progress?: number;
598
-
599
- /**
600
- * <p>A Base64-encoded SHA256 checksum of the data. Only SHA256 checksums are
601
- * supported.</p>
602
- */
603
- Checksum: string | undefined;
604
-
605
- /**
606
- * <p>The algorithm used to generate the checksum. Currently, the only supported algorithm
607
- * is <code>SHA256</code>.</p>
608
- */
609
- ChecksumAlgorithm: ChecksumAlgorithm | string | undefined;
610
- }
611
-
612
- export namespace PutSnapshotBlockRequest {
613
- /**
614
- * @internal
615
- */
616
- export const filterSensitiveLog = (obj: PutSnapshotBlockRequest): any => ({
617
- ...obj,
618
- ...(obj.BlockData && { BlockData: SENSITIVE_STRING }),
619
- });
620
- }
621
-
622
- export interface PutSnapshotBlockResponse {
623
- /**
624
- * <p>The SHA256 checksum generated for the block data by Amazon EBS.</p>
625
- */
626
- Checksum?: string;
627
-
628
- /**
629
- * <p>The algorithm used by Amazon EBS to generate the checksum.</p>
630
- */
631
- ChecksumAlgorithm?: ChecksumAlgorithm | string;
632
- }
633
-
634
- export namespace PutSnapshotBlockResponse {
635
- /**
636
- * @internal
637
- */
638
- export const filterSensitiveLog = (obj: PutSnapshotBlockResponse): any => ({
639
- ...obj,
640
- });
641
- }
642
-
643
- /**
644
- * <p>Describes a tag.</p>
645
- */
646
- export interface Tag {
647
- /**
648
- * <p>The key of the tag.</p>
649
- */
650
- Key?: string;
651
-
652
- /**
653
- * <p>The value of the tag.</p>
654
- */
655
- Value?: string;
656
- }
657
-
658
- export namespace Tag {
659
- /**
660
- * @internal
661
- */
662
- export const filterSensitiveLog = (obj: Tag): any => ({
663
- ...obj,
664
- });
665
- }
666
-
667
- export interface StartSnapshotRequest {
668
- /**
669
- * <p>The size of the volume, in GiB. The maximum size is <code>65536</code> GiB (64
670
- * TiB).</p>
671
- */
672
- VolumeSize: number | undefined;
673
-
674
- /**
675
- * <p>The ID of the parent snapshot. If there is no parent snapshot, or if you are creating
676
- * the first snapshot for an on-premises volume, omit this parameter.</p>
677
- * <p>If your account is enabled for encryption by default, you cannot use an unencrypted
678
- * snapshot as a parent snapshot. You must first create an encrypted copy of the parent
679
- * snapshot using <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CopySnapshot.html">CopySnapshot</a>.</p>
680
- */
681
- ParentSnapshotId?: string;
682
-
683
- /**
684
- * <p>The tags to apply to the snapshot.</p>
685
- */
686
- Tags?: Tag[];
687
-
688
- /**
689
- * <p>A description for the snapshot.</p>
690
- */
691
- Description?: string;
692
-
693
- /**
694
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
695
- * request. Idempotency ensures that an API request completes only once. With an idempotent
696
- * request, if the original request completes successfully. The subsequent retries with the same
697
- * client token return the result from the original successful request and they have no additional
698
- * effect.</p>
699
- * <p>If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.</p>
700
- * <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-direct-api-idempotency.html">
701
- * Idempotency for StartSnapshot API</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
702
- */
703
- ClientToken?: string;
704
-
705
- /**
706
- * <p>Indicates whether to encrypt the snapshot. To create an encrypted snapshot, specify
707
- * <code>true</code>. To create an unencrypted snapshot, omit this parameter.</p>
708
- * <p>If you specify a value for <b>ParentSnapshotId</b>, omit
709
- * this parameter.</p>
710
- * <p>If you specify <code>true</code>, the snapshot is encrypted using the KMS key specified
711
- * using the <b>KmsKeyArn</b> parameter. If no value is specified
712
- * for <b>KmsKeyArn</b>, the default KMS key for your account is
713
- * used. If no default KMS key has been specified for your account, the Amazon Web Services managed KMS key is used.
714
- * To set a default KMS key for your account, use <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyEbsDefaultKmsKeyId.html">
715
- * ModifyEbsDefaultKmsKeyId</a>.</p>
716
- * <p>If your account is enabled for encryption by default, you cannot set this parameter to
717
- * <code>false</code>. In this case, you can omit this parameter.</p>
718
- *
719
- * <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-accessing-snapshot.html#ebsapis-using-encryption">
720
- * Using encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
721
- */
722
- Encrypted?: boolean;
723
-
724
- /**
725
- * <p>The Amazon Resource Name (ARN) of the Key Management Service (KMS)
726
- * key to be used to encrypt the snapshot. If you do not specify a
727
- * KMS key, the default Amazon Web Services managed KMS key is used.</p>
728
- * <p>If you specify a <b>ParentSnapshotId</b>, omit this
729
- * parameter; the snapshot will be encrypted using the same KMS key that was used to encrypt
730
- * the parent snapshot.</p>
731
- * <p>If <b>Encrypted</b> is set to <code>true</code>,
732
- * you must specify a KMS key ARN. </p>
733
- */
734
- KmsKeyArn?: string;
735
-
736
- /**
737
- * <p>The amount of time (in minutes) after which the snapshot is automatically cancelled
738
- * if:</p>
739
- * <ul>
740
- * <li>
741
- * <p>No blocks are written to the snapshot.</p>
742
- * </li>
743
- * <li>
744
- * <p>The snapshot is not completed after writing the last block of data.</p>
745
- * </li>
746
- * </ul>
747
- * <p>If no value is specified, the timeout defaults to <code>60</code> minutes.</p>
748
- */
749
- Timeout?: number;
750
- }
751
-
752
- export namespace StartSnapshotRequest {
753
- /**
754
- * @internal
755
- */
756
- export const filterSensitiveLog = (obj: StartSnapshotRequest): any => ({
757
- ...obj,
758
- ...(obj.KmsKeyArn && { KmsKeyArn: SENSITIVE_STRING }),
759
- });
760
- }
761
-
762
- export interface StartSnapshotResponse {
763
- /**
764
- * <p>The description of the snapshot.</p>
765
- */
766
- Description?: string;
767
-
768
- /**
769
- * <p>The ID of the snapshot.</p>
770
- */
771
- SnapshotId?: string;
772
-
773
- /**
774
- * <p>The Amazon Web Services account ID of the snapshot owner.</p>
775
- */
776
- OwnerId?: string;
777
-
778
- /**
779
- * <p>The status of the snapshot.</p>
780
- */
781
- Status?: Status | string;
782
-
783
- /**
784
- * <p>The timestamp when the snapshot was created.</p>
785
- */
786
- StartTime?: Date;
787
-
788
- /**
789
- * <p>The size of the volume, in GiB.</p>
790
- */
791
- VolumeSize?: number;
792
-
793
- /**
794
- * <p>The size of the blocks in the snapshot, in bytes.</p>
795
- */
796
- BlockSize?: number;
797
-
798
- /**
799
- * <p>The tags applied to the snapshot. You can specify up to 50 tags per snapshot. For more
800
- * information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html"> Tagging your Amazon EC2
801
- * resources</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
802
- */
803
- Tags?: Tag[];
804
-
805
- /**
806
- * <p>The ID of the parent snapshot.</p>
807
- */
808
- ParentSnapshotId?: string;
809
-
810
- /**
811
- * <p>The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used to encrypt the snapshot.</p>
812
- */
813
- KmsKeyArn?: string;
814
- }
815
-
816
- export namespace StartSnapshotResponse {
817
- /**
818
- * @internal
819
- */
820
- export const filterSensitiveLog = (obj: StartSnapshotResponse): any => ({
821
- ...obj,
822
- ...(obj.KmsKeyArn && { KmsKeyArn: SENSITIVE_STRING }),
823
- });
824
- }