@aws-sdk/client-ebs 3.378.0 → 3.379.1
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/README.md +0 -2
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/models/models_0.js +11 -1
- package/dist-cjs/protocols/Aws_restJson1.js +1 -0
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/models/models_0.js +10 -0
- package/dist-es/protocols/Aws_restJson1.js +1 -0
- package/dist-types/EBS.d.ts +2 -5
- package/dist-types/EBSClient.d.ts +2 -5
- package/dist-types/commands/CompleteSnapshotCommand.d.ts +12 -6
- package/dist-types/commands/GetSnapshotBlockCommand.d.ts +10 -4
- package/dist-types/commands/ListChangedBlocksCommand.d.ts +9 -3
- package/dist-types/commands/ListSnapshotBlocksCommand.d.ts +9 -3
- package/dist-types/commands/PutSnapshotBlockCommand.d.ts +12 -6
- package/dist-types/commands/StartSnapshotCommand.d.ts +12 -5
- package/dist-types/endpoint/EndpointParameters.d.ts +3 -0
- package/dist-types/index.d.ts +3 -5
- package/dist-types/models/models_0.d.ts +62 -52
- package/dist-types/ts3.4/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +12 -0
- package/package.json +6 -6
package/README.md
CHANGED
|
@@ -12,13 +12,11 @@ two snapshots. If you’re an independent software vendor (ISV) who offers backu
|
|
|
12
12
|
Amazon EBS, the EBS direct APIs make it more efficient and cost-effective to track incremental changes on
|
|
13
13
|
your Amazon EBS volumes through snapshots. This can be done without having to create new volumes
|
|
14
14
|
from snapshots, and then use Amazon Elastic Compute Cloud (Amazon EC2) instances to compare the differences.</p>
|
|
15
|
-
|
|
16
15
|
<p>You can create incremental snapshots directly from data on-premises into volumes and the
|
|
17
16
|
cloud to use for quick disaster recovery. With the ability to write and read snapshots, you can
|
|
18
17
|
write your on-premises data to an snapshot during a disaster. Then after recovery, you can
|
|
19
18
|
restore it back to Amazon Web Services or on-premises from the snapshot. You no longer need to build and
|
|
20
19
|
maintain complex mechanisms to copy data to and from Amazon EBS.</p>
|
|
21
|
-
|
|
22
20
|
<p>This API reference provides detailed information about the actions, data types,
|
|
23
21
|
parameters, and errors of the EBS direct APIs. For more information about the elements that
|
|
24
22
|
make up the EBS direct APIs, and examples of how to use them effectively, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-accessing-snapshot.html">Accessing the Contents of an Amazon EBS Snapshot</a> in the <i>Amazon Elastic Compute Cloud User
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.ruleSet = void 0;
|
|
4
|
-
const
|
|
5
|
-
const a = "
|
|
6
|
-
const _data = { version: "1.0", parameters: { Region:
|
|
4
|
+
const q = "required", r = "fn", s = "argv", t = "ref";
|
|
5
|
+
const a = "isSet", b = "tree", c = "error", d = "endpoint", e = "PartitionResult", f = { [q]: false, "type": "String" }, g = { [q]: true, "default": false, "type": "Boolean" }, h = { [t]: "Endpoint" }, i = { [r]: "booleanEquals", [s]: [{ [t]: "UseFIPS" }, true] }, j = { [r]: "booleanEquals", [s]: [{ [t]: "UseDualStack" }, true] }, k = {}, l = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsFIPS"] }] }, m = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsDualStack"] }] }, n = [i], o = [j], p = [{ [t]: "Region" }];
|
|
6
|
+
const _data = { version: "1.0", parameters: { Region: f, UseDualStack: g, UseFIPS: g, Endpoint: f }, rules: [{ conditions: [{ [r]: a, [s]: [h] }], type: b, rules: [{ conditions: n, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: c }, { type: b, rules: [{ conditions: o, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: c }, { endpoint: { url: h, properties: k, headers: k }, type: d }] }] }, { type: b, rules: [{ conditions: [{ [r]: a, [s]: p }], type: b, rules: [{ conditions: [{ [r]: "aws.partition", [s]: p, assign: e }], type: b, rules: [{ conditions: [i, j], type: b, rules: [{ conditions: [l, m], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://ebs-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: c }] }, { conditions: n, type: b, rules: [{ conditions: [l], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://ebs-fips.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: c }] }, { conditions: o, type: b, rules: [{ conditions: [m], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://ebs.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: c }] }, { type: b, rules: [{ endpoint: { url: "https://ebs.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }] }, { error: "Invalid Configuration: Missing Region", type: c }] }] };
|
|
7
7
|
exports.ruleSet = _data;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.StartSnapshotResponseFilterSensitiveLog = exports.StartSnapshotRequestFilterSensitiveLog = exports.PutSnapshotBlockRequestFilterSensitiveLog = exports.ListSnapshotBlocksResponseFilterSensitiveLog = exports.ListChangedBlocksResponseFilterSensitiveLog = exports.GetSnapshotBlockResponseFilterSensitiveLog = exports.ChangedBlockFilterSensitiveLog = exports.ConflictException = exports.ConcurrentLimitExceededException = exports.ValidationException = exports.ValidationExceptionReason = exports.ServiceQuotaExceededException = exports.ServiceQuotaExceededExceptionReason = exports.ResourceNotFoundException = exports.ResourceNotFoundExceptionReason = exports.RequestThrottledException = exports.RequestThrottledExceptionReason = exports.InternalServerException = exports.Status = exports.ChecksumAlgorithm = exports.ChecksumAggregationMethod = exports.AccessDeniedException = exports.AccessDeniedExceptionReason = void 0;
|
|
3
|
+
exports.StartSnapshotResponseFilterSensitiveLog = exports.StartSnapshotRequestFilterSensitiveLog = exports.PutSnapshotBlockRequestFilterSensitiveLog = exports.ListSnapshotBlocksResponseFilterSensitiveLog = exports.ListChangedBlocksResponseFilterSensitiveLog = exports.GetSnapshotBlockResponseFilterSensitiveLog = exports.ChangedBlockFilterSensitiveLog = exports.SSEType = exports.ConflictException = exports.ConcurrentLimitExceededException = exports.ValidationException = exports.ValidationExceptionReason = exports.ServiceQuotaExceededException = exports.ServiceQuotaExceededExceptionReason = exports.ResourceNotFoundException = exports.ResourceNotFoundExceptionReason = exports.RequestThrottledException = exports.RequestThrottledExceptionReason = exports.InternalServerException = exports.Status = exports.ChecksumAlgorithm = exports.ChecksumAggregationMethod = exports.AccessDeniedException = exports.AccessDeniedExceptionReason = void 0;
|
|
4
4
|
const smithy_client_1 = require("@smithy/smithy-client");
|
|
5
5
|
const EBSServiceException_1 = require("./EBSServiceException");
|
|
6
6
|
exports.AccessDeniedExceptionReason = {
|
|
@@ -69,6 +69,8 @@ class RequestThrottledException extends EBSServiceException_1.EBSServiceExceptio
|
|
|
69
69
|
exports.RequestThrottledException = RequestThrottledException;
|
|
70
70
|
exports.ResourceNotFoundExceptionReason = {
|
|
71
71
|
DEPENDENCY_RESOURCE_NOT_FOUND: "DEPENDENCY_RESOURCE_NOT_FOUND",
|
|
72
|
+
GRANT_NOT_FOUND: "GRANT_NOT_FOUND",
|
|
73
|
+
IMAGE_NOT_FOUND: "IMAGE_NOT_FOUND",
|
|
72
74
|
SNAPSHOT_NOT_FOUND: "SNAPSHOT_NOT_FOUND",
|
|
73
75
|
};
|
|
74
76
|
class ResourceNotFoundException extends EBSServiceException_1.EBSServiceException {
|
|
@@ -111,12 +113,15 @@ exports.ValidationExceptionReason = {
|
|
|
111
113
|
INVALID_CONTENT_ENCODING: "INVALID_CONTENT_ENCODING",
|
|
112
114
|
INVALID_CUSTOMER_KEY: "INVALID_CUSTOMER_KEY",
|
|
113
115
|
INVALID_DEPENDENCY_REQUEST: "INVALID_DEPENDENCY_REQUEST",
|
|
116
|
+
INVALID_GRANT_TOKEN: "INVALID_GRANT_TOKEN",
|
|
117
|
+
INVALID_IMAGE_ID: "INVALID_IMAGE_ID",
|
|
114
118
|
INVALID_PAGE_TOKEN: "INVALID_PAGE_TOKEN",
|
|
115
119
|
INVALID_PARAMETER_VALUE: "INVALID_PARAMETER_VALUE",
|
|
116
120
|
INVALID_SNAPSHOT_ID: "INVALID_SNAPSHOT_ID",
|
|
117
121
|
INVALID_TAG: "INVALID_TAG",
|
|
118
122
|
INVALID_VOLUME_SIZE: "INVALID_VOLUME_SIZE",
|
|
119
123
|
UNRELATED_SNAPSHOTS: "UNRELATED_SNAPSHOTS",
|
|
124
|
+
WRITE_REQUEST_TIMEOUT: "WRITE_REQUEST_TIMEOUT",
|
|
120
125
|
};
|
|
121
126
|
class ValidationException extends EBSServiceException_1.EBSServiceException {
|
|
122
127
|
constructor(opts) {
|
|
@@ -161,6 +166,11 @@ class ConflictException extends EBSServiceException_1.EBSServiceException {
|
|
|
161
166
|
}
|
|
162
167
|
}
|
|
163
168
|
exports.ConflictException = ConflictException;
|
|
169
|
+
exports.SSEType = {
|
|
170
|
+
NONE: "none",
|
|
171
|
+
SSE_EBS: "sse-ebs",
|
|
172
|
+
SSE_KMS: "sse-kms",
|
|
173
|
+
};
|
|
164
174
|
const ChangedBlockFilterSensitiveLog = (obj) => ({
|
|
165
175
|
...obj,
|
|
166
176
|
});
|
|
@@ -429,6 +429,7 @@ const de_StartSnapshotCommand = async (output, context) => {
|
|
|
429
429
|
OwnerId: smithy_client_1.expectString,
|
|
430
430
|
ParentSnapshotId: smithy_client_1.expectString,
|
|
431
431
|
SnapshotId: smithy_client_1.expectString,
|
|
432
|
+
SseType: smithy_client_1.expectString,
|
|
432
433
|
StartTime: (_) => (0, smithy_client_1.expectNonNull)((0, smithy_client_1.parseEpochTimestamp)((0, smithy_client_1.expectNumber)(_))),
|
|
433
434
|
Status: smithy_client_1.expectString,
|
|
434
435
|
Tags: smithy_client_1._json,
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
const
|
|
2
|
-
const a = "
|
|
3
|
-
const _data = { version: "1.0", parameters: { Region:
|
|
1
|
+
const q = "required", r = "fn", s = "argv", t = "ref";
|
|
2
|
+
const a = "isSet", b = "tree", c = "error", d = "endpoint", e = "PartitionResult", f = { [q]: false, "type": "String" }, g = { [q]: true, "default": false, "type": "Boolean" }, h = { [t]: "Endpoint" }, i = { [r]: "booleanEquals", [s]: [{ [t]: "UseFIPS" }, true] }, j = { [r]: "booleanEquals", [s]: [{ [t]: "UseDualStack" }, true] }, k = {}, l = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsFIPS"] }] }, m = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsDualStack"] }] }, n = [i], o = [j], p = [{ [t]: "Region" }];
|
|
3
|
+
const _data = { version: "1.0", parameters: { Region: f, UseDualStack: g, UseFIPS: g, Endpoint: f }, rules: [{ conditions: [{ [r]: a, [s]: [h] }], type: b, rules: [{ conditions: n, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: c }, { type: b, rules: [{ conditions: o, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: c }, { endpoint: { url: h, properties: k, headers: k }, type: d }] }] }, { type: b, rules: [{ conditions: [{ [r]: a, [s]: p }], type: b, rules: [{ conditions: [{ [r]: "aws.partition", [s]: p, assign: e }], type: b, rules: [{ conditions: [i, j], type: b, rules: [{ conditions: [l, m], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://ebs-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: c }] }, { conditions: n, type: b, rules: [{ conditions: [l], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://ebs-fips.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: c }] }, { conditions: o, type: b, rules: [{ conditions: [m], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://ebs.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: c }] }, { type: b, rules: [{ endpoint: { url: "https://ebs.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }] }, { error: "Invalid Configuration: Missing Region", type: c }] }] };
|
|
4
4
|
export const ruleSet = _data;
|
|
@@ -63,6 +63,8 @@ export class RequestThrottledException extends __BaseException {
|
|
|
63
63
|
}
|
|
64
64
|
export const ResourceNotFoundExceptionReason = {
|
|
65
65
|
DEPENDENCY_RESOURCE_NOT_FOUND: "DEPENDENCY_RESOURCE_NOT_FOUND",
|
|
66
|
+
GRANT_NOT_FOUND: "GRANT_NOT_FOUND",
|
|
67
|
+
IMAGE_NOT_FOUND: "IMAGE_NOT_FOUND",
|
|
66
68
|
SNAPSHOT_NOT_FOUND: "SNAPSHOT_NOT_FOUND",
|
|
67
69
|
};
|
|
68
70
|
export class ResourceNotFoundException extends __BaseException {
|
|
@@ -103,12 +105,15 @@ export const ValidationExceptionReason = {
|
|
|
103
105
|
INVALID_CONTENT_ENCODING: "INVALID_CONTENT_ENCODING",
|
|
104
106
|
INVALID_CUSTOMER_KEY: "INVALID_CUSTOMER_KEY",
|
|
105
107
|
INVALID_DEPENDENCY_REQUEST: "INVALID_DEPENDENCY_REQUEST",
|
|
108
|
+
INVALID_GRANT_TOKEN: "INVALID_GRANT_TOKEN",
|
|
109
|
+
INVALID_IMAGE_ID: "INVALID_IMAGE_ID",
|
|
106
110
|
INVALID_PAGE_TOKEN: "INVALID_PAGE_TOKEN",
|
|
107
111
|
INVALID_PARAMETER_VALUE: "INVALID_PARAMETER_VALUE",
|
|
108
112
|
INVALID_SNAPSHOT_ID: "INVALID_SNAPSHOT_ID",
|
|
109
113
|
INVALID_TAG: "INVALID_TAG",
|
|
110
114
|
INVALID_VOLUME_SIZE: "INVALID_VOLUME_SIZE",
|
|
111
115
|
UNRELATED_SNAPSHOTS: "UNRELATED_SNAPSHOTS",
|
|
116
|
+
WRITE_REQUEST_TIMEOUT: "WRITE_REQUEST_TIMEOUT",
|
|
112
117
|
};
|
|
113
118
|
export class ValidationException extends __BaseException {
|
|
114
119
|
constructor(opts) {
|
|
@@ -150,6 +155,11 @@ export class ConflictException extends __BaseException {
|
|
|
150
155
|
this.Message = opts.Message;
|
|
151
156
|
}
|
|
152
157
|
}
|
|
158
|
+
export const SSEType = {
|
|
159
|
+
NONE: "none",
|
|
160
|
+
SSE_EBS: "sse-ebs",
|
|
161
|
+
SSE_KMS: "sse-kms",
|
|
162
|
+
};
|
|
153
163
|
export const ChangedBlockFilterSensitiveLog = (obj) => ({
|
|
154
164
|
...obj,
|
|
155
165
|
});
|
|
@@ -415,6 +415,7 @@ export const de_StartSnapshotCommand = async (output, context) => {
|
|
|
415
415
|
OwnerId: __expectString,
|
|
416
416
|
ParentSnapshotId: __expectString,
|
|
417
417
|
SnapshotId: __expectString,
|
|
418
|
+
SseType: __expectString,
|
|
418
419
|
StartTime: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
|
|
419
420
|
Status: __expectString,
|
|
420
421
|
Tags: _json,
|
package/dist-types/EBS.d.ts
CHANGED
|
@@ -52,15 +52,12 @@ export interface EBS {
|
|
|
52
52
|
* Amazon EBS, the EBS direct APIs make it more efficient and cost-effective to track incremental changes on
|
|
53
53
|
* your Amazon EBS volumes through snapshots. This can be done without having to create new volumes
|
|
54
54
|
* from snapshots, and then use Amazon Elastic Compute Cloud (Amazon EC2) instances to compare the differences.</p>
|
|
55
|
-
*
|
|
56
|
-
* <p>You can create incremental snapshots directly from data on-premises into volumes and the
|
|
55
|
+
* <p>You can create incremental snapshots directly from data on-premises into volumes and the
|
|
57
56
|
* cloud to use for quick disaster recovery. With the ability to write and read snapshots, you can
|
|
58
57
|
* write your on-premises data to an snapshot during a disaster. Then after recovery, you can
|
|
59
58
|
* restore it back to Amazon Web Services or on-premises from the snapshot. You no longer need to build and
|
|
60
59
|
* maintain complex mechanisms to copy data to and from Amazon EBS.</p>
|
|
61
|
-
*
|
|
62
|
-
*
|
|
63
|
-
* <p>This API reference provides detailed information about the actions, data types,
|
|
60
|
+
* <p>This API reference provides detailed information about the actions, data types,
|
|
64
61
|
* parameters, and errors of the EBS direct APIs. For more information about the elements that
|
|
65
62
|
* make up the EBS direct APIs, and examples of how to use them effectively, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-accessing-snapshot.html">Accessing the Contents of an Amazon EBS Snapshot</a> in the <i>Amazon Elastic Compute Cloud User
|
|
66
63
|
* Guide</i>. For more information about the supported Amazon Web Services Regions, endpoints,
|
|
@@ -162,15 +162,12 @@ export interface EBSClientResolvedConfig extends EBSClientResolvedConfigType {
|
|
|
162
162
|
* Amazon EBS, the EBS direct APIs make it more efficient and cost-effective to track incremental changes on
|
|
163
163
|
* your Amazon EBS volumes through snapshots. This can be done without having to create new volumes
|
|
164
164
|
* from snapshots, and then use Amazon Elastic Compute Cloud (Amazon EC2) instances to compare the differences.</p>
|
|
165
|
-
*
|
|
166
|
-
* <p>You can create incremental snapshots directly from data on-premises into volumes and the
|
|
165
|
+
* <p>You can create incremental snapshots directly from data on-premises into volumes and the
|
|
167
166
|
* cloud to use for quick disaster recovery. With the ability to write and read snapshots, you can
|
|
168
167
|
* write your on-premises data to an snapshot during a disaster. Then after recovery, you can
|
|
169
168
|
* restore it back to Amazon Web Services or on-premises from the snapshot. You no longer need to build and
|
|
170
169
|
* maintain complex mechanisms to copy data to and from Amazon EBS.</p>
|
|
171
|
-
*
|
|
172
|
-
*
|
|
173
|
-
* <p>This API reference provides detailed information about the actions, data types,
|
|
170
|
+
* <p>This API reference provides detailed information about the actions, data types,
|
|
174
171
|
* parameters, and errors of the EBS direct APIs. For more information about the elements that
|
|
175
172
|
* make up the EBS direct APIs, and examples of how to use them effectively, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-accessing-snapshot.html">Accessing the Contents of an Amazon EBS Snapshot</a> in the <i>Amazon Elastic Compute Cloud User
|
|
176
173
|
* Guide</i>. For more information about the supported Amazon Web Services Regions, endpoints,
|
|
@@ -26,6 +26,12 @@ export interface CompleteSnapshotCommandOutput extends CompleteSnapshotResponse,
|
|
|
26
26
|
* <p>Seals and completes the snapshot after all of the required blocks of data have been
|
|
27
27
|
* written to it. Completing the snapshot changes the status to <code>completed</code>. You
|
|
28
28
|
* cannot write new blocks to a snapshot after it has been completed.</p>
|
|
29
|
+
* <note>
|
|
30
|
+
* <p>You should always retry requests that receive server (<code>5xx</code>)
|
|
31
|
+
* error responses, and <code>ThrottlingException</code> and <code>RequestThrottledException</code>
|
|
32
|
+
* client error responses. For more information see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/error-retries.html">Error retries</a> in the
|
|
33
|
+
* <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
|
|
34
|
+
* </note>
|
|
29
35
|
* @example
|
|
30
36
|
* Use a bare-bones client and the command you need to make an API call.
|
|
31
37
|
* ```javascript
|
|
@@ -36,13 +42,13 @@ export interface CompleteSnapshotCommandOutput extends CompleteSnapshotResponse,
|
|
|
36
42
|
* SnapshotId: "STRING_VALUE", // required
|
|
37
43
|
* ChangedBlocksCount: Number("int"), // required
|
|
38
44
|
* Checksum: "STRING_VALUE",
|
|
39
|
-
* ChecksumAlgorithm: "
|
|
40
|
-
* ChecksumAggregationMethod: "
|
|
45
|
+
* ChecksumAlgorithm: "SHA256",
|
|
46
|
+
* ChecksumAggregationMethod: "LINEAR",
|
|
41
47
|
* };
|
|
42
48
|
* const command = new CompleteSnapshotCommand(input);
|
|
43
49
|
* const response = await client.send(command);
|
|
44
50
|
* // { // CompleteSnapshotResponse
|
|
45
|
-
* // Status: "
|
|
51
|
+
* // Status: "completed" || "pending" || "error",
|
|
46
52
|
* // };
|
|
47
53
|
*
|
|
48
54
|
* ```
|
|
@@ -57,11 +63,11 @@ export interface CompleteSnapshotCommandOutput extends CompleteSnapshotResponse,
|
|
|
57
63
|
* <p>You do not have sufficient access to perform this action.</p>
|
|
58
64
|
*
|
|
59
65
|
* @throws {@link InternalServerException} (server fault)
|
|
60
|
-
* <p>An internal error has occurred
|
|
66
|
+
* <p>An internal error has occurred. For more information see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/error-retries.html">Error retries</a>.</p>
|
|
61
67
|
*
|
|
62
68
|
* @throws {@link RequestThrottledException} (client fault)
|
|
63
|
-
* <p>The number of API requests has
|
|
64
|
-
* limit
|
|
69
|
+
* <p>The number of API requests has exceeded the maximum allowed API request
|
|
70
|
+
* throttling limit for the snapshot. For more information see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/error-retries.html">Error retries</a>.</p>
|
|
65
71
|
*
|
|
66
72
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
67
73
|
* <p>The specified resource does not exist.</p>
|
|
@@ -25,6 +25,12 @@ export interface GetSnapshotBlockCommandOutput extends Omit<GetSnapshotBlockResp
|
|
|
25
25
|
/**
|
|
26
26
|
* @public
|
|
27
27
|
* <p>Returns the data in a block in an Amazon Elastic Block Store snapshot.</p>
|
|
28
|
+
* <note>
|
|
29
|
+
* <p>You should always retry requests that receive server (<code>5xx</code>)
|
|
30
|
+
* error responses, and <code>ThrottlingException</code> and <code>RequestThrottledException</code>
|
|
31
|
+
* client error responses. For more information see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/error-retries.html">Error retries</a> in the
|
|
32
|
+
* <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
|
|
33
|
+
* </note>
|
|
28
34
|
* @example
|
|
29
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
30
36
|
* ```javascript
|
|
@@ -42,7 +48,7 @@ export interface GetSnapshotBlockCommandOutput extends Omit<GetSnapshotBlockResp
|
|
|
42
48
|
* // DataLength: Number("int"),
|
|
43
49
|
* // BlockData: "STREAMING_BLOB_VALUE",
|
|
44
50
|
* // Checksum: "STRING_VALUE",
|
|
45
|
-
* // ChecksumAlgorithm: "
|
|
51
|
+
* // ChecksumAlgorithm: "SHA256",
|
|
46
52
|
* // };
|
|
47
53
|
*
|
|
48
54
|
* ```
|
|
@@ -57,11 +63,11 @@ export interface GetSnapshotBlockCommandOutput extends Omit<GetSnapshotBlockResp
|
|
|
57
63
|
* <p>You do not have sufficient access to perform this action.</p>
|
|
58
64
|
*
|
|
59
65
|
* @throws {@link InternalServerException} (server fault)
|
|
60
|
-
* <p>An internal error has occurred
|
|
66
|
+
* <p>An internal error has occurred. For more information see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/error-retries.html">Error retries</a>.</p>
|
|
61
67
|
*
|
|
62
68
|
* @throws {@link RequestThrottledException} (client fault)
|
|
63
|
-
* <p>The number of API requests has
|
|
64
|
-
* limit
|
|
69
|
+
* <p>The number of API requests has exceeded the maximum allowed API request
|
|
70
|
+
* throttling limit for the snapshot. For more information see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/error-retries.html">Error retries</a>.</p>
|
|
65
71
|
*
|
|
66
72
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
67
73
|
* <p>The specified resource does not exist.</p>
|
|
@@ -25,6 +25,12 @@ export interface ListChangedBlocksCommandOutput extends ListChangedBlocksRespons
|
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Returns information about the blocks that are different between two
|
|
27
27
|
* Amazon Elastic Block Store snapshots of the same volume/snapshot lineage.</p>
|
|
28
|
+
* <note>
|
|
29
|
+
* <p>You should always retry requests that receive server (<code>5xx</code>)
|
|
30
|
+
* error responses, and <code>ThrottlingException</code> and <code>RequestThrottledException</code>
|
|
31
|
+
* client error responses. For more information see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/error-retries.html">Error retries</a> in the
|
|
32
|
+
* <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
|
|
33
|
+
* </note>
|
|
28
34
|
* @example
|
|
29
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
30
36
|
* ```javascript
|
|
@@ -66,11 +72,11 @@ export interface ListChangedBlocksCommandOutput extends ListChangedBlocksRespons
|
|
|
66
72
|
* <p>You do not have sufficient access to perform this action.</p>
|
|
67
73
|
*
|
|
68
74
|
* @throws {@link InternalServerException} (server fault)
|
|
69
|
-
* <p>An internal error has occurred
|
|
75
|
+
* <p>An internal error has occurred. For more information see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/error-retries.html">Error retries</a>.</p>
|
|
70
76
|
*
|
|
71
77
|
* @throws {@link RequestThrottledException} (client fault)
|
|
72
|
-
* <p>The number of API requests has
|
|
73
|
-
* limit
|
|
78
|
+
* <p>The number of API requests has exceeded the maximum allowed API request
|
|
79
|
+
* throttling limit for the snapshot. For more information see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/error-retries.html">Error retries</a>.</p>
|
|
74
80
|
*
|
|
75
81
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
76
82
|
* <p>The specified resource does not exist.</p>
|
|
@@ -24,6 +24,12 @@ export interface ListSnapshotBlocksCommandOutput extends ListSnapshotBlocksRespo
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Returns information about the blocks in an Amazon Elastic Block Store snapshot.</p>
|
|
27
|
+
* <note>
|
|
28
|
+
* <p>You should always retry requests that receive server (<code>5xx</code>)
|
|
29
|
+
* error responses, and <code>ThrottlingException</code> and <code>RequestThrottledException</code>
|
|
30
|
+
* client error responses. For more information see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/error-retries.html">Error retries</a> in the
|
|
31
|
+
* <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
|
|
32
|
+
* </note>
|
|
27
33
|
* @example
|
|
28
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
29
35
|
* ```javascript
|
|
@@ -63,11 +69,11 @@ export interface ListSnapshotBlocksCommandOutput extends ListSnapshotBlocksRespo
|
|
|
63
69
|
* <p>You do not have sufficient access to perform this action.</p>
|
|
64
70
|
*
|
|
65
71
|
* @throws {@link InternalServerException} (server fault)
|
|
66
|
-
* <p>An internal error has occurred
|
|
72
|
+
* <p>An internal error has occurred. For more information see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/error-retries.html">Error retries</a>.</p>
|
|
67
73
|
*
|
|
68
74
|
* @throws {@link RequestThrottledException} (client fault)
|
|
69
|
-
* <p>The number of API requests has
|
|
70
|
-
* limit
|
|
75
|
+
* <p>The number of API requests has exceeded the maximum allowed API request
|
|
76
|
+
* throttling limit for the snapshot. For more information see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/error-retries.html">Error retries</a>.</p>
|
|
71
77
|
*
|
|
72
78
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
73
79
|
* <p>The specified resource does not exist.</p>
|
|
@@ -27,7 +27,13 @@ export interface PutSnapshotBlockCommandOutput extends PutSnapshotBlockResponse,
|
|
|
27
27
|
* <p>Writes a block of data to a snapshot. If the specified block contains
|
|
28
28
|
* data, the existing data is overwritten. The target snapshot must be in the
|
|
29
29
|
* <code>pending</code> state.</p>
|
|
30
|
-
*
|
|
30
|
+
* <p>Data written to a snapshot must be aligned with 512-KiB sectors.</p>
|
|
31
|
+
* <note>
|
|
32
|
+
* <p>You should always retry requests that receive server (<code>5xx</code>)
|
|
33
|
+
* error responses, and <code>ThrottlingException</code> and <code>RequestThrottledException</code>
|
|
34
|
+
* client error responses. For more information see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/error-retries.html">Error retries</a> in the
|
|
35
|
+
* <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
|
|
36
|
+
* </note>
|
|
31
37
|
* @example
|
|
32
38
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
39
|
* ```javascript
|
|
@@ -41,13 +47,13 @@ export interface PutSnapshotBlockCommandOutput extends PutSnapshotBlockResponse,
|
|
|
41
47
|
* DataLength: Number("int"), // required
|
|
42
48
|
* Progress: Number("int"),
|
|
43
49
|
* Checksum: "STRING_VALUE", // required
|
|
44
|
-
* ChecksumAlgorithm: "
|
|
50
|
+
* ChecksumAlgorithm: "SHA256", // required
|
|
45
51
|
* };
|
|
46
52
|
* const command = new PutSnapshotBlockCommand(input);
|
|
47
53
|
* const response = await client.send(command);
|
|
48
54
|
* // { // PutSnapshotBlockResponse
|
|
49
55
|
* // Checksum: "STRING_VALUE",
|
|
50
|
-
* // ChecksumAlgorithm: "
|
|
56
|
+
* // ChecksumAlgorithm: "SHA256",
|
|
51
57
|
* // };
|
|
52
58
|
*
|
|
53
59
|
* ```
|
|
@@ -62,11 +68,11 @@ export interface PutSnapshotBlockCommandOutput extends PutSnapshotBlockResponse,
|
|
|
62
68
|
* <p>You do not have sufficient access to perform this action.</p>
|
|
63
69
|
*
|
|
64
70
|
* @throws {@link InternalServerException} (server fault)
|
|
65
|
-
* <p>An internal error has occurred
|
|
71
|
+
* <p>An internal error has occurred. For more information see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/error-retries.html">Error retries</a>.</p>
|
|
66
72
|
*
|
|
67
73
|
* @throws {@link RequestThrottledException} (client fault)
|
|
68
|
-
* <p>The number of API requests has
|
|
69
|
-
* limit
|
|
74
|
+
* <p>The number of API requests has exceeded the maximum allowed API request
|
|
75
|
+
* throttling limit for the snapshot. For more information see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/error-retries.html">Error retries</a>.</p>
|
|
70
76
|
*
|
|
71
77
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
72
78
|
* <p>The specified resource does not exist.</p>
|
|
@@ -25,8 +25,14 @@ export interface StartSnapshotCommandOutput extends StartSnapshotResponse, __Met
|
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Creates a new Amazon EBS snapshot. The new snapshot enters the <code>pending</code> state
|
|
27
27
|
* after the request completes. </p>
|
|
28
|
-
*
|
|
28
|
+
* <p>After creating the snapshot, use <a href="https://docs.aws.amazon.com/ebs/latest/APIReference/API_PutSnapshotBlock.html"> PutSnapshotBlock</a> to
|
|
29
29
|
* write blocks of data to the snapshot.</p>
|
|
30
|
+
* <note>
|
|
31
|
+
* <p>You should always retry requests that receive server (<code>5xx</code>)
|
|
32
|
+
* error responses, and <code>ThrottlingException</code> and <code>RequestThrottledException</code>
|
|
33
|
+
* client error responses. For more information see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/error-retries.html">Error retries</a> in the
|
|
34
|
+
* <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
|
|
35
|
+
* </note>
|
|
30
36
|
* @example
|
|
31
37
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
38
|
* ```javascript
|
|
@@ -54,7 +60,7 @@ export interface StartSnapshotCommandOutput extends StartSnapshotResponse, __Met
|
|
|
54
60
|
* // Description: "STRING_VALUE",
|
|
55
61
|
* // SnapshotId: "STRING_VALUE",
|
|
56
62
|
* // OwnerId: "STRING_VALUE",
|
|
57
|
-
* // Status: "
|
|
63
|
+
* // Status: "completed" || "pending" || "error",
|
|
58
64
|
* // StartTime: new Date("TIMESTAMP"),
|
|
59
65
|
* // VolumeSize: Number("long"),
|
|
60
66
|
* // BlockSize: Number("int"),
|
|
@@ -66,6 +72,7 @@ export interface StartSnapshotCommandOutput extends StartSnapshotResponse, __Met
|
|
|
66
72
|
* // ],
|
|
67
73
|
* // ParentSnapshotId: "STRING_VALUE",
|
|
68
74
|
* // KmsKeyArn: "STRING_VALUE",
|
|
75
|
+
* // SseType: "sse-ebs" || "sse-kms" || "none",
|
|
69
76
|
* // };
|
|
70
77
|
*
|
|
71
78
|
* ```
|
|
@@ -89,11 +96,11 @@ export interface StartSnapshotCommandOutput extends StartSnapshotResponse, __Met
|
|
|
89
96
|
* request.</p>
|
|
90
97
|
*
|
|
91
98
|
* @throws {@link InternalServerException} (server fault)
|
|
92
|
-
* <p>An internal error has occurred
|
|
99
|
+
* <p>An internal error has occurred. For more information see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/error-retries.html">Error retries</a>.</p>
|
|
93
100
|
*
|
|
94
101
|
* @throws {@link RequestThrottledException} (client fault)
|
|
95
|
-
* <p>The number of API requests has
|
|
96
|
-
* limit
|
|
102
|
+
* <p>The number of API requests has exceeded the maximum allowed API request
|
|
103
|
+
* throttling limit for the snapshot. For more information see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/error-retries.html">Error retries</a>.</p>
|
|
97
104
|
*
|
|
98
105
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
99
106
|
* <p>The specified resource does not exist.</p>
|
|
@@ -1,4 +1,7 @@
|
|
|
1
1
|
import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
|
|
2
|
+
/**
|
|
3
|
+
* @public
|
|
4
|
+
*/
|
|
2
5
|
export interface ClientInputEndpointParameters {
|
|
3
6
|
region?: string | Provider<string>;
|
|
4
7
|
useDualstackEndpoint?: boolean | Provider<boolean>;
|
package/dist-types/index.d.ts
CHANGED
|
@@ -5,15 +5,12 @@
|
|
|
5
5
|
* Amazon EBS, the EBS direct APIs make it more efficient and cost-effective to track incremental changes on
|
|
6
6
|
* your Amazon EBS volumes through snapshots. This can be done without having to create new volumes
|
|
7
7
|
* from snapshots, and then use Amazon Elastic Compute Cloud (Amazon EC2) instances to compare the differences.</p>
|
|
8
|
-
*
|
|
9
|
-
* <p>You can create incremental snapshots directly from data on-premises into volumes and the
|
|
8
|
+
* <p>You can create incremental snapshots directly from data on-premises into volumes and the
|
|
10
9
|
* cloud to use for quick disaster recovery. With the ability to write and read snapshots, you can
|
|
11
10
|
* write your on-premises data to an snapshot during a disaster. Then after recovery, you can
|
|
12
11
|
* restore it back to Amazon Web Services or on-premises from the snapshot. You no longer need to build and
|
|
13
12
|
* maintain complex mechanisms to copy data to and from Amazon EBS.</p>
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
* <p>This API reference provides detailed information about the actions, data types,
|
|
13
|
+
* <p>This API reference provides detailed information about the actions, data types,
|
|
17
14
|
* parameters, and errors of the EBS direct APIs. For more information about the elements that
|
|
18
15
|
* make up the EBS direct APIs, and examples of how to use them effectively, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-accessing-snapshot.html">Accessing the Contents of an Amazon EBS Snapshot</a> in the <i>Amazon Elastic Compute Cloud User
|
|
19
16
|
* Guide</i>. For more information about the supported Amazon Web Services Regions, endpoints,
|
|
@@ -24,6 +21,7 @@
|
|
|
24
21
|
*/
|
|
25
22
|
export * from "./EBSClient";
|
|
26
23
|
export * from "./EBS";
|
|
24
|
+
export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
|
|
27
25
|
export * from "./commands";
|
|
28
26
|
export * from "./pagination";
|
|
29
27
|
export * from "./models";
|
|
@@ -103,7 +103,7 @@ export interface CompleteSnapshotRequest {
|
|
|
103
103
|
/**
|
|
104
104
|
* <p>An aggregated Base-64 SHA256 checksum based on the checksums of each written
|
|
105
105
|
* block.</p>
|
|
106
|
-
*
|
|
106
|
+
* <p>To generate the aggregated checksum using the linear aggregation method, arrange the
|
|
107
107
|
* checksums for each written block in ascending order of their block index, concatenate
|
|
108
108
|
* them to form a single string, and then generate the checksum on the entire string using
|
|
109
109
|
* the SHA256 algorithm.</p>
|
|
@@ -144,7 +144,7 @@ export interface CompleteSnapshotResponse {
|
|
|
144
144
|
}
|
|
145
145
|
/**
|
|
146
146
|
* @public
|
|
147
|
-
* <p>An internal error has occurred
|
|
147
|
+
* <p>An internal error has occurred. For more information see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/error-retries.html">Error retries</a>.</p>
|
|
148
148
|
*/
|
|
149
149
|
export declare class InternalServerException extends __BaseException {
|
|
150
150
|
readonly name: "InternalServerException";
|
|
@@ -170,8 +170,8 @@ export declare const RequestThrottledExceptionReason: {
|
|
|
170
170
|
export type RequestThrottledExceptionReason = (typeof RequestThrottledExceptionReason)[keyof typeof RequestThrottledExceptionReason];
|
|
171
171
|
/**
|
|
172
172
|
* @public
|
|
173
|
-
* <p>The number of API requests has
|
|
174
|
-
* limit
|
|
173
|
+
* <p>The number of API requests has exceeded the maximum allowed API request
|
|
174
|
+
* throttling limit for the snapshot. For more information see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/error-retries.html">Error retries</a>.</p>
|
|
175
175
|
*/
|
|
176
176
|
export declare class RequestThrottledException extends __BaseException {
|
|
177
177
|
readonly name: "RequestThrottledException";
|
|
@@ -192,6 +192,8 @@ export declare class RequestThrottledException extends __BaseException {
|
|
|
192
192
|
*/
|
|
193
193
|
export declare const ResourceNotFoundExceptionReason: {
|
|
194
194
|
readonly DEPENDENCY_RESOURCE_NOT_FOUND: "DEPENDENCY_RESOURCE_NOT_FOUND";
|
|
195
|
+
readonly GRANT_NOT_FOUND: "GRANT_NOT_FOUND";
|
|
196
|
+
readonly IMAGE_NOT_FOUND: "IMAGE_NOT_FOUND";
|
|
195
197
|
readonly SNAPSHOT_NOT_FOUND: "SNAPSHOT_NOT_FOUND";
|
|
196
198
|
};
|
|
197
199
|
/**
|
|
@@ -254,12 +256,15 @@ export declare const ValidationExceptionReason: {
|
|
|
254
256
|
readonly INVALID_CONTENT_ENCODING: "INVALID_CONTENT_ENCODING";
|
|
255
257
|
readonly INVALID_CUSTOMER_KEY: "INVALID_CUSTOMER_KEY";
|
|
256
258
|
readonly INVALID_DEPENDENCY_REQUEST: "INVALID_DEPENDENCY_REQUEST";
|
|
259
|
+
readonly INVALID_GRANT_TOKEN: "INVALID_GRANT_TOKEN";
|
|
260
|
+
readonly INVALID_IMAGE_ID: "INVALID_IMAGE_ID";
|
|
257
261
|
readonly INVALID_PAGE_TOKEN: "INVALID_PAGE_TOKEN";
|
|
258
262
|
readonly INVALID_PARAMETER_VALUE: "INVALID_PARAMETER_VALUE";
|
|
259
263
|
readonly INVALID_SNAPSHOT_ID: "INVALID_SNAPSHOT_ID";
|
|
260
264
|
readonly INVALID_TAG: "INVALID_TAG";
|
|
261
265
|
readonly INVALID_VOLUME_SIZE: "INVALID_VOLUME_SIZE";
|
|
262
266
|
readonly UNRELATED_SNAPSHOTS: "UNRELATED_SNAPSHOTS";
|
|
267
|
+
readonly WRITE_REQUEST_TIMEOUT: "WRITE_REQUEST_TIMEOUT";
|
|
263
268
|
};
|
|
264
269
|
/**
|
|
265
270
|
* @public
|
|
@@ -317,13 +322,13 @@ export declare class ConflictException extends __BaseException {
|
|
|
317
322
|
export interface GetSnapshotBlockRequest {
|
|
318
323
|
/**
|
|
319
324
|
* <p>The ID of the snapshot containing the block from which to get data.</p>
|
|
320
|
-
*
|
|
325
|
+
* <important>
|
|
321
326
|
* <p>If the specified snapshot is encrypted, you must have permission to use the
|
|
322
327
|
* KMS key that was used to encrypt the snapshot. For more information, see
|
|
323
328
|
* <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapis-using-encryption.html">
|
|
324
329
|
* Using encryption</a> in the <i>Amazon Elastic Compute Cloud User
|
|
325
330
|
* Guide</i>.</p>
|
|
326
|
-
*
|
|
331
|
+
* </important>
|
|
327
332
|
*/
|
|
328
333
|
SnapshotId: string | undefined;
|
|
329
334
|
/**
|
|
@@ -367,32 +372,32 @@ export interface GetSnapshotBlockResponse {
|
|
|
367
372
|
export interface ListChangedBlocksRequest {
|
|
368
373
|
/**
|
|
369
374
|
* <p>The ID of the first snapshot to use for the comparison.</p>
|
|
370
|
-
*
|
|
375
|
+
* <important>
|
|
371
376
|
* <p>The <code>FirstSnapshotID</code> parameter must be specified with a
|
|
372
377
|
* <code>SecondSnapshotId</code> parameter; otherwise, an error occurs.</p>
|
|
373
|
-
*
|
|
378
|
+
* </important>
|
|
374
379
|
*/
|
|
375
380
|
FirstSnapshotId?: string;
|
|
376
381
|
/**
|
|
377
382
|
* <p>The ID of the second snapshot to use for the comparison.</p>
|
|
378
|
-
*
|
|
383
|
+
* <important>
|
|
379
384
|
* <p>The <code>SecondSnapshotId</code> parameter must be specified with a
|
|
380
385
|
* <code>FirstSnapshotID</code> parameter; otherwise, an error occurs.</p>
|
|
381
|
-
*
|
|
386
|
+
* </important>
|
|
382
387
|
*/
|
|
383
388
|
SecondSnapshotId: string | undefined;
|
|
384
389
|
/**
|
|
385
390
|
* <p>The token to request the next page of results.</p>
|
|
386
|
-
*
|
|
391
|
+
* <p>If you specify <b>NextToken</b>, then
|
|
387
392
|
* <b>StartingBlockIndex</b> is ignored.</p>
|
|
388
393
|
*/
|
|
389
394
|
NextToken?: string;
|
|
390
395
|
/**
|
|
391
396
|
* <p>The maximum number of blocks to be returned by the request.</p>
|
|
392
|
-
*
|
|
397
|
+
* <p>Even if additional blocks can be retrieved from the snapshot, the request can
|
|
393
398
|
* return less blocks than <b>MaxResults</b> or an empty
|
|
394
399
|
* array of blocks.</p>
|
|
395
|
-
*
|
|
400
|
+
* <p>To retrieve the next set of blocks from the snapshot, make another request with
|
|
396
401
|
* the returned <b>NextToken</b> value. The value of
|
|
397
402
|
* <b>NextToken</b> is <code>null</code> when there are no
|
|
398
403
|
* more blocks to return.</p>
|
|
@@ -400,9 +405,9 @@ export interface ListChangedBlocksRequest {
|
|
|
400
405
|
MaxResults?: number;
|
|
401
406
|
/**
|
|
402
407
|
* <p>The block index from which the comparison should start.</p>
|
|
403
|
-
*
|
|
408
|
+
* <p>The list in the response will start from this block index or the next valid block
|
|
404
409
|
* index in the snapshots.</p>
|
|
405
|
-
*
|
|
410
|
+
* <p>If you specify <b>NextToken</b>, then
|
|
406
411
|
* <b>StartingBlockIndex</b> is ignored.</p>
|
|
407
412
|
*/
|
|
408
413
|
StartingBlockIndex?: number;
|
|
@@ -443,16 +448,16 @@ export interface ListSnapshotBlocksRequest {
|
|
|
443
448
|
SnapshotId: string | undefined;
|
|
444
449
|
/**
|
|
445
450
|
* <p>The token to request the next page of results.</p>
|
|
446
|
-
*
|
|
451
|
+
* <p>If you specify <b>NextToken</b>, then
|
|
447
452
|
* <b>StartingBlockIndex</b> is ignored.</p>
|
|
448
453
|
*/
|
|
449
454
|
NextToken?: string;
|
|
450
455
|
/**
|
|
451
456
|
* <p>The maximum number of blocks to be returned by the request.</p>
|
|
452
|
-
*
|
|
457
|
+
* <p>Even if additional blocks can be retrieved from the snapshot, the request can
|
|
453
458
|
* return less blocks than <b>MaxResults</b> or an empty
|
|
454
459
|
* array of blocks.</p>
|
|
455
|
-
*
|
|
460
|
+
* <p>To retrieve the next set of blocks from the snapshot, make another request with
|
|
456
461
|
* the returned <b>NextToken</b> value. The value of
|
|
457
462
|
* <b>NextToken</b> is <code>null</code> when there are no
|
|
458
463
|
* more blocks to return.</p>
|
|
@@ -461,7 +466,7 @@ export interface ListSnapshotBlocksRequest {
|
|
|
461
466
|
/**
|
|
462
467
|
* <p>The block index from which the list should start. The list in the response will start
|
|
463
468
|
* from this block index or the next valid block index in the snapshot.</p>
|
|
464
|
-
*
|
|
469
|
+
* <p>If you specify <b>NextToken</b>, then
|
|
465
470
|
* <b>StartingBlockIndex</b> is ignored.</p>
|
|
466
471
|
*/
|
|
467
472
|
StartingBlockIndex?: number;
|
|
@@ -498,13 +503,13 @@ export interface ListSnapshotBlocksResponse {
|
|
|
498
503
|
export interface PutSnapshotBlockRequest {
|
|
499
504
|
/**
|
|
500
505
|
* <p>The ID of the snapshot.</p>
|
|
501
|
-
*
|
|
506
|
+
* <important>
|
|
502
507
|
* <p>If the specified snapshot is encrypted, you must have permission to use
|
|
503
508
|
* the KMS key that was used to encrypt the snapshot. For more information,
|
|
504
509
|
* see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapis-using-encryption.html">
|
|
505
510
|
* Using encryption</a> in the <i>Amazon Elastic Compute Cloud User
|
|
506
511
|
* Guide</i>..</p>
|
|
507
|
-
*
|
|
512
|
+
* </important>
|
|
508
513
|
*/
|
|
509
514
|
SnapshotId: string | undefined;
|
|
510
515
|
/**
|
|
@@ -517,7 +522,7 @@ export interface PutSnapshotBlockRequest {
|
|
|
517
522
|
BlockIndex: number | undefined;
|
|
518
523
|
/**
|
|
519
524
|
* <p>The data to write to the block.</p>
|
|
520
|
-
*
|
|
525
|
+
* <p>The block data is not signed as part of the Signature Version 4 signing process. As a
|
|
521
526
|
* result, you must generate and provide a Base64-encoded SHA256 checksum for the block
|
|
522
527
|
* data using the <b>x-amz-Checksum</b> header. Also, you
|
|
523
528
|
* must specify the checksum algorithm using the <b>x-amz-Checksum-Algorithm</b>
|
|
@@ -532,7 +537,7 @@ export interface PutSnapshotBlockRequest {
|
|
|
532
537
|
/**
|
|
533
538
|
* <p>The size of the data to write to the block, in bytes. Currently, the only supported
|
|
534
539
|
* size is <code>524288</code> bytes.</p>
|
|
535
|
-
*
|
|
540
|
+
* <p>Valid values: <code>524288</code>
|
|
536
541
|
* </p>
|
|
537
542
|
*/
|
|
538
543
|
DataLength: number | undefined;
|
|
@@ -590,26 +595,22 @@ export interface StartSnapshotRequest {
|
|
|
590
595
|
/**
|
|
591
596
|
* <p>The ID of the parent snapshot. If there is no parent snapshot, or if you are creating
|
|
592
597
|
* the first snapshot for an on-premises volume, omit this parameter.</p>
|
|
593
|
-
*
|
|
598
|
+
* <p>You can't specify <b>ParentSnapshotId</b> and
|
|
594
599
|
* <b>Encrypted</b> in the same request. If you specify both
|
|
595
600
|
* parameters, the request fails with <code>ValidationException</code>.</p>
|
|
596
|
-
*
|
|
597
|
-
*
|
|
598
|
-
*
|
|
599
|
-
* <p>The encryption status of the snapshot depends on the values that you specify for
|
|
601
|
+
* <p>The encryption status of the snapshot depends on the values that you specify for
|
|
600
602
|
* <b>Encrypted</b>, <b>KmsKeyArn</b>,
|
|
601
603
|
* and <b>ParentSnapshotId</b>, and whether your Amazon Web Services account
|
|
602
604
|
* is enabled for <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default">
|
|
603
605
|
* encryption by default</a>. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapis-using-encryption.html">
|
|
604
606
|
* Using encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
|
|
605
|
-
*
|
|
606
|
-
* <important>
|
|
607
|
+
* <important>
|
|
607
608
|
* <p>If you specify an encrypted parent snapshot, you must have permission to use the
|
|
608
609
|
* KMS key that was used to encrypt the parent snapshot. For more information, see
|
|
609
610
|
* <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapi-permissions.html#ebsapi-kms-permissions">
|
|
610
611
|
* Permissions to use Key Management Service keys</a> in the <i>Amazon Elastic Compute Cloud User
|
|
611
612
|
* Guide</i>.</p>
|
|
612
|
-
*
|
|
613
|
+
* </important>
|
|
613
614
|
*/
|
|
614
615
|
ParentSnapshotId?: string;
|
|
615
616
|
/**
|
|
@@ -626,69 +627,74 @@ export interface StartSnapshotRequest {
|
|
|
626
627
|
* request, if the original request completes successfully. The subsequent retries with the same
|
|
627
628
|
* client token return the result from the original successful request and they have no additional
|
|
628
629
|
* effect.</p>
|
|
629
|
-
*
|
|
630
|
-
*
|
|
630
|
+
* <p>If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.</p>
|
|
631
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-direct-api-idempotency.html">
|
|
631
632
|
* Idempotency for StartSnapshot API</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
|
|
632
633
|
*/
|
|
633
634
|
ClientToken?: string;
|
|
634
635
|
/**
|
|
635
636
|
* <p>Indicates whether to encrypt the snapshot.</p>
|
|
636
|
-
*
|
|
637
|
-
* <p>You can't specify <b>Encrypted</b> and <b>
|
|
637
|
+
* <p>You can't specify <b>Encrypted</b> and <b>
|
|
638
638
|
* ParentSnapshotId</b> in the same request. If you specify both parameters, the
|
|
639
639
|
* request fails with <code>ValidationException</code>.</p>
|
|
640
|
-
*
|
|
641
|
-
* <p>The encryption status of the snapshot depends on the values that you specify for
|
|
640
|
+
* <p>The encryption status of the snapshot depends on the values that you specify for
|
|
642
641
|
* <b>Encrypted</b>, <b>KmsKeyArn</b>,
|
|
643
642
|
* and <b>ParentSnapshotId</b>, and whether your Amazon Web Services account
|
|
644
643
|
* is enabled for <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default">
|
|
645
644
|
* encryption by default</a>. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapis-using-encryption.html">
|
|
646
645
|
* Using encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
|
|
647
|
-
*
|
|
648
|
-
*
|
|
649
|
-
*
|
|
650
|
-
* <important>
|
|
646
|
+
* <important>
|
|
651
647
|
* <p>To create an encrypted snapshot, you must have permission to use the KMS key. For
|
|
652
648
|
* more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapi-permissions.html#ebsapi-kms-permissions">
|
|
653
649
|
* Permissions to use Key Management Service keys</a> in the <i>Amazon Elastic Compute Cloud User
|
|
654
650
|
* Guide</i>.</p>
|
|
655
|
-
*
|
|
651
|
+
* </important>
|
|
656
652
|
*/
|
|
657
653
|
Encrypted?: boolean;
|
|
658
654
|
/**
|
|
659
655
|
* <p>The Amazon Resource Name (ARN) of the Key Management Service (KMS) key to be used to encrypt the snapshot.</p>
|
|
660
|
-
*
|
|
661
|
-
* <p>The encryption status of the snapshot depends on the values that you specify for
|
|
656
|
+
* <p>The encryption status of the snapshot depends on the values that you specify for
|
|
662
657
|
* <b>Encrypted</b>, <b>KmsKeyArn</b>,
|
|
663
658
|
* and <b>ParentSnapshotId</b>, and whether your Amazon Web Services account
|
|
664
659
|
* is enabled for <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default">
|
|
665
660
|
* encryption by default</a>. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapis-using-encryption.html">
|
|
666
661
|
* Using encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
|
|
667
|
-
*
|
|
668
|
-
*
|
|
669
|
-
* <important>
|
|
662
|
+
* <important>
|
|
670
663
|
* <p>To create an encrypted snapshot, you must have permission to use the KMS key. For
|
|
671
664
|
* more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapi-permissions.html#ebsapi-kms-permissions">
|
|
672
665
|
* Permissions to use Key Management Service keys</a> in the <i>Amazon Elastic Compute Cloud User
|
|
673
666
|
* Guide</i>.</p>
|
|
674
|
-
*
|
|
667
|
+
* </important>
|
|
675
668
|
*/
|
|
676
669
|
KmsKeyArn?: string;
|
|
677
670
|
/**
|
|
678
671
|
* <p>The amount of time (in minutes) after which the snapshot is automatically cancelled
|
|
679
672
|
* if:</p>
|
|
680
|
-
*
|
|
673
|
+
* <ul>
|
|
681
674
|
* <li>
|
|
682
|
-
*
|
|
675
|
+
* <p>No blocks are written to the snapshot.</p>
|
|
683
676
|
* </li>
|
|
684
677
|
* <li>
|
|
685
|
-
*
|
|
678
|
+
* <p>The snapshot is not completed after writing the last block of data.</p>
|
|
686
679
|
* </li>
|
|
687
680
|
* </ul>
|
|
688
|
-
*
|
|
681
|
+
* <p>If no value is specified, the timeout defaults to <code>60</code> minutes.</p>
|
|
689
682
|
*/
|
|
690
683
|
Timeout?: number;
|
|
691
684
|
}
|
|
685
|
+
/**
|
|
686
|
+
* @public
|
|
687
|
+
* @enum
|
|
688
|
+
*/
|
|
689
|
+
export declare const SSEType: {
|
|
690
|
+
readonly NONE: "none";
|
|
691
|
+
readonly SSE_EBS: "sse-ebs";
|
|
692
|
+
readonly SSE_KMS: "sse-kms";
|
|
693
|
+
};
|
|
694
|
+
/**
|
|
695
|
+
* @public
|
|
696
|
+
*/
|
|
697
|
+
export type SSEType = (typeof SSEType)[keyof typeof SSEType];
|
|
692
698
|
/**
|
|
693
699
|
* @public
|
|
694
700
|
*/
|
|
@@ -735,6 +741,10 @@ export interface StartSnapshotResponse {
|
|
|
735
741
|
* <p>The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used to encrypt the snapshot.</p>
|
|
736
742
|
*/
|
|
737
743
|
KmsKeyArn?: string;
|
|
744
|
+
/**
|
|
745
|
+
* <p>Reserved for future use.</p>
|
|
746
|
+
*/
|
|
747
|
+
SseType?: SSEType | string;
|
|
738
748
|
}
|
|
739
749
|
/**
|
|
740
750
|
* @internal
|
|
@@ -77,6 +77,8 @@ export declare class RequestThrottledException extends __BaseException {
|
|
|
77
77
|
}
|
|
78
78
|
export declare const ResourceNotFoundExceptionReason: {
|
|
79
79
|
readonly DEPENDENCY_RESOURCE_NOT_FOUND: "DEPENDENCY_RESOURCE_NOT_FOUND";
|
|
80
|
+
readonly GRANT_NOT_FOUND: "GRANT_NOT_FOUND";
|
|
81
|
+
readonly IMAGE_NOT_FOUND: "IMAGE_NOT_FOUND";
|
|
80
82
|
readonly SNAPSHOT_NOT_FOUND: "SNAPSHOT_NOT_FOUND";
|
|
81
83
|
};
|
|
82
84
|
export type ResourceNotFoundExceptionReason =
|
|
@@ -111,12 +113,15 @@ export declare const ValidationExceptionReason: {
|
|
|
111
113
|
readonly INVALID_CONTENT_ENCODING: "INVALID_CONTENT_ENCODING";
|
|
112
114
|
readonly INVALID_CUSTOMER_KEY: "INVALID_CUSTOMER_KEY";
|
|
113
115
|
readonly INVALID_DEPENDENCY_REQUEST: "INVALID_DEPENDENCY_REQUEST";
|
|
116
|
+
readonly INVALID_GRANT_TOKEN: "INVALID_GRANT_TOKEN";
|
|
117
|
+
readonly INVALID_IMAGE_ID: "INVALID_IMAGE_ID";
|
|
114
118
|
readonly INVALID_PAGE_TOKEN: "INVALID_PAGE_TOKEN";
|
|
115
119
|
readonly INVALID_PARAMETER_VALUE: "INVALID_PARAMETER_VALUE";
|
|
116
120
|
readonly INVALID_SNAPSHOT_ID: "INVALID_SNAPSHOT_ID";
|
|
117
121
|
readonly INVALID_TAG: "INVALID_TAG";
|
|
118
122
|
readonly INVALID_VOLUME_SIZE: "INVALID_VOLUME_SIZE";
|
|
119
123
|
readonly UNRELATED_SNAPSHOTS: "UNRELATED_SNAPSHOTS";
|
|
124
|
+
readonly WRITE_REQUEST_TIMEOUT: "WRITE_REQUEST_TIMEOUT";
|
|
120
125
|
};
|
|
121
126
|
export type ValidationExceptionReason =
|
|
122
127
|
(typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason];
|
|
@@ -211,6 +216,12 @@ export interface StartSnapshotRequest {
|
|
|
211
216
|
KmsKeyArn?: string;
|
|
212
217
|
Timeout?: number;
|
|
213
218
|
}
|
|
219
|
+
export declare const SSEType: {
|
|
220
|
+
readonly NONE: "none";
|
|
221
|
+
readonly SSE_EBS: "sse-ebs";
|
|
222
|
+
readonly SSE_KMS: "sse-kms";
|
|
223
|
+
};
|
|
224
|
+
export type SSEType = (typeof SSEType)[keyof typeof SSEType];
|
|
214
225
|
export interface StartSnapshotResponse {
|
|
215
226
|
Description?: string;
|
|
216
227
|
SnapshotId?: string;
|
|
@@ -222,6 +233,7 @@ export interface StartSnapshotResponse {
|
|
|
222
233
|
Tags?: Tag[];
|
|
223
234
|
ParentSnapshotId?: string;
|
|
224
235
|
KmsKeyArn?: string;
|
|
236
|
+
SseType?: SSEType | string;
|
|
225
237
|
}
|
|
226
238
|
export declare const ChangedBlockFilterSensitiveLog: (obj: ChangedBlock) => any;
|
|
227
239
|
export declare const GetSnapshotBlockResponseFilterSensitiveLog: (
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-ebs",
|
|
3
3
|
"description": "AWS SDK for JavaScript Ebs Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.379.1",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|
|
@@ -21,13 +21,13 @@
|
|
|
21
21
|
"dependencies": {
|
|
22
22
|
"@aws-crypto/sha256-browser": "3.0.0",
|
|
23
23
|
"@aws-crypto/sha256-js": "3.0.0",
|
|
24
|
-
"@aws-sdk/client-sts": "3.
|
|
25
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
26
|
-
"@aws-sdk/middleware-host-header": "3.
|
|
24
|
+
"@aws-sdk/client-sts": "3.379.1",
|
|
25
|
+
"@aws-sdk/credential-provider-node": "3.379.1",
|
|
26
|
+
"@aws-sdk/middleware-host-header": "3.379.1",
|
|
27
27
|
"@aws-sdk/middleware-logger": "3.378.0",
|
|
28
28
|
"@aws-sdk/middleware-recursion-detection": "3.378.0",
|
|
29
|
-
"@aws-sdk/middleware-signing": "3.
|
|
30
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
29
|
+
"@aws-sdk/middleware-signing": "3.379.1",
|
|
30
|
+
"@aws-sdk/middleware-user-agent": "3.379.1",
|
|
31
31
|
"@aws-sdk/types": "3.378.0",
|
|
32
32
|
"@aws-sdk/util-endpoints": "3.378.0",
|
|
33
33
|
"@aws-sdk/util-user-agent-browser": "3.378.0",
|