@aws-sdk/client-timestream-query 3.533.0 → 3.536.0

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

@@ -1,8 +1,8 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
 import { TimestreamQueryServiceException as __BaseException } from "./TimestreamQueryServiceException";
 /**
- * @public
  * <p> You are not authorized to perform this action. </p>
+ * @public
  */
 export declare class AccessDeniedException extends __BaseException {
     readonly name: "AccessDeniedException";
@@ -18,9 +18,9 @@ export declare class AccessDeniedException extends __BaseException {
  */
 export interface CancelQueryRequest {
     /**
-     * @public
      * <p> The ID of the query that needs to be cancelled. <code>QueryID</code> is returned as
      *             part of the query result. </p>
+     * @public
      */
     QueryId: string | undefined;
 }
@@ -29,17 +29,17 @@ export interface CancelQueryRequest {
  */
 export interface CancelQueryResponse {
     /**
-     * @public
      * <p> A <code>CancellationMessage</code> is returned when a <code>CancelQuery</code>
      *             request for the query specified by <code>QueryId</code> has already been issued. </p>
+     * @public
      */
     CancellationMessage?: string;
 }
 /**
- * @public
  * <p>
  *             Timestream was unable to fully process this request because of an internal
  *             server error. </p>
+ * @public
  */
 export declare class InternalServerException extends __BaseException {
     readonly name: "InternalServerException";
@@ -51,8 +51,8 @@ export declare class InternalServerException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
 }
 /**
- * @public
  * <p>The requested endpoint was not valid.</p>
+ * @public
  */
 export declare class InvalidEndpointException extends __BaseException {
     readonly name: "InvalidEndpointException";
@@ -64,8 +64,8 @@ export declare class InvalidEndpointException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InvalidEndpointException, __BaseException>);
 }
 /**
- * @public
  * <p>The request was denied due to request throttling.</p>
+ * @public
  */
 export declare class ThrottlingException extends __BaseException {
     readonly name: "ThrottlingException";
@@ -77,8 +77,8 @@ export declare class ThrottlingException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
 }
 /**
- * @public
  * <p> Invalid or malformed request. </p>
+ * @public
  */
 export declare class ValidationException extends __BaseException {
     readonly name: "ValidationException";
@@ -111,8 +111,8 @@ export declare const ScalarType: {
  */
 export type ScalarType = (typeof ScalarType)[keyof typeof ScalarType];
 /**
- * @public
  * <p> Unable to poll results for a cancelled query. </p>
+ * @public
  */
 export declare class ConflictException extends __BaseException {
     readonly name: "ConflictException";
@@ -136,90 +136,90 @@ export declare const S3EncryptionOption: {
  */
 export type S3EncryptionOption = (typeof S3EncryptionOption)[keyof typeof S3EncryptionOption];
 /**
- * @public
  * <p>Details on S3 location for error reports that result from running a query. </p>
+ * @public
  */
 export interface S3Configuration {
     /**
-     * @public
      * <p> Name of the S3 bucket under which error reports will be created.</p>
+     * @public
      */
     BucketName: string | undefined;
     /**
-     * @public
      * <p> Prefix for the error report key. Timestream by default adds the following prefix to
      *             the error report path. </p>
+     * @public
      */
     ObjectKeyPrefix?: string;
     /**
-     * @public
      * <p> Encryption at rest options for the error reports. If no encryption option is
      *             specified, Timestream will choose SSE_S3 as default. </p>
+     * @public
      */
     EncryptionOption?: S3EncryptionOption;
 }
 /**
- * @public
  * <p>Configuration required for error reporting.</p>
+ * @public
  */
 export interface ErrorReportConfiguration {
     /**
-     * @public
      * <p>The S3 configuration for the error reports.</p>
+     * @public
      */
     S3Configuration: S3Configuration | undefined;
 }
 /**
- * @public
  * <p>Details on SNS that are required to send the notification.</p>
+ * @public
  */
 export interface SnsConfiguration {
     /**
-     * @public
      * <p>SNS topic ARN that the scheduled query status notifications will be sent to.</p>
+     * @public
      */
     TopicArn: string | undefined;
 }
 /**
+ * <p>Notification configuration for a scheduled query. A notification is sent by Timestream
+ *             when a scheduled query is created, its state is updated or when it is deleted. </p>
  * @public
- * <p>Notification configuration for a scheduled query. A notification is sent by
- *             Timestream when a scheduled query is created, its state is updated or when it is deleted. </p>
  */
 export interface NotificationConfiguration {
     /**
-     * @public
      * <p>Details on SNS configuration. </p>
+     * @public
      */
     SnsConfiguration: SnsConfiguration | undefined;
 }
 /**
- * @public
  * <p>Configuration of the schedule of the query.</p>
+ * @public
  */
 export interface ScheduleConfiguration {
     /**
-     * @public
      * <p>An expression that denotes when to trigger the scheduled query run. This can be a cron
      *             expression or a rate expression. </p>
+     * @public
      */
     ScheduleExpression: string | undefined;
 }
 /**
- * @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. Tags enable you to
  *             categorize databases and/or tables, for example, by purpose, owner, or environment.
  *         </p>
+ * @public
  */
 export interface Tag {
     /**
-     * @public
      * <p>The key of the tag. Tag keys are case sensitive. </p>
+     * @public
      */
     Key: string | undefined;
     /**
-     * @public
      * <p>The value of the tag. Tag values are case sensitive and can be null. </p>
+     * @public
      */
     Value: string | undefined;
 }
@@ -235,19 +235,19 @@ export declare const DimensionValueType: {
  */
 export type DimensionValueType = (typeof DimensionValueType)[keyof typeof DimensionValueType];
 /**
- * @public
  * <p>This type is used to map column(s) from the query result to a dimension in the
  *             destination table.</p>
+ * @public
  */
 export interface DimensionMapping {
     /**
-     * @public
      * <p>Column name from query result.</p>
+     * @public
      */
     Name: string | undefined;
     /**
-     * @public
      * <p>Type for the dimension. </p>
+     * @public
      */
     DimensionValueType: DimensionValueType | undefined;
 }
@@ -282,139 +282,139 @@ export declare const ScalarMeasureValueType: {
  */
 export type ScalarMeasureValueType = (typeof ScalarMeasureValueType)[keyof typeof ScalarMeasureValueType];
 /**
- * @public
  * <p>Attribute mapping for MULTI value measures.</p>
+ * @public
  */
 export interface MultiMeasureAttributeMapping {
     /**
-     * @public
      * <p>Source column from where the attribute value is to be read.</p>
+     * @public
      */
     SourceColumn: string | undefined;
     /**
-     * @public
      * <p>Custom name to be used for attribute name in derived table. If not provided, source
      *             column name would be used.</p>
+     * @public
      */
     TargetMultiMeasureAttributeName?: string;
     /**
-     * @public
      * <p>Type of the attribute to be read from the source column.</p>
+     * @public
      */
     MeasureValueType: ScalarMeasureValueType | undefined;
 }
 /**
- * @public
  * <p>MixedMeasureMappings are mappings that can be used to ingest data into a mixture of
  *             narrow and multi measures in the derived table.</p>
+ * @public
  */
 export interface MixedMeasureMapping {
     /**
-     * @public
      * <p>Refers to the value of measure_name in a result row. This field is required if
      *             MeasureNameColumn is provided.</p>
+     * @public
      */
     MeasureName?: string;
     /**
-     * @public
      * <p>This field refers to the source column from which measure-value is to be read for
      *             result materialization.</p>
+     * @public
      */
     SourceColumn?: string;
     /**
-     * @public
      * <p>Target measure name to be used. If not provided, the target measure name by default
      *             would be measure-name if provided, or sourceColumn otherwise. </p>
+     * @public
      */
     TargetMeasureName?: string;
     /**
-     * @public
      * <p>Type of the value that is to be read from sourceColumn. If the mapping is for MULTI,
      *             use MeasureValueType.MULTI.</p>
+     * @public
      */
     MeasureValueType: MeasureValueType | undefined;
     /**
-     * @public
      * <p>Required when measureValueType is MULTI. Attribute mappings for MULTI value
      *             measures.</p>
+     * @public
      */
     MultiMeasureAttributeMappings?: MultiMeasureAttributeMapping[];
 }
 /**
- * @public
  * <p>Only one of MixedMeasureMappings or MultiMeasureMappings is to be provided.
  *             MultiMeasureMappings can be used to ingest data as multi measures in the derived
  *             table.</p>
+ * @public
  */
 export interface MultiMeasureMappings {
     /**
-     * @public
      * <p>The name of the target multi-measure name in the derived table. This input is required
      *             when measureNameColumn is not provided. If MeasureNameColumn is provided, then value
      *             from that column will be used as multi-measure name.</p>
+     * @public
      */
     TargetMultiMeasureName?: string;
     /**
-     * @public
      * <p>Required. Attribute mappings to be used for mapping query results to ingest data for
      *             multi-measure attributes.</p>
+     * @public
      */
     MultiMeasureAttributeMappings: MultiMeasureAttributeMapping[] | undefined;
 }
 /**
- * @public
  * <p> Configuration to write data into Timestream database and table. This configuration
  *             allows the user to map the query result select columns into the destination table
  *             columns. </p>
+ * @public
  */
 export interface TimestreamConfiguration {
     /**
-     * @public
      * <p>Name of Timestream database to which the query result will be written.</p>
+     * @public
      */
     DatabaseName: string | undefined;
     /**
+     * <p>Name of Timestream table that the query result will be written to. The table should be
+     *             within the same database that is provided in Timestream configuration.</p>
      * @public
-     * <p>Name of Timestream table that the query result will be written to. The table should
-     *             be within the same database that is provided in Timestream configuration.</p>
      */
     TableName: string | undefined;
     /**
-     * @public
      * <p>Column from query result that should be used as the time column in destination table.
      *             Column type for this should be TIMESTAMP.</p>
+     * @public
      */
     TimeColumn: string | undefined;
     /**
-     * @public
      * <p> This is to allow mapping column(s) from the query result to the dimension in the
      *             destination table. </p>
+     * @public
      */
     DimensionMappings: DimensionMapping[] | undefined;
     /**
-     * @public
      * <p>Multi-measure mappings.</p>
+     * @public
      */
     MultiMeasureMappings?: MultiMeasureMappings;
     /**
-     * @public
      * <p>Specifies how to map measures to multi-measure records.</p>
+     * @public
      */
     MixedMeasureMappings?: MixedMeasureMapping[];
     /**
-     * @public
      * <p>Name of the measure column.</p>
+     * @public
      */
     MeasureNameColumn?: string;
 }
 /**
- * @public
  * <p>Configuration used for writing the output of a query.</p>
+ * @public
  */
 export interface TargetConfiguration {
     /**
-     * @public
      * <p>Configuration needed to write data into the Timestream database and table.</p>
+     * @public
      */
     TimestreamConfiguration: TimestreamConfiguration | undefined;
 }
@@ -423,42 +423,44 @@ export interface TargetConfiguration {
  */
 export interface CreateScheduledQueryRequest {
     /**
-     * @public
      * <p>Name of the scheduled query.</p>
+     * @public
      */
     Name: string | undefined;
     /**
+     * <p>The query string to run. Parameter names can be specified in the query string
+     *                 <code>@</code> character followed by an identifier. The named Parameter
+     *                 <code>@scheduled_runtime</code> is reserved and can be used in the query to get the
+     *             time at which the query is scheduled to run.</p>
+     *          <p>The timestamp calculated according to the ScheduleConfiguration parameter, will be the
+     *             value of <code>@scheduled_runtime</code> paramater for each query run. For example,
+     *             consider an instance of a scheduled query executing on 2021-12-01 00:00:00. For this
+     *             instance, the <code>@scheduled_runtime</code> parameter is initialized to the timestamp
+     *             2021-12-01 00:00:00 when invoking the query.</p>
      * @public
-     * <p>The query string to run. Parameter
-     *             names can be specified in the query string <code>@</code> character followed by an
-     *             identifier. The named Parameter <code>@scheduled_runtime</code> is reserved and can be used in the query to get the time at which the query is scheduled to run.</p>
-     *          <p>The timestamp calculated according to the ScheduleConfiguration parameter, will be the value of <code>@scheduled_runtime</code> paramater for each query run.
-     *             For example, consider an instance of a scheduled query executing on 2021-12-01 00:00:00. For this instance, the <code>@scheduled_runtime</code> parameter is
-     *             initialized to the timestamp 2021-12-01 00:00:00 when invoking the query.</p>
      */
     QueryString: string | undefined;
     /**
-     * @public
      * <p>The schedule configuration for the query.</p>
+     * @public
      */
     ScheduleConfiguration: ScheduleConfiguration | undefined;
     /**
-     * @public
      * <p>Notification configuration for the scheduled query. A notification is sent by
-     *             Timestream when a query run finishes, when the state is updated or when you delete it. </p>
+     *             Timestream when a query run finishes, when the state is updated or when you delete it.
+     *         </p>
+     * @public
      */
     NotificationConfiguration: NotificationConfiguration | undefined;
     /**
-     * @public
      * <p>Configuration used for writing the result of a query.</p>
+     * @public
      */
     TargetConfiguration?: TargetConfiguration;
     /**
-     * @public
-     * <p>Using a ClientToken makes the call to CreateScheduledQuery idempotent, in other words, making the same request repeatedly will produce the same result. Making
-     *             multiple identical CreateScheduledQuery requests has the same effect as making a single request.
-     *
-     *  </p>
+     * <p>Using a ClientToken makes the call to CreateScheduledQuery idempotent, in other words,
+     *             making the same request repeatedly will produce the same result. Making multiple
+     *             identical CreateScheduledQuery requests has the same effect as making a single request. </p>
      *          <ul>
      *             <li>
      *                <p> If CreateScheduledQuery is called without a <code>ClientToken</code>, the
@@ -469,31 +471,36 @@ export interface CreateScheduledQueryRequest {
      *                     as a new request. </p>
      *             </li>
      *          </ul>
+     * @public
      */
     ClientToken?: string;
     /**
+     * <p>The ARN for the IAM role that Timestream will assume when running the scheduled query.
+     *         </p>
      * @public
-     * <p>The ARN for the IAM role that Timestream will assume when running the scheduled query. </p>
      */
     ScheduledQueryExecutionRoleArn: string | undefined;
     /**
-     * @public
      * <p>A list of key-value pairs to label the scheduled query.</p>
+     * @public
      */
     Tags?: Tag[];
     /**
-     * @public
-     * <p>The Amazon KMS key used to encrypt the scheduled query resource, at-rest. If the Amazon KMS
-     *             key is not specified, the scheduled query resource will be encrypted with a Timestream
-     *             owned Amazon KMS key. To specify a KMS key, use the key ID, key ARN, alias name, or alias
-     *             ARN. When using an alias name, prefix the name with <i>alias/</i>
+     * <p>The Amazon KMS key used to encrypt the scheduled query resource, at-rest. If the
+     *             Amazon KMS key is not specified, the scheduled query resource will be encrypted with a
+     *             Timestream owned Amazon KMS key. To specify a KMS key, use the key ID, key ARN, alias
+     *             name, or alias ARN. When using an alias name, prefix the name with
+     *                 <i>alias/</i>
      *          </p>
-     *          <p>If ErrorReportConfiguration uses <code>SSE_KMS</code> as encryption type, the same KmsKeyId is used to encrypt the error report at rest.</p>
+     *          <p>If ErrorReportConfiguration uses <code>SSE_KMS</code> as encryption type, the same
+     *             KmsKeyId is used to encrypt the error report at rest.</p>
+     * @public
      */
     KmsKeyId?: string;
     /**
+     * <p>Configuration for error reporting. Error reports will be generated when a problem is
+     *             encountered when writing the query results. </p>
      * @public
-     * <p>Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results. </p>
      */
     ErrorReportConfiguration: ErrorReportConfiguration | undefined;
 }
@@ -502,14 +509,14 @@ export interface CreateScheduledQueryRequest {
  */
 export interface CreateScheduledQueryResponse {
     /**
-     * @public
      * <p>ARN for the created scheduled query.</p>
+     * @public
      */
     Arn: string | undefined;
 }
 /**
- * @public
  * <p>You have exceeded the service quota.</p>
+ * @public
  */
 export declare class ServiceQuotaExceededException extends __BaseException {
     readonly name: "ServiceQuotaExceededException";
@@ -525,22 +532,22 @@ export declare class ServiceQuotaExceededException extends __BaseException {
  */
 export interface DeleteScheduledQueryRequest {
     /**
-     * @public
      * <p>The ARN of the scheduled query. </p>
+     * @public
      */
     ScheduledQueryArn: string | undefined;
 }
 /**
- * @public
  * <p>The requested resource could not be found.</p>
+ * @public
  */
 export declare class ResourceNotFoundException extends __BaseException {
     readonly name: "ResourceNotFoundException";
     readonly $fault: "client";
     Message?: string;
     /**
-     * @public
      * <p>The ARN of the scheduled query.</p>
+     * @public
      */
     ScheduledQueryArn?: string;
     /**
@@ -554,19 +561,19 @@ export declare class ResourceNotFoundException extends __BaseException {
 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>
+ * @public
  */
 export interface Endpoint {
     /**
-     * @public
      * <p>An endpoint address.</p>
+     * @public
      */
     Address: string | undefined;
     /**
-     * @public
      * <p>The TTL for the endpoint, in minutes.</p>
+     * @public
      */
     CachePeriodInMinutes: number | undefined;
 }
@@ -575,9 +582,9 @@ export interface Endpoint {
  */
 export interface DescribeEndpointsResponse {
     /**
-     * @public
      * <p>An <code>Endpoints</code> object is returned when a <code>DescribeEndpoints</code>
      *             request is made.</p>
+     * @public
      */
     Endpoints: Endpoint[] | undefined;
 }
@@ -586,68 +593,69 @@ export interface DescribeEndpointsResponse {
  */
 export interface DescribeScheduledQueryRequest {
     /**
-     * @public
      * <p>The ARN of the scheduled query.</p>
+     * @public
      */
     ScheduledQueryArn: string | undefined;
 }
 /**
- * @public
  * <p> S3 report location for the scheduled query run.</p>
+ * @public
  */
 export interface S3ReportLocation {
     /**
-     * @public
      * <p> S3 bucket name. </p>
+     * @public
      */
     BucketName?: string;
     /**
-     * @public
      * <p>S3 key. </p>
+     * @public
      */
     ObjectKey?: string;
 }
 /**
- * @public
  * <p>This contains the location of the error report for a single scheduled query call.
  *         </p>
+ * @public
  */
 export interface ErrorReportLocation {
     /**
-     * @public
      * <p>The S3 location where error reports are written.</p>
+     * @public
      */
     S3ReportLocation?: S3ReportLocation;
 }
 /**
- * @public
  * <p>Statistics for a single scheduled query run.</p>
+ * @public
  */
 export interface ExecutionStats {
     /**
+     * <p>Total time, measured in milliseconds, that was needed for the scheduled query run to
+     *             complete.</p>
      * @public
-     * <p>Total time, measured in milliseconds, that was needed for the scheduled query run to complete.</p>
      */
     ExecutionTimeInMillis?: number;
     /**
-     * @public
      * <p>Data writes metered for records ingested in a single scheduled query run.</p>
+     * @public
      */
     DataWrites?: number;
     /**
-     * @public
      * <p>Bytes metered for a single scheduled query run.</p>
+     * @public
      */
     BytesMetered?: number;
     /**
-     * @public
      * <p>The number of records ingested for a single scheduled query run. </p>
+     * @public
      */
     RecordsIngested?: number;
     /**
-     * @public
      * <p>Number of rows present in the output from running a query before ingestion to
      *             destination data source.</p>
+     * @public
      */
     QueryResultRows?: number;
 }
@@ -666,40 +674,41 @@ export declare const ScheduledQueryRunStatus: {
  */
 export type ScheduledQueryRunStatus = (typeof ScheduledQueryRunStatus)[keyof typeof ScheduledQueryRunStatus];
 /**
- * @public
  * <p>Run summary for the scheduled query</p>
+ * @public
  */
 export interface ScheduledQueryRunSummary {
     /**
-     * @public
      * <p>InvocationTime for this run. This is the time at which the query is scheduled to run.
-     *             Parameter <code>@scheduled_runtime</code> can be used in the query to get the value. </p>
+     *             Parameter <code>@scheduled_runtime</code> can be used in the query to get the value.
+     *         </p>
+     * @public
      */
     InvocationTime?: Date;
     /**
-     * @public
      * <p>The actual time when the query was run.</p>
+     * @public
      */
     TriggerTime?: Date;
     /**
-     * @public
      * <p>The status of a scheduled query run.</p>
+     * @public
      */
     RunStatus?: ScheduledQueryRunStatus;
     /**
-     * @public
      * <p>Runtime statistics for a scheduled run.</p>
+     * @public
      */
     ExecutionStats?: ExecutionStats;
     /**
-     * @public
      * <p>S3 location for error report.</p>
+     * @public
      */
     ErrorReportLocation?: ErrorReportLocation;
     /**
-     * @public
      * <p>Error message for the scheduled query in case of failure. You might have to look at
      *             the error report to get more detailed error reasons. </p>
+     * @public
      */
     FailureReason?: string;
 }
@@ -716,83 +725,83 @@ export declare const ScheduledQueryState: {
  */
 export type ScheduledQueryState = (typeof ScheduledQueryState)[keyof typeof ScheduledQueryState];
 /**
- * @public
  * <p>Structure that describes scheduled query.</p>
+ * @public
  */
 export interface ScheduledQueryDescription {
     /**
-     * @public
      * <p>Scheduled query ARN.</p>
+     * @public
      */
     Arn: string | undefined;
     /**
-     * @public
      * <p>Name of the scheduled query.</p>
+     * @public
      */
     Name: string | undefined;
     /**
-     * @public
      * <p>The query to be run.</p>
+     * @public
      */
     QueryString: string | undefined;
     /**
-     * @public
      * <p>Creation time of the scheduled query.</p>
+     * @public
      */
     CreationTime?: Date;
     /**
-     * @public
      * <p>State of the scheduled query. </p>
+     * @public
      */
     State: ScheduledQueryState | undefined;
     /**
-     * @public
      * <p>Last time the query was run.</p>
+     * @public
      */
     PreviousInvocationTime?: Date;
     /**
-     * @public
      * <p>The next time the scheduled query is scheduled to run.</p>
+     * @public
      */
     NextInvocationTime?: Date;
     /**
-     * @public
      * <p>Schedule configuration.</p>
+     * @public
      */
     ScheduleConfiguration: ScheduleConfiguration | undefined;
     /**
-     * @public
      * <p>Notification configuration.</p>
+     * @public
      */
     NotificationConfiguration: NotificationConfiguration | undefined;
     /**
-     * @public
      * <p>Scheduled query target store configuration.</p>
+     * @public
      */
     TargetConfiguration?: TargetConfiguration;
     /**
-     * @public
      * <p>IAM role that Timestream uses to run the schedule query.</p>
+     * @public
      */
     ScheduledQueryExecutionRoleArn?: string;
     /**
-     * @public
      * <p>A customer provided KMS key used to encrypt the scheduled query resource.</p>
+     * @public
      */
     KmsKeyId?: string;
     /**
-     * @public
      * <p>Error-reporting configuration for the scheduled query.</p>
+     * @public
      */
     ErrorReportConfiguration?: ErrorReportConfiguration;
     /**
-     * @public
      * <p>Runtime summary for the last scheduled query run. </p>
+     * @public
      */
     LastRunSummary?: ScheduledQueryRunSummary;
     /**
-     * @public
      * <p>Runtime summary for the last five failed scheduled query runs.</p>
+     * @public
      */
     RecentlyFailedRuns?: ScheduledQueryRunSummary[];
 }
@@ -801,8 +810,8 @@ export interface ScheduledQueryDescription {
  */
 export interface DescribeScheduledQueryResponse {
     /**
-     * @public
      * <p>The scheduled query.</p>
+     * @public
      */
     ScheduledQuery: ScheduledQueryDescription | undefined;
 }
@@ -811,18 +820,19 @@ export interface DescribeScheduledQueryResponse {
  */
 export interface ExecuteScheduledQueryRequest {
     /**
-     * @public
      * <p>ARN of the scheduled query.</p>
+     * @public
      */
     ScheduledQueryArn: string | undefined;
     /**
+     * <p>The timestamp in UTC. Query will be run as if it was invoked at this timestamp.
+     *         </p>
      * @public
-     * <p>The timestamp in UTC. Query will be run as if it was invoked at this timestamp. </p>
      */
     InvocationTime: Date | undefined;
     /**
-     * @public
      * <p>Not used. </p>
+     * @public
      */
     ClientToken?: string;
 }
@@ -831,95 +841,95 @@ export interface ExecuteScheduledQueryRequest {
  */
 export interface ListScheduledQueriesRequest {
     /**
-     * @public
      * <p>The maximum number of items to return in the output. If the total number of items
      *             available is more than the value specified, a <code>NextToken</code> is provided in the
      *             output. To resume pagination, provide the <code>NextToken</code> value as the argument
      *             to the subsequent call to <code>ListScheduledQueriesRequest</code>.</p>
+     * @public
      */
     MaxResults?: number;
     /**
-     * @public
      * <p> A pagination token to resume pagination.</p>
+     * @public
      */
     NextToken?: string;
 }
 /**
- * @public
  * <p>Destination for scheduled query.</p>
+ * @public
  */
 export interface TimestreamDestination {
     /**
-     * @public
      * <p>Timestream database name. </p>
+     * @public
      */
     DatabaseName?: string;
     /**
-     * @public
      * <p>Timestream table name. </p>
+     * @public
      */
     TableName?: string;
 }
 /**
- * @public
  * <p>Destination details to write data for a target data source. Current supported data
  *             source is Timestream.</p>
+ * @public
  */
 export interface TargetDestination {
     /**
-     * @public
      * <p>Query result destination details for Timestream data source.</p>
+     * @public
      */
     TimestreamDestination?: TimestreamDestination;
 }
 /**
- * @public
  * <p>Scheduled Query</p>
+ * @public
  */
 export interface ScheduledQuery {
     /**
-     * @public
      * <p>The Amazon Resource Name.</p>
+     * @public
      */
     Arn: string | undefined;
     /**
-     * @public
      * <p>The name of the scheduled query.</p>
+     * @public
      */
     Name: string | undefined;
     /**
-     * @public
      * <p>The creation time of the scheduled query.</p>
+     * @public
      */
     CreationTime?: Date;
     /**
-     * @public
      * <p>State of scheduled query. </p>
+     * @public
      */
     State: ScheduledQueryState | undefined;
     /**
-     * @public
      * <p>The last time the scheduled query was run.</p>
+     * @public
      */
     PreviousInvocationTime?: Date;
     /**
-     * @public
      * <p>The next time the scheduled query is to be run.</p>
+     * @public
      */
     NextInvocationTime?: Date;
     /**
-     * @public
      * <p>Configuration for scheduled query error reporting.</p>
+     * @public
      */
     ErrorReportConfiguration?: ErrorReportConfiguration;
     /**
-     * @public
      * <p>Target data source where final scheduled query result will be written.</p>
+     * @public
      */
     TargetDestination?: TargetDestination;
     /**
-     * @public
      * <p>Status of the last scheduled query run.</p>
+     * @public
      */
     LastRunStatus?: ScheduledQueryRunStatus;
 }
@@ -928,14 +938,14 @@ export interface ScheduledQuery {
  */
 export interface ListScheduledQueriesResponse {
     /**
-     * @public
      * <p>A list of scheduled queries.</p>
+     * @public
      */
     ScheduledQueries: ScheduledQuery[] | undefined;
     /**
-     * @public
      * <p>A token to specify where to start paginating. This is the NextToken from a previously
      *             truncated response.</p>
+     * @public
      */
     NextToken?: string;
 }
@@ -944,19 +954,19 @@ export interface ListScheduledQueriesResponse {
  */
 export interface ListTagsForResourceRequest {
     /**
-     * @public
      * <p>The Timestream resource with tags to be listed. This value is an Amazon Resource Name
      *             (ARN).</p>
+     * @public
      */
     ResourceARN: string | undefined;
     /**
-     * @public
      * <p>The maximum number of tags to return.</p>
+     * @public
      */
     MaxResults?: number;
     /**
-     * @public
      * <p>A pagination token to resume pagination.</p>
+     * @public
      */
     NextToken?: string;
 }
@@ -965,14 +975,14 @@ export interface ListTagsForResourceRequest {
  */
 export interface ListTagsForResourceResponse {
     /**
-     * @public
      * <p>The tags currently associated with the Timestream resource. </p>
+     * @public
      */
     Tags: Tag[] | undefined;
     /**
-     * @public
      * <p>A pagination token to resume pagination with a subsequent call to
      *                 <code>ListTagsForResourceResponse</code>.</p>
+     * @public
      */
     NextToken?: string;
 }
@@ -981,24 +991,24 @@ export interface ListTagsForResourceResponse {
  */
 export interface PrepareQueryRequest {
     /**
-     * @public
      * <p>The Timestream query string that you want to use as a prepared statement. Parameter
      *             names can be specified in the query string <code>@</code> character followed by an
      *             identifier. </p>
+     * @public
      */
     QueryString: string | undefined;
     /**
-     * @public
      * <p>By setting this value to <code>true</code>, Timestream will only validate that the
      *             query string is a valid Timestream query, and not store the prepared query for later
      *             use.</p>
+     * @public
      */
     ValidateOnly?: boolean;
 }
 /**
- * @public
  * <p>
  *             Timestream was unable to run the query successfully. </p>
+ * @public
  */
 export declare class QueryExecutionException extends __BaseException {
     readonly name: "QueryExecutionException";
@@ -1014,12 +1024,11 @@ export declare class QueryExecutionException extends __BaseException {
  */
 export interface QueryRequest {
     /**
-     * @public
      * <p> The query to be run by Timestream. </p>
+     * @public
      */
     QueryString: string | undefined;
     /**
-     * @public
      * <p> Unique, case-sensitive string of up to 64 ASCII characters specified when a
      *                 <code>Query</code> request is made. Providing a <code>ClientToken</code> makes the
      *             call to <code>Query</code>
@@ -1047,10 +1056,10 @@ export interface QueryRequest {
      *                     as a new request. </p>
      *             </li>
      *          </ul>
+     * @public
      */
     ClientToken?: string;
     /**
-     * @public
      * <p> A pagination token used to return a set of results. When the <code>Query</code> API
      *             is invoked using <code>NextToken</code>, that particular invocation is assumed to be a
      *             subsequent invocation of a prior call to <code>Query</code>, and a result set is
@@ -1090,10 +1099,10 @@ export interface QueryRequest {
      *                         pagination token</code> error. </p>
      *             </li>
      *          </ul>
+     * @public
      */
     NextToken?: string;
     /**
-     * @public
      * <p> The total number of rows to be returned in the <code>Query</code> output. The initial
      *             run of <code>Query</code> with a <code>MaxRows</code> value specified will return the
      *             result set of the query in two cases: </p>
@@ -1114,32 +1123,33 @@ export interface QueryRequest {
      *             fewer rows to keep the response size from exceeding the 1 MB limit. If
      *                 <code>MaxRows</code> is not provided, Timestream will send the necessary
      *             number of rows to meet the 1 MB limit.</p>
+     * @public
      */
     MaxRows?: number;
 }
 /**
- * @public
  * <p>Information about the status of the query, including progress and bytes
  *             scanned.</p>
+ * @public
  */
 export interface QueryStatus {
     /**
-     * @public
      * <p>The progress of the query, expressed as a percentage.</p>
+     * @public
      */
     ProgressPercentage?: number;
     /**
-     * @public
      * <p>The amount of data scanned by the query in bytes. This is a cumulative sum and
      *             represents the total amount of bytes scanned since the query was started. </p>
+     * @public
      */
     CumulativeBytesScanned?: number;
     /**
-     * @public
      * <p>The amount of data scanned by the query in bytes that you will be charged for. This is
      *             a cumulative sum and represents the total amount of data that you will be charged for
      *             since the query was started. The charge is applied only once and is either applied when
      *             the query completes running or when the query is cancelled. </p>
+     * @public
      */
     CumulativeBytesMetered?: number;
 }
@@ -1148,14 +1158,14 @@ export interface QueryStatus {
  */
 export interface TagResourceRequest {
     /**
-     * @public
      * <p>Identifies the Timestream resource to which tags should be added. This value is an
      *             Amazon Resource Name (ARN).</p>
+     * @public
      */
     ResourceARN: string | undefined;
     /**
-     * @public
      * <p>The tags to be assigned to the Timestream resource.</p>
+     * @public
      */
     Tags: Tag[] | undefined;
 }
@@ -1169,15 +1179,15 @@ export interface TagResourceResponse {
  */
 export interface UntagResourceRequest {
     /**
-     * @public
      * <p>The Timestream resource that the tags will be removed from. This value is an Amazon
      *             Resource Name (ARN). </p>
+     * @public
      */
     ResourceARN: string | undefined;
     /**
-     * @public
      * <p>A list of tags keys. Existing tags of the resource whose keys are members of this list
      *             will be removed from the Timestream resource. </p>
+     * @public
      */
     TagKeys: string[] | undefined;
 }
@@ -1191,178 +1201,179 @@ export interface UntagResourceResponse {
  */
 export interface UpdateScheduledQueryRequest {
     /**
-     * @public
      * <p>ARN of the scheuled query.</p>
+     * @public
      */
     ScheduledQueryArn: string | undefined;
     /**
-     * @public
      * <p>State of the scheduled query. </p>
+     * @public
      */
     State: ScheduledQueryState | undefined;
 }
 /**
- * @public
  * <p> Contains the metadata for query results such as the column names, data types, and
  *             other attributes. </p>
+ * @public
  */
 export interface ColumnInfo {
     /**
-     * @public
      * <p> The name of the result set column. The name of the result set is available for
      *             columns of all data types except for arrays. </p>
+     * @public
      */
     Name?: string;
     /**
-     * @public
      * <p>The data type of the result set column. The data type can be a scalar or complex.
      *             Scalar data types are integers, strings, doubles, Booleans, and others. Complex data
      *             types are types such as arrays, rows, and others. </p>
+     * @public
      */
     Type: Type | undefined;
 }
 /**
- * @public
  * <p>Contains the data type of a column in a query result set. The data type can be scalar
  *             or complex. The supported scalar data types are integers, Boolean, string, double,
  *             timestamp, date, time, and intervals. The supported complex data types are arrays, rows,
  *             and timeseries.</p>
+ * @public
  */
 export interface Type {
     /**
-     * @public
      * <p>Indicates if the column is of type string, integer, Boolean, double, timestamp, date,
-     *             time. </p>
+     *             time. For more information, see <a href="https://docs.aws.amazon.com/timestream/latest/developerguide/supported-data-types.html">Supported data
+     *                 types</a>.</p>
+     * @public
      */
     ScalarType?: ScalarType;
     /**
-     * @public
      * <p>Indicates if the column is an array.</p>
+     * @public
      */
     ArrayColumnInfo?: ColumnInfo;
     /**
-     * @public
      * <p>Indicates if the column is a timeseries data type.</p>
+     * @public
      */
     TimeSeriesMeasureValueColumnInfo?: ColumnInfo;
     /**
-     * @public
      * <p>Indicates if the column is a row.</p>
+     * @public
      */
     RowColumnInfo?: ColumnInfo[];
 }
 /**
- * @public
  * <p> Datum represents a single data point in a query result. </p>
+ * @public
  */
 export interface Datum {
     /**
-     * @public
      * <p> Indicates if the data point is a scalar value such as integer, string, double, or
      *             Boolean. </p>
+     * @public
      */
     ScalarValue?: string;
     /**
-     * @public
      * <p> Indicates if the data point is a timeseries data type. </p>
+     * @public
      */
     TimeSeriesValue?: TimeSeriesDataPoint[];
     /**
-     * @public
      * <p> Indicates if the data point is an array. </p>
+     * @public
      */
     ArrayValue?: Datum[];
     /**
-     * @public
      * <p> Indicates if the data point is a row. </p>
+     * @public
      */
     RowValue?: Row;
     /**
-     * @public
      * <p> Indicates if the data point is null. </p>
+     * @public
      */
     NullValue?: boolean;
 }
 /**
- * @public
  * <p>Mapping for named parameters.</p>
+ * @public
  */
 export interface ParameterMapping {
     /**
-     * @public
      * <p>Parameter name.</p>
+     * @public
      */
     Name: string | undefined;
     /**
-     * @public
      * <p>Contains the data type of a column in a query result set. The data type can be scalar
      *             or complex. The supported scalar data types are integers, Boolean, string, double,
      *             timestamp, date, time, and intervals. The supported complex data types are arrays, rows,
      *             and timeseries.</p>
+     * @public
      */
     Type: Type | undefined;
 }
 /**
- * @public
  * <p>Details of the column that is returned by the query. </p>
+ * @public
  */
 export interface SelectColumn {
     /**
-     * @public
      * <p>Name of the column.</p>
+     * @public
      */
     Name?: string;
     /**
-     * @public
      * <p>Contains the data type of a column in a query result set. The data type can be scalar
      *             or complex. The supported scalar data types are integers, Boolean, string, double,
      *             timestamp, date, time, and intervals. The supported complex data types are arrays, rows,
      *             and timeseries.</p>
+     * @public
      */
     Type?: Type;
     /**
-     * @public
      * <p> Database that has this column.</p>
+     * @public
      */
     DatabaseName?: string;
     /**
-     * @public
      * <p>Table within the database that has this column. </p>
+     * @public
      */
     TableName?: string;
     /**
-     * @public
      * <p>True, if the column name was aliased by the query. False otherwise.</p>
+     * @public
      */
     Aliased?: boolean;
 }
 /**
- * @public
  * <p>The timeseries data type represents the values of a measure over time. A time series
  *             is an array of rows of timestamps and measure values, with rows sorted in ascending
  *             order of time. A TimeSeriesDataPoint is a single data point in the time series. It
  *             represents a tuple of (time, measure value) in a time series. </p>
+ * @public
  */
 export interface TimeSeriesDataPoint {
     /**
-     * @public
      * <p>The timestamp when the measure value was collected.</p>
+     * @public
      */
     Time: string | undefined;
     /**
-     * @public
      * <p>The measure value for the data point.</p>
+     * @public
      */
     Value: Datum | undefined;
 }
 /**
- * @public
  * <p>Represents a single row in the query results.</p>
+ * @public
  */
 export interface Row {
     /**
-     * @public
      * <p>List of data points in a single row of the result set.</p>
+     * @public
      */
     Data: Datum[] | undefined;
 }
@@ -1371,30 +1382,30 @@ export interface Row {
  */
 export interface QueryResponse {
     /**
-     * @public
      * <p> A unique ID for the given query. </p>
+     * @public
      */
     QueryId: string | undefined;
     /**
-     * @public
      * <p> A pagination token that can be used again on a <code>Query</code> call to get the
      *             next set of results. </p>
+     * @public
      */
     NextToken?: string;
     /**
-     * @public
      * <p> The result set rows returned by the query. </p>
+     * @public
      */
     Rows: Row[] | undefined;
     /**
-     * @public
      * <p> The column data types of the returned result set. </p>
+     * @public
      */
     ColumnInfo: ColumnInfo[] | undefined;
     /**
-     * @public
      * <p>Information about the status of the query, including progress and bytes
      *             scanned.</p>
+     * @public
      */
     QueryStatus?: QueryStatus;
 }
@@ -1403,18 +1414,18 @@ export interface QueryResponse {
  */
 export interface PrepareQueryResponse {
     /**
-     * @public
      * <p>The query string that you want prepare.</p>
+     * @public
      */
     QueryString: string | undefined;
     /**
-     * @public
      * <p>A list of SELECT clause columns of the submitted query string. </p>
+     * @public
      */
     Columns: SelectColumn[] | undefined;
     /**
-     * @public
      * <p>A list of parameters used in the submitted query string. </p>
+     * @public
      */
     Parameters: ParameterMapping[] | undefined;
 }