@aws-sdk/client-timestream-write 3.295.0 → 3.297.0

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

@@ -1,6 +1,7 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
 import { TimestreamWriteServiceException as __BaseException } from "./TimestreamWriteServiceException";
 /**
+ * @public
  * <p>You are not authorized to perform this action.</p>
  */
 export declare class AccessDeniedException extends __BaseException {
@@ -12,10 +13,14 @@ export declare class AccessDeniedException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
 }
+/**
+ * @public
+ */
 export declare enum BatchLoadDataFormat {
     CSV = "CSV"
 }
 /**
+ * @public
  * <p>Details about the progress of a batch load task.</p>
  */
 export interface BatchLoadProgressReport {
@@ -44,6 +49,9 @@ export interface BatchLoadProgressReport {
      */
     BytesMetered?: number;
 }
+/**
+ * @public
+ */
 export declare enum BatchLoadStatus {
     CREATED = "CREATED",
     FAILED = "FAILED",
@@ -53,6 +61,7 @@ export declare enum BatchLoadStatus {
     SUCCEEDED = "SUCCEEDED"
 }
 /**
+ * @public
  * <p>Details about a batch load task.</p>
  */
 export interface BatchLoadTask {
@@ -87,6 +96,7 @@ export interface BatchLoadTask {
     ResumableUntil?: Date;
 }
 /**
+ * @public
  * <p></p>
  */
 export interface DimensionMapping {
@@ -100,6 +110,9 @@ export interface DimensionMapping {
      */
     DestinationColumn?: string;
 }
+/**
+ * @public
+ */
 export declare enum MeasureValueType {
     BIGINT = "BIGINT",
     BOOLEAN = "BOOLEAN",
@@ -108,6 +121,9 @@ export declare enum MeasureValueType {
     TIMESTAMP = "TIMESTAMP",
     VARCHAR = "VARCHAR"
 }
+/**
+ * @public
+ */
 export declare enum ScalarMeasureValueType {
     BIGINT = "BIGINT",
     BOOLEAN = "BOOLEAN",
@@ -116,6 +132,7 @@ export declare enum ScalarMeasureValueType {
     VARCHAR = "VARCHAR"
 }
 /**
+ * @public
  * <p></p>
  */
 export interface MultiMeasureAttributeMapping {
@@ -133,6 +150,7 @@ export interface MultiMeasureAttributeMapping {
     MeasureValueType?: ScalarMeasureValueType | string;
 }
 /**
+ * @public
  * <p></p>
  */
 export interface MixedMeasureMapping {
@@ -158,6 +176,7 @@ export interface MixedMeasureMapping {
     MultiMeasureAttributeMappings?: MultiMeasureAttributeMapping[];
 }
 /**
+ * @public
  * <p></p>
  */
 export interface MultiMeasureMappings {
@@ -170,6 +189,9 @@ export interface MultiMeasureMappings {
      */
     MultiMeasureAttributeMappings: MultiMeasureAttributeMapping[] | undefined;
 }
+/**
+ * @public
+ */
 export declare enum TimeUnit {
     MICROSECONDS = "MICROSECONDS",
     MILLISECONDS = "MILLISECONDS",
@@ -177,6 +199,7 @@ export declare enum TimeUnit {
     SECONDS = "SECONDS"
 }
 /**
+ * @public
  * <p>Data model for a batch load task.</p>
  */
 export interface DataModel {
@@ -208,6 +231,7 @@ export interface DataModel {
     MeasureNameColumn?: string;
 }
 /**
+ * @public
  * <p></p>
  */
 export interface DataModelS3Configuration {
@@ -221,6 +245,7 @@ export interface DataModelS3Configuration {
     ObjectKey?: string;
 }
 /**
+ * @public
  * <p></p>
  */
 export interface DataModelConfiguration {
@@ -234,6 +259,7 @@ export interface DataModelConfiguration {
     DataModelS3Configuration?: DataModelS3Configuration;
 }
 /**
+ * @public
  * <p>A delimited data format where the column separator can be a comma and the record
  *          separator is a newline character.</p>
  */
@@ -261,6 +287,7 @@ export interface CsvConfiguration {
     TrimWhiteSpace?: boolean;
 }
 /**
+ * @public
  * <p>
  *       </p>
  */
@@ -276,6 +303,7 @@ export interface DataSourceS3Configuration {
     ObjectKeyPrefix?: string;
 }
 /**
+ * @public
  * <p>Defines configuration details about the data source.</p>
  */
 export interface DataSourceConfiguration {
@@ -293,11 +321,15 @@ export interface DataSourceConfiguration {
      */
     DataFormat: BatchLoadDataFormat | string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum S3EncryptionOption {
     SSE_KMS = "SSE_KMS",
     SSE_S3 = "SSE_S3"
 }
 /**
+ * @public
  * <p></p>
  */
 export interface ReportS3Configuration {
@@ -319,6 +351,7 @@ export interface ReportS3Configuration {
     KmsKeyId?: string;
 }
 /**
+ * @public
  * <p>Report configuration for a batch load task. This contains details about where error reports are stored.</p>
  */
 export interface ReportConfiguration {
@@ -329,6 +362,7 @@ export interface ReportConfiguration {
     ReportS3Configuration?: ReportS3Configuration;
 }
 /**
+ * @public
  * <p>Details about a batch load task.</p>
  */
 export interface BatchLoadTaskDescription {
@@ -387,6 +421,7 @@ export interface BatchLoadTaskDescription {
     ResumableUntil?: Date;
 }
 /**
+ * @public
  * <p>Timestream was unable to process this request because it contains resource that
  *          already exists.</p>
  */
@@ -399,6 +434,9 @@ export declare class ConflictException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface CreateBatchLoadTaskRequest {
     /**
      * <p></p>
@@ -429,6 +467,9 @@ export interface CreateBatchLoadTaskRequest {
      */
     RecordVersion?: number;
 }
+/**
+ * @public
+ */
 export interface CreateBatchLoadTaskResponse {
     /**
      * <p>The ID of the batch load task.</p>
@@ -436,6 +477,7 @@ export interface CreateBatchLoadTaskResponse {
     TaskId: string | undefined;
 }
 /**
+ * @public
  * <p>
  *          Timestream was unable to fully process this request because of an internal server
  *          error.</p>
@@ -450,6 +492,7 @@ export declare class InternalServerException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
 }
 /**
+ * @public
  * <p>The requested endpoint was not valid.</p>
  */
 export declare class InvalidEndpointException extends __BaseException {
@@ -462,6 +505,7 @@ export declare class InvalidEndpointException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InvalidEndpointException, __BaseException>);
 }
 /**
+ * @public
  * <p>The operation tried to access a nonexistent resource. The resource might not be
  *          specified correctly, or its status might not be ACTIVE.</p>
  */
@@ -475,6 +519,7 @@ export declare class ResourceNotFoundException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
 }
 /**
+ * @public
  * <p> The instance quota of resource exceeded for this account.</p>
  */
 export declare class ServiceQuotaExceededException extends __BaseException {
@@ -487,6 +532,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
 }
 /**
+ * @public
  * <p> Too many requests were made by a user and they exceeded the service quotas. The request
  *          was throttled.</p>
  */
@@ -500,6 +546,7 @@ export declare class ThrottlingException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
 }
 /**
+ * @public
  * <p> An invalid or malformed request.</p>
  */
 export declare class ValidationException extends __BaseException {
@@ -512,6 +559,7 @@ export declare class ValidationException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
 }
 /**
+ * @public
  * <p> A tag is a label that you assign to a Timestream database and/or table. Each
  *          tag consists of a key and an optional value, both of which you define. With tags, you can
  *          categorize databases and/or tables, for example, by purpose, owner, or environment. </p>
@@ -526,6 +574,9 @@ export interface Tag {
      */
     Value: string | undefined;
 }
+/**
+ * @public
+ */
 export interface CreateDatabaseRequest {
     /**
      * <p>The name of the Timestream database.</p>
@@ -542,6 +593,7 @@ export interface CreateDatabaseRequest {
     Tags?: Tag[];
 }
 /**
+ * @public
  * <p>A top-level container for a table. Databases and tables are the fundamental management
  *          concepts in Amazon Timestream. All tables in a database are encrypted with the
  *          same KMS key.</p>
@@ -573,6 +625,9 @@ export interface Database {
      */
     LastUpdatedTime?: Date;
 }
+/**
+ * @public
+ */
 export interface CreateDatabaseResponse {
     /**
      * <p>The newly created Timestream database.</p>
@@ -580,6 +635,7 @@ export interface CreateDatabaseResponse {
     Database?: Database;
 }
 /**
+ * @public
  * <p>The configuration that specifies an S3 location.</p>
  */
 export interface S3Configuration {
@@ -603,6 +659,7 @@ export interface S3Configuration {
     KmsKeyId?: string;
 }
 /**
+ * @public
  * <p>The location to write error reports for records rejected, asynchronously, during
  *          magnetic store writes.</p>
  */
@@ -614,6 +671,7 @@ export interface MagneticStoreRejectedDataLocation {
     S3Configuration?: S3Configuration;
 }
 /**
+ * @public
  * <p>The set of properties on a table for configuring magnetic store writes.</p>
  */
 export interface MagneticStoreWriteProperties {
@@ -628,6 +686,7 @@ export interface MagneticStoreWriteProperties {
     MagneticStoreRejectedDataLocation?: MagneticStoreRejectedDataLocation;
 }
 /**
+ * @public
  * <p>Retention properties contain the duration for which your time-series data must be stored
  *          in the magnetic store and the memory store. </p>
  */
@@ -641,6 +700,9 @@ export interface RetentionProperties {
      */
     MagneticStoreRetentionPeriodInDays: number | undefined;
 }
+/**
+ * @public
+ */
 export interface CreateTableRequest {
     /**
      * <p>The name of the Timestream database.</p>
@@ -664,12 +726,16 @@ export interface CreateTableRequest {
      */
     MagneticStoreWriteProperties?: MagneticStoreWriteProperties;
 }
+/**
+ * @public
+ */
 export declare enum TableStatus {
     ACTIVE = "ACTIVE",
     DELETING = "DELETING",
     RESTORING = "RESTORING"
 }
 /**
+ * @public
  * <p>Represents a database table in Timestream. Tables contain one or more related
  *          time series. You can modify the retention duration of the memory store and the magnetic
  *          store for a table. </p>
@@ -718,18 +784,27 @@ export interface Table {
      */
     MagneticStoreWriteProperties?: MagneticStoreWriteProperties;
 }
+/**
+ * @public
+ */
 export interface CreateTableResponse {
     /**
      * <p>The newly created Timestream table.</p>
      */
     Table?: Table;
 }
+/**
+ * @public
+ */
 export interface DeleteDatabaseRequest {
     /**
      * <p>The name of the Timestream database to be deleted.</p>
      */
     DatabaseName: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteTableRequest {
     /**
      * <p>The name of the database where the Timestream database is to be deleted.</p>
@@ -740,33 +815,49 @@ export interface DeleteTableRequest {
      */
     TableName: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DescribeBatchLoadTaskRequest {
     /**
      * <p>The ID of the batch load task.</p>
      */
     TaskId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DescribeBatchLoadTaskResponse {
     /**
      * <p>Description of the batch load task.</p>
      */
     BatchLoadTaskDescription: BatchLoadTaskDescription | undefined;
 }
+/**
+ * @public
+ */
 export interface DescribeDatabaseRequest {
     /**
      * <p>The name of the Timestream database.</p>
      */
     DatabaseName: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DescribeDatabaseResponse {
     /**
      * <p>The name of the Timestream table.</p>
      */
     Database?: Database;
 }
+/**
+ * @public
+ */
 export interface DescribeEndpointsRequest {
 }
 /**
+ * @public
  * <p>Represents an available endpoint against which to make API calls against, as well as the
  *          TTL for that endpoint.</p>
  */
@@ -780,6 +871,9 @@ export interface Endpoint {
      */
     CachePeriodInMinutes: number | undefined;
 }
+/**
+ * @public
+ */
 export interface DescribeEndpointsResponse {
     /**
      * <p>An <code>Endpoints</code> object is returned when a <code>DescribeEndpoints</code>
@@ -787,6 +881,9 @@ export interface DescribeEndpointsResponse {
      */
     Endpoints: Endpoint[] | undefined;
 }
+/**
+ * @public
+ */
 export interface DescribeTableRequest {
     /**
      * <p>The name of the Timestream database.</p>
@@ -797,16 +894,23 @@ export interface DescribeTableRequest {
      */
     TableName: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DescribeTableResponse {
     /**
      * <p>The Timestream table.</p>
      */
     Table?: Table;
 }
+/**
+ * @public
+ */
 export declare enum DimensionValueType {
     VARCHAR = "VARCHAR"
 }
 /**
+ * @public
  * <p>Represents the metadata attributes of the time series. For example, the name and
  *          Availability Zone of an EC2 instance or the name of the manufacturer of a wind turbine are
  *          dimensions. </p>
@@ -829,6 +933,9 @@ export interface Dimension {
      */
     DimensionValueType?: DimensionValueType | string;
 }
+/**
+ * @public
+ */
 export interface ListBatchLoadTasksRequest {
     /**
      * <p>A token to specify where to start paginating. This is the NextToken from a previously
@@ -847,6 +954,9 @@ export interface ListBatchLoadTasksRequest {
      */
     TaskStatus?: BatchLoadStatus | string;
 }
+/**
+ * @public
+ */
 export interface ListBatchLoadTasksResponse {
     /**
      * <p>A token to specify where to start paginating. Provide the next
@@ -858,6 +968,9 @@ export interface ListBatchLoadTasksResponse {
      */
     BatchLoadTasks?: BatchLoadTask[];
 }
+/**
+ * @public
+ */
 export interface ListDatabasesRequest {
     /**
      * <p>The pagination token. To resume pagination, provide the NextToken value as argument of a
@@ -872,6 +985,9 @@ export interface ListDatabasesRequest {
      */
     MaxResults?: number;
 }
+/**
+ * @public
+ */
 export interface ListDatabasesResponse {
     /**
      * <p>A list of database names.</p>
@@ -882,6 +998,9 @@ export interface ListDatabasesResponse {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListTablesRequest {
     /**
      * <p>The name of the Timestream database.</p>
@@ -900,6 +1019,9 @@ export interface ListTablesRequest {
      */
     MaxResults?: number;
 }
+/**
+ * @public
+ */
 export interface ListTablesResponse {
     /**
      * <p>A list of tables.</p>
@@ -911,6 +1033,9 @@ export interface ListTablesResponse {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListTagsForResourceRequest {
     /**
      * <p> The Timestream resource with tags to be listed. This value is an Amazon
@@ -918,6 +1043,9 @@ export interface ListTagsForResourceRequest {
      */
     ResourceARN: string | undefined;
 }
+/**
+ * @public
+ */
 export interface ListTagsForResourceResponse {
     /**
      * <p> The tags currently associated with the Timestream resource. </p>
@@ -925,6 +1053,7 @@ export interface ListTagsForResourceResponse {
     Tags?: Tag[];
 }
 /**
+ * @public
  * <p> 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>
@@ -948,6 +1077,7 @@ export interface MeasureValue {
     Type: MeasureValueType | string | undefined;
 }
 /**
+ * @public
  * <p>Represents a time-series data point being written into Timestream. Each record
  *          contains an array of dimensions. Dimensions represent the metadata attributes of a
  *          time-series data point, such as the instance name or Availability Zone of an EC2 instance.
@@ -1015,6 +1145,7 @@ export interface _Record {
     MeasureValues?: MeasureValue[];
 }
 /**
+ * @public
  * <p>Information on the records ingested by this request.</p>
  */
 export interface RecordsIngested {
@@ -1032,6 +1163,7 @@ export interface RecordsIngested {
     MagneticStore?: number;
 }
 /**
+ * @public
  * <p> Represents records that were not successfully inserted into Timestream due to
  *          data validation issues that must be resolved before reinserting time-series data into the
  *          system. </p>
@@ -1093,6 +1225,7 @@ export interface RejectedRecord {
     ExistingVersion?: number;
 }
 /**
+ * @public
  * <p> WriteRecords would throw this exception in the following cases: </p>
  *          <ul>
  *             <li>
@@ -1138,14 +1271,23 @@ export declare class RejectedRecordsException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<RejectedRecordsException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface ResumeBatchLoadTaskRequest {
     /**
      * <p>The ID of the batch load task to resume.</p>
      */
     TaskId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface ResumeBatchLoadTaskResponse {
 }
+/**
+ * @public
+ */
 export interface TagResourceRequest {
     /**
      * <p> Identifies the Timestream resource to which tags should be added. This value
@@ -1157,8 +1299,14 @@ export interface TagResourceRequest {
      */
     Tags: Tag[] | undefined;
 }
+/**
+ * @public
+ */
 export interface TagResourceResponse {
 }
+/**
+ * @public
+ */
 export interface UntagResourceRequest {
     /**
      * <p> The Timestream resource that the tags will be removed from. This value is an
@@ -1171,8 +1319,14 @@ export interface UntagResourceRequest {
      */
     TagKeys: string[] | undefined;
 }
+/**
+ * @public
+ */
 export interface UntagResourceResponse {
 }
+/**
+ * @public
+ */
 export interface UpdateDatabaseRequest {
     /**
      * <p> The name of the database. </p>
@@ -1207,6 +1361,9 @@ export interface UpdateDatabaseRequest {
      */
     KmsKeyId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface UpdateDatabaseResponse {
     /**
      * <p>A top-level container for a table. Databases and tables are the fundamental management
@@ -1215,6 +1372,9 @@ export interface UpdateDatabaseResponse {
      */
     Database?: Database;
 }
+/**
+ * @public
+ */
 export interface UpdateTableRequest {
     /**
      * <p>The name of the Timestream database.</p>
@@ -1233,12 +1393,18 @@ export interface UpdateTableRequest {
      */
     MagneticStoreWriteProperties?: MagneticStoreWriteProperties;
 }
+/**
+ * @public
+ */
 export interface UpdateTableResponse {
     /**
      * <p>The updated Timestream table.</p>
      */
     Table?: Table;
 }
+/**
+ * @public
+ */
 export interface WriteRecordsRequest {
     /**
      * <p>The name of the Timestream database.</p>
@@ -1263,6 +1429,9 @@ export interface WriteRecordsRequest {
      */
     Records: _Record[] | undefined;
 }
+/**
+ * @public
+ */
 export interface WriteRecordsResponse {
     /**
      * <p>Information on the records ingested by this request.</p>

package/dist-types/pagination/Interfaces.d.ts

@@ -1,5 +1,8 @@
 import { PaginationConfiguration } from "@aws-sdk/types";
 import { TimestreamWriteClient } from "../TimestreamWriteClient";
+/**
+ * @public
+ */
 export interface TimestreamWritePaginationConfiguration extends PaginationConfiguration {
     client: TimestreamWriteClient;
 }

package/dist-types/pagination/ListBatchLoadTasksPaginator.d.ts

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListBatchLoadTasksCommandInput, ListBatchLoadTasksCommandOutput } from "../commands/ListBatchLoadTasksCommand";
 import { TimestreamWritePaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListBatchLoadTasks(config: TimestreamWritePaginationConfiguration, input: ListBatchLoadTasksCommandInput, ...additionalArguments: any): Paginator<ListBatchLoadTasksCommandOutput>;

package/dist-types/pagination/ListDatabasesPaginator.d.ts

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListDatabasesCommandInput, ListDatabasesCommandOutput } from "../commands/ListDatabasesCommand";
 import { TimestreamWritePaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListDatabases(config: TimestreamWritePaginationConfiguration, input: ListDatabasesCommandInput, ...additionalArguments: any): Paginator<ListDatabasesCommandOutput>;

package/dist-types/pagination/ListTablesPaginator.d.ts

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListTablesCommandInput, ListTablesCommandOutput } from "../commands/ListTablesCommand";
 import { TimestreamWritePaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListTables(config: TimestreamWritePaginationConfiguration, input: ListTablesCommandInput, ...additionalArguments: any): Paginator<ListTablesCommandOutput>;