@aws-sdk/client-timestream-write 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.
Files changed (28) hide show
  1. package/dist-types/TimestreamWrite.d.ts +20 -0
  2. package/dist-types/TimestreamWriteClient.d.ts +24 -4
  3. package/dist-types/commands/CreateBatchLoadTaskCommand.d.ts +16 -0
  4. package/dist-types/commands/CreateDatabaseCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateTableCommand.d.ts +16 -0
  6. package/dist-types/commands/DeleteDatabaseCommand.d.ts +16 -0
  7. package/dist-types/commands/DeleteTableCommand.d.ts +16 -0
  8. package/dist-types/commands/DescribeBatchLoadTaskCommand.d.ts +16 -0
  9. package/dist-types/commands/DescribeDatabaseCommand.d.ts +16 -0
  10. package/dist-types/commands/DescribeEndpointsCommand.d.ts +16 -0
  11. package/dist-types/commands/DescribeTableCommand.d.ts +16 -0
  12. package/dist-types/commands/ListBatchLoadTasksCommand.d.ts +16 -0
  13. package/dist-types/commands/ListDatabasesCommand.d.ts +16 -0
  14. package/dist-types/commands/ListTablesCommand.d.ts +16 -0
  15. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  16. package/dist-types/commands/ResumeBatchLoadTaskCommand.d.ts +16 -0
  17. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  18. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  19. package/dist-types/commands/UpdateDatabaseCommand.d.ts +16 -0
  20. package/dist-types/commands/UpdateTableCommand.d.ts +16 -0
  21. package/dist-types/commands/WriteRecordsCommand.d.ts +16 -0
  22. package/dist-types/models/TimestreamWriteServiceException.d.ts +2 -0
  23. package/dist-types/models/models_0.d.ts +169 -0
  24. package/dist-types/pagination/Interfaces.d.ts +3 -0
  25. package/dist-types/pagination/ListBatchLoadTasksPaginator.d.ts +3 -0
  26. package/dist-types/pagination/ListDatabasesPaginator.d.ts +3 -0
  27. package/dist-types/pagination/ListTablesPaginator.d.ts +3 -0
  28. package/package.json +3 -3
@@ -20,6 +20,7 @@ import { UpdateTableCommandInput, UpdateTableCommandOutput } from "./commands/Up
20
20
  import { WriteRecordsCommandInput, WriteRecordsCommandOutput } from "./commands/WriteRecordsCommand";
21
21
  import { TimestreamWriteClient } from "./TimestreamWriteClient";
22
22
  /**
23
+ * @public
23
24
  * <fullname>Amazon Timestream Write</fullname>
24
25
  * <p>Amazon Timestream is a fast, scalable, fully managed time-series database service
25
26
  * that makes it easy to store and analyze trillions of time-series data points per day. With
@@ -36,6 +37,7 @@ import { TimestreamWriteClient } from "./TimestreamWriteClient";
36
37
  */
37
38
  export declare class TimestreamWrite extends TimestreamWriteClient {
38
39
  /**
40
+ * @public
39
41
  * <p>Creates a new Timestream batch load task. A batch load task processes data from
40
42
  * a CSV source in an S3 location and writes to a Timestream table. A mapping from
41
43
  * source to target is defined in a batch load task. Errors and events are written to a report
@@ -50,6 +52,7 @@ export declare class TimestreamWrite extends TimestreamWriteClient {
50
52
  createBatchLoadTask(args: CreateBatchLoadTaskCommandInput, cb: (err: any, data?: CreateBatchLoadTaskCommandOutput) => void): void;
51
53
  createBatchLoadTask(args: CreateBatchLoadTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBatchLoadTaskCommandOutput) => void): void;
52
54
  /**
55
+ * @public
53
56
  * <p>Creates a new Timestream database. If the KMS key is not
54
57
  * specified, the database will be encrypted with a Timestream managed KMS key located in your account. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">Amazon Web Services managed keys</a>. <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html">Service quotas apply</a>. For
55
58
  * details, see <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-db.html">code sample</a>.
@@ -59,6 +62,7 @@ export declare class TimestreamWrite extends TimestreamWriteClient {
59
62
  createDatabase(args: CreateDatabaseCommandInput, cb: (err: any, data?: CreateDatabaseCommandOutput) => void): void;
60
63
  createDatabase(args: CreateDatabaseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatabaseCommandOutput) => void): void;
61
64
  /**
65
+ * @public
62
66
  * <p>Adds a new table to an existing database in your account. In an Amazon Web Services account, table names must be at least unique within each Region if they are in the same
63
67
  * database. You might have identical table names in the same Region if the tables are in
64
68
  * separate databases. While creating the table, you must specify the table name, database
@@ -70,6 +74,7 @@ export declare class TimestreamWrite extends TimestreamWriteClient {
70
74
  createTable(args: CreateTableCommandInput, cb: (err: any, data?: CreateTableCommandOutput) => void): void;
71
75
  createTable(args: CreateTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTableCommandOutput) => void): void;
72
76
  /**
77
+ * @public
73
78
  * <p>Deletes a given Timestream database. <i>This is an irreversible
74
79
  * operation. After a database is deleted, the time-series data from its tables cannot be
75
80
  * recovered.</i>
@@ -87,6 +92,7 @@ export declare class TimestreamWrite extends TimestreamWriteClient {
87
92
  deleteDatabase(args: DeleteDatabaseCommandInput, cb: (err: any, data?: DeleteDatabaseCommandOutput) => void): void;
88
93
  deleteDatabase(args: DeleteDatabaseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDatabaseCommandOutput) => void): void;
89
94
  /**
95
+ * @public
90
96
  * <p>Deletes a given Timestream table. This is an irreversible operation. After a
91
97
  * Timestream database table is deleted, the time-series data stored in the table
92
98
  * cannot be recovered. </p>
@@ -101,6 +107,7 @@ export declare class TimestreamWrite extends TimestreamWriteClient {
101
107
  deleteTable(args: DeleteTableCommandInput, cb: (err: any, data?: DeleteTableCommandOutput) => void): void;
102
108
  deleteTable(args: DeleteTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTableCommandOutput) => void): void;
103
109
  /**
110
+ * @public
104
111
  * <p>Returns information about the batch load task, including configurations, mappings,
105
112
  * progress, and other details. <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html">Service quotas apply</a>. See
106
113
  * <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-batch-load.html">code
@@ -110,6 +117,7 @@ export declare class TimestreamWrite extends TimestreamWriteClient {
110
117
  describeBatchLoadTask(args: DescribeBatchLoadTaskCommandInput, cb: (err: any, data?: DescribeBatchLoadTaskCommandOutput) => void): void;
111
118
  describeBatchLoadTask(args: DescribeBatchLoadTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBatchLoadTaskCommandOutput) => void): void;
112
119
  /**
120
+ * @public
113
121
  * <p>Returns information about the database, including the database name, time that the
114
122
  * database was created, and the total number of tables found within the database. <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html">Service
115
123
  * quotas apply</a>. See <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-db.html">code sample</a>
@@ -119,6 +127,7 @@ export declare class TimestreamWrite extends TimestreamWriteClient {
119
127
  describeDatabase(args: DescribeDatabaseCommandInput, cb: (err: any, data?: DescribeDatabaseCommandOutput) => void): void;
120
128
  describeDatabase(args: DescribeDatabaseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDatabaseCommandOutput) => void): void;
121
129
  /**
130
+ * @public
122
131
  * <p>Returns a list of available endpoints to make Timestream API calls against.
123
132
  * This API operation is available through both the Write and Query APIs.</p>
124
133
  * <p>Because the Timestream SDKs are designed to transparently work with the
@@ -145,6 +154,7 @@ export declare class TimestreamWrite extends TimestreamWriteClient {
145
154
  describeEndpoints(args: DescribeEndpointsCommandInput, cb: (err: any, data?: DescribeEndpointsCommandOutput) => void): void;
146
155
  describeEndpoints(args: DescribeEndpointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEndpointsCommandOutput) => void): void;
147
156
  /**
157
+ * @public
148
158
  * <p>Returns information about the table, including the table name, database name, retention
149
159
  * duration of the memory store and the magnetic store. <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html">Service quotas apply</a>. See
150
160
  * <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-table.html">code
@@ -154,6 +164,7 @@ export declare class TimestreamWrite extends TimestreamWriteClient {
154
164
  describeTable(args: DescribeTableCommandInput, cb: (err: any, data?: DescribeTableCommandOutput) => void): void;
155
165
  describeTable(args: DescribeTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTableCommandOutput) => void): void;
156
166
  /**
167
+ * @public
157
168
  * <p>Provides a list of batch load tasks, along with the name, status, when the task is
158
169
  * resumable until, and other details. See <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-batch-load-tasks.html">code
159
170
  * sample</a> for details.</p>
@@ -162,6 +173,7 @@ export declare class TimestreamWrite extends TimestreamWriteClient {
162
173
  listBatchLoadTasks(args: ListBatchLoadTasksCommandInput, cb: (err: any, data?: ListBatchLoadTasksCommandOutput) => void): void;
163
174
  listBatchLoadTasks(args: ListBatchLoadTasksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBatchLoadTasksCommandOutput) => void): void;
164
175
  /**
176
+ * @public
165
177
  * <p>Returns a list of your Timestream databases. <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html">Service quotas apply</a>. See
166
178
  * <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-db.html">code sample</a> for
167
179
  * details. </p>
@@ -170,6 +182,7 @@ export declare class TimestreamWrite extends TimestreamWriteClient {
170
182
  listDatabases(args: ListDatabasesCommandInput, cb: (err: any, data?: ListDatabasesCommandOutput) => void): void;
171
183
  listDatabases(args: ListDatabasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatabasesCommandOutput) => void): void;
172
184
  /**
185
+ * @public
173
186
  * <p>Provides a list of tables, along with the name, status, and retention properties of each
174
187
  * table. See <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-table.html">code sample</a>
175
188
  * for details. </p>
@@ -178,12 +191,14 @@ export declare class TimestreamWrite extends TimestreamWriteClient {
178
191
  listTables(args: ListTablesCommandInput, cb: (err: any, data?: ListTablesCommandOutput) => void): void;
179
192
  listTables(args: ListTablesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTablesCommandOutput) => void): void;
180
193
  /**
194
+ * @public
181
195
  * <p> Lists all tags on a Timestream resource. </p>
182
196
  */
183
197
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
184
198
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
185
199
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
186
200
  /**
201
+ * @public
187
202
  * <p>
188
203
  * </p>
189
204
  */
@@ -191,6 +206,7 @@ export declare class TimestreamWrite extends TimestreamWriteClient {
191
206
  resumeBatchLoadTask(args: ResumeBatchLoadTaskCommandInput, cb: (err: any, data?: ResumeBatchLoadTaskCommandOutput) => void): void;
192
207
  resumeBatchLoadTask(args: ResumeBatchLoadTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResumeBatchLoadTaskCommandOutput) => void): void;
193
208
  /**
209
+ * @public
194
210
  * <p> Associates a set of tags with a Timestream resource. You can then activate
195
211
  * these user-defined tags so that they appear on the Billing and Cost Management console for
196
212
  * cost allocation tracking. </p>
@@ -199,12 +215,14 @@ export declare class TimestreamWrite extends TimestreamWriteClient {
199
215
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
200
216
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
201
217
  /**
218
+ * @public
202
219
  * <p> Removes the association of tags from a Timestream resource. </p>
203
220
  */
204
221
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
205
222
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
206
223
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
207
224
  /**
225
+ * @public
208
226
  * <p> Modifies the KMS key for an existing database. While updating the
209
227
  * database, you must specify the database name and the identifier of the new KMS key to be used (<code>KmsKeyId</code>). If there are any concurrent
210
228
  * <code>UpdateDatabase</code> requests, first writer wins. </p>
@@ -215,6 +233,7 @@ export declare class TimestreamWrite extends TimestreamWriteClient {
215
233
  updateDatabase(args: UpdateDatabaseCommandInput, cb: (err: any, data?: UpdateDatabaseCommandOutput) => void): void;
216
234
  updateDatabase(args: UpdateDatabaseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDatabaseCommandOutput) => void): void;
217
235
  /**
236
+ * @public
218
237
  * <p>Modifies the retention duration of the memory store and magnetic store for your Timestream table. Note that the change in retention duration takes effect immediately.
219
238
  * For example, if the retention period of the memory store was initially set to 2 hours and
220
239
  * then changed to 24 hours, the memory store will be capable of holding 24 hours of data, but
@@ -226,6 +245,7 @@ export declare class TimestreamWrite extends TimestreamWriteClient {
226
245
  updateTable(args: UpdateTableCommandInput, cb: (err: any, data?: UpdateTableCommandOutput) => void): void;
227
246
  updateTable(args: UpdateTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTableCommandOutput) => void): void;
228
247
  /**
248
+ * @public
229
249
  * <p>Enables you to write your time-series data into Timestream. You can specify a
230
250
  * single data point or a batch of data points to be inserted into the system. Timestream offers you a flexible schema that auto detects the column names and data
231
251
  * types for your Timestream tables based on the dimension names and data types of
@@ -28,15 +28,24 @@ import { UpdateDatabaseCommandInput, UpdateDatabaseCommandOutput } from "./comma
28
28
  import { UpdateTableCommandInput, UpdateTableCommandOutput } from "./commands/UpdateTableCommand";
29
29
  import { WriteRecordsCommandInput, WriteRecordsCommandOutput } from "./commands/WriteRecordsCommand";
30
30
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
31
+ /**
32
+ * @public
33
+ */
31
34
  export type ServiceInputTypes = CreateBatchLoadTaskCommandInput | CreateDatabaseCommandInput | CreateTableCommandInput | DeleteDatabaseCommandInput | DeleteTableCommandInput | DescribeBatchLoadTaskCommandInput | DescribeDatabaseCommandInput | DescribeEndpointsCommandInput | DescribeTableCommandInput | ListBatchLoadTasksCommandInput | ListDatabasesCommandInput | ListTablesCommandInput | ListTagsForResourceCommandInput | ResumeBatchLoadTaskCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateDatabaseCommandInput | UpdateTableCommandInput | WriteRecordsCommandInput;
35
+ /**
36
+ * @public
37
+ */
32
38
  export type ServiceOutputTypes = CreateBatchLoadTaskCommandOutput | CreateDatabaseCommandOutput | CreateTableCommandOutput | DeleteDatabaseCommandOutput | DeleteTableCommandOutput | DescribeBatchLoadTaskCommandOutput | DescribeDatabaseCommandOutput | DescribeEndpointsCommandOutput | DescribeTableCommandOutput | ListBatchLoadTasksCommandOutput | ListDatabasesCommandOutput | ListTablesCommandOutput | ListTagsForResourceCommandOutput | ResumeBatchLoadTaskCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateDatabaseCommandOutput | UpdateTableCommandOutput | WriteRecordsCommandOutput;
39
+ /**
40
+ * @public
41
+ */
33
42
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
34
43
  /**
35
44
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
36
45
  */
37
46
  requestHandler?: __HttpHandler;
38
47
  /**
39
- * A constructor for a class implementing the {@link __Checksum} interface
48
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
40
49
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
41
50
  * @internal
42
51
  */
@@ -132,23 +141,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
132
141
  */
133
142
  logger?: __Logger;
134
143
  /**
135
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
144
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
136
145
  */
137
146
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
138
147
  }
148
+ /**
149
+ * @public
150
+ */
139
151
  type TimestreamWriteClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & EndpointDiscoveryInputConfig & ClientInputEndpointParameters;
140
152
  /**
141
- * The configuration interface of TimestreamWriteClient class constructor that set the region, credentials and other options.
153
+ * @public
154
+ *
155
+ * The configuration interface of TimestreamWriteClient class constructor that set the region, credentials and other options.
142
156
  */
143
157
  export interface TimestreamWriteClientConfig extends TimestreamWriteClientConfigType {
144
158
  }
159
+ /**
160
+ * @public
161
+ */
145
162
  type TimestreamWriteClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & EndpointDiscoveryResolvedConfig & ClientResolvedEndpointParameters;
146
163
  /**
147
- * The resolved configuration interface of TimestreamWriteClient class. This is resolved and normalized from the {@link TimestreamWriteClientConfig | constructor configuration interface}.
164
+ * @public
165
+ *
166
+ * The resolved configuration interface of TimestreamWriteClient class. This is resolved and normalized from the {@link TimestreamWriteClientConfig | constructor configuration interface}.
148
167
  */
149
168
  export interface TimestreamWriteClientResolvedConfig extends TimestreamWriteClientResolvedConfigType {
150
169
  }
151
170
  /**
171
+ * @public
152
172
  * <fullname>Amazon Timestream Write</fullname>
153
173
  * <p>Amazon Timestream is a fast, scalable, fully managed time-series database service
154
174
  * that makes it easy to store and analyze trillions of time-series data points per day. With
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateBatchLoadTaskRequest, CreateBatchLoadTaskResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TimestreamWriteClientResolvedConfig } from "../TimestreamWriteClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateBatchLoadTaskCommand}.
8
10
  */
9
11
  export interface CreateBatchLoadTaskCommandInput extends CreateBatchLoadTaskRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateBatchLoadTaskCommand}.
13
17
  */
14
18
  export interface CreateBatchLoadTaskCommandOutput extends CreateBatchLoadTaskResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a new Timestream batch load task. A batch load task processes data from
18
23
  * a CSV source in an S3 location and writes to a Timestream table. A mapping from
19
24
  * source to target is defined in a batch load task. Errors and events are written to a report
@@ -33,6 +38,8 @@ export interface CreateBatchLoadTaskCommandOutput extends CreateBatchLoadTaskRes
33
38
  * const response = await client.send(command);
34
39
  * ```
35
40
  *
41
+ * @param CreateBatchLoadTaskCommandInput - {@link CreateBatchLoadTaskCommandInput}
42
+ * @returns {@link CreateBatchLoadTaskCommandOutput}
36
43
  * @see {@link CreateBatchLoadTaskCommandInput} for command's `input` shape.
37
44
  * @see {@link CreateBatchLoadTaskCommandOutput} for command's `response` shape.
38
45
  * @see {@link TimestreamWriteClientResolvedConfig | config} for TimestreamWriteClient's `config` shape.
@@ -71,11 +78,20 @@ export interface CreateBatchLoadTaskCommandOutput extends CreateBatchLoadTaskRes
71
78
  export declare class CreateBatchLoadTaskCommand extends $Command<CreateBatchLoadTaskCommandInput, CreateBatchLoadTaskCommandOutput, TimestreamWriteClientResolvedConfig> {
72
79
  readonly input: CreateBatchLoadTaskCommandInput;
73
80
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
81
+ /**
82
+ * @public
83
+ */
74
84
  constructor(input: CreateBatchLoadTaskCommandInput);
75
85
  /**
76
86
  * @internal
77
87
  */
78
88
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TimestreamWriteClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateBatchLoadTaskCommandInput, CreateBatchLoadTaskCommandOutput>;
89
+ /**
90
+ * @internal
91
+ */
79
92
  private serialize;
93
+ /**
94
+ * @internal
95
+ */
80
96
  private deserialize;
81
97
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateDatabaseRequest, CreateDatabaseResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TimestreamWriteClientResolvedConfig } from "../TimestreamWriteClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateDatabaseCommand}.
8
10
  */
9
11
  export interface CreateDatabaseCommandInput extends CreateDatabaseRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateDatabaseCommand}.
13
17
  */
14
18
  export interface CreateDatabaseCommandOutput extends CreateDatabaseResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a new Timestream database. If the KMS key is not
18
23
  * specified, the database will be encrypted with a Timestream managed KMS key located in your account. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">Amazon Web Services managed keys</a>. <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html">Service quotas apply</a>. For
19
24
  * details, see <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-db.html">code sample</a>.
@@ -28,6 +33,8 @@ export interface CreateDatabaseCommandOutput extends CreateDatabaseResponse, __M
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param CreateDatabaseCommandInput - {@link CreateDatabaseCommandInput}
37
+ * @returns {@link CreateDatabaseCommandOutput}
31
38
  * @see {@link CreateDatabaseCommandInput} for command's `input` shape.
32
39
  * @see {@link CreateDatabaseCommandOutput} for command's `response` shape.
33
40
  * @see {@link TimestreamWriteClientResolvedConfig | config} for TimestreamWriteClient's `config` shape.
@@ -62,11 +69,20 @@ export interface CreateDatabaseCommandOutput extends CreateDatabaseResponse, __M
62
69
  export declare class CreateDatabaseCommand extends $Command<CreateDatabaseCommandInput, CreateDatabaseCommandOutput, TimestreamWriteClientResolvedConfig> {
63
70
  readonly input: CreateDatabaseCommandInput;
64
71
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
72
+ /**
73
+ * @public
74
+ */
65
75
  constructor(input: CreateDatabaseCommandInput);
66
76
  /**
67
77
  * @internal
68
78
  */
69
79
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TimestreamWriteClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateDatabaseCommandInput, CreateDatabaseCommandOutput>;
80
+ /**
81
+ * @internal
82
+ */
70
83
  private serialize;
84
+ /**
85
+ * @internal
86
+ */
71
87
  private deserialize;
72
88
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateTableRequest, CreateTableResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TimestreamWriteClientResolvedConfig } from "../TimestreamWriteClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateTableCommand}.
8
10
  */
9
11
  export interface CreateTableCommandInput extends CreateTableRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateTableCommand}.
13
17
  */
14
18
  export interface CreateTableCommandOutput extends CreateTableResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Adds a new table to an existing database in your account. In an Amazon Web Services account, table names must be at least unique within each Region if they are in the same
18
23
  * database. You might have identical table names in the same Region if the tables are in
19
24
  * separate databases. While creating the table, you must specify the table name, database
@@ -30,6 +35,8 @@ export interface CreateTableCommandOutput extends CreateTableResponse, __Metadat
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param CreateTableCommandInput - {@link CreateTableCommandInput}
39
+ * @returns {@link CreateTableCommandOutput}
33
40
  * @see {@link CreateTableCommandInput} for command's `input` shape.
34
41
  * @see {@link CreateTableCommandOutput} for command's `response` shape.
35
42
  * @see {@link TimestreamWriteClientResolvedConfig | config} for TimestreamWriteClient's `config` shape.
@@ -68,11 +75,20 @@ export interface CreateTableCommandOutput extends CreateTableResponse, __Metadat
68
75
  export declare class CreateTableCommand extends $Command<CreateTableCommandInput, CreateTableCommandOutput, TimestreamWriteClientResolvedConfig> {
69
76
  readonly input: CreateTableCommandInput;
70
77
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
78
+ /**
79
+ * @public
80
+ */
71
81
  constructor(input: CreateTableCommandInput);
72
82
  /**
73
83
  * @internal
74
84
  */
75
85
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TimestreamWriteClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateTableCommandInput, CreateTableCommandOutput>;
86
+ /**
87
+ * @internal
88
+ */
76
89
  private serialize;
90
+ /**
91
+ * @internal
92
+ */
77
93
  private deserialize;
78
94
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteDatabaseRequest } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TimestreamWriteClientResolvedConfig } from "../TimestreamWriteClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteDatabaseCommand}.
8
10
  */
9
11
  export interface DeleteDatabaseCommandInput extends DeleteDatabaseRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteDatabaseCommand}.
13
17
  */
14
18
  export interface DeleteDatabaseCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a given Timestream database. <i>This is an irreversible
18
23
  * operation. After a database is deleted, the time-series data from its tables cannot be
19
24
  * recovered.</i>
@@ -36,6 +41,8 @@ export interface DeleteDatabaseCommandOutput extends __MetadataBearer {
36
41
  * const response = await client.send(command);
37
42
  * ```
38
43
  *
44
+ * @param DeleteDatabaseCommandInput - {@link DeleteDatabaseCommandInput}
45
+ * @returns {@link DeleteDatabaseCommandOutput}
39
46
  * @see {@link DeleteDatabaseCommandInput} for command's `input` shape.
40
47
  * @see {@link DeleteDatabaseCommandOutput} for command's `response` shape.
41
48
  * @see {@link TimestreamWriteClientResolvedConfig | config} for TimestreamWriteClient's `config` shape.
@@ -67,11 +74,20 @@ export interface DeleteDatabaseCommandOutput extends __MetadataBearer {
67
74
  export declare class DeleteDatabaseCommand extends $Command<DeleteDatabaseCommandInput, DeleteDatabaseCommandOutput, TimestreamWriteClientResolvedConfig> {
68
75
  readonly input: DeleteDatabaseCommandInput;
69
76
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
77
+ /**
78
+ * @public
79
+ */
70
80
  constructor(input: DeleteDatabaseCommandInput);
71
81
  /**
72
82
  * @internal
73
83
  */
74
84
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TimestreamWriteClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteDatabaseCommandInput, DeleteDatabaseCommandOutput>;
85
+ /**
86
+ * @internal
87
+ */
75
88
  private serialize;
89
+ /**
90
+ * @internal
91
+ */
76
92
  private deserialize;
77
93
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteTableRequest } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TimestreamWriteClientResolvedConfig } from "../TimestreamWriteClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteTableCommand}.
8
10
  */
9
11
  export interface DeleteTableCommandInput extends DeleteTableRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteTableCommand}.
13
17
  */
14
18
  export interface DeleteTableCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a given Timestream table. This is an irreversible operation. After a
18
23
  * Timestream database table is deleted, the time-series data stored in the table
19
24
  * cannot be recovered. </p>
@@ -33,6 +38,8 @@ export interface DeleteTableCommandOutput extends __MetadataBearer {
33
38
  * const response = await client.send(command);
34
39
  * ```
35
40
  *
41
+ * @param DeleteTableCommandInput - {@link DeleteTableCommandInput}
42
+ * @returns {@link DeleteTableCommandOutput}
36
43
  * @see {@link DeleteTableCommandInput} for command's `input` shape.
37
44
  * @see {@link DeleteTableCommandOutput} for command's `response` shape.
38
45
  * @see {@link TimestreamWriteClientResolvedConfig | config} for TimestreamWriteClient's `config` shape.
@@ -64,11 +71,20 @@ export interface DeleteTableCommandOutput extends __MetadataBearer {
64
71
  export declare class DeleteTableCommand extends $Command<DeleteTableCommandInput, DeleteTableCommandOutput, TimestreamWriteClientResolvedConfig> {
65
72
  readonly input: DeleteTableCommandInput;
66
73
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
74
+ /**
75
+ * @public
76
+ */
67
77
  constructor(input: DeleteTableCommandInput);
68
78
  /**
69
79
  * @internal
70
80
  */
71
81
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TimestreamWriteClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteTableCommandInput, DeleteTableCommandOutput>;
82
+ /**
83
+ * @internal
84
+ */
72
85
  private serialize;
86
+ /**
87
+ * @internal
88
+ */
73
89
  private deserialize;
74
90
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeBatchLoadTaskRequest, DescribeBatchLoadTaskResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TimestreamWriteClientResolvedConfig } from "../TimestreamWriteClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeBatchLoadTaskCommand}.
8
10
  */
9
11
  export interface DescribeBatchLoadTaskCommandInput extends DescribeBatchLoadTaskRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeBatchLoadTaskCommand}.
13
17
  */
14
18
  export interface DescribeBatchLoadTaskCommandOutput extends DescribeBatchLoadTaskResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns information about the batch load task, including configurations, mappings,
18
23
  * progress, and other details. <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html">Service quotas apply</a>. See
19
24
  * <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-batch-load.html">code
@@ -28,6 +33,8 @@ export interface DescribeBatchLoadTaskCommandOutput extends DescribeBatchLoadTas
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param DescribeBatchLoadTaskCommandInput - {@link DescribeBatchLoadTaskCommandInput}
37
+ * @returns {@link DescribeBatchLoadTaskCommandOutput}
31
38
  * @see {@link DescribeBatchLoadTaskCommandInput} for command's `input` shape.
32
39
  * @see {@link DescribeBatchLoadTaskCommandOutput} for command's `response` shape.
33
40
  * @see {@link TimestreamWriteClientResolvedConfig | config} for TimestreamWriteClient's `config` shape.
@@ -56,11 +63,20 @@ export interface DescribeBatchLoadTaskCommandOutput extends DescribeBatchLoadTas
56
63
  export declare class DescribeBatchLoadTaskCommand extends $Command<DescribeBatchLoadTaskCommandInput, DescribeBatchLoadTaskCommandOutput, TimestreamWriteClientResolvedConfig> {
57
64
  readonly input: DescribeBatchLoadTaskCommandInput;
58
65
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
66
+ /**
67
+ * @public
68
+ */
59
69
  constructor(input: DescribeBatchLoadTaskCommandInput);
60
70
  /**
61
71
  * @internal
62
72
  */
63
73
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TimestreamWriteClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeBatchLoadTaskCommandInput, DescribeBatchLoadTaskCommandOutput>;
74
+ /**
75
+ * @internal
76
+ */
64
77
  private serialize;
78
+ /**
79
+ * @internal
80
+ */
65
81
  private deserialize;
66
82
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeDatabaseRequest, DescribeDatabaseResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TimestreamWriteClientResolvedConfig } from "../TimestreamWriteClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeDatabaseCommand}.
8
10
  */
9
11
  export interface DescribeDatabaseCommandInput extends DescribeDatabaseRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeDatabaseCommand}.
13
17
  */
14
18
  export interface DescribeDatabaseCommandOutput extends DescribeDatabaseResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns information about the database, including the database name, time that the
18
23
  * database was created, and the total number of tables found within the database. <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html">Service
19
24
  * quotas apply</a>. See <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-db.html">code sample</a>
@@ -28,6 +33,8 @@ export interface DescribeDatabaseCommandOutput extends DescribeDatabaseResponse,
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param DescribeDatabaseCommandInput - {@link DescribeDatabaseCommandInput}
37
+ * @returns {@link DescribeDatabaseCommandOutput}
31
38
  * @see {@link DescribeDatabaseCommandInput} for command's `input` shape.
32
39
  * @see {@link DescribeDatabaseCommandOutput} for command's `response` shape.
33
40
  * @see {@link TimestreamWriteClientResolvedConfig | config} for TimestreamWriteClient's `config` shape.
@@ -59,11 +66,20 @@ export interface DescribeDatabaseCommandOutput extends DescribeDatabaseResponse,
59
66
  export declare class DescribeDatabaseCommand extends $Command<DescribeDatabaseCommandInput, DescribeDatabaseCommandOutput, TimestreamWriteClientResolvedConfig> {
60
67
  readonly input: DescribeDatabaseCommandInput;
61
68
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
69
+ /**
70
+ * @public
71
+ */
62
72
  constructor(input: DescribeDatabaseCommandInput);
63
73
  /**
64
74
  * @internal
65
75
  */
66
76
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TimestreamWriteClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeDatabaseCommandInput, DescribeDatabaseCommandOutput>;
77
+ /**
78
+ * @internal
79
+ */
67
80
  private serialize;
81
+ /**
82
+ * @internal
83
+ */
68
84
  private deserialize;
69
85
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeEndpointsRequest, DescribeEndpointsResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TimestreamWriteClientResolvedConfig } from "../TimestreamWriteClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeEndpointsCommand}.
8
10
  */
9
11
  export interface DescribeEndpointsCommandInput extends DescribeEndpointsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeEndpointsCommand}.
13
17
  */
14
18
  export interface DescribeEndpointsCommandOutput extends DescribeEndpointsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns a list of available endpoints to make Timestream API calls against.
18
23
  * This API operation is available through both the Write and Query APIs.</p>
19
24
  * <p>Because the Timestream SDKs are designed to transparently work with the
@@ -45,6 +50,8 @@ export interface DescribeEndpointsCommandOutput extends DescribeEndpointsRespons
45
50
  * const response = await client.send(command);
46
51
  * ```
47
52
  *
53
+ * @param DescribeEndpointsCommandInput - {@link DescribeEndpointsCommandInput}
54
+ * @returns {@link DescribeEndpointsCommandOutput}
48
55
  * @see {@link DescribeEndpointsCommandInput} for command's `input` shape.
49
56
  * @see {@link DescribeEndpointsCommandOutput} for command's `response` shape.
50
57
  * @see {@link TimestreamWriteClientResolvedConfig | config} for TimestreamWriteClient's `config` shape.
@@ -66,11 +73,20 @@ export interface DescribeEndpointsCommandOutput extends DescribeEndpointsRespons
66
73
  export declare class DescribeEndpointsCommand extends $Command<DescribeEndpointsCommandInput, DescribeEndpointsCommandOutput, TimestreamWriteClientResolvedConfig> {
67
74
  readonly input: DescribeEndpointsCommandInput;
68
75
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
76
+ /**
77
+ * @public
78
+ */
69
79
  constructor(input: DescribeEndpointsCommandInput);
70
80
  /**
71
81
  * @internal
72
82
  */
73
83
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: TimestreamWriteClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeEndpointsCommandInput, DescribeEndpointsCommandOutput>;
84
+ /**
85
+ * @internal
86
+ */
74
87
  private serialize;
88
+ /**
89
+ * @internal
90
+ */
75
91
  private deserialize;
76
92
  }