@aws-sdk/client-timestream-write 3.279.0 → 3.281.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 (61) hide show
  1. package/README.md +174 -13
  2. package/dist-cjs/TimestreamWrite.js +60 -0
  3. package/dist-cjs/commands/CreateBatchLoadTaskCommand.js +48 -0
  4. package/dist-cjs/commands/DescribeBatchLoadTaskCommand.js +48 -0
  5. package/dist-cjs/commands/ListBatchLoadTasksCommand.js +48 -0
  6. package/dist-cjs/commands/ResumeBatchLoadTaskCommand.js +48 -0
  7. package/dist-cjs/commands/index.js +4 -0
  8. package/dist-cjs/endpoint/ruleset.js +3 -3
  9. package/dist-cjs/models/models_0.js +153 -37
  10. package/dist-cjs/pagination/ListBatchLoadTasksPaginator.js +36 -0
  11. package/dist-cjs/pagination/index.js +1 -0
  12. package/dist-cjs/protocols/Aws_json1_0.js +626 -1
  13. package/dist-es/TimestreamWrite.js +60 -0
  14. package/dist-es/commands/CreateBatchLoadTaskCommand.js +44 -0
  15. package/dist-es/commands/DescribeBatchLoadTaskCommand.js +44 -0
  16. package/dist-es/commands/ListBatchLoadTasksCommand.js +44 -0
  17. package/dist-es/commands/ResumeBatchLoadTaskCommand.js +44 -0
  18. package/dist-es/commands/index.js +4 -0
  19. package/dist-es/endpoint/ruleset.js +3 -3
  20. package/dist-es/models/models_0.js +127 -34
  21. package/dist-es/pagination/ListBatchLoadTasksPaginator.js +32 -0
  22. package/dist-es/pagination/index.js +1 -0
  23. package/dist-es/protocols/Aws_json1_0.js +617 -0
  24. package/dist-types/TimestreamWrite.d.ts +154 -131
  25. package/dist-types/TimestreamWriteClient.d.ts +18 -8
  26. package/dist-types/commands/CreateBatchLoadTaskCommand.d.ts +51 -0
  27. package/dist-types/commands/CreateDatabaseCommand.d.ts +9 -6
  28. package/dist-types/commands/CreateTableCommand.d.ts +12 -9
  29. package/dist-types/commands/DeleteDatabaseCommand.d.ts +15 -11
  30. package/dist-types/commands/DeleteTableCommand.d.ts +13 -8
  31. package/dist-types/commands/DescribeBatchLoadTaskCommand.d.ts +46 -0
  32. package/dist-types/commands/DescribeDatabaseCommand.d.ts +10 -4
  33. package/dist-types/commands/DescribeEndpointsCommand.d.ts +16 -8
  34. package/dist-types/commands/DescribeTableCommand.d.ts +10 -5
  35. package/dist-types/commands/ListBatchLoadTasksCommand.d.ts +45 -0
  36. package/dist-types/commands/ListDatabasesCommand.d.ts +9 -4
  37. package/dist-types/commands/ListTablesCommand.d.ts +9 -4
  38. package/dist-types/commands/ListTagsForResourceCommand.d.ts +7 -3
  39. package/dist-types/commands/ResumeBatchLoadTaskCommand.d.ts +44 -0
  40. package/dist-types/commands/TagResourceCommand.d.ts +9 -5
  41. package/dist-types/commands/UntagResourceCommand.d.ts +7 -3
  42. package/dist-types/commands/UpdateDatabaseCommand.d.ts +11 -7
  43. package/dist-types/commands/UpdateTableCommand.d.ts +12 -8
  44. package/dist-types/commands/WriteRecordsCommand.d.ts +42 -41
  45. package/dist-types/commands/index.d.ts +4 -0
  46. package/dist-types/models/models_0.d.ts +786 -274
  47. package/dist-types/pagination/ListBatchLoadTasksPaginator.d.ts +4 -0
  48. package/dist-types/pagination/index.d.ts +1 -0
  49. package/dist-types/protocols/Aws_json1_0.d.ts +12 -0
  50. package/dist-types/ts3.4/TimestreamWrite.d.ts +68 -0
  51. package/dist-types/ts3.4/TimestreamWriteClient.d.ts +24 -0
  52. package/dist-types/ts3.4/commands/CreateBatchLoadTaskCommand.d.ts +38 -0
  53. package/dist-types/ts3.4/commands/DescribeBatchLoadTaskCommand.d.ts +41 -0
  54. package/dist-types/ts3.4/commands/ListBatchLoadTasksCommand.d.ts +38 -0
  55. package/dist-types/ts3.4/commands/ResumeBatchLoadTaskCommand.d.ts +38 -0
  56. package/dist-types/ts3.4/commands/index.d.ts +4 -0
  57. package/dist-types/ts3.4/models/models_0.d.ts +253 -43
  58. package/dist-types/ts3.4/pagination/ListBatchLoadTasksPaginator.d.ts +11 -0
  59. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  60. package/dist-types/ts3.4/protocols/Aws_json1_0.d.ts +48 -0
  61. package/package.json +6 -4
@@ -3,55 +3,56 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { WriteRecordsRequest, WriteRecordsResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, TimestreamWriteClientResolvedConfig } from "../TimestreamWriteClient";
6
+ /**
7
+ * The input for {@link WriteRecordsCommand}.
8
+ */
6
9
  export interface WriteRecordsCommandInput extends WriteRecordsRequest {
7
10
  }
11
+ /**
12
+ * The output of {@link WriteRecordsCommand}.
13
+ */
8
14
  export interface WriteRecordsCommandOutput extends WriteRecordsResponse, __MetadataBearer {
9
15
  }
10
16
  /**
11
- * <p>The WriteRecords operation enables you to write your time series
12
- * data into Timestream. You can specify a single data point or a batch
13
- * of data points to be inserted into the system. Timestream offers you
14
- * with a flexible schema that auto detects the column names and data types
15
- * for your Timestream tables based on the dimension names and data types of
16
- * the data points you specify when invoking writes into the database.
17
- * Timestream support eventual consistency read semantics. This means that
18
- * when you query data immediately after writing a batch of data into Timestream,
19
- * the query results might not reflect the results of a recently completed write
20
- * operation. The results may also include some stale data. If you repeat the
21
- * query request after a short time, the results should return the latest data.
22
- * <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html">Service quotas apply</a>.
23
- * </p>
24
- *
25
- * <p>See
26
- * <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.write.html">code sample</a> for details.</p>
27
- *
17
+ * <p>Enables you to write your time-series data into Timestream. You can specify a
18
+ * 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
19
+ * types for your Timestream tables based on the dimension names and data types of
20
+ * the data points you specify when invoking writes into the database. </p>
21
+ * <p>Timestream supports eventual consistency read semantics. This means that when
22
+ * you query data immediately after writing a batch of data into Timestream, the
23
+ * query results might not reflect the results of a recently completed write operation. The
24
+ * results may also include some stale data. If you repeat the query request after a short
25
+ * time, the results should return the latest data. <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html">Service quotas apply</a>. </p>
26
+ * <p>See <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.write.html">code sample</a> for
27
+ * details.</p>
28
28
  * <p>
29
29
  * <b>Upserts</b>
30
30
  * </p>
31
- *
32
- * <p>You can use the <code>Version</code> parameter in a <code>WriteRecords</code> request to update data points.
33
- * 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.
34
- * Timestream will update an existing record’s measure value along with its <code>Version</code> upon receiving a write request with a higher
35
- * <code>Version</code> number for that record.
36
- * Upon receiving an update request where the measure value is the same as that of the existing record,
37
- * Timestream still updates <code>Version</code>, if it is greater than the existing value of <code>Version</code>.
38
- * You can update a data point as many times as desired, as long as the value of <code>Version</code> continuously increases.
39
- * </p>
40
- * <p>
41
- * For example, suppose you write a new record without indicating <code>Version</code> in the request.
42
- * Timestream will store this record, and set <code>Version</code> to <code>1</code>.
43
- * Now, suppose you try to update this record with a <code>WriteRecords</code> request of the same record with a different measure value but,
44
- * like before, do not provide <code>Version</code>.
45
- * 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.
46
- * However, if you were to resend the update request with <code>Version</code> set to <code>2</code>,
47
- * Timestream would then succeed in updating the record’s value,
48
- * and the <code>Version</code> would be set to <code>2</code>.
49
- * Next, suppose you sent a <code>WriteRecords</code> request with this same record and an identical measure value,
50
- * but with <code>Version</code> set to <code>3</code>.
51
- * In this case, Timestream would only update <code>Version</code> to <code>3</code>.
52
- * Any further updates would need to send a version number greater than <code>3</code>,
53
- * or the update requests would receive a <code>RejectedRecordsException</code>.
54
- * </p>
31
+ * <p>You can use the <code>Version</code> parameter in a <code>WriteRecords</code> request to
32
+ * update data points. Timestream tracks a version number with each record.
33
+ * <code>Version</code> defaults to <code>1</code> when it's not specified for the record
34
+ * in the request. Timestream updates an existing record’s measure value along with
35
+ * its <code>Version</code> when it receives a write request with a higher
36
+ * <code>Version</code> number for that record. When it receives an update request where
37
+ * the measure value is the same as that of the existing record, Timestream still
38
+ * updates <code>Version</code>, if it is greater than the existing value of
39
+ * <code>Version</code>. You can update a data point as many times as desired, as long as
40
+ * the value of <code>Version</code> continuously increases. </p>
41
+ * <p> For example, suppose you write a new record without indicating <code>Version</code> in
42
+ * the request. Timestream stores this record, and set <code>Version</code> to
43
+ * <code>1</code>. Now, suppose you try to update this record with a
44
+ * <code>WriteRecords</code> request of the same record with a different measure value but,
45
+ * like before, do not provide <code>Version</code>. In this case, Timestream will
46
+ * reject this update with a <code>RejectedRecordsException</code> since the updated record’s
47
+ * version is not greater than the existing value of Version. </p>
48
+ * <p>However, if you were to resend the update request with <code>Version</code> set to
49
+ * <code>2</code>, Timestream would then succeed in updating the record’s value,
50
+ * and the <code>Version</code> would be set to <code>2</code>. Next, suppose you sent a
51
+ * <code>WriteRecords</code> request with this same record and an identical measure value,
52
+ * but with <code>Version</code> set to <code>3</code>. In this case, Timestream
53
+ * would only update <code>Version</code> to <code>3</code>. Any further updates would need to
54
+ * send a version number greater than <code>3</code>, or the update requests would receive a
55
+ * <code>RejectedRecordsException</code>. </p>
55
56
  * @example
56
57
  * Use a bare-bones client and the command you need to make an API call.
57
58
  * ```javascript
@@ -1,13 +1,17 @@
1
+ export * from "./CreateBatchLoadTaskCommand";
1
2
  export * from "./CreateDatabaseCommand";
2
3
  export * from "./CreateTableCommand";
3
4
  export * from "./DeleteDatabaseCommand";
4
5
  export * from "./DeleteTableCommand";
6
+ export * from "./DescribeBatchLoadTaskCommand";
5
7
  export * from "./DescribeDatabaseCommand";
6
8
  export * from "./DescribeEndpointsCommand";
7
9
  export * from "./DescribeTableCommand";
10
+ export * from "./ListBatchLoadTasksCommand";
8
11
  export * from "./ListDatabasesCommand";
9
12
  export * from "./ListTablesCommand";
10
13
  export * from "./ListTagsForResourceCommand";
14
+ export * from "./ResumeBatchLoadTaskCommand";
11
15
  export * from "./TagResourceCommand";
12
16
  export * from "./UntagResourceCommand";
13
17
  export * from "./UpdateDatabaseCommand";