@aws-sdk/client-timestream-write 3.42.0 → 3.43.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +11 -0
- package/README.md +8 -1
- package/dist-cjs/commands/WriteRecordsCommand.js +1 -1
- package/dist-cjs/models/models_0.js +45 -1
- package/dist-cjs/protocols/Aws_json1_0.js +101 -1
- package/dist-es/commands/WriteRecordsCommand.js +2 -2
- package/dist-es/models/models_0.js +31 -0
- package/dist-es/protocols/Aws_json1_0.js +91 -11
- package/dist-types/TimestreamWrite.d.ts +83 -21
- package/dist-types/TimestreamWriteClient.d.ts +7 -1
- package/dist-types/commands/CreateDatabaseCommand.d.ts +6 -3
- package/dist-types/commands/CreateTableCommand.d.ts +5 -4
- package/dist-types/commands/DeleteDatabaseCommand.d.ts +7 -2
- package/dist-types/commands/DeleteTableCommand.d.ts +5 -1
- package/dist-types/commands/DescribeDatabaseCommand.d.ts +2 -1
- package/dist-types/commands/DescribeEndpointsCommand.d.ts +9 -4
- package/dist-types/commands/DescribeTableCommand.d.ts +2 -1
- package/dist-types/commands/ListDatabasesCommand.d.ts +2 -1
- package/dist-types/commands/ListTablesCommand.d.ts +2 -0
- package/dist-types/commands/UpdateDatabaseCommand.d.ts +2 -0
- package/dist-types/commands/UpdateTableCommand.d.ts +2 -1
- package/dist-types/commands/WriteRecordsCommand.d.ts +34 -4
- package/dist-types/models/models_0.d.ts +207 -18
- package/dist-types/ts3.4/commands/WriteRecordsCommand.d.ts +2 -2
- package/dist-types/ts3.4/models/models_0.d.ts +84 -1
- package/package.json +2 -2
|
@@ -16,26 +16,36 @@ import { UpdateTableCommandInput, UpdateTableCommandOutput } from "./commands/Up
|
|
|
16
16
|
import { WriteRecordsCommandInput, WriteRecordsCommandOutput } from "./commands/WriteRecordsCommand";
|
|
17
17
|
import { TimestreamWriteClient } from "./TimestreamWriteClient";
|
|
18
18
|
/**
|
|
19
|
-
* <
|
|
19
|
+
* <fullname>Amazon Timestream Write</fullname>
|
|
20
|
+
* <p>Amazon Timestream is a fast, scalable, fully managed time series database service that makes it easy to store and analyze trillions of time series data points per day.
|
|
21
|
+
* With Timestream, you can easily store and analyze IoT sensor data to derive insights from your IoT applications.
|
|
22
|
+
* You can analyze industrial telemetry to streamline equipment management and maintenance.
|
|
23
|
+
* You can also store and analyze log data and metrics to improve the performance and availability of your applications.
|
|
24
|
+
* Timestream is built from the ground up to effectively ingest, process,
|
|
25
|
+
* and store time series data. It organizes data to optimize query processing. It automatically scales based on the volume of data ingested and on the query volume to ensure you receive optimal performance while inserting and querying data. As your data grows over time, Timestream’s adaptive query processing engine spans across storage tiers to provide fast analysis while reducing costs.</p>
|
|
20
26
|
*/
|
|
21
27
|
export declare class TimestreamWrite extends TimestreamWriteClient {
|
|
22
28
|
/**
|
|
23
|
-
* <p>Creates a new Timestream database. If the KMS key is not specified, the database will be encrypted with a Timestream managed KMS
|
|
24
|
-
*
|
|
25
|
-
*
|
|
29
|
+
* <p>Creates a new Timestream database. If the KMS key is not specified, the database will be encrypted with a Timestream managed KMS
|
|
30
|
+
* key located in your account.
|
|
31
|
+
* Refer to <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">Amazon Web Services managed KMS keys</a> for more info.
|
|
32
|
+
* <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html">Service quotas apply</a>.
|
|
33
|
+
* See
|
|
34
|
+
* <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-db.html">code sample</a> for details.
|
|
26
35
|
* </p>
|
|
27
36
|
*/
|
|
28
37
|
createDatabase(args: CreateDatabaseCommandInput, options?: __HttpHandlerOptions): Promise<CreateDatabaseCommandOutput>;
|
|
29
38
|
createDatabase(args: CreateDatabaseCommandInput, cb: (err: any, data?: CreateDatabaseCommandOutput) => void): void;
|
|
30
39
|
createDatabase(args: CreateDatabaseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatabaseCommandOutput) => void): void;
|
|
31
40
|
/**
|
|
32
|
-
* <p>The CreateTable operation adds a new table to an existing database in your account. In an
|
|
41
|
+
* <p>The CreateTable operation adds a new table to an existing database in your account. In an Amazon Web Services account,
|
|
33
42
|
* table names must be at least unique within each Region if they are in the same database.
|
|
34
|
-
* You may have identical table names in the same Region if the tables are in
|
|
43
|
+
* You may have identical table names in the same Region if the tables are in separate databases.
|
|
35
44
|
* While creating the table, you must specify the table name, database name,
|
|
36
45
|
* and the retention properties.
|
|
37
|
-
*
|
|
38
|
-
*
|
|
46
|
+
* <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html">Service quotas apply</a>.
|
|
47
|
+
* See
|
|
48
|
+
* <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-table.html">code sample</a> for details.
|
|
39
49
|
* </p>
|
|
40
50
|
*/
|
|
41
51
|
createTable(args: CreateTableCommandInput, options?: __HttpHandlerOptions): Promise<CreateTableCommandOutput>;
|
|
@@ -46,11 +56,16 @@ export declare class TimestreamWrite extends TimestreamWriteClient {
|
|
|
46
56
|
* After a database is deleted, the time series data from its tables cannot be recovered.</i>
|
|
47
57
|
* </p>
|
|
48
58
|
*
|
|
49
|
-
* <
|
|
59
|
+
* <note>
|
|
60
|
+
* <p>All tables in the database must be deleted first, or a ValidationException error will be thrown.
|
|
50
61
|
* </p>
|
|
51
62
|
*
|
|
52
|
-
*
|
|
63
|
+
* <p>Due to the nature of distributed retries,
|
|
53
64
|
* the operation can return either success or a ResourceNotFoundException. Clients should consider them equivalent.</p>
|
|
65
|
+
* </note>
|
|
66
|
+
*
|
|
67
|
+
* <p>See
|
|
68
|
+
* <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.delete-db.html">code sample</a> for details.</p>
|
|
54
69
|
*/
|
|
55
70
|
deleteDatabase(args: DeleteDatabaseCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDatabaseCommandOutput>;
|
|
56
71
|
deleteDatabase(args: DeleteDatabaseCommandInput, cb: (err: any, data?: DeleteDatabaseCommandOutput) => void): void;
|
|
@@ -60,8 +75,12 @@ export declare class TimestreamWrite extends TimestreamWriteClient {
|
|
|
60
75
|
* After a Timestream database table is deleted, the time series data stored in
|
|
61
76
|
* the table cannot be recovered.
|
|
62
77
|
* </p>
|
|
63
|
-
* <
|
|
78
|
+
* <note>
|
|
79
|
+
* <p>Due to the nature of distributed retries,
|
|
64
80
|
* the operation can return either success or a ResourceNotFoundException. Clients should consider them equivalent.</p>
|
|
81
|
+
* </note>
|
|
82
|
+
* <p>See
|
|
83
|
+
* <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.delete-table.html">code sample</a> for details.</p>
|
|
65
84
|
*/
|
|
66
85
|
deleteTable(args: DeleteTableCommandInput, options?: __HttpHandlerOptions): Promise<DeleteTableCommandOutput>;
|
|
67
86
|
deleteTable(args: DeleteTableCommandInput, cb: (err: any, data?: DeleteTableCommandOutput) => void): void;
|
|
@@ -69,26 +88,32 @@ export declare class TimestreamWrite extends TimestreamWriteClient {
|
|
|
69
88
|
/**
|
|
70
89
|
* <p>Returns information about the database, including the database name, time that the database was created,
|
|
71
90
|
* and the total number of tables found within the database.
|
|
72
|
-
*
|
|
91
|
+
* <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html">Service quotas apply</a>. See
|
|
92
|
+
* <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-db.html">code sample</a> for details.</p>
|
|
73
93
|
*/
|
|
74
94
|
describeDatabase(args: DescribeDatabaseCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDatabaseCommandOutput>;
|
|
75
95
|
describeDatabase(args: DescribeDatabaseCommandInput, cb: (err: any, data?: DescribeDatabaseCommandOutput) => void): void;
|
|
76
96
|
describeDatabase(args: DescribeDatabaseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDatabaseCommandOutput) => void): void;
|
|
77
97
|
/**
|
|
78
|
-
* <p>DescribeEndpoints returns a list of available endpoints to make Timestream API calls against.
|
|
79
|
-
*
|
|
98
|
+
* <p>DescribeEndpoints returns a list of available endpoints to make Timestream API calls against.
|
|
99
|
+
* This API is available through both Write and Query.</p>
|
|
100
|
+
* <p>Because the Timestream SDKs are designed to transparently work with the service’s architecture,
|
|
80
101
|
* including the management and mapping of the service endpoints,
|
|
81
102
|
* <i>it is not recommended that you use this API unless</i>:</p>
|
|
82
103
|
* <ul>
|
|
83
104
|
* <li>
|
|
105
|
+
* <p>You are using <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/VPCEndpoints">VPC endpoints (Amazon Web Services PrivateLink) with Timestream</a>
|
|
106
|
+
* </p>
|
|
107
|
+
* </li>
|
|
108
|
+
* <li>
|
|
84
109
|
* <p>Your application uses a programming language that does not yet have SDK support</p>
|
|
85
110
|
* </li>
|
|
86
111
|
* <li>
|
|
87
112
|
* <p>You require better control over the client-side implementation</p>
|
|
88
113
|
* </li>
|
|
89
114
|
* </ul>
|
|
90
|
-
* <p>For detailed information on how to use DescribeEndpoints,
|
|
91
|
-
* see <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/Using-API.endpoint-discovery
|
|
115
|
+
* <p>For detailed information on how and when to use and implement DescribeEndpoints,
|
|
116
|
+
* see <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/Using.API.html#Using-API.endpoint-discovery">The Endpoint Discovery Pattern</a>.</p>
|
|
92
117
|
*/
|
|
93
118
|
describeEndpoints(args: DescribeEndpointsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeEndpointsCommandOutput>;
|
|
94
119
|
describeEndpoints(args: DescribeEndpointsCommandInput, cb: (err: any, data?: DescribeEndpointsCommandOutput) => void): void;
|
|
@@ -96,7 +121,8 @@ export declare class TimestreamWrite extends TimestreamWriteClient {
|
|
|
96
121
|
/**
|
|
97
122
|
* <p>Returns information about the table, including the table name, database name,
|
|
98
123
|
* retention duration of the memory store and the magnetic store.
|
|
99
|
-
*
|
|
124
|
+
* <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html">Service quotas apply</a>. See
|
|
125
|
+
* <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-table.html">code sample</a> for details.
|
|
100
126
|
* </p>
|
|
101
127
|
*/
|
|
102
128
|
describeTable(args: DescribeTableCommandInput, options?: __HttpHandlerOptions): Promise<DescribeTableCommandOutput>;
|
|
@@ -104,7 +130,8 @@ export declare class TimestreamWrite extends TimestreamWriteClient {
|
|
|
104
130
|
describeTable(args: DescribeTableCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTableCommandOutput) => void): void;
|
|
105
131
|
/**
|
|
106
132
|
* <p>Returns a list of your Timestream databases.
|
|
107
|
-
*
|
|
133
|
+
* <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html">Service quotas apply</a>. See
|
|
134
|
+
* <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-db.html">code sample</a> for details.
|
|
108
135
|
* </p>
|
|
109
136
|
*/
|
|
110
137
|
listDatabases(args: ListDatabasesCommandInput, options?: __HttpHandlerOptions): Promise<ListDatabasesCommandOutput>;
|
|
@@ -112,6 +139,8 @@ export declare class TimestreamWrite extends TimestreamWriteClient {
|
|
|
112
139
|
listDatabases(args: ListDatabasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatabasesCommandOutput) => void): void;
|
|
113
140
|
/**
|
|
114
141
|
* <p>A list of tables, along with the name, status and retention properties of each table.
|
|
142
|
+
* See
|
|
143
|
+
* <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-table.html">code sample</a> for details.
|
|
115
144
|
* </p>
|
|
116
145
|
*/
|
|
117
146
|
listTables(args: ListTablesCommandInput, options?: __HttpHandlerOptions): Promise<ListTablesCommandOutput>;
|
|
@@ -149,6 +178,8 @@ export declare class TimestreamWrite extends TimestreamWriteClient {
|
|
|
149
178
|
* you must specify the database name and the identifier of the new KMS key to be used (<code>KmsKeyId</code>).
|
|
150
179
|
* If there are any concurrent <code>UpdateDatabase</code> requests, first writer wins.
|
|
151
180
|
* </p>
|
|
181
|
+
* <p>See
|
|
182
|
+
* <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.update-db.html">code sample</a> for details.</p>
|
|
152
183
|
*/
|
|
153
184
|
updateDatabase(args: UpdateDatabaseCommandInput, options?: __HttpHandlerOptions): Promise<UpdateDatabaseCommandOutput>;
|
|
154
185
|
updateDatabase(args: UpdateDatabaseCommandInput, cb: (err: any, data?: UpdateDatabaseCommandOutput) => void): void;
|
|
@@ -160,7 +191,8 @@ export declare class TimestreamWrite extends TimestreamWriteClient {
|
|
|
160
191
|
* the memory store will be capable of holding 24 hours of data, but will
|
|
161
192
|
* be populated with 24 hours of data 22 hours after this change was made.
|
|
162
193
|
* Timestream does not retrieve data from the magnetic store to populate the memory store. </p>
|
|
163
|
-
* <p>
|
|
194
|
+
* <p>See
|
|
195
|
+
* <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.update-table.html">code sample</a> for details.</p>
|
|
164
196
|
*/
|
|
165
197
|
updateTable(args: UpdateTableCommandInput, options?: __HttpHandlerOptions): Promise<UpdateTableCommandOutput>;
|
|
166
198
|
updateTable(args: UpdateTableCommandInput, cb: (err: any, data?: UpdateTableCommandOutput) => void): void;
|
|
@@ -177,9 +209,39 @@ export declare class TimestreamWrite extends TimestreamWriteClient {
|
|
|
177
209
|
* the query results might not reflect the results of a recently completed write
|
|
178
210
|
* operation. The results may also include some stale data. If you repeat the
|
|
179
211
|
* query request after a short time, the results should return the latest data.
|
|
180
|
-
*
|
|
181
|
-
* see <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html">Access Management</a> in the Timestream Developer Guide.
|
|
212
|
+
* <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html">Service quotas apply</a>.
|
|
182
213
|
* </p>
|
|
214
|
+
*
|
|
215
|
+
* <p>See
|
|
216
|
+
* <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.write.html">code sample</a> for details.</p>
|
|
217
|
+
*
|
|
218
|
+
* <p>
|
|
219
|
+
* <b>Upserts</b>
|
|
220
|
+
* </p>
|
|
221
|
+
*
|
|
222
|
+
* <p>You can use the <code>Version</code> parameter in a <code>WriteRecords</code> request to update data points.
|
|
223
|
+
* Timestream tracks a version number with each record. <code>Version</code> defaults to <code>1</code> when not specified for the record in the request.
|
|
224
|
+
* Timestream will update an existing record’s measure value along with its <code>Version</code> upon receiving a write request with a higher
|
|
225
|
+
* <code>Version</code> number for that record.
|
|
226
|
+
* Upon receiving an update request where the measure value is the same as that of the existing record,
|
|
227
|
+
* Timestream still updates <code>Version</code>, if it is greater than the existing value of <code>Version</code>.
|
|
228
|
+
* You can update a data point as many times as desired, as long as the value of <code>Version</code> continuously increases.
|
|
229
|
+
* </p>
|
|
230
|
+
* <p>
|
|
231
|
+
* For example, suppose you write a new record without indicating <code>Version</code> in the request.
|
|
232
|
+
* Timestream will store this record, and set <code>Version</code> to <code>1</code>.
|
|
233
|
+
* Now, suppose you try to update this record with a <code>WriteRecords</code> request of the same record with a different measure value but,
|
|
234
|
+
* like before, do not provide <code>Version</code>.
|
|
235
|
+
* In this case, Timestream will reject this update with a <code>RejectedRecordsException</code> since the updated record’s version is not greater than the existing value of Version.
|
|
236
|
+
* However, if you were to resend the update request with <code>Version</code> set to <code>2</code>,
|
|
237
|
+
* Timestream would then succeed in updating the record’s value,
|
|
238
|
+
* and the <code>Version</code> would be set to <code>2</code>.
|
|
239
|
+
* Next, suppose you sent a <code>WriteRecords</code> request with this same record and an identical measure value,
|
|
240
|
+
* but with <code>Version</code> set to <code>3</code>.
|
|
241
|
+
* In this case, Timestream would only update <code>Version</code> to <code>3</code>.
|
|
242
|
+
* Any further updates would need to send a version number greater than <code>3</code>,
|
|
243
|
+
* or the update requests would receive a <code>RejectedRecordsException</code>.
|
|
244
|
+
* </p>
|
|
183
245
|
*/
|
|
184
246
|
writeRecords(args: WriteRecordsCommandInput, options?: __HttpHandlerOptions): Promise<WriteRecordsCommandOutput>;
|
|
185
247
|
writeRecords(args: WriteRecordsCommandInput, cb: (err: any, data?: WriteRecordsCommandOutput) => void): void;
|
|
@@ -144,7 +144,13 @@ declare type TimestreamWriteClientResolvedConfigType = __SmithyResolvedConfigura
|
|
|
144
144
|
export interface TimestreamWriteClientResolvedConfig extends TimestreamWriteClientResolvedConfigType {
|
|
145
145
|
}
|
|
146
146
|
/**
|
|
147
|
-
* <
|
|
147
|
+
* <fullname>Amazon Timestream Write</fullname>
|
|
148
|
+
* <p>Amazon Timestream is a fast, scalable, fully managed time series database service that makes it easy to store and analyze trillions of time series data points per day.
|
|
149
|
+
* With Timestream, you can easily store and analyze IoT sensor data to derive insights from your IoT applications.
|
|
150
|
+
* You can analyze industrial telemetry to streamline equipment management and maintenance.
|
|
151
|
+
* You can also store and analyze log data and metrics to improve the performance and availability of your applications.
|
|
152
|
+
* Timestream is built from the ground up to effectively ingest, process,
|
|
153
|
+
* and store time series data. It organizes data to optimize query processing. It automatically scales based on the volume of data ingested and on the query volume to ensure you receive optimal performance while inserting and querying data. As your data grows over time, Timestream’s adaptive query processing engine spans across storage tiers to provide fast analysis while reducing costs.</p>
|
|
148
154
|
*/
|
|
149
155
|
export declare class TimestreamWriteClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, TimestreamWriteClientResolvedConfig> {
|
|
150
156
|
/**
|
|
@@ -7,9 +7,12 @@ export interface CreateDatabaseCommandInput extends CreateDatabaseRequest {
|
|
|
7
7
|
export interface CreateDatabaseCommandOutput extends CreateDatabaseResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Creates a new Timestream database. If the KMS key is not specified, the database will be encrypted with a Timestream managed KMS
|
|
11
|
-
*
|
|
12
|
-
*
|
|
10
|
+
* <p>Creates a new Timestream database. If the KMS key is not specified, the database will be encrypted with a Timestream managed KMS
|
|
11
|
+
* key located in your account.
|
|
12
|
+
* Refer to <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">Amazon Web Services managed KMS keys</a> for more info.
|
|
13
|
+
* <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html">Service quotas apply</a>.
|
|
14
|
+
* See
|
|
15
|
+
* <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-db.html">code sample</a> for details.
|
|
13
16
|
* </p>
|
|
14
17
|
* @example
|
|
15
18
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -7,13 +7,14 @@ export interface CreateTableCommandInput extends CreateTableRequest {
|
|
|
7
7
|
export interface CreateTableCommandOutput extends CreateTableResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>The CreateTable operation adds a new table to an existing database in your account. In an
|
|
10
|
+
* <p>The CreateTable operation adds a new table to an existing database in your account. In an Amazon Web Services account,
|
|
11
11
|
* table names must be at least unique within each Region if they are in the same database.
|
|
12
|
-
* You may have identical table names in the same Region if the tables are in
|
|
12
|
+
* You may have identical table names in the same Region if the tables are in separate databases.
|
|
13
13
|
* While creating the table, you must specify the table name, database name,
|
|
14
14
|
* and the retention properties.
|
|
15
|
-
*
|
|
16
|
-
*
|
|
15
|
+
* <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html">Service quotas apply</a>.
|
|
16
|
+
* See
|
|
17
|
+
* <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-table.html">code sample</a> for details.
|
|
17
18
|
* </p>
|
|
18
19
|
* @example
|
|
19
20
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -11,11 +11,16 @@ export interface DeleteDatabaseCommandOutput extends __MetadataBearer {
|
|
|
11
11
|
* After a database is deleted, the time series data from its tables cannot be recovered.</i>
|
|
12
12
|
* </p>
|
|
13
13
|
*
|
|
14
|
-
* <
|
|
14
|
+
* <note>
|
|
15
|
+
* <p>All tables in the database must be deleted first, or a ValidationException error will be thrown.
|
|
15
16
|
* </p>
|
|
16
17
|
*
|
|
17
|
-
*
|
|
18
|
+
* <p>Due to the nature of distributed retries,
|
|
18
19
|
* the operation can return either success or a ResourceNotFoundException. Clients should consider them equivalent.</p>
|
|
20
|
+
* </note>
|
|
21
|
+
*
|
|
22
|
+
* <p>See
|
|
23
|
+
* <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.delete-db.html">code sample</a> for details.</p>
|
|
19
24
|
* @example
|
|
20
25
|
* Use a bare-bones client and the command you need to make an API call.
|
|
21
26
|
* ```javascript
|
|
@@ -11,8 +11,12 @@ export interface DeleteTableCommandOutput extends __MetadataBearer {
|
|
|
11
11
|
* After a Timestream database table is deleted, the time series data stored in
|
|
12
12
|
* the table cannot be recovered.
|
|
13
13
|
* </p>
|
|
14
|
-
* <
|
|
14
|
+
* <note>
|
|
15
|
+
* <p>Due to the nature of distributed retries,
|
|
15
16
|
* the operation can return either success or a ResourceNotFoundException. Clients should consider them equivalent.</p>
|
|
17
|
+
* </note>
|
|
18
|
+
* <p>See
|
|
19
|
+
* <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.delete-table.html">code sample</a> for details.</p>
|
|
16
20
|
* @example
|
|
17
21
|
* Use a bare-bones client and the command you need to make an API call.
|
|
18
22
|
* ```javascript
|
|
@@ -9,7 +9,8 @@ export interface DescribeDatabaseCommandOutput extends DescribeDatabaseResponse,
|
|
|
9
9
|
/**
|
|
10
10
|
* <p>Returns information about the database, including the database name, time that the database was created,
|
|
11
11
|
* and the total number of tables found within the database.
|
|
12
|
-
*
|
|
12
|
+
* <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html">Service quotas apply</a>. See
|
|
13
|
+
* <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-db.html">code sample</a> for details.</p>
|
|
13
14
|
* @example
|
|
14
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
16
|
* ```javascript
|
|
@@ -7,20 +7,25 @@ export interface DescribeEndpointsCommandInput extends DescribeEndpointsRequest
|
|
|
7
7
|
export interface DescribeEndpointsCommandOutput extends DescribeEndpointsResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>DescribeEndpoints returns a list of available endpoints to make Timestream API calls against.
|
|
11
|
-
*
|
|
10
|
+
* <p>DescribeEndpoints returns a list of available endpoints to make Timestream API calls against.
|
|
11
|
+
* This API is available through both Write and Query.</p>
|
|
12
|
+
* <p>Because the Timestream SDKs are designed to transparently work with the service’s architecture,
|
|
12
13
|
* including the management and mapping of the service endpoints,
|
|
13
14
|
* <i>it is not recommended that you use this API unless</i>:</p>
|
|
14
15
|
* <ul>
|
|
15
16
|
* <li>
|
|
17
|
+
* <p>You are using <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/VPCEndpoints">VPC endpoints (Amazon Web Services PrivateLink) with Timestream</a>
|
|
18
|
+
* </p>
|
|
19
|
+
* </li>
|
|
20
|
+
* <li>
|
|
16
21
|
* <p>Your application uses a programming language that does not yet have SDK support</p>
|
|
17
22
|
* </li>
|
|
18
23
|
* <li>
|
|
19
24
|
* <p>You require better control over the client-side implementation</p>
|
|
20
25
|
* </li>
|
|
21
26
|
* </ul>
|
|
22
|
-
* <p>For detailed information on how to use DescribeEndpoints,
|
|
23
|
-
* see <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/Using-API.endpoint-discovery
|
|
27
|
+
* <p>For detailed information on how and when to use and implement DescribeEndpoints,
|
|
28
|
+
* see <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/Using.API.html#Using-API.endpoint-discovery">The Endpoint Discovery Pattern</a>.</p>
|
|
24
29
|
* @example
|
|
25
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
26
31
|
* ```javascript
|
|
@@ -9,7 +9,8 @@ export interface DescribeTableCommandOutput extends DescribeTableResponse, __Met
|
|
|
9
9
|
/**
|
|
10
10
|
* <p>Returns information about the table, including the table name, database name,
|
|
11
11
|
* retention duration of the memory store and the magnetic store.
|
|
12
|
-
*
|
|
12
|
+
* <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html">Service quotas apply</a>. See
|
|
13
|
+
* <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-table.html">code sample</a> for details.
|
|
13
14
|
* </p>
|
|
14
15
|
* @example
|
|
15
16
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -8,7 +8,8 @@ export interface ListDatabasesCommandOutput extends ListDatabasesResponse, __Met
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Returns a list of your Timestream databases.
|
|
11
|
-
*
|
|
11
|
+
* <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html">Service quotas apply</a>. See
|
|
12
|
+
* <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-db.html">code sample</a> for details.
|
|
12
13
|
* </p>
|
|
13
14
|
* @example
|
|
14
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -8,6 +8,8 @@ export interface ListTablesCommandOutput extends ListTablesResponse, __MetadataB
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>A list of tables, along with the name, status and retention properties of each table.
|
|
11
|
+
* See
|
|
12
|
+
* <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-table.html">code sample</a> for details.
|
|
11
13
|
* </p>
|
|
12
14
|
* @example
|
|
13
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -12,6 +12,8 @@ export interface UpdateDatabaseCommandOutput extends UpdateDatabaseResponse, __M
|
|
|
12
12
|
* you must specify the database name and the identifier of the new KMS key to be used (<code>KmsKeyId</code>).
|
|
13
13
|
* If there are any concurrent <code>UpdateDatabase</code> requests, first writer wins.
|
|
14
14
|
* </p>
|
|
15
|
+
* <p>See
|
|
16
|
+
* <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.update-db.html">code sample</a> for details.</p>
|
|
15
17
|
* @example
|
|
16
18
|
* Use a bare-bones client and the command you need to make an API call.
|
|
17
19
|
* ```javascript
|
|
@@ -13,7 +13,8 @@ export interface UpdateTableCommandOutput extends UpdateTableResponse, __Metadat
|
|
|
13
13
|
* the memory store will be capable of holding 24 hours of data, but will
|
|
14
14
|
* be populated with 24 hours of data 22 hours after this change was made.
|
|
15
15
|
* Timestream does not retrieve data from the magnetic store to populate the memory store. </p>
|
|
16
|
-
* <p>
|
|
16
|
+
* <p>See
|
|
17
|
+
* <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.update-table.html">code sample</a> for details.</p>
|
|
17
18
|
* @example
|
|
18
19
|
* Use a bare-bones client and the command you need to make an API call.
|
|
19
20
|
* ```javascript
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
2
2
|
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
3
|
-
import { WriteRecordsRequest } from "../models/models_0";
|
|
3
|
+
import { WriteRecordsRequest, WriteRecordsResponse } from "../models/models_0";
|
|
4
4
|
import { ServiceInputTypes, ServiceOutputTypes, TimestreamWriteClientResolvedConfig } from "../TimestreamWriteClient";
|
|
5
5
|
export interface WriteRecordsCommandInput extends WriteRecordsRequest {
|
|
6
6
|
}
|
|
7
|
-
export interface WriteRecordsCommandOutput extends __MetadataBearer {
|
|
7
|
+
export interface WriteRecordsCommandOutput extends WriteRecordsResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>The WriteRecords operation enables you to write your time series
|
|
@@ -18,9 +18,39 @@ export interface WriteRecordsCommandOutput extends __MetadataBearer {
|
|
|
18
18
|
* the query results might not reflect the results of a recently completed write
|
|
19
19
|
* operation. The results may also include some stale data. If you repeat the
|
|
20
20
|
* query request after a short time, the results should return the latest data.
|
|
21
|
-
*
|
|
22
|
-
* see <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html">Access Management</a> in the Timestream Developer Guide.
|
|
21
|
+
* <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html">Service quotas apply</a>.
|
|
23
22
|
* </p>
|
|
23
|
+
*
|
|
24
|
+
* <p>See
|
|
25
|
+
* <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.write.html">code sample</a> for details.</p>
|
|
26
|
+
*
|
|
27
|
+
* <p>
|
|
28
|
+
* <b>Upserts</b>
|
|
29
|
+
* </p>
|
|
30
|
+
*
|
|
31
|
+
* <p>You can use the <code>Version</code> parameter in a <code>WriteRecords</code> request to update data points.
|
|
32
|
+
* Timestream tracks a version number with each record. <code>Version</code> defaults to <code>1</code> when not specified for the record in the request.
|
|
33
|
+
* Timestream will update an existing record’s measure value along with its <code>Version</code> upon receiving a write request with a higher
|
|
34
|
+
* <code>Version</code> number for that record.
|
|
35
|
+
* Upon receiving an update request where the measure value is the same as that of the existing record,
|
|
36
|
+
* Timestream still updates <code>Version</code>, if it is greater than the existing value of <code>Version</code>.
|
|
37
|
+
* You can update a data point as many times as desired, as long as the value of <code>Version</code> continuously increases.
|
|
38
|
+
* </p>
|
|
39
|
+
* <p>
|
|
40
|
+
* For example, suppose you write a new record without indicating <code>Version</code> in the request.
|
|
41
|
+
* Timestream will store this record, and set <code>Version</code> to <code>1</code>.
|
|
42
|
+
* Now, suppose you try to update this record with a <code>WriteRecords</code> request of the same record with a different measure value but,
|
|
43
|
+
* like before, do not provide <code>Version</code>.
|
|
44
|
+
* In this case, Timestream will reject this update with a <code>RejectedRecordsException</code> since the updated record’s version is not greater than the existing value of Version.
|
|
45
|
+
* However, if you were to resend the update request with <code>Version</code> set to <code>2</code>,
|
|
46
|
+
* Timestream would then succeed in updating the record’s value,
|
|
47
|
+
* and the <code>Version</code> would be set to <code>2</code>.
|
|
48
|
+
* Next, suppose you sent a <code>WriteRecords</code> request with this same record and an identical measure value,
|
|
49
|
+
* but with <code>Version</code> set to <code>3</code>.
|
|
50
|
+
* In this case, Timestream would only update <code>Version</code> to <code>3</code>.
|
|
51
|
+
* Any further updates would need to send a version number greater than <code>3</code>,
|
|
52
|
+
* or the update requests would receive a <code>RejectedRecordsException</code>.
|
|
53
|
+
* </p>
|
|
24
54
|
* @example
|
|
25
55
|
* Use a bare-bones client and the command you need to make an API call.
|
|
26
56
|
* ```javascript
|