@aws-sdk/client-timestream-write 3.41.0 → 3.46.0

package/dist-types/models/models_0.d.ts

@@ -60,8 +60,10 @@ export interface CreateDatabaseRequest {
      */
     DatabaseName: string | undefined;
     /**
-     * <p>The KMS key for the database. If the KMS key is not specified, the database will be encrypted with a Timestream
-     *          managed KMS key located in your account. 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.</p>
+     * <p>The KMS key for the database.
+     *          If the KMS key is not specified, the database will be encrypted with a Timestream
+     *          managed KMS key located in your account.
+     *          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.</p>
      */
     KmsKeyId?: string;
     /**
@@ -198,6 +200,71 @@ export declare namespace ValidationException {
      */
     const filterSensitiveLog: (obj: ValidationException) => any;
 }
+export declare enum S3EncryptionOption {
+    SSE_KMS = "SSE_KMS",
+    SSE_S3 = "SSE_S3"
+}
+/**
+ * <p>Configuration specifing an S3 location.</p>
+ */
+export interface S3Configuration {
+    /**
+     * <p>>Bucket name of the customer S3 bucket.</p>
+     */
+    BucketName?: string;
+    /**
+     * <p>Object key preview for the customer S3 location.</p>
+     */
+    ObjectKeyPrefix?: string;
+    /**
+     * <p>Encryption option for the customer s3 location. Options are S3 server side encryption with an S3-managed key or KMS managed key.</p>
+     */
+    EncryptionOption?: S3EncryptionOption | string;
+    /**
+     * <p>KMS key id for the customer s3 location when encrypting with a KMS managed key.</p>
+     */
+    KmsKeyId?: string;
+}
+export declare namespace S3Configuration {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: S3Configuration) => any;
+}
+/**
+ * <p>The location to write error reports for records rejected, asynchronously, during magnetic store writes.</p>
+ */
+export interface MagneticStoreRejectedDataLocation {
+    /**
+     * <p>Configuration of an S3 location to write error reports for records rejected, asynchronously, during magnetic store writes.</p>
+     */
+    S3Configuration?: S3Configuration;
+}
+export declare namespace MagneticStoreRejectedDataLocation {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: MagneticStoreRejectedDataLocation) => any;
+}
+/**
+ * <p>The set of properties on a table for configuring magnetic store writes.</p>
+ */
+export interface MagneticStoreWriteProperties {
+    /**
+     * <p>A flag to enable magnetic store writes.</p>
+     */
+    EnableMagneticStoreWrites: boolean | undefined;
+    /**
+     * <p>The location to write error reports for records rejected asynchronously during magnetic store writes.</p>
+     */
+    MagneticStoreRejectedDataLocation?: MagneticStoreRejectedDataLocation;
+}
+export declare namespace MagneticStoreWriteProperties {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: MagneticStoreWriteProperties) => any;
+}
 /**
  * <p>Retention properties contain the duration for which your time series data must be stored in the magnetic store and the memory store.
  *       </p>
@@ -237,6 +304,10 @@ export interface CreateTableRequest {
      *    </p>
      */
     Tags?: Tag[];
+    /**
+     * <p>Contains properties to set on the table when enabling magnetic store writes.</p>
+     */
+    MagneticStoreWriteProperties?: MagneticStoreWriteProperties;
 }
 export declare namespace CreateTableRequest {
     /**
@@ -291,6 +362,10 @@ export interface Table {
      * <p>The time when the Timestream table was last updated.</p>
      */
     LastUpdatedTime?: Date;
+    /**
+     * <p>Contains properties to set on the table when enabling magnetic store writes.</p>
+     */
+    MagneticStoreWriteProperties?: MagneticStoreWriteProperties;
 }
 export declare namespace Table {
     /**
@@ -576,8 +651,36 @@ export declare enum MeasureValueType {
     BIGINT = "BIGINT",
     BOOLEAN = "BOOLEAN",
     DOUBLE = "DOUBLE",
+    MULTI = "MULTI",
+    TIMESTAMP = "TIMESTAMP",
     VARCHAR = "VARCHAR"
 }
+/**
+ * <p> MeasureValue represents the data attribute of the time series. For example, the CPU utilization of an EC2 instance or the RPM of a wind turbine are measures. MeasureValue has both name and value. </p>
+ *          <p> MeasureValue is only allowed for type <code>MULTI</code>. Using <code>MULTI</code> type, you can pass multiple data attributes associated with the same time series in a single record </p>
+ */
+export interface MeasureValue {
+    /**
+     * <p> Name of the MeasureValue.  </p>
+     *          <p> For constraints on MeasureValue names, refer to <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html#limits.naming">
+     *       Naming Constraints</a> in the Timestream developer guide.</p>
+     */
+    Name: string | undefined;
+    /**
+     * <p> Value for the MeasureValue. </p>
+     */
+    Value: string | undefined;
+    /**
+     * <p>Contains the data type of the MeasureValue for the time series data point.</p>
+     */
+    Type: MeasureValueType | string | undefined;
+}
+export declare namespace MeasureValue {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: MeasureValue) => any;
+}
 export declare enum TimeUnit {
     MICROSECONDS = "MICROSECONDS",
     MILLISECONDS = "MILLISECONDS",
@@ -595,6 +698,14 @@ export declare enum TimeUnit {
  *        In addition, the record contains the timestamp when the measure was collected that
  *        the timestamp unit which represents the granularity of the timestamp.
  *        </p>
+ *          <p>
+ *         Records have a <code>Version</code> field, which is a 64-bit <code>long</code> that you can use for updating data points.
+ *         Writes of a duplicate record with the same dimension,
+ *         timestamp, and measure name
+ *         but different measure value will only succeed if the <code>Version</code> attribute of the record in the write request
+ *         is higher than that of the existing record.
+ *         Timestream defaults to a <code>Version</code> of <code>1</code> for records without the <code>Version</code> field.
+ *      </p>
  */
 export interface _Record {
     /**
@@ -613,7 +724,7 @@ export interface _Record {
     MeasureValue?: string;
     /**
      * <p>
-     * Contains the data type of the measure value for the time series data point.
+     * Contains the data type of the measure value for the time series data point. Default type is <code>DOUBLE</code>.
      * </p>
      */
     MeasureValueType?: MeasureValueType | string;
@@ -629,15 +740,26 @@ export interface _Record {
     /**
      * <p>
      * The granularity of the timestamp unit. It indicates if the time value is in seconds, milliseconds, nanoseconds or other supported values.
+     * Default is <code>MILLISECONDS</code>.
      * </p>
      */
     TimeUnit?: TimeUnit | string;
     /**
      * <p>64-bit attribute used for record updates.
      *          Write requests for duplicate data with a higher version number will update the existing measure value and version.
-     *          In cases where the measure value is the same, <code>Version</code> will still be updated . Default value is to 1.</p>
+     *          In cases where the measure value is the same, <code>Version</code> will still be updated . Default value is <code>1</code>.</p>
+     *
+     *          <note>
+     *             <p>
+     *                <code>Version</code> must be <code>1</code> or greater, or you will receive a <code>ValidationException</code> error.</p>
+     *          </note>
      */
     Version?: number;
+    /**
+     * <p> Contains the list of MeasureValue for time series data points. </p>
+     *          <p> This is only allowed for type <code>MULTI</code>. For scalar values, use <code>MeasureValue</code> attribute of the Record directly. </p>
+     */
+    MeasureValues?: MeasureValue[];
 }
 export declare namespace _Record {
     /**
@@ -645,6 +767,29 @@ export declare namespace _Record {
      */
     const filterSensitiveLog: (obj: _Record) => any;
 }
+/**
+ * <p>Information on the records ingested by this request.</p>
+ */
+export interface RecordsIngested {
+    /**
+     * <p>Total count of successfully ingested records.</p>
+     */
+    Total?: number;
+    /**
+     * <p>Count of records ingested into the memory store.</p>
+     */
+    MemoryStore?: number;
+    /**
+     * <p>Count of records ingested into the magnetic store.</p>
+     */
+    MagneticStore?: number;
+}
+export declare namespace RecordsIngested {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: RecordsIngested) => any;
+}
 /**
  * <p>
  * Records that were not successfully inserted into Timestream due to data validation issues
@@ -664,10 +809,22 @@ export interface RejectedRecord {
      *       </p>
      *          <ul>
      *             <li>
-     *                <p>
-     *                  Records with duplicate data where there are multiple records with the same dimensions,
-     *          timestamps, and measure names but different measure values.
+     *                <p>Records with duplicate data where there are multiple records with the same dimensions,
+     *                   timestamps, and measure names but:
      *                </p>
+     *                <ul>
+     *                   <li>
+     *                      <p>Measure values are different</p>
+     *                   </li>
+     *                   <li>
+     *                      <p>Version is not present in the request <i>or</i>
+     *                      the value of version in the new record is equal to or lower than the existing value</p>
+     *                   </li>
+     *                </ul>
+     *                <p>
+     *                   If Timestream rejects data for this case, the <code>ExistingVersion</code> field in the <code>RejectedRecords</code>
+     *                   response will indicate the current record’s version.
+     *                   To force an update, you can resend the request with a version for the record set to a value greater than the <code>ExistingVersion</code>.</p>
      *             </li>
      *             <li>
      *                <p>
@@ -715,10 +872,22 @@ export declare namespace RejectedRecord {
  *       </p>
  *          <ul>
  *             <li>
- *                <p>
- *                  Records with duplicate data where there are multiple records with the same dimensions,
- *          timestamps, and measure names but different measure values.
- *                </p>
+ *                <p>Records with duplicate data where there are multiple records with the same dimensions,
+ *                   timestamps, and measure names but:
+ *                   </p>
+ *                   <ul>
+ *                   <li>
+ *                      <p>Measure values are different</p>
+ *                   </li>
+ *                   <li>
+ *                      <p>Version is not present in the request <i>or</i>
+ *                         the value of version in the new record is equal to or lower than the existing value</p>
+ *                   </li>
+ *                </ul>
+ *                   <p>
+ *                   In this case, if Timestream rejects data, the <code>ExistingVersion</code> field in the <code>RejectedRecords</code>
+ *                   response will indicate the current record’s version.
+ *                   To force an update, you can resend the request with a version for the record set to a value greater than the <code>ExistingVersion</code>.</p>
  *             </li>
  *             <li>
  *                <p>
@@ -732,7 +901,7 @@ export declare namespace RejectedRecord {
  *             </li>
  *          </ul>
  *          <p>
- *          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.
+ *          For more information, see <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html">Quotas</a> in the Timestream Developer Guide.
  *          </p>
  */
 export interface RejectedRecordsException extends __SmithyException, $MetadataBearer {
@@ -867,13 +1036,17 @@ export interface UpdateTableRequest {
      */
     DatabaseName: string | undefined;
     /**
-     * <p>The name of the Timesream table.</p>
+     * <p>The name of the Timestream table.</p>
      */
     TableName: string | undefined;
     /**
      * <p>The retention duration of the memory store and the magnetic store.</p>
      */
-    RetentionProperties: RetentionProperties | undefined;
+    RetentionProperties?: RetentionProperties;
+    /**
+     * <p>Contains properties to set on the table when enabling magnetic store writes.</p>
+     */
+    MagneticStoreWriteProperties?: MagneticStoreWriteProperties;
 }
 export declare namespace UpdateTableRequest {
     /**
@@ -899,19 +1072,23 @@ export interface WriteRecordsRequest {
      */
     DatabaseName: string | undefined;
     /**
-     * <p>The name of the Timesream table.</p>
+     * <p>The name of the Timestream table.</p>
      */
     TableName: string | undefined;
     /**
-     * <p>A record containing the common measure and dimension attributes
+     * <p>A record containing the common measure, dimension, time,
+     *          and version attributes
      *        shared across all the records in the request. The measure and dimension
-     *        attributes specified in here will be merged with the measure and dimension
+     *        attributes specified will be merged with the measure and dimension
      *        attributes in the records object when the data is written into Timestream.
+     *        Dimensions may not overlap,
+     *        or a <code>ValidationException</code> will be thrown.
+     *          In other words, a record must contain dimensions with unique names.
      *        </p>
      */
     CommonAttributes?: _Record;
     /**
-     * <p>An array of records containing the unique dimension and measure
+     * <p>An array of records containing the unique measure, dimension, time, and version
      *        attributes for each time series data point.
      *        </p>
      */
@@ -923,3 +1100,15 @@ export declare namespace WriteRecordsRequest {
      */
     const filterSensitiveLog: (obj: WriteRecordsRequest) => any;
 }
+export interface WriteRecordsResponse {
+    /**
+     * <p>Information on the records ingested by this request.</p>
+     */
+    RecordsIngested?: RecordsIngested;
+}
+export declare namespace WriteRecordsResponse {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: WriteRecordsResponse) => any;
+}

package/dist-types/ts3.4/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 {
 }
 
 export declare class WriteRecordsCommand extends $Command<WriteRecordsCommandInput, WriteRecordsCommandOutput, TimestreamWriteClientResolvedConfig> {

package/dist-types/ts3.4/models/models_0.d.ts

@@ -119,6 +119,45 @@ export declare namespace ValidationException {
     
     const filterSensitiveLog: (obj: ValidationException) => any;
 }
+export declare enum S3EncryptionOption {
+    SSE_KMS = "SSE_KMS",
+    SSE_S3 = "SSE_S3"
+}
+
+export interface S3Configuration {
+    
+    BucketName?: string;
+    
+    ObjectKeyPrefix?: string;
+    
+    EncryptionOption?: S3EncryptionOption | string;
+    
+    KmsKeyId?: string;
+}
+export declare namespace S3Configuration {
+    
+    const filterSensitiveLog: (obj: S3Configuration) => any;
+}
+
+export interface MagneticStoreRejectedDataLocation {
+    
+    S3Configuration?: S3Configuration;
+}
+export declare namespace MagneticStoreRejectedDataLocation {
+    
+    const filterSensitiveLog: (obj: MagneticStoreRejectedDataLocation) => any;
+}
+
+export interface MagneticStoreWriteProperties {
+    
+    EnableMagneticStoreWrites: boolean | undefined;
+    
+    MagneticStoreRejectedDataLocation?: MagneticStoreRejectedDataLocation;
+}
+export declare namespace MagneticStoreWriteProperties {
+    
+    const filterSensitiveLog: (obj: MagneticStoreWriteProperties) => any;
+}
 
 export interface RetentionProperties {
     
@@ -139,6 +178,8 @@ export interface CreateTableRequest {
     RetentionProperties?: RetentionProperties;
     
     Tags?: Tag[];
+    
+    MagneticStoreWriteProperties?: MagneticStoreWriteProperties;
 }
 export declare namespace CreateTableRequest {
     
@@ -164,6 +205,8 @@ export interface Table {
     CreationTime?: Date;
     
     LastUpdatedTime?: Date;
+    
+    MagneticStoreWriteProperties?: MagneticStoreWriteProperties;
 }
 export declare namespace Table {
     
@@ -342,8 +385,23 @@ export declare enum MeasureValueType {
     BIGINT = "BIGINT",
     BOOLEAN = "BOOLEAN",
     DOUBLE = "DOUBLE",
+    MULTI = "MULTI",
+    TIMESTAMP = "TIMESTAMP",
     VARCHAR = "VARCHAR"
 }
+
+export interface MeasureValue {
+    
+    Name: string | undefined;
+    
+    Value: string | undefined;
+    
+    Type: MeasureValueType | string | undefined;
+}
+export declare namespace MeasureValue {
+    
+    const filterSensitiveLog: (obj: MeasureValue) => any;
+}
 export declare enum TimeUnit {
     MICROSECONDS = "MICROSECONDS",
     MILLISECONDS = "MILLISECONDS",
@@ -366,12 +424,27 @@ export interface _Record {
     TimeUnit?: TimeUnit | string;
     
     Version?: number;
+    
+    MeasureValues?: MeasureValue[];
 }
 export declare namespace _Record {
     
     const filterSensitiveLog: (obj: _Record) => any;
 }
 
+export interface RecordsIngested {
+    
+    Total?: number;
+    
+    MemoryStore?: number;
+    
+    MagneticStore?: number;
+}
+export declare namespace RecordsIngested {
+    
+    const filterSensitiveLog: (obj: RecordsIngested) => any;
+}
+
 export interface RejectedRecord {
     
     RecordIndex?: number;
@@ -451,7 +524,9 @@ export interface UpdateTableRequest {
     
     TableName: string | undefined;
     
-    RetentionProperties: RetentionProperties | undefined;
+    RetentionProperties?: RetentionProperties;
+    
+    MagneticStoreWriteProperties?: MagneticStoreWriteProperties;
 }
 export declare namespace UpdateTableRequest {
     
@@ -479,3 +554,11 @@ export declare namespace WriteRecordsRequest {
     
     const filterSensitiveLog: (obj: WriteRecordsRequest) => any;
 }
+export interface WriteRecordsResponse {
+    
+    RecordsIngested?: RecordsIngested;
+}
+export declare namespace WriteRecordsResponse {
+    
+    const filterSensitiveLog: (obj: WriteRecordsResponse) => any;
+}

package/package.json

@@ -1,18 +1,17 @@
 {
   "name": "@aws-sdk/client-timestream-write",
   "description": "AWS SDK for JavaScript Timestream Write Client for Node.js, Browser and React Native",
-  "version": "3.41.0",
+  "version": "3.46.0",
   "scripts": {
     "build": "yarn build:cjs && yarn build:es && yarn build:types",
     "build:cjs": "tsc -p tsconfig.json",
-    "build:docs": "yarn clean:docs && typedoc ./",
+    "build:docs": "typedoc",
     "build:es": "tsc -p tsconfig.es.json",
     "build:types": "tsc -p tsconfig.types.json",
+    "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4",
     "clean": "yarn clean:dist && yarn clean:docs",
-    "clean:dist": "rimraf ./dist",
-    "clean:docs": "rimraf ./docs",
-    "downlevel-dts": "downlevel-dts dist-types dist-types/ts3.4",
-    "test": "jest --coverage --passWithNoTests"
+    "clean:dist": "rimraf ./dist-*",
+    "clean:docs": "rimraf ./docs"
   },
   "main": "./dist-cjs/index.js",
   "types": "./dist-types/index.d.ts",
@@ -21,49 +20,43 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "2.0.0",
     "@aws-crypto/sha256-js": "2.0.0",
-    "@aws-sdk/client-sts": "3.41.0",
-    "@aws-sdk/config-resolver": "3.40.0",
-    "@aws-sdk/credential-provider-node": "3.41.0",
-    "@aws-sdk/fetch-http-handler": "3.40.0",
-    "@aws-sdk/hash-node": "3.40.0",
-    "@aws-sdk/invalid-dependency": "3.40.0",
-    "@aws-sdk/middleware-content-length": "3.40.0",
-    "@aws-sdk/middleware-endpoint-discovery": "3.40.0",
-    "@aws-sdk/middleware-host-header": "3.40.0",
-    "@aws-sdk/middleware-logger": "3.40.0",
-    "@aws-sdk/middleware-retry": "3.40.0",
-    "@aws-sdk/middleware-serde": "3.40.0",
-    "@aws-sdk/middleware-signing": "3.40.0",
-    "@aws-sdk/middleware-stack": "3.40.0",
-    "@aws-sdk/middleware-user-agent": "3.40.0",
-    "@aws-sdk/node-config-provider": "3.40.0",
-    "@aws-sdk/node-http-handler": "3.40.0",
-    "@aws-sdk/protocol-http": "3.40.0",
-    "@aws-sdk/smithy-client": "3.41.0",
-    "@aws-sdk/types": "3.40.0",
-    "@aws-sdk/url-parser": "3.40.0",
-    "@aws-sdk/util-base64-browser": "3.37.0",
-    "@aws-sdk/util-base64-node": "3.37.0",
-    "@aws-sdk/util-body-length-browser": "3.37.0",
-    "@aws-sdk/util-body-length-node": "3.37.0",
-    "@aws-sdk/util-user-agent-browser": "3.40.0",
-    "@aws-sdk/util-user-agent-node": "3.40.0",
-    "@aws-sdk/util-utf8-browser": "3.37.0",
-    "@aws-sdk/util-utf8-node": "3.37.0",
+    "@aws-sdk/client-sts": "3.46.0",
+    "@aws-sdk/config-resolver": "3.46.0",
+    "@aws-sdk/credential-provider-node": "3.46.0",
+    "@aws-sdk/fetch-http-handler": "3.46.0",
+    "@aws-sdk/hash-node": "3.46.0",
+    "@aws-sdk/invalid-dependency": "3.46.0",
+    "@aws-sdk/middleware-content-length": "3.46.0",
+    "@aws-sdk/middleware-endpoint-discovery": "3.46.0",
+    "@aws-sdk/middleware-host-header": "3.46.0",
+    "@aws-sdk/middleware-logger": "3.46.0",
+    "@aws-sdk/middleware-retry": "3.46.0",
+    "@aws-sdk/middleware-serde": "3.46.0",
+    "@aws-sdk/middleware-signing": "3.46.0",
+    "@aws-sdk/middleware-stack": "3.46.0",
+    "@aws-sdk/middleware-user-agent": "3.46.0",
+    "@aws-sdk/node-config-provider": "3.46.0",
+    "@aws-sdk/node-http-handler": "3.46.0",
+    "@aws-sdk/protocol-http": "3.46.0",
+    "@aws-sdk/smithy-client": "3.46.0",
+    "@aws-sdk/types": "3.46.0",
+    "@aws-sdk/url-parser": "3.46.0",
+    "@aws-sdk/util-base64-browser": "3.46.0",
+    "@aws-sdk/util-base64-node": "3.46.0",
+    "@aws-sdk/util-body-length-browser": "3.46.0",
+    "@aws-sdk/util-body-length-node": "3.46.0",
+    "@aws-sdk/util-user-agent-browser": "3.46.0",
+    "@aws-sdk/util-user-agent-node": "3.46.0",
+    "@aws-sdk/util-utf8-browser": "3.46.0",
+    "@aws-sdk/util-utf8-node": "3.46.0",
     "tslib": "^2.3.0"
   },
   "devDependencies": {
-    "@aws-sdk/service-client-documentation-generator": "3.38.0",
-    "@types/node": "^12.7.5",
-    "downlevel-dts": "0.7.0",
-    "jest": "^26.1.0",
-    "rimraf": "^3.0.0",
-    "ts-jest": "^26.4.1",
-    "typedoc": "^0.19.2",
-    "typescript": "~4.3.5"
+    "@aws-sdk/service-client-documentation-generator": "3.46.0",
+    "@types/node": "^12.7.5"
   },
   "engines": {
-    "node": ">=10.0.0"
+    "node": ">=12.0.0"
   },
   "typesVersions": {
     "<4.0": {