@aws-sdk/client-ebs 3.296.0 → 3.297.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.
@@ -7,6 +7,7 @@ import { PutSnapshotBlockCommandInput, PutSnapshotBlockCommandOutput } from "./c
7
7
  import { StartSnapshotCommandInput, StartSnapshotCommandOutput } from "./commands/StartSnapshotCommand";
8
8
  import { EBSClient } from "./EBSClient";
9
9
  /**
10
+ * @public
10
11
  * <p>You can use the Amazon Elastic Block Store (Amazon EBS) direct APIs to create Amazon EBS snapshots, write data directly to
11
12
  * your snapshots, read data on your snapshots, and identify the differences or changes between
12
13
  * two snapshots. If you’re an independent software vendor (ISV) who offers backup services for
@@ -30,6 +31,7 @@ import { EBSClient } from "./EBSClient";
30
31
  */
31
32
  export declare class EBS extends EBSClient {
32
33
  /**
34
+ * @public
33
35
  * <p>Seals and completes the snapshot after all of the required blocks of data have been
34
36
  * written to it. Completing the snapshot changes the status to <code>completed</code>. You
35
37
  * cannot write new blocks to a snapshot after it has been completed.</p>
@@ -38,12 +40,14 @@ export declare class EBS extends EBSClient {
38
40
  completeSnapshot(args: CompleteSnapshotCommandInput, cb: (err: any, data?: CompleteSnapshotCommandOutput) => void): void;
39
41
  completeSnapshot(args: CompleteSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CompleteSnapshotCommandOutput) => void): void;
40
42
  /**
43
+ * @public
41
44
  * <p>Returns the data in a block in an Amazon Elastic Block Store snapshot.</p>
42
45
  */
43
46
  getSnapshotBlock(args: GetSnapshotBlockCommandInput, options?: __HttpHandlerOptions): Promise<GetSnapshotBlockCommandOutput>;
44
47
  getSnapshotBlock(args: GetSnapshotBlockCommandInput, cb: (err: any, data?: GetSnapshotBlockCommandOutput) => void): void;
45
48
  getSnapshotBlock(args: GetSnapshotBlockCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSnapshotBlockCommandOutput) => void): void;
46
49
  /**
50
+ * @public
47
51
  * <p>Returns information about the blocks that are different between two
48
52
  * Amazon Elastic Block Store snapshots of the same volume/snapshot lineage.</p>
49
53
  */
@@ -51,12 +55,14 @@ export declare class EBS extends EBSClient {
51
55
  listChangedBlocks(args: ListChangedBlocksCommandInput, cb: (err: any, data?: ListChangedBlocksCommandOutput) => void): void;
52
56
  listChangedBlocks(args: ListChangedBlocksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChangedBlocksCommandOutput) => void): void;
53
57
  /**
58
+ * @public
54
59
  * <p>Returns information about the blocks in an Amazon Elastic Block Store snapshot.</p>
55
60
  */
56
61
  listSnapshotBlocks(args: ListSnapshotBlocksCommandInput, options?: __HttpHandlerOptions): Promise<ListSnapshotBlocksCommandOutput>;
57
62
  listSnapshotBlocks(args: ListSnapshotBlocksCommandInput, cb: (err: any, data?: ListSnapshotBlocksCommandOutput) => void): void;
58
63
  listSnapshotBlocks(args: ListSnapshotBlocksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSnapshotBlocksCommandOutput) => void): void;
59
64
  /**
65
+ * @public
60
66
  * <p>Writes a block of data to a snapshot. If the specified block contains
61
67
  * data, the existing data is overwritten. The target snapshot must be in the
62
68
  * <code>pending</code> state.</p>
@@ -66,6 +72,7 @@ export declare class EBS extends EBSClient {
66
72
  putSnapshotBlock(args: PutSnapshotBlockCommandInput, cb: (err: any, data?: PutSnapshotBlockCommandOutput) => void): void;
67
73
  putSnapshotBlock(args: PutSnapshotBlockCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutSnapshotBlockCommandOutput) => void): void;
68
74
  /**
75
+ * @public
69
76
  * <p>Creates a new Amazon EBS snapshot. The new snapshot enters the <code>pending</code> state
70
77
  * after the request completes. </p>
71
78
  * <p>After creating the snapshot, use <a href="https://docs.aws.amazon.com/ebs/latest/APIReference/API_PutSnapshotBlock.html"> PutSnapshotBlock</a> to
@@ -14,15 +14,24 @@ import { ListSnapshotBlocksCommandInput, ListSnapshotBlocksCommandOutput } from
14
14
  import { PutSnapshotBlockCommandInput, PutSnapshotBlockCommandOutput } from "./commands/PutSnapshotBlockCommand";
15
15
  import { StartSnapshotCommandInput, StartSnapshotCommandOutput } from "./commands/StartSnapshotCommand";
16
16
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
17
+ /**
18
+ * @public
19
+ */
17
20
  export type ServiceInputTypes = CompleteSnapshotCommandInput | GetSnapshotBlockCommandInput | ListChangedBlocksCommandInput | ListSnapshotBlocksCommandInput | PutSnapshotBlockCommandInput | StartSnapshotCommandInput;
21
+ /**
22
+ * @public
23
+ */
18
24
  export type ServiceOutputTypes = CompleteSnapshotCommandOutput | GetSnapshotBlockCommandOutput | ListChangedBlocksCommandOutput | ListSnapshotBlocksCommandOutput | PutSnapshotBlockCommandOutput | StartSnapshotCommandOutput;
25
+ /**
26
+ * @public
27
+ */
19
28
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
20
29
  /**
21
30
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
22
31
  */
23
32
  requestHandler?: __HttpHandler;
24
33
  /**
25
- * A constructor for a class implementing the {@link __Checksum} interface
34
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
26
35
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
27
36
  * @internal
28
37
  */
@@ -112,7 +121,7 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
112
121
  */
113
122
  logger?: __Logger;
114
123
  /**
115
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
124
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
116
125
  */
117
126
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
118
127
  /**
@@ -121,19 +130,30 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
121
130
  */
122
131
  sdkStreamMixin?: __SdkStreamMixinInjector;
123
132
  }
133
+ /**
134
+ * @public
135
+ */
124
136
  type EBSClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
125
137
  /**
126
- * The configuration interface of EBSClient class constructor that set the region, credentials and other options.
138
+ * @public
139
+ *
140
+ * The configuration interface of EBSClient class constructor that set the region, credentials and other options.
127
141
  */
128
142
  export interface EBSClientConfig extends EBSClientConfigType {
129
143
  }
144
+ /**
145
+ * @public
146
+ */
130
147
  type EBSClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
131
148
  /**
132
- * The resolved configuration interface of EBSClient class. This is resolved and normalized from the {@link EBSClientConfig | constructor configuration interface}.
149
+ * @public
150
+ *
151
+ * The resolved configuration interface of EBSClient class. This is resolved and normalized from the {@link EBSClientConfig | constructor configuration interface}.
133
152
  */
134
153
  export interface EBSClientResolvedConfig extends EBSClientResolvedConfigType {
135
154
  }
136
155
  /**
156
+ * @public
137
157
  * <p>You can use the Amazon Elastic Block Store (Amazon EBS) direct APIs to create Amazon EBS snapshots, write data directly to
138
158
  * your snapshots, read data on your snapshots, and identify the differences or changes between
139
159
  * two snapshots. If you’re an independent software vendor (ISV) who offers backup services for
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { EBSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EBSClient";
5
5
  import { CompleteSnapshotRequest, CompleteSnapshotResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CompleteSnapshotCommand}.
8
10
  */
9
11
  export interface CompleteSnapshotCommandInput extends CompleteSnapshotRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CompleteSnapshotCommand}.
13
17
  */
14
18
  export interface CompleteSnapshotCommandOutput extends CompleteSnapshotResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Seals and completes the snapshot after all of the required blocks of data have been
18
23
  * written to it. Completing the snapshot changes the status to <code>completed</code>. You
19
24
  * cannot write new blocks to a snapshot after it has been completed.</p>
@@ -27,6 +32,8 @@ export interface CompleteSnapshotCommandOutput extends CompleteSnapshotResponse,
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param CompleteSnapshotCommandInput - {@link CompleteSnapshotCommandInput}
36
+ * @returns {@link CompleteSnapshotCommandOutput}
30
37
  * @see {@link CompleteSnapshotCommandInput} for command's `input` shape.
31
38
  * @see {@link CompleteSnapshotCommandOutput} for command's `response` shape.
32
39
  * @see {@link EBSClientResolvedConfig | config} for EBSClient's `config` shape.
@@ -55,11 +62,20 @@ export interface CompleteSnapshotCommandOutput extends CompleteSnapshotResponse,
55
62
  export declare class CompleteSnapshotCommand extends $Command<CompleteSnapshotCommandInput, CompleteSnapshotCommandOutput, EBSClientResolvedConfig> {
56
63
  readonly input: CompleteSnapshotCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: CompleteSnapshotCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: EBSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CompleteSnapshotCommandInput, CompleteSnapshotCommandOutput>;
73
+ /**
74
+ * @internal
75
+ */
63
76
  private serialize;
77
+ /**
78
+ * @internal
79
+ */
64
80
  private deserialize;
65
81
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { EBSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EBSClient";
5
5
  import { GetSnapshotBlockRequest, GetSnapshotBlockResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetSnapshotBlockCommand}.
8
10
  */
9
11
  export interface GetSnapshotBlockCommandInput extends GetSnapshotBlockRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetSnapshotBlockCommand}.
13
17
  */
14
18
  export interface GetSnapshotBlockCommandOutput extends __WithSdkStreamMixin<GetSnapshotBlockResponse, "BlockData">, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns the data in a block in an Amazon Elastic Block Store snapshot.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface GetSnapshotBlockCommandOutput extends __WithSdkStreamMixin<GetS
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetSnapshotBlockCommandInput - {@link GetSnapshotBlockCommandInput}
34
+ * @returns {@link GetSnapshotBlockCommandOutput}
28
35
  * @see {@link GetSnapshotBlockCommandInput} for command's `input` shape.
29
36
  * @see {@link GetSnapshotBlockCommandOutput} for command's `response` shape.
30
37
  * @see {@link EBSClientResolvedConfig | config} for EBSClient's `config` shape.
@@ -53,11 +60,20 @@ export interface GetSnapshotBlockCommandOutput extends __WithSdkStreamMixin<GetS
53
60
  export declare class GetSnapshotBlockCommand extends $Command<GetSnapshotBlockCommandInput, GetSnapshotBlockCommandOutput, EBSClientResolvedConfig> {
54
61
  readonly input: GetSnapshotBlockCommandInput;
55
62
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
63
+ /**
64
+ * @public
65
+ */
56
66
  constructor(input: GetSnapshotBlockCommandInput);
57
67
  /**
58
68
  * @internal
59
69
  */
60
70
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: EBSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetSnapshotBlockCommandInput, GetSnapshotBlockCommandOutput>;
71
+ /**
72
+ * @internal
73
+ */
61
74
  private serialize;
75
+ /**
76
+ * @internal
77
+ */
62
78
  private deserialize;
63
79
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { EBSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EBSClient";
5
5
  import { ListChangedBlocksRequest, ListChangedBlocksResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListChangedBlocksCommand}.
8
10
  */
9
11
  export interface ListChangedBlocksCommandInput extends ListChangedBlocksRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListChangedBlocksCommand}.
13
17
  */
14
18
  export interface ListChangedBlocksCommandOutput extends ListChangedBlocksResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns information about the blocks that are different between two
18
23
  * Amazon Elastic Block Store snapshots of the same volume/snapshot lineage.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface ListChangedBlocksCommandOutput extends ListChangedBlocksRespons
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param ListChangedBlocksCommandInput - {@link ListChangedBlocksCommandInput}
35
+ * @returns {@link ListChangedBlocksCommandOutput}
29
36
  * @see {@link ListChangedBlocksCommandInput} for command's `input` shape.
30
37
  * @see {@link ListChangedBlocksCommandOutput} for command's `response` shape.
31
38
  * @see {@link EBSClientResolvedConfig | config} for EBSClient's `config` shape.
@@ -54,11 +61,20 @@ export interface ListChangedBlocksCommandOutput extends ListChangedBlocksRespons
54
61
  export declare class ListChangedBlocksCommand extends $Command<ListChangedBlocksCommandInput, ListChangedBlocksCommandOutput, EBSClientResolvedConfig> {
55
62
  readonly input: ListChangedBlocksCommandInput;
56
63
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
64
+ /**
65
+ * @public
66
+ */
57
67
  constructor(input: ListChangedBlocksCommandInput);
58
68
  /**
59
69
  * @internal
60
70
  */
61
71
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: EBSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListChangedBlocksCommandInput, ListChangedBlocksCommandOutput>;
72
+ /**
73
+ * @internal
74
+ */
62
75
  private serialize;
76
+ /**
77
+ * @internal
78
+ */
63
79
  private deserialize;
64
80
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { EBSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EBSClient";
5
5
  import { ListSnapshotBlocksRequest, ListSnapshotBlocksResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListSnapshotBlocksCommand}.
8
10
  */
9
11
  export interface ListSnapshotBlocksCommandInput extends ListSnapshotBlocksRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListSnapshotBlocksCommand}.
13
17
  */
14
18
  export interface ListSnapshotBlocksCommandOutput extends ListSnapshotBlocksResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns information about the blocks in an Amazon Elastic Block Store snapshot.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListSnapshotBlocksCommandOutput extends ListSnapshotBlocksRespo
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListSnapshotBlocksCommandInput - {@link ListSnapshotBlocksCommandInput}
34
+ * @returns {@link ListSnapshotBlocksCommandOutput}
28
35
  * @see {@link ListSnapshotBlocksCommandInput} for command's `input` shape.
29
36
  * @see {@link ListSnapshotBlocksCommandOutput} for command's `response` shape.
30
37
  * @see {@link EBSClientResolvedConfig | config} for EBSClient's `config` shape.
@@ -53,11 +60,20 @@ export interface ListSnapshotBlocksCommandOutput extends ListSnapshotBlocksRespo
53
60
  export declare class ListSnapshotBlocksCommand extends $Command<ListSnapshotBlocksCommandInput, ListSnapshotBlocksCommandOutput, EBSClientResolvedConfig> {
54
61
  readonly input: ListSnapshotBlocksCommandInput;
55
62
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
63
+ /**
64
+ * @public
65
+ */
56
66
  constructor(input: ListSnapshotBlocksCommandInput);
57
67
  /**
58
68
  * @internal
59
69
  */
60
70
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: EBSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListSnapshotBlocksCommandInput, ListSnapshotBlocksCommandOutput>;
71
+ /**
72
+ * @internal
73
+ */
61
74
  private serialize;
75
+ /**
76
+ * @internal
77
+ */
62
78
  private deserialize;
63
79
  }
@@ -5,9 +5,11 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
5
5
  import { EBSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EBSClient";
6
6
  import { PutSnapshotBlockRequest, PutSnapshotBlockResponse } from "../models/models_0";
7
7
  /**
8
+ * @public
9
+ *
8
10
  * The input for {@link PutSnapshotBlockCommand}.
9
11
  */
10
- type PutSnapshotBlockCommandInputType = Omit<PutSnapshotBlockRequest, "BlockData"> & {
12
+ export type PutSnapshotBlockCommandInputType = Omit<PutSnapshotBlockRequest, "BlockData"> & {
11
13
  /**
12
14
  * For *`PutSnapshotBlockRequest["BlockData"]`*, see {@link PutSnapshotBlockRequest.BlockData}.
13
15
  */
@@ -19,11 +21,14 @@ type PutSnapshotBlockCommandInputType = Omit<PutSnapshotBlockRequest, "BlockData
19
21
  export interface PutSnapshotBlockCommandInput extends PutSnapshotBlockCommandInputType {
20
22
  }
21
23
  /**
24
+ * @public
25
+ *
22
26
  * The output of {@link PutSnapshotBlockCommand}.
23
27
  */
24
28
  export interface PutSnapshotBlockCommandOutput extends PutSnapshotBlockResponse, __MetadataBearer {
25
29
  }
26
30
  /**
31
+ * @public
27
32
  * <p>Writes a block of data to a snapshot. If the specified block contains
28
33
  * data, the existing data is overwritten. The target snapshot must be in the
29
34
  * <code>pending</code> state.</p>
@@ -38,6 +43,8 @@ export interface PutSnapshotBlockCommandOutput extends PutSnapshotBlockResponse,
38
43
  * const response = await client.send(command);
39
44
  * ```
40
45
  *
46
+ * @param PutSnapshotBlockCommandInput - {@link PutSnapshotBlockCommandInput}
47
+ * @returns {@link PutSnapshotBlockCommandOutput}
41
48
  * @see {@link PutSnapshotBlockCommandInput} for command's `input` shape.
42
49
  * @see {@link PutSnapshotBlockCommandOutput} for command's `response` shape.
43
50
  * @see {@link EBSClientResolvedConfig | config} for EBSClient's `config` shape.
@@ -66,12 +73,20 @@ export interface PutSnapshotBlockCommandOutput extends PutSnapshotBlockResponse,
66
73
  export declare class PutSnapshotBlockCommand extends $Command<PutSnapshotBlockCommandInput, PutSnapshotBlockCommandOutput, EBSClientResolvedConfig> {
67
74
  readonly input: PutSnapshotBlockCommandInput;
68
75
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
76
+ /**
77
+ * @public
78
+ */
69
79
  constructor(input: PutSnapshotBlockCommandInput);
70
80
  /**
71
81
  * @internal
72
82
  */
73
83
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: EBSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutSnapshotBlockCommandInput, PutSnapshotBlockCommandOutput>;
84
+ /**
85
+ * @internal
86
+ */
74
87
  private serialize;
88
+ /**
89
+ * @internal
90
+ */
75
91
  private deserialize;
76
92
  }
77
- export {};
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { EBSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EBSClient";
5
5
  import { StartSnapshotRequest, StartSnapshotResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link StartSnapshotCommand}.
8
10
  */
9
11
  export interface StartSnapshotCommandInput extends StartSnapshotRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link StartSnapshotCommand}.
13
17
  */
14
18
  export interface StartSnapshotCommandOutput extends StartSnapshotResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a new Amazon EBS snapshot. The new snapshot enters the <code>pending</code> state
18
23
  * after the request completes. </p>
19
24
  * <p>After creating the snapshot, use <a href="https://docs.aws.amazon.com/ebs/latest/APIReference/API_PutSnapshotBlock.html"> PutSnapshotBlock</a> to
@@ -28,6 +33,8 @@ export interface StartSnapshotCommandOutput extends StartSnapshotResponse, __Met
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param StartSnapshotCommandInput - {@link StartSnapshotCommandInput}
37
+ * @returns {@link StartSnapshotCommandOutput}
31
38
  * @see {@link StartSnapshotCommandInput} for command's `input` shape.
32
39
  * @see {@link StartSnapshotCommandOutput} for command's `response` shape.
33
40
  * @see {@link EBSClientResolvedConfig | config} for EBSClient's `config` shape.
@@ -65,11 +72,20 @@ export interface StartSnapshotCommandOutput extends StartSnapshotResponse, __Met
65
72
  export declare class StartSnapshotCommand extends $Command<StartSnapshotCommandInput, StartSnapshotCommandOutput, EBSClientResolvedConfig> {
66
73
  readonly input: StartSnapshotCommandInput;
67
74
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
75
+ /**
76
+ * @public
77
+ */
68
78
  constructor(input: StartSnapshotCommandInput);
69
79
  /**
70
80
  * @internal
71
81
  */
72
82
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: EBSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartSnapshotCommandInput, StartSnapshotCommandOutput>;
83
+ /**
84
+ * @internal
85
+ */
73
86
  private serialize;
87
+ /**
88
+ * @internal
89
+ */
74
90
  private deserialize;
75
91
  }
@@ -1,5 +1,7 @@
1
1
  import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
2
2
  /**
3
+ * @public
4
+ *
3
5
  * Base exception class for all service exceptions from EBS service.
4
6
  */
5
7
  export declare class EBSServiceException extends __ServiceException {
@@ -2,11 +2,15 @@
2
2
  import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
3
3
  import { Readable } from "stream";
4
4
  import { EBSServiceException as __BaseException } from "./EBSServiceException";
5
+ /**
6
+ * @public
7
+ */
5
8
  export declare enum AccessDeniedExceptionReason {
6
9
  DEPENDENCY_ACCESS_DENIED = "DEPENDENCY_ACCESS_DENIED",
7
10
  UNAUTHORIZED_ACCOUNT = "UNAUTHORIZED_ACCOUNT"
8
11
  }
9
12
  /**
13
+ * @public
10
14
  * <p>You do not have sufficient access to perform this action.</p>
11
15
  */
12
16
  export declare class AccessDeniedException extends __BaseException {
@@ -23,6 +27,7 @@ export declare class AccessDeniedException extends __BaseException {
23
27
  constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
24
28
  }
25
29
  /**
30
+ * @public
26
31
  * <p>A block of data in an Amazon Elastic Block Store snapshot.</p>
27
32
  */
28
33
  export interface Block {
@@ -36,6 +41,7 @@ export interface Block {
36
41
  BlockToken?: string;
37
42
  }
38
43
  /**
44
+ * @public
39
45
  * <p>A block of data in an Amazon Elastic Block Store snapshot that is different from another snapshot of
40
46
  * the same volume/snapshot lineage.</p>
41
47
  */
@@ -56,12 +62,21 @@ export interface ChangedBlock {
56
62
  */
57
63
  SecondBlockToken?: string;
58
64
  }
65
+ /**
66
+ * @public
67
+ */
59
68
  export declare enum ChecksumAggregationMethod {
60
69
  CHECKSUM_AGGREGATION_LINEAR = "LINEAR"
61
70
  }
71
+ /**
72
+ * @public
73
+ */
62
74
  export declare enum ChecksumAlgorithm {
63
75
  CHECKSUM_ALGORITHM_SHA256 = "SHA256"
64
76
  }
77
+ /**
78
+ * @public
79
+ */
65
80
  export interface CompleteSnapshotRequest {
66
81
  /**
67
82
  * <p>The ID of the snapshot.</p>
@@ -91,11 +106,17 @@ export interface CompleteSnapshotRequest {
91
106
  */
92
107
  ChecksumAggregationMethod?: ChecksumAggregationMethod | string;
93
108
  }
109
+ /**
110
+ * @public
111
+ */
94
112
  export declare enum Status {
95
113
  COMPLETED = "completed",
96
114
  ERROR = "error",
97
115
  PENDING = "pending"
98
116
  }
117
+ /**
118
+ * @public
119
+ */
99
120
  export interface CompleteSnapshotResponse {
100
121
  /**
101
122
  * <p>The status of the snapshot.</p>
@@ -103,6 +124,7 @@ export interface CompleteSnapshotResponse {
103
124
  Status?: Status | string;
104
125
  }
105
126
  /**
127
+ * @public
106
128
  * <p>An internal error has occurred.</p>
107
129
  */
108
130
  export declare class InternalServerException extends __BaseException {
@@ -114,12 +136,16 @@ export declare class InternalServerException extends __BaseException {
114
136
  */
115
137
  constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
116
138
  }
139
+ /**
140
+ * @public
141
+ */
117
142
  export declare enum RequestThrottledExceptionReason {
118
143
  ACCOUNT_THROTTLED = "ACCOUNT_THROTTLED",
119
144
  DEPENDENCY_REQUEST_THROTTLED = "DEPENDENCY_REQUEST_THROTTLED",
120
145
  RESOURCE_LEVEL_THROTTLE = "RESOURCE_LEVEL_THROTTLE"
121
146
  }
122
147
  /**
148
+ * @public
123
149
  * <p>The number of API requests has exceed the maximum allowed API request throttling
124
150
  * limit.</p>
125
151
  */
@@ -136,11 +162,15 @@ export declare class RequestThrottledException extends __BaseException {
136
162
  */
137
163
  constructor(opts: __ExceptionOptionType<RequestThrottledException, __BaseException>);
138
164
  }
165
+ /**
166
+ * @public
167
+ */
139
168
  export declare enum ResourceNotFoundExceptionReason {
140
169
  DEPENDENCY_RESOURCE_NOT_FOUND = "DEPENDENCY_RESOURCE_NOT_FOUND",
141
170
  SNAPSHOT_NOT_FOUND = "SNAPSHOT_NOT_FOUND"
142
171
  }
143
172
  /**
173
+ * @public
144
174
  * <p>The specified resource does not exist.</p>
145
175
  */
146
176
  export declare class ResourceNotFoundException extends __BaseException {
@@ -156,10 +186,14 @@ export declare class ResourceNotFoundException extends __BaseException {
156
186
  */
157
187
  constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
158
188
  }
189
+ /**
190
+ * @public
191
+ */
159
192
  export declare enum ServiceQuotaExceededExceptionReason {
160
193
  DEPENDENCY_SERVICE_QUOTA_EXCEEDED = "DEPENDENCY_SERVICE_QUOTA_EXCEEDED"
161
194
  }
162
195
  /**
196
+ * @public
163
197
  * <p>Your current service quotas do not allow you to perform this action.</p>
164
198
  */
165
199
  export declare class ServiceQuotaExceededException extends __BaseException {
@@ -175,6 +209,9 @@ export declare class ServiceQuotaExceededException extends __BaseException {
175
209
  */
176
210
  constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
177
211
  }
212
+ /**
213
+ * @public
214
+ */
178
215
  export declare enum ValidationExceptionReason {
179
216
  CONFLICTING_BLOCK_UPDATE = "CONFLICTING_BLOCK_UPDATE",
180
217
  INVALID_BLOCK = "INVALID_BLOCK",
@@ -190,6 +227,7 @@ export declare enum ValidationExceptionReason {
190
227
  UNRELATED_SNAPSHOTS = "UNRELATED_SNAPSHOTS"
191
228
  }
192
229
  /**
230
+ * @public
193
231
  * <p>The input fails to satisfy the constraints of the EBS direct APIs.</p>
194
232
  */
195
233
  export declare class ValidationException extends __BaseException {
@@ -206,6 +244,7 @@ export declare class ValidationException extends __BaseException {
206
244
  constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
207
245
  }
208
246
  /**
247
+ * @public
209
248
  * <p>You have reached the limit for concurrent API requests. For more information, see
210
249
  * <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
211
250
  * User Guide</i>.</p>
@@ -220,6 +259,7 @@ export declare class ConcurrentLimitExceededException extends __BaseException {
220
259
  constructor(opts: __ExceptionOptionType<ConcurrentLimitExceededException, __BaseException>);
221
260
  }
222
261
  /**
262
+ * @public
223
263
  * <p>The request uses the same client token as a previous, but non-identical
224
264
  * request.</p>
225
265
  */
@@ -232,6 +272,9 @@ export declare class ConflictException extends __BaseException {
232
272
  */
233
273
  constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
234
274
  }
275
+ /**
276
+ * @public
277
+ */
235
278
  export interface GetSnapshotBlockRequest {
236
279
  /**
237
280
  * <p>The ID of the snapshot containing the block from which to get data.</p>
@@ -258,6 +301,9 @@ export interface GetSnapshotBlockRequest {
258
301
  */
259
302
  BlockToken: string | undefined;
260
303
  }
304
+ /**
305
+ * @public
306
+ */
261
307
  export interface GetSnapshotBlockResponse {
262
308
  /**
263
309
  * <p>The size of the data in the block.</p>
@@ -276,6 +322,9 @@ export interface GetSnapshotBlockResponse {
276
322
  */
277
323
  ChecksumAlgorithm?: ChecksumAlgorithm | string;
278
324
  }
325
+ /**
326
+ * @public
327
+ */
279
328
  export interface ListChangedBlocksRequest {
280
329
  /**
281
330
  * <p>The ID of the first snapshot to use for the comparison.</p>
@@ -319,6 +368,9 @@ export interface ListChangedBlocksRequest {
319
368
  */
320
369
  StartingBlockIndex?: number;
321
370
  }
371
+ /**
372
+ * @public
373
+ */
322
374
  export interface ListChangedBlocksResponse {
323
375
  /**
324
376
  * <p>An array of objects containing information about the changed blocks.</p>
@@ -342,6 +394,9 @@ export interface ListChangedBlocksResponse {
342
394
  */
343
395
  NextToken?: string;
344
396
  }
397
+ /**
398
+ * @public
399
+ */
345
400
  export interface ListSnapshotBlocksRequest {
346
401
  /**
347
402
  * <p>The ID of the snapshot from which to get block indexes and block tokens.</p>
@@ -372,6 +427,9 @@ export interface ListSnapshotBlocksRequest {
372
427
  */
373
428
  StartingBlockIndex?: number;
374
429
  }
430
+ /**
431
+ * @public
432
+ */
375
433
  export interface ListSnapshotBlocksResponse {
376
434
  /**
377
435
  * <p>An array of objects containing information about the blocks.</p>
@@ -395,6 +453,9 @@ export interface ListSnapshotBlocksResponse {
395
453
  */
396
454
  NextToken?: string;
397
455
  }
456
+ /**
457
+ * @public
458
+ */
398
459
  export interface PutSnapshotBlockRequest {
399
460
  /**
400
461
  * <p>The ID of the snapshot.</p>
@@ -451,6 +512,9 @@ export interface PutSnapshotBlockRequest {
451
512
  */
452
513
  ChecksumAlgorithm: ChecksumAlgorithm | string | undefined;
453
514
  }
515
+ /**
516
+ * @public
517
+ */
454
518
  export interface PutSnapshotBlockResponse {
455
519
  /**
456
520
  * <p>The SHA256 checksum generated for the block data by Amazon EBS.</p>
@@ -462,6 +526,7 @@ export interface PutSnapshotBlockResponse {
462
526
  ChecksumAlgorithm?: ChecksumAlgorithm | string;
463
527
  }
464
528
  /**
529
+ * @public
465
530
  * <p>Describes a tag.</p>
466
531
  */
467
532
  export interface Tag {
@@ -474,6 +539,9 @@ export interface Tag {
474
539
  */
475
540
  Value?: string;
476
541
  }
542
+ /**
543
+ * @public
544
+ */
477
545
  export interface StartSnapshotRequest {
478
546
  /**
479
547
  * <p>The size of the volume, in GiB. The maximum size is <code>65536</code> GiB (64
@@ -582,6 +650,9 @@ export interface StartSnapshotRequest {
582
650
  */
583
651
  Timeout?: number;
584
652
  }
653
+ /**
654
+ * @public
655
+ */
585
656
  export interface StartSnapshotResponse {
586
657
  /**
587
658
  * <p>The description of the snapshot.</p>
@@ -1,5 +1,8 @@
1
1
  import { PaginationConfiguration } from "@aws-sdk/types";
2
2
  import { EBSClient } from "../EBSClient";
3
+ /**
4
+ * @public
5
+ */
3
6
  export interface EBSPaginationConfiguration extends PaginationConfiguration {
4
7
  client: EBSClient;
5
8
  }
@@ -1,4 +1,7 @@
1
1
  import { Paginator } from "@aws-sdk/types";
2
2
  import { ListChangedBlocksCommandInput, ListChangedBlocksCommandOutput } from "../commands/ListChangedBlocksCommand";
3
3
  import { EBSPaginationConfiguration } from "./Interfaces";
4
+ /**
5
+ * @public
6
+ */
4
7
  export declare function paginateListChangedBlocks(config: EBSPaginationConfiguration, input: ListChangedBlocksCommandInput, ...additionalArguments: any): Paginator<ListChangedBlocksCommandOutput>;
@@ -1,4 +1,7 @@
1
1
  import { Paginator } from "@aws-sdk/types";
2
2
  import { ListSnapshotBlocksCommandInput, ListSnapshotBlocksCommandOutput } from "../commands/ListSnapshotBlocksCommand";
3
3
  import { EBSPaginationConfiguration } from "./Interfaces";
4
+ /**
5
+ * @public
6
+ */
4
7
  export declare function paginateListSnapshotBlocks(config: EBSPaginationConfiguration, input: ListSnapshotBlocksCommandInput, ...additionalArguments: any): Paginator<ListSnapshotBlocksCommandOutput>;
@@ -15,7 +15,7 @@ import {
15
15
  PutSnapshotBlockRequest,
16
16
  PutSnapshotBlockResponse,
17
17
  } from "../models/models_0";
18
- type PutSnapshotBlockCommandInputType = Pick<
18
+ export type PutSnapshotBlockCommandInputType = Pick<
19
19
  PutSnapshotBlockRequest,
20
20
  Exclude<keyof PutSnapshotBlockRequest, "BlockData">
21
21
  > & {
@@ -46,4 +46,3 @@ export declare class PutSnapshotBlockCommand extends $Command<
46
46
  private serialize;
47
47
  private deserialize;
48
48
  }
49
- export {};
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.296.0",
4
+ "version": "3.297.0",
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",
@@ -20,9 +20,9 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "3.0.0",
22
22
  "@aws-crypto/sha256-js": "3.0.0",
23
- "@aws-sdk/client-sts": "3.296.0",
23
+ "@aws-sdk/client-sts": "3.297.0",
24
24
  "@aws-sdk/config-resolver": "3.296.0",
25
- "@aws-sdk/credential-provider-node": "3.296.0",
25
+ "@aws-sdk/credential-provider-node": "3.297.0",
26
26
  "@aws-sdk/fetch-http-handler": "3.296.0",
27
27
  "@aws-sdk/hash-node": "3.296.0",
28
28
  "@aws-sdk/invalid-dependency": "3.296.0",