@aws-sdk/client-timestream-write 3.40.0 → 3.45.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 (31) hide show
  1. package/CHANGELOG.md +41 -0
  2. package/README.md +8 -1
  3. package/dist-cjs/commands/WriteRecordsCommand.js +1 -1
  4. package/dist-cjs/endpoints.js +9 -0
  5. package/dist-cjs/models/models_0.js +45 -1
  6. package/dist-cjs/protocols/Aws_json1_0.js +101 -1
  7. package/dist-es/commands/WriteRecordsCommand.js +2 -2
  8. package/dist-es/endpoints.js +9 -0
  9. package/dist-es/models/models_0.js +31 -0
  10. package/dist-es/protocols/Aws_json1_0.js +91 -11
  11. package/dist-types/TimestreamWrite.d.ts +83 -21
  12. package/dist-types/TimestreamWriteClient.d.ts +7 -1
  13. package/dist-types/commands/CreateDatabaseCommand.d.ts +7 -4
  14. package/dist-types/commands/CreateTableCommand.d.ts +6 -5
  15. package/dist-types/commands/DeleteDatabaseCommand.d.ts +8 -3
  16. package/dist-types/commands/DeleteTableCommand.d.ts +6 -2
  17. package/dist-types/commands/DescribeDatabaseCommand.d.ts +3 -2
  18. package/dist-types/commands/DescribeEndpointsCommand.d.ts +10 -5
  19. package/dist-types/commands/DescribeTableCommand.d.ts +3 -2
  20. package/dist-types/commands/ListDatabasesCommand.d.ts +3 -2
  21. package/dist-types/commands/ListTablesCommand.d.ts +3 -1
  22. package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
  23. package/dist-types/commands/TagResourceCommand.d.ts +1 -1
  24. package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
  25. package/dist-types/commands/UpdateDatabaseCommand.d.ts +3 -1
  26. package/dist-types/commands/UpdateTableCommand.d.ts +3 -2
  27. package/dist-types/commands/WriteRecordsCommand.d.ts +35 -5
  28. package/dist-types/models/models_0.d.ts +207 -18
  29. package/dist-types/ts3.4/commands/WriteRecordsCommand.d.ts +2 -2
  30. package/dist-types/ts3.4/models/models_0.d.ts +84 -1
  31. package/package.json +7 -7
@@ -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
- * <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. With Timestream, you can easily store and analyze IoT sensor data to derive insights from your IoT applications. You can analyze industrial telemetry to streamline equipment management and maintenance. You can also store and analyze log data and metrics to improve the performance and availability of your applications. Timestream is built from the ground up to effectively ingest, process, 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>
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 key located in your account.
24
- * Refer to <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">AWS managed KMS keys</a> for more info.
25
- * Service quotas apply. For more information, see <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html">Access Management</a> in the Timestream Developer Guide.
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 AWS account,
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 seperate databases.
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
- * Service quotas apply. For more information, see <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html">Access Management</a>
38
- * in the Timestream Developer Guide.
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
- * <p>All tables in the database must be deleted first, or a ValidationException error will be thrown.
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
- * <p>Due to the nature of distributed retries,
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
- * <p>Due to the nature of distributed retries,
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
- * Service quotas apply. For more information, see <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html">Access Management</a> in the Timestream Developer Guide.</p>
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. This API is available through both Write and Query.</p>
79
- * <p>Because Timestream’s SDKs are designed to transparently work with the service’s architecture,
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.html">The Endpoint Discovery Pattern and REST APIs</a>.</p>
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
- * Service quotas apply. For more information, see <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html">Access Management</a> in the Timestream Developer Guide.
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
- * Service quotas apply. For more information, see <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html">Access Management</a> in the Timestream Developer Guide.
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>Service quotas apply. For more information, see <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html">Access Management</a> in the Timestream Developer Guide.</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
- * Service quotas apply. For more information,
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
- * <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. With Timestream, you can easily store and analyze IoT sensor data to derive insights from your IoT applications. You can analyze industrial telemetry to streamline equipment management and maintenance. You can also store and analyze log data and metrics to improve the performance and availability of your applications. Timestream is built from the ground up to effectively ingest, process, 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>
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 key located in your account.
11
- * Refer to <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">AWS managed KMS keys</a> for more info.
12
- * Service quotas apply. For more information, see <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html">Access Management</a> in the Timestream Developer Guide.
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.
@@ -23,7 +26,7 @@ export interface CreateDatabaseCommandOutput extends CreateDatabaseResponse, __M
23
26
  *
24
27
  * @see {@link CreateDatabaseCommandInput} for command's `input` shape.
25
28
  * @see {@link CreateDatabaseCommandOutput} for command's `response` shape.
26
- * @see {@link TimestreamWriteClientResolvedConfig | config} for command's `input` shape.
29
+ * @see {@link TimestreamWriteClientResolvedConfig | config} for TimestreamWriteClient's `config` shape.
27
30
  *
28
31
  */
29
32
  export declare class CreateDatabaseCommand extends $Command<CreateDatabaseCommandInput, CreateDatabaseCommandOutput, TimestreamWriteClientResolvedConfig> {
@@ -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 AWS account,
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 seperate databases.
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
- * Service quotas apply. For more information, see <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html">Access Management</a>
16
- * in the Timestream Developer Guide.
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.
@@ -27,7 +28,7 @@ export interface CreateTableCommandOutput extends CreateTableResponse, __Metadat
27
28
  *
28
29
  * @see {@link CreateTableCommandInput} for command's `input` shape.
29
30
  * @see {@link CreateTableCommandOutput} for command's `response` shape.
30
- * @see {@link TimestreamWriteClientResolvedConfig | config} for command's `input` shape.
31
+ * @see {@link TimestreamWriteClientResolvedConfig | config} for TimestreamWriteClient's `config` shape.
31
32
  *
32
33
  */
33
34
  export declare class CreateTableCommand extends $Command<CreateTableCommandInput, CreateTableCommandOutput, TimestreamWriteClientResolvedConfig> {
@@ -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
- * <p>All tables in the database must be deleted first, or a ValidationException error will be thrown.
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
- * <p>Due to the nature of distributed retries,
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
@@ -28,7 +33,7 @@ export interface DeleteDatabaseCommandOutput extends __MetadataBearer {
28
33
  *
29
34
  * @see {@link DeleteDatabaseCommandInput} for command's `input` shape.
30
35
  * @see {@link DeleteDatabaseCommandOutput} for command's `response` shape.
31
- * @see {@link TimestreamWriteClientResolvedConfig | config} for command's `input` shape.
36
+ * @see {@link TimestreamWriteClientResolvedConfig | config} for TimestreamWriteClient's `config` shape.
32
37
  *
33
38
  */
34
39
  export declare class DeleteDatabaseCommand extends $Command<DeleteDatabaseCommandInput, DeleteDatabaseCommandOutput, TimestreamWriteClientResolvedConfig> {
@@ -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
- * <p>Due to the nature of distributed retries,
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
@@ -25,7 +29,7 @@ export interface DeleteTableCommandOutput extends __MetadataBearer {
25
29
  *
26
30
  * @see {@link DeleteTableCommandInput} for command's `input` shape.
27
31
  * @see {@link DeleteTableCommandOutput} for command's `response` shape.
28
- * @see {@link TimestreamWriteClientResolvedConfig | config} for command's `input` shape.
32
+ * @see {@link TimestreamWriteClientResolvedConfig | config} for TimestreamWriteClient's `config` shape.
29
33
  *
30
34
  */
31
35
  export declare class DeleteTableCommand extends $Command<DeleteTableCommandInput, DeleteTableCommandOutput, TimestreamWriteClientResolvedConfig> {
@@ -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
- * Service quotas apply. For more information, see <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html">Access Management</a> in the Timestream Developer Guide.</p>
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
@@ -22,7 +23,7 @@ export interface DescribeDatabaseCommandOutput extends DescribeDatabaseResponse,
22
23
  *
23
24
  * @see {@link DescribeDatabaseCommandInput} for command's `input` shape.
24
25
  * @see {@link DescribeDatabaseCommandOutput} for command's `response` shape.
25
- * @see {@link TimestreamWriteClientResolvedConfig | config} for command's `input` shape.
26
+ * @see {@link TimestreamWriteClientResolvedConfig | config} for TimestreamWriteClient's `config` shape.
26
27
  *
27
28
  */
28
29
  export declare class DescribeDatabaseCommand extends $Command<DescribeDatabaseCommandInput, DescribeDatabaseCommandOutput, TimestreamWriteClientResolvedConfig> {
@@ -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. This API is available through both Write and Query.</p>
11
- * <p>Because Timestream’s SDKs are designed to transparently work with the service’s architecture,
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.html">The Endpoint Discovery Pattern and REST APIs</a>.</p>
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
@@ -33,7 +38,7 @@ export interface DescribeEndpointsCommandOutput extends DescribeEndpointsRespons
33
38
  *
34
39
  * @see {@link DescribeEndpointsCommandInput} for command's `input` shape.
35
40
  * @see {@link DescribeEndpointsCommandOutput} for command's `response` shape.
36
- * @see {@link TimestreamWriteClientResolvedConfig | config} for command's `input` shape.
41
+ * @see {@link TimestreamWriteClientResolvedConfig | config} for TimestreamWriteClient's `config` shape.
37
42
  *
38
43
  */
39
44
  export declare class DescribeEndpointsCommand extends $Command<DescribeEndpointsCommandInput, DescribeEndpointsCommandOutput, TimestreamWriteClientResolvedConfig> {
@@ -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
- * Service quotas apply. For more information, see <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html">Access Management</a> in the Timestream Developer Guide.
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.
@@ -23,7 +24,7 @@ export interface DescribeTableCommandOutput extends DescribeTableResponse, __Met
23
24
  *
24
25
  * @see {@link DescribeTableCommandInput} for command's `input` shape.
25
26
  * @see {@link DescribeTableCommandOutput} for command's `response` shape.
26
- * @see {@link TimestreamWriteClientResolvedConfig | config} for command's `input` shape.
27
+ * @see {@link TimestreamWriteClientResolvedConfig | config} for TimestreamWriteClient's `config` shape.
27
28
  *
28
29
  */
29
30
  export declare class DescribeTableCommand extends $Command<DescribeTableCommandInput, DescribeTableCommandOutput, TimestreamWriteClientResolvedConfig> {
@@ -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
- * Service quotas apply. For more information, see <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html">Access Management</a> in the Timestream Developer Guide.
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.
@@ -22,7 +23,7 @@ export interface ListDatabasesCommandOutput extends ListDatabasesResponse, __Met
22
23
  *
23
24
  * @see {@link ListDatabasesCommandInput} for command's `input` shape.
24
25
  * @see {@link ListDatabasesCommandOutput} for command's `response` shape.
25
- * @see {@link TimestreamWriteClientResolvedConfig | config} for command's `input` shape.
26
+ * @see {@link TimestreamWriteClientResolvedConfig | config} for TimestreamWriteClient's `config` shape.
26
27
  *
27
28
  */
28
29
  export declare class ListDatabasesCommand extends $Command<ListDatabasesCommandInput, ListDatabasesCommandOutput, TimestreamWriteClientResolvedConfig> {
@@ -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.
@@ -21,7 +23,7 @@ export interface ListTablesCommandOutput extends ListTablesResponse, __MetadataB
21
23
  *
22
24
  * @see {@link ListTablesCommandInput} for command's `input` shape.
23
25
  * @see {@link ListTablesCommandOutput} for command's `response` shape.
24
- * @see {@link TimestreamWriteClientResolvedConfig | config} for command's `input` shape.
26
+ * @see {@link TimestreamWriteClientResolvedConfig | config} for TimestreamWriteClient's `config` shape.
25
27
  *
26
28
  */
27
29
  export declare class ListTablesCommand extends $Command<ListTablesCommandInput, ListTablesCommandOutput, TimestreamWriteClientResolvedConfig> {
@@ -22,7 +22,7 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
22
22
  *
23
23
  * @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
24
24
  * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
25
- * @see {@link TimestreamWriteClientResolvedConfig | config} for command's `input` shape.
25
+ * @see {@link TimestreamWriteClientResolvedConfig | config} for TimestreamWriteClient's `config` shape.
26
26
  *
27
27
  */
28
28
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, TimestreamWriteClientResolvedConfig> {
@@ -24,7 +24,7 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
24
24
  *
25
25
  * @see {@link TagResourceCommandInput} for command's `input` shape.
26
26
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
27
- * @see {@link TimestreamWriteClientResolvedConfig | config} for command's `input` shape.
27
+ * @see {@link TimestreamWriteClientResolvedConfig | config} for TimestreamWriteClient's `config` shape.
28
28
  *
29
29
  */
30
30
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, TimestreamWriteClientResolvedConfig> {
@@ -22,7 +22,7 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
22
22
  *
23
23
  * @see {@link UntagResourceCommandInput} for command's `input` shape.
24
24
  * @see {@link UntagResourceCommandOutput} for command's `response` shape.
25
- * @see {@link TimestreamWriteClientResolvedConfig | config} for command's `input` shape.
25
+ * @see {@link TimestreamWriteClientResolvedConfig | config} for TimestreamWriteClient's `config` shape.
26
26
  *
27
27
  */
28
28
  export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, TimestreamWriteClientResolvedConfig> {
@@ -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
@@ -24,7 +26,7 @@ export interface UpdateDatabaseCommandOutput extends UpdateDatabaseResponse, __M
24
26
  *
25
27
  * @see {@link UpdateDatabaseCommandInput} for command's `input` shape.
26
28
  * @see {@link UpdateDatabaseCommandOutput} for command's `response` shape.
27
- * @see {@link TimestreamWriteClientResolvedConfig | config} for command's `input` shape.
29
+ * @see {@link TimestreamWriteClientResolvedConfig | config} for TimestreamWriteClient's `config` shape.
28
30
  *
29
31
  */
30
32
  export declare class UpdateDatabaseCommand extends $Command<UpdateDatabaseCommandInput, UpdateDatabaseCommandOutput, TimestreamWriteClientResolvedConfig> {
@@ -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>Service quotas apply. For more information, see <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html">Access Management</a> in the Timestream Developer Guide.</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
@@ -26,7 +27,7 @@ export interface UpdateTableCommandOutput extends UpdateTableResponse, __Metadat
26
27
  *
27
28
  * @see {@link UpdateTableCommandInput} for command's `input` shape.
28
29
  * @see {@link UpdateTableCommandOutput} for command's `response` shape.
29
- * @see {@link TimestreamWriteClientResolvedConfig | config} for command's `input` shape.
30
+ * @see {@link TimestreamWriteClientResolvedConfig | config} for TimestreamWriteClient's `config` shape.
30
31
  *
31
32
  */
32
33
  export declare class UpdateTableCommand extends $Command<UpdateTableCommandInput, UpdateTableCommandOutput, TimestreamWriteClientResolvedConfig> {
@@ -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
- * Service quotas apply. For more information,
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
@@ -33,7 +63,7 @@ export interface WriteRecordsCommandOutput extends __MetadataBearer {
33
63
  *
34
64
  * @see {@link WriteRecordsCommandInput} for command's `input` shape.
35
65
  * @see {@link WriteRecordsCommandOutput} for command's `response` shape.
36
- * @see {@link TimestreamWriteClientResolvedConfig | config} for command's `input` shape.
66
+ * @see {@link TimestreamWriteClientResolvedConfig | config} for TimestreamWriteClient's `config` shape.
37
67
  *
38
68
  */
39
69
  export declare class WriteRecordsCommand extends $Command<WriteRecordsCommandInput, WriteRecordsCommandOutput, TimestreamWriteClientResolvedConfig> {