@aws-sdk/client-timestream-write 3.348.0 → 3.349.0

package/dist-cjs/models/models_0.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CreateBatchLoadTaskRequestFilterSensitiveLog = exports.RejectedRecordsException = exports.DimensionValueType = exports.TableStatus = exports.ValidationException = exports.ThrottlingException = exports.ServiceQuotaExceededException = exports.ResourceNotFoundException = exports.InvalidEndpointException = exports.InternalServerException = exports.ConflictException = exports.S3EncryptionOption = exports.TimeUnit = exports.ScalarMeasureValueType = exports.MeasureValueType = exports.BatchLoadStatus = exports.BatchLoadDataFormat = exports.AccessDeniedException = void 0;
+exports.CreateBatchLoadTaskRequestFilterSensitiveLog = exports.RejectedRecordsException = exports.DimensionValueType = exports.TableStatus = exports.PartitionKeyType = exports.PartitionKeyEnforcementLevel = exports.ValidationException = exports.ThrottlingException = exports.ServiceQuotaExceededException = exports.ResourceNotFoundException = exports.InvalidEndpointException = exports.InternalServerException = exports.ConflictException = exports.S3EncryptionOption = exports.TimeUnit = exports.ScalarMeasureValueType = exports.MeasureValueType = exports.BatchLoadStatus = exports.BatchLoadDataFormat = exports.AccessDeniedException = void 0;
 const smithy_client_1 = require("@aws-sdk/smithy-client");
 const TimestreamWriteServiceException_1 = require("./TimestreamWriteServiceException");
 class AccessDeniedException extends TimestreamWriteServiceException_1.TimestreamWriteServiceException {
@@ -151,6 +151,14 @@ class ValidationException extends TimestreamWriteServiceException_1.TimestreamWr
     }
 }
 exports.ValidationException = ValidationException;
+exports.PartitionKeyEnforcementLevel = {
+    OPTIONAL: "OPTIONAL",
+    REQUIRED: "REQUIRED",
+};
+exports.PartitionKeyType = {
+    DIMENSION: "DIMENSION",
+    MEASURE: "MEASURE",
+};
 exports.TableStatus = {
     ACTIVE: "ACTIVE",
     DELETING: "DELETING",

package/dist-cjs/protocols/Aws_json1_0.js

@@ -1233,6 +1233,7 @@ const de_Table = (output, context) => {
         LastUpdatedTime: (_) => (0, smithy_client_1.expectNonNull)((0, smithy_client_1.parseEpochTimestamp)((0, smithy_client_1.expectNumber)(_))),
         MagneticStoreWriteProperties: smithy_client_1._json,
         RetentionProperties: smithy_client_1._json,
+        Schema: smithy_client_1._json,
         TableName: smithy_client_1.expectString,
         TableStatus: smithy_client_1.expectString,
     });

package/dist-es/models/models_0.js

@@ -140,6 +140,14 @@ export class ValidationException extends __BaseException {
         this.Message = opts.Message;
     }
 }
+export const PartitionKeyEnforcementLevel = {
+    OPTIONAL: "OPTIONAL",
+    REQUIRED: "REQUIRED",
+};
+export const PartitionKeyType = {
+    DIMENSION: "DIMENSION",
+    MEASURE: "MEASURE",
+};
 export const TableStatus = {
     ACTIVE: "ACTIVE",
     DELETING: "DELETING",

package/dist-es/protocols/Aws_json1_0.js

@@ -1192,6 +1192,7 @@ const de_Table = (output, context) => {
         LastUpdatedTime: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
         MagneticStoreWriteProperties: _json,
         RetentionProperties: _json,
+        Schema: _json,
         TableName: __expectString,
         TableStatus: __expectString,
     });

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

@@ -27,8 +27,8 @@ export interface CreateBatchLoadTaskCommandOutput extends CreateBatchLoadTaskRes
  *          a CSV source in an S3 location and writes to a Timestream table. A mapping from
  *          source to target is defined in a batch load task. Errors and events are written to a report
  *          at an S3 location. For the report, if the KMS key is not specified, the
- *          batch load task will be encrypted with a Timestream managed KMS key
- *          located in your account. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">Amazon Web Services managed
+ *          report will be encrypted with an S3 managed key when <code>SSE_S3</code> is the option.
+ *          Otherwise an error is thrown. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">Amazon Web Services managed
  *             keys</a>. <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html">Service quotas apply</a>. For
  *          details, see <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-batch-load.html">code
  *             sample</a>.</p>

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

@@ -59,6 +59,15 @@ export interface CreateTableCommandOutput extends CreateTableResponse, __Metadat
  *       },
  *     },
  *   },
+ *   Schema: { // Schema
+ *     CompositePartitionKey: [ // PartitionKeyList
+ *       { // PartitionKey
+ *         Type: "DIMENSION" || "MEASURE", // required
+ *         Name: "STRING_VALUE",
+ *         EnforcementInRecord: "REQUIRED" || "OPTIONAL",
+ *       },
+ *     ],
+ *   },
  * };
  * const command = new CreateTableCommand(input);
  * const response = await client.send(command);
@@ -85,6 +94,15 @@ export interface CreateTableCommandOutput extends CreateTableResponse, __Metadat
  * //         },
  * //       },
  * //     },
+ * //     Schema: { // Schema
+ * //       CompositePartitionKey: [ // PartitionKeyList
+ * //         { // PartitionKey
+ * //           Type: "DIMENSION" || "MEASURE", // required
+ * //           Name: "STRING_VALUE",
+ * //           EnforcementInRecord: "REQUIRED" || "OPTIONAL",
+ * //         },
+ * //       ],
+ * //     },
  * //   },
  * // };
  *

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

@@ -62,6 +62,15 @@ export interface DescribeTableCommandOutput extends DescribeTableResponse, __Met
  * //         },
  * //       },
  * //     },
+ * //     Schema: { // Schema
+ * //       CompositePartitionKey: [ // PartitionKeyList
+ * //         { // PartitionKey
+ * //           Type: "DIMENSION" || "MEASURE", // required
+ * //           Name: "STRING_VALUE",
+ * //           EnforcementInRecord: "REQUIRED" || "OPTIONAL",
+ * //         },
+ * //       ],
+ * //     },
  * //   },
  * // };
  *

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

@@ -63,6 +63,15 @@ export interface ListTablesCommandOutput extends ListTablesResponse, __MetadataB
  * //           },
  * //         },
  * //       },
+ * //       Schema: { // Schema
+ * //         CompositePartitionKey: [ // PartitionKeyList
+ * //           { // PartitionKey
+ * //             Type: "DIMENSION" || "MEASURE", // required
+ * //             Name: "STRING_VALUE",
+ * //             EnforcementInRecord: "REQUIRED" || "OPTIONAL",
+ * //           },
+ * //         ],
+ * //       },
  * //     },
  * //   ],
  * //   NextToken: "STRING_VALUE",

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

@@ -53,6 +53,15 @@ export interface UpdateTableCommandOutput extends UpdateTableResponse, __Metadat
  *       },
  *     },
  *   },
+ *   Schema: { // Schema
+ *     CompositePartitionKey: [ // PartitionKeyList
+ *       { // PartitionKey
+ *         Type: "DIMENSION" || "MEASURE", // required
+ *         Name: "STRING_VALUE",
+ *         EnforcementInRecord: "REQUIRED" || "OPTIONAL",
+ *       },
+ *     ],
+ *   },
  * };
  * const command = new UpdateTableCommand(input);
  * const response = await client.send(command);
@@ -79,6 +88,15 @@ export interface UpdateTableCommandOutput extends UpdateTableResponse, __Metadat
  * //         },
  * //       },
  * //     },
+ * //     Schema: { // Schema
+ * //       CompositePartitionKey: [ // PartitionKeyList
+ * //         { // PartitionKey
+ * //           Type: "DIMENSION" || "MEASURE", // required
+ * //           Name: "STRING_VALUE",
+ * //           EnforcementInRecord: "REQUIRED" || "OPTIONAL",
+ * //         },
+ * //       ],
+ * //     },
  * //   },
  * // };
  *

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

@@ -382,7 +382,8 @@ export interface ReportS3Configuration {
 }
 /**
  * @public
- * <p>Report configuration for a batch load task. This contains details about where error reports are stored.</p>
+ * <p>Report configuration for a batch load task. This contains details about where error
+ *          reports are stored.</p>
  */
 export interface ReportConfiguration {
     /**
@@ -413,11 +414,13 @@ export interface BatchLoadTaskDescription {
      */
     ProgressReport?: BatchLoadProgressReport;
     /**
-     * <p>Report configuration for a batch load task. This contains details about where error reports are stored.</p>
+     * <p>Report configuration for a batch load task. This contains details about where error
+     *          reports are stored.</p>
      */
     ReportConfiguration?: ReportConfiguration;
     /**
-     * <p>Data model configuration for a batch load task. This contains details about where a data model for a batch load task is stored.</p>
+     * <p>Data model configuration for a batch load task. This contains details about where a data
+     *          model for a batch load task is stored.</p>
      */
     DataModelConfiguration?: DataModelConfiguration;
     /**
@@ -481,7 +484,8 @@ export interface CreateBatchLoadTaskRequest {
      */
     DataSourceConfiguration: DataSourceConfiguration | undefined;
     /**
-     * <p>Report configuration for a batch load task. This contains details about where error reports are stored.</p>
+     * <p>Report configuration for a batch load task. This contains details about where error
+     *          reports are stored.</p>
      */
     ReportConfiguration: ReportConfiguration | undefined;
     /**
@@ -730,6 +734,67 @@ export interface RetentionProperties {
      */
     MagneticStoreRetentionPeriodInDays: number | undefined;
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const PartitionKeyEnforcementLevel: {
+    readonly OPTIONAL: "OPTIONAL";
+    readonly REQUIRED: "REQUIRED";
+};
+/**
+ * @public
+ */
+export type PartitionKeyEnforcementLevel = (typeof PartitionKeyEnforcementLevel)[keyof typeof PartitionKeyEnforcementLevel];
+/**
+ * @public
+ * @enum
+ */
+export declare const PartitionKeyType: {
+    readonly DIMENSION: "DIMENSION";
+    readonly MEASURE: "MEASURE";
+};
+/**
+ * @public
+ */
+export type PartitionKeyType = (typeof PartitionKeyType)[keyof typeof PartitionKeyType];
+/**
+ * @public
+ * <p> An attribute used in partitioning data in a table. A dimension key partitions data
+ *          using the values of the dimension specified by the dimension-name as partition key, while a
+ *          measure key partitions data using measure names (values of the 'measure_name' column).
+ *       </p>
+ */
+export interface PartitionKey {
+    /**
+     * <p> The type of the partition key. Options are DIMENSION (dimension key) and MEASURE
+     *          (measure key). </p>
+     */
+    Type: PartitionKeyType | string | undefined;
+    /**
+     * <p> The name of the attribute used for a dimension key. </p>
+     */
+    Name?: string;
+    /**
+     * <p> The level of enforcement for the specification of a dimension key in ingested records.
+     *          Options are REQUIRED (dimension key must be specified) and OPTIONAL (dimension key does not
+     *          have to be specified). </p>
+     */
+    EnforcementInRecord?: PartitionKeyEnforcementLevel | string;
+}
+/**
+ * @public
+ * <p> A Schema specifies the expected data model of the table. </p>
+ */
+export interface Schema {
+    /**
+     * <p>A non-empty list of partition keys defining the attributes used to partition the table
+     *          data. The order of the list determines the partition hierarchy. The name and type of each
+     *          partition key as well as the partition key order cannot be changed after the table is
+     *          created. However, the enforcement level of each partition key can be changed. </p>
+     */
+    CompositePartitionKey?: PartitionKey[];
+}
 /**
  * @public
  */
@@ -755,6 +820,10 @@ export interface CreateTableRequest {
      * <p>Contains properties to set on the table when enabling magnetic store writes.</p>
      */
     MagneticStoreWriteProperties?: MagneticStoreWriteProperties;
+    /**
+     * <p> The schema of the table. </p>
+     */
+    Schema?: Schema;
 }
 /**
  * @public
@@ -818,6 +887,10 @@ export interface Table {
      * <p>Contains properties to set on the table when enabling magnetic store writes.</p>
      */
     MagneticStoreWriteProperties?: MagneticStoreWriteProperties;
+    /**
+     * <p> The schema of the table. </p>
+     */
+    Schema?: Schema;
 }
 /**
  * @public
@@ -1108,7 +1181,8 @@ export interface MeasureValue {
      */
     Name: string | undefined;
     /**
-     * <p> The value for the MeasureValue. </p>
+     * <p> The value for the MeasureValue. For information, see <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/writes.html#writes.data-types">Data
+     *          types</a>.</p>
      */
     Value: string | undefined;
     /**
@@ -1149,7 +1223,8 @@ export interface _Record {
     MeasureValue?: string;
     /**
      * <p> Contains the data type of the measure value for the time-series data point. Default
-     *          type is <code>DOUBLE</code>. </p>
+     *          type is <code>DOUBLE</code>. For more information, see <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/writes.html#writes.data-types">Data
+     *          types</a>.</p>
      */
     MeasureValueType?: MeasureValueType | string;
     /**
@@ -1432,6 +1507,10 @@ export interface UpdateTableRequest {
      * <p>Contains properties to set on the table when enabling magnetic store writes.</p>
      */
     MagneticStoreWriteProperties?: MagneticStoreWriteProperties;
+    /**
+     * <p> The schema of the table. </p>
+     */
+    Schema?: Schema;
 }
 /**
  * @public

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

@@ -251,12 +251,33 @@ export interface RetentionProperties {
   MemoryStoreRetentionPeriodInHours: number | undefined;
   MagneticStoreRetentionPeriodInDays: number | undefined;
 }
+export declare const PartitionKeyEnforcementLevel: {
+  readonly OPTIONAL: "OPTIONAL";
+  readonly REQUIRED: "REQUIRED";
+};
+export type PartitionKeyEnforcementLevel =
+  (typeof PartitionKeyEnforcementLevel)[keyof typeof PartitionKeyEnforcementLevel];
+export declare const PartitionKeyType: {
+  readonly DIMENSION: "DIMENSION";
+  readonly MEASURE: "MEASURE";
+};
+export type PartitionKeyType =
+  (typeof PartitionKeyType)[keyof typeof PartitionKeyType];
+export interface PartitionKey {
+  Type: PartitionKeyType | string | undefined;
+  Name?: string;
+  EnforcementInRecord?: PartitionKeyEnforcementLevel | string;
+}
+export interface Schema {
+  CompositePartitionKey?: PartitionKey[];
+}
 export interface CreateTableRequest {
   DatabaseName: string | undefined;
   TableName: string | undefined;
   RetentionProperties?: RetentionProperties;
   Tags?: Tag[];
   MagneticStoreWriteProperties?: MagneticStoreWriteProperties;
+  Schema?: Schema;
 }
 export declare const TableStatus: {
   readonly ACTIVE: "ACTIVE";
@@ -273,6 +294,7 @@ export interface Table {
   CreationTime?: Date;
   LastUpdatedTime?: Date;
   MagneticStoreWriteProperties?: MagneticStoreWriteProperties;
+  Schema?: Schema;
 }
 export interface CreateTableResponse {
   Table?: Table;
@@ -413,6 +435,7 @@ export interface UpdateTableRequest {
   TableName: string | undefined;
   RetentionProperties?: RetentionProperties;
   MagneticStoreWriteProperties?: MagneticStoreWriteProperties;
+  Schema?: Schema;
 }
 export interface UpdateTableResponse {
   Table?: Table;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-timestream-write",
   "description": "AWS SDK for JavaScript Timestream Write Client for Node.js, Browser and React Native",
-  "version": "3.348.0",
+  "version": "3.349.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",