@aws-sdk/client-timestream-write 3.39.0 → 3.43.0

package/dist-types/commands/DeleteDatabaseCommand.d.ts

@@ -11,11 +11,16 @@ export interface DeleteDatabaseCommandOutput extends __MetadataBearer {
  *       After a database is deleted, the time series data from its tables cannot be recovered.</i>
  *          </p>
  *
- *          <p>All tables in the database must be deleted first, or a ValidationException error will be thrown.
+ *          <note>
+ *             <p>All tables in the database must be deleted first, or a ValidationException error will be thrown.
  *       </p>
  *
- *          <p>Due to the nature of distributed retries,
+ *             <p>Due to the nature of distributed retries,
  *          the operation can return either success or a ResourceNotFoundException. Clients should consider them equivalent.</p>
+ *          </note>
+ *
+ *          <p>See
+ *          <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.delete-db.html">code sample</a> for details.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -28,7 +33,7 @@ export interface DeleteDatabaseCommandOutput extends __MetadataBearer {
  *
  * @see {@link DeleteDatabaseCommandInput} for command's `input` shape.
  * @see {@link DeleteDatabaseCommandOutput} for command's `response` shape.
- * @see {@link TimestreamWriteClientResolvedConfig | config} for command's `input` shape.
+ * @see {@link TimestreamWriteClientResolvedConfig | config} for TimestreamWriteClient's `config` shape.
  *
  */
 export declare class DeleteDatabaseCommand extends $Command<DeleteDatabaseCommandInput, DeleteDatabaseCommandOutput, TimestreamWriteClientResolvedConfig> {

package/dist-types/commands/DeleteTableCommand.d.ts

@@ -11,8 +11,12 @@ export interface DeleteTableCommandOutput extends __MetadataBearer {
  *        After a Timestream database table is deleted, the time series data stored in
  *        the table cannot be recovered.
  *        </p>
- *          <p>Due to the nature of distributed retries,
+ *          <note>
+ *             <p>Due to the nature of distributed retries,
  *          the operation can return either success or a ResourceNotFoundException. Clients should consider them equivalent.</p>
+ *          </note>
+ *          <p>See
+ *          <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.delete-table.html">code sample</a> for details.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -25,7 +29,7 @@ export interface DeleteTableCommandOutput extends __MetadataBearer {
  *
  * @see {@link DeleteTableCommandInput} for command's `input` shape.
  * @see {@link DeleteTableCommandOutput} for command's `response` shape.
- * @see {@link TimestreamWriteClientResolvedConfig | config} for command's `input` shape.
+ * @see {@link TimestreamWriteClientResolvedConfig | config} for TimestreamWriteClient's `config` shape.
  *
  */
 export declare class DeleteTableCommand extends $Command<DeleteTableCommandInput, DeleteTableCommandOutput, TimestreamWriteClientResolvedConfig> {

package/dist-types/commands/DescribeDatabaseCommand.d.ts

@@ -9,7 +9,8 @@ export interface DescribeDatabaseCommandOutput extends DescribeDatabaseResponse,
 /**
  * <p>Returns information about the database, including the database name, time that the database was created,
  *          and the total number of tables found within the database.
- *          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>
+ *          <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html">Service quotas apply</a>. See
+ *          <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-db.html">code sample</a> for details.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -22,7 +23,7 @@ export interface DescribeDatabaseCommandOutput extends DescribeDatabaseResponse,
  *
  * @see {@link DescribeDatabaseCommandInput} for command's `input` shape.
  * @see {@link DescribeDatabaseCommandOutput} for command's `response` shape.
- * @see {@link TimestreamWriteClientResolvedConfig | config} for command's `input` shape.
+ * @see {@link TimestreamWriteClientResolvedConfig | config} for TimestreamWriteClient's `config` shape.
  *
  */
 export declare class DescribeDatabaseCommand extends $Command<DescribeDatabaseCommandInput, DescribeDatabaseCommandOutput, TimestreamWriteClientResolvedConfig> {

package/dist-types/commands/DescribeEndpointsCommand.d.ts

@@ -7,20 +7,25 @@ export interface DescribeEndpointsCommandInput extends DescribeEndpointsRequest
 export interface DescribeEndpointsCommandOutput extends DescribeEndpointsResponse, __MetadataBearer {
 }
 /**
- * <p>DescribeEndpoints returns a list of available endpoints to make Timestream API calls against. This API is available through both Write and Query.</p>
- *          <p>Because Timestream’s SDKs are designed to transparently work with the service’s architecture,
+ * <p>DescribeEndpoints returns a list of available endpoints to make Timestream API calls against.
+ *          This API is available through both Write and Query.</p>
+ *          <p>Because the Timestream SDKs are designed to transparently work with the service’s architecture,
  *          including the management and mapping of the service endpoints,
  *          <i>it is not recommended that you use this API unless</i>:</p>
  *          <ul>
  *             <li>
+ *                <p>You are using <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/VPCEndpoints">VPC endpoints (Amazon Web Services PrivateLink) with Timestream</a>
+ *                </p>
+ *             </li>
+ *             <li>
  *                <p>Your application uses a programming language that does not yet have SDK support</p>
  *             </li>
  *             <li>
  *                <p>You require better control over the client-side implementation</p>
  *             </li>
  *          </ul>
- *          <p>For detailed information on how to use DescribeEndpoints,
- *          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>
+ *          <p>For detailed information on how and when to use and implement DescribeEndpoints,
+ *          see <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/Using.API.html#Using-API.endpoint-discovery">The Endpoint Discovery Pattern</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -33,7 +38,7 @@ export interface DescribeEndpointsCommandOutput extends DescribeEndpointsRespons
  *
  * @see {@link DescribeEndpointsCommandInput} for command's `input` shape.
  * @see {@link DescribeEndpointsCommandOutput} for command's `response` shape.
- * @see {@link TimestreamWriteClientResolvedConfig | config} for command's `input` shape.
+ * @see {@link TimestreamWriteClientResolvedConfig | config} for TimestreamWriteClient's `config` shape.
  *
  */
 export declare class DescribeEndpointsCommand extends $Command<DescribeEndpointsCommandInput, DescribeEndpointsCommandOutput, TimestreamWriteClientResolvedConfig> {

package/dist-types/commands/DescribeTableCommand.d.ts

@@ -9,7 +9,8 @@ export interface DescribeTableCommandOutput extends DescribeTableResponse, __Met
 /**
  * <p>Returns information about the table, including the table name, database name,
  *       retention duration of the memory store and the magnetic store.
- *          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.
+ *          <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html">Service quotas apply</a>. See
+ *          <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-table.html">code sample</a> for details.
  *       </p>
  * @example
  * 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
  *
  * @see {@link DescribeTableCommandInput} for command's `input` shape.
  * @see {@link DescribeTableCommandOutput} for command's `response` shape.
- * @see {@link TimestreamWriteClientResolvedConfig | config} for command's `input` shape.
+ * @see {@link TimestreamWriteClientResolvedConfig | config} for TimestreamWriteClient's `config` shape.
  *
  */
 export declare class DescribeTableCommand extends $Command<DescribeTableCommandInput, DescribeTableCommandOutput, TimestreamWriteClientResolvedConfig> {

package/dist-types/commands/ListDatabasesCommand.d.ts

@@ -8,7 +8,8 @@ export interface ListDatabasesCommandOutput extends ListDatabasesResponse, __Met
 }
 /**
  * <p>Returns a list of your Timestream databases.
- *          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.
+ *          <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html">Service quotas apply</a>. See
+ *          <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-db.html">code sample</a> for details.
  *       </p>
  * @example
  * 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
  *
  * @see {@link ListDatabasesCommandInput} for command's `input` shape.
  * @see {@link ListDatabasesCommandOutput} for command's `response` shape.
- * @see {@link TimestreamWriteClientResolvedConfig | config} for command's `input` shape.
+ * @see {@link TimestreamWriteClientResolvedConfig | config} for TimestreamWriteClient's `config` shape.
  *
  */
 export declare class ListDatabasesCommand extends $Command<ListDatabasesCommandInput, ListDatabasesCommandOutput, TimestreamWriteClientResolvedConfig> {

package/dist-types/commands/ListTablesCommand.d.ts

@@ -8,6 +8,8 @@ export interface ListTablesCommandOutput extends ListTablesResponse, __MetadataB
 }
 /**
  * <p>A list of tables, along with the name, status and retention properties of each table.
+ *          See
+ *          <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-table.html">code sample</a> for details.
  *       </p>
  * @example
  * 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
  *
  * @see {@link ListTablesCommandInput} for command's `input` shape.
  * @see {@link ListTablesCommandOutput} for command's `response` shape.
- * @see {@link TimestreamWriteClientResolvedConfig | config} for command's `input` shape.
+ * @see {@link TimestreamWriteClientResolvedConfig | config} for TimestreamWriteClient's `config` shape.
  *
  */
 export declare class ListTablesCommand extends $Command<ListTablesCommandInput, ListTablesCommandOutput, TimestreamWriteClientResolvedConfig> {

package/dist-types/commands/ListTagsForResourceCommand.d.ts

@@ -22,7 +22,7 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
  *
  * @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
  * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
- * @see {@link TimestreamWriteClientResolvedConfig | config} for command's `input` shape.
+ * @see {@link TimestreamWriteClientResolvedConfig | config} for TimestreamWriteClient's `config` shape.
  *
  */
 export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, TimestreamWriteClientResolvedConfig> {

package/dist-types/commands/TagResourceCommand.d.ts

@@ -24,7 +24,7 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
  *
  * @see {@link TagResourceCommandInput} for command's `input` shape.
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
- * @see {@link TimestreamWriteClientResolvedConfig | config} for command's `input` shape.
+ * @see {@link TimestreamWriteClientResolvedConfig | config} for TimestreamWriteClient's `config` shape.
  *
  */
 export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, TimestreamWriteClientResolvedConfig> {

package/dist-types/commands/UntagResourceCommand.d.ts

@@ -22,7 +22,7 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
  *
  * @see {@link UntagResourceCommandInput} for command's `input` shape.
  * @see {@link UntagResourceCommandOutput} for command's `response` shape.
- * @see {@link TimestreamWriteClientResolvedConfig | config} for command's `input` shape.
+ * @see {@link TimestreamWriteClientResolvedConfig | config} for TimestreamWriteClient's `config` shape.
  *
  */
 export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, TimestreamWriteClientResolvedConfig> {

package/dist-types/commands/UpdateDatabaseCommand.d.ts

@@ -12,6 +12,8 @@ export interface UpdateDatabaseCommandOutput extends UpdateDatabaseResponse, __M
  *     you must specify the database name and the identifier of the new KMS key to be used (<code>KmsKeyId</code>).
  *     If there are any concurrent <code>UpdateDatabase</code> requests, first writer wins.
  *    </p>
+ *          <p>See
+ *          <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.update-db.html">code sample</a> for details.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -24,7 +26,7 @@ export interface UpdateDatabaseCommandOutput extends UpdateDatabaseResponse, __M
  *
  * @see {@link UpdateDatabaseCommandInput} for command's `input` shape.
  * @see {@link UpdateDatabaseCommandOutput} for command's `response` shape.
- * @see {@link TimestreamWriteClientResolvedConfig | config} for command's `input` shape.
+ * @see {@link TimestreamWriteClientResolvedConfig | config} for TimestreamWriteClient's `config` shape.
  *
  */
 export declare class UpdateDatabaseCommand extends $Command<UpdateDatabaseCommandInput, UpdateDatabaseCommandOutput, TimestreamWriteClientResolvedConfig> {

package/dist-types/commands/UpdateTableCommand.d.ts

@@ -13,7 +13,8 @@ export interface UpdateTableCommandOutput extends UpdateTableResponse, __Metadat
  *          the memory store will be capable of holding 24 hours of data, but will
  *          be populated with 24 hours of data 22 hours after this change was made.
  *          Timestream does not retrieve data from the magnetic store to populate the memory store. </p>
- *          <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>
+ *          <p>See
+ *          <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.update-table.html">code sample</a> for details.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -26,7 +27,7 @@ export interface UpdateTableCommandOutput extends UpdateTableResponse, __Metadat
  *
  * @see {@link UpdateTableCommandInput} for command's `input` shape.
  * @see {@link UpdateTableCommandOutput} for command's `response` shape.
- * @see {@link TimestreamWriteClientResolvedConfig | config} for command's `input` shape.
+ * @see {@link TimestreamWriteClientResolvedConfig | config} for TimestreamWriteClient's `config` shape.
  *
  */
 export declare class UpdateTableCommand extends $Command<UpdateTableCommandInput, UpdateTableCommandOutput, TimestreamWriteClientResolvedConfig> {

package/dist-types/commands/WriteRecordsCommand.d.ts

@@ -1,10 +1,10 @@
 import { Command as $Command } from "@aws-sdk/smithy-client";
 import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
-import { WriteRecordsRequest } from "../models/models_0";
+import { WriteRecordsRequest, WriteRecordsResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, TimestreamWriteClientResolvedConfig } from "../TimestreamWriteClient";
 export interface WriteRecordsCommandInput extends WriteRecordsRequest {
 }
-export interface WriteRecordsCommandOutput extends __MetadataBearer {
+export interface WriteRecordsCommandOutput extends WriteRecordsResponse, __MetadataBearer {
 }
 /**
  * <p>The WriteRecords operation enables you to write your time series
@@ -18,9 +18,39 @@ export interface WriteRecordsCommandOutput extends __MetadataBearer {
  *       the query results might not reflect the results of a recently completed write
  *       operation. The results may also include some stale data. If you repeat the
  *       query request after a short time, the results should return the latest data.
- *       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.
+ *          <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html">Service quotas apply</a>.
  *         </p>
+ *
+ *          <p>See
+ *          <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.write.html">code sample</a> for details.</p>
+ *
+ *          <p>
+ *             <b>Upserts</b>
+ *          </p>
+ *
+ *          <p>You can use the <code>Version</code> parameter in a <code>WriteRecords</code> request to update data points.
+ *          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.
+ *          Timestream will update an existing record’s measure value along with its <code>Version</code> upon receiving a write request with a higher
+ *          <code>Version</code> number for that record.
+ *          Upon receiving an update request where the measure value is the same as that of the existing record,
+ *          Timestream still updates <code>Version</code>, if it is greater than the existing value of <code>Version</code>.
+ *          You can update a data point as many times as desired, as long as the value of <code>Version</code> continuously increases.
+ *       </p>
+ *          <p>
+ *          For example, suppose you write a new record without indicating <code>Version</code> in the request.
+ *          Timestream will store this record, and set <code>Version</code> to <code>1</code>.
+ *          Now, suppose you try to update this record with a <code>WriteRecords</code> request of the same record with a different measure value but,
+ *          like before, do not provide <code>Version</code>.
+ *          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.
+ *          However, if you were to resend the update request with <code>Version</code> set to <code>2</code>,
+ *          Timestream would then succeed in updating the record’s value,
+ *          and the <code>Version</code> would be set to <code>2</code>.
+ *          Next, suppose you sent a <code>WriteRecords</code> request with this same record and an identical measure value,
+ *          but with <code>Version</code> set to <code>3</code>.
+ *          In this case, Timestream would only update <code>Version</code> to <code>3</code>.
+ *          Any further updates would need to send a version number greater than <code>3</code>,
+ *          or the update requests would receive a <code>RejectedRecordsException</code>.
+ *       </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -33,7 +63,7 @@ export interface WriteRecordsCommandOutput extends __MetadataBearer {
  *
  * @see {@link WriteRecordsCommandInput} for command's `input` shape.
  * @see {@link WriteRecordsCommandOutput} for command's `response` shape.
- * @see {@link TimestreamWriteClientResolvedConfig | config} for command's `input` shape.
+ * @see {@link TimestreamWriteClientResolvedConfig | config} for TimestreamWriteClient's `config` shape.
  *
  */
 export declare class WriteRecordsCommand extends $Command<WriteRecordsCommandInput, WriteRecordsCommandOutput, TimestreamWriteClientResolvedConfig> {