For similar capabilities to Amazon Timestream for LiveAnalytics, consider Amazon Timestream for InfluxDB. It offers simplified data ingestion and single-digit millisecond query response times for real-time analytics. Learn more [here](https://docs.aws.amazon.com//timestream/latest/developerguide/timestream-for-influxdb.html).

# Data Types
<a name="API_Types"></a>

The following data types are supported by Amazon Timestream Write:
+  [BatchLoadProgressReport](API_BatchLoadProgressReport.md) 
+  [BatchLoadTask](API_BatchLoadTask.md) 
+  [BatchLoadTaskDescription](API_BatchLoadTaskDescription.md) 
+  [CsvConfiguration](API_CsvConfiguration.md) 
+  [Database](API_Database.md) 
+  [DataModel](API_DataModel.md) 
+  [DataModelConfiguration](API_DataModelConfiguration.md) 
+  [DataModelS3Configuration](API_DataModelS3Configuration.md) 
+  [DataSourceConfiguration](API_DataSourceConfiguration.md) 
+  [DataSourceS3Configuration](API_DataSourceS3Configuration.md) 
+  [Dimension](API_Dimension.md) 
+  [DimensionMapping](API_DimensionMapping.md) 
+  [Endpoint](API_Endpoint.md) 
+  [MagneticStoreRejectedDataLocation](API_MagneticStoreRejectedDataLocation.md) 
+  [MagneticStoreWriteProperties](API_MagneticStoreWriteProperties.md) 
+  [MeasureValue](API_MeasureValue.md) 
+  [MixedMeasureMapping](API_MixedMeasureMapping.md) 
+  [MultiMeasureAttributeMapping](API_MultiMeasureAttributeMapping.md) 
+  [MultiMeasureMappings](API_MultiMeasureMappings.md) 
+  [PartitionKey](API_PartitionKey.md) 
+  [Record](API_Record.md) 
+  [RecordsIngested](API_RecordsIngested.md) 
+  [RejectedRecord](API_RejectedRecord.md) 
+  [ReportConfiguration](API_ReportConfiguration.md) 
+  [ReportS3Configuration](API_ReportS3Configuration.md) 
+  [RetentionProperties](API_RetentionProperties.md) 
+  [S3Configuration](API_S3Configuration.md) 
+  [Schema](API_Schema.md) 
+  [Table](API_Table.md) 
+  [Tag](API_Tag.md) 

The following data types are supported by Amazon Timestream Query:
+  [AccountSettingsNotificationConfiguration](API_query_AccountSettingsNotificationConfiguration.md) 
+  [ColumnInfo](API_query_ColumnInfo.md) 
+  [Datum](API_query_Datum.md) 
+  [DimensionMapping](API_query_DimensionMapping.md) 
+  [Endpoint](API_query_Endpoint.md) 
+  [ErrorReportConfiguration](API_query_ErrorReportConfiguration.md) 
+  [ErrorReportLocation](API_query_ErrorReportLocation.md) 
+  [ExecutionStats](API_query_ExecutionStats.md) 
+  [LastUpdate](API_query_LastUpdate.md) 
+  [MixedMeasureMapping](API_query_MixedMeasureMapping.md) 
+  [MultiMeasureAttributeMapping](API_query_MultiMeasureAttributeMapping.md) 
+  [MultiMeasureMappings](API_query_MultiMeasureMappings.md) 
+  [NotificationConfiguration](API_query_NotificationConfiguration.md) 
+  [ParameterMapping](API_query_ParameterMapping.md) 
+  [ProvisionedCapacityRequest](API_query_ProvisionedCapacityRequest.md) 
+  [ProvisionedCapacityResponse](API_query_ProvisionedCapacityResponse.md) 
+  [QueryComputeRequest](API_query_QueryComputeRequest.md) 
+  [QueryComputeResponse](API_query_QueryComputeResponse.md) 
+  [QueryInsights](API_query_QueryInsights.md) 
+  [QueryInsightsResponse](API_query_QueryInsightsResponse.md) 
+  [QuerySpatialCoverage](API_query_QuerySpatialCoverage.md) 
+  [QuerySpatialCoverageMax](API_query_QuerySpatialCoverageMax.md) 
+  [QueryStatus](API_query_QueryStatus.md) 
+  [QueryTemporalRange](API_query_QueryTemporalRange.md) 
+  [QueryTemporalRangeMax](API_query_QueryTemporalRangeMax.md) 
+  [Row](API_query_Row.md) 
+  [S3Configuration](API_query_S3Configuration.md) 
+  [S3ReportLocation](API_query_S3ReportLocation.md) 
+  [ScheduleConfiguration](API_query_ScheduleConfiguration.md) 
+  [ScheduledQuery](API_query_ScheduledQuery.md) 
+  [ScheduledQueryDescription](API_query_ScheduledQueryDescription.md) 
+  [ScheduledQueryInsights](API_query_ScheduledQueryInsights.md) 
+  [ScheduledQueryInsightsResponse](API_query_ScheduledQueryInsightsResponse.md) 
+  [ScheduledQueryRunSummary](API_query_ScheduledQueryRunSummary.md) 
+  [SelectColumn](API_query_SelectColumn.md) 
+  [SnsConfiguration](API_query_SnsConfiguration.md) 
+  [Tag](API_query_Tag.md) 
+  [TargetConfiguration](API_query_TargetConfiguration.md) 
+  [TargetDestination](API_query_TargetDestination.md) 
+  [TimeSeriesDataPoint](API_query_TimeSeriesDataPoint.md) 
+  [TimestreamConfiguration](API_query_TimestreamConfiguration.md) 
+  [TimestreamDestination](API_query_TimestreamDestination.md) 
+  [Type](API_query_Type.md) 

# Amazon Timestream Write
<a name="API_Types_Amazon_Timestream_Write"></a>

The following data types are supported by Amazon Timestream Write:
+  [BatchLoadProgressReport](API_BatchLoadProgressReport.md) 
+  [BatchLoadTask](API_BatchLoadTask.md) 
+  [BatchLoadTaskDescription](API_BatchLoadTaskDescription.md) 
+  [CsvConfiguration](API_CsvConfiguration.md) 
+  [Database](API_Database.md) 
+  [DataModel](API_DataModel.md) 
+  [DataModelConfiguration](API_DataModelConfiguration.md) 
+  [DataModelS3Configuration](API_DataModelS3Configuration.md) 
+  [DataSourceConfiguration](API_DataSourceConfiguration.md) 
+  [DataSourceS3Configuration](API_DataSourceS3Configuration.md) 
+  [Dimension](API_Dimension.md) 
+  [DimensionMapping](API_DimensionMapping.md) 
+  [Endpoint](API_Endpoint.md) 
+  [MagneticStoreRejectedDataLocation](API_MagneticStoreRejectedDataLocation.md) 
+  [MagneticStoreWriteProperties](API_MagneticStoreWriteProperties.md) 
+  [MeasureValue](API_MeasureValue.md) 
+  [MixedMeasureMapping](API_MixedMeasureMapping.md) 
+  [MultiMeasureAttributeMapping](API_MultiMeasureAttributeMapping.md) 
+  [MultiMeasureMappings](API_MultiMeasureMappings.md) 
+  [PartitionKey](API_PartitionKey.md) 
+  [Record](API_Record.md) 
+  [RecordsIngested](API_RecordsIngested.md) 
+  [RejectedRecord](API_RejectedRecord.md) 
+  [ReportConfiguration](API_ReportConfiguration.md) 
+  [ReportS3Configuration](API_ReportS3Configuration.md) 
+  [RetentionProperties](API_RetentionProperties.md) 
+  [S3Configuration](API_S3Configuration.md) 
+  [Schema](API_Schema.md) 
+  [Table](API_Table.md) 
+  [Tag](API_Tag.md) 

# BatchLoadProgressReport
<a name="API_BatchLoadProgressReport"></a>

Details about the progress of a batch load task.

## Contents
<a name="API_BatchLoadProgressReport_Contents"></a>

 ** BytesMetered **   <a name="timestream-Type-BatchLoadProgressReport-BytesMetered"></a>
  
Type: Long  
Required: No

 ** FileFailures **   <a name="timestream-Type-BatchLoadProgressReport-FileFailures"></a>
  
Type: Long  
Required: No

 ** ParseFailures **   <a name="timestream-Type-BatchLoadProgressReport-ParseFailures"></a>
  
Type: Long  
Required: No

 ** RecordIngestionFailures **   <a name="timestream-Type-BatchLoadProgressReport-RecordIngestionFailures"></a>
  
Type: Long  
Required: No

 ** RecordsIngested **   <a name="timestream-Type-BatchLoadProgressReport-RecordsIngested"></a>
  
Type: Long  
Required: No

 ** RecordsProcessed **   <a name="timestream-Type-BatchLoadProgressReport-RecordsProcessed"></a>
  
Type: Long  
Required: No

## See Also
<a name="API_BatchLoadProgressReport_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/BatchLoadProgressReport) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/BatchLoadProgressReport) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/BatchLoadProgressReport) 

# BatchLoadTask
<a name="API_BatchLoadTask"></a>

Details about a batch load task.

## Contents
<a name="API_BatchLoadTask_Contents"></a>

 ** CreationTime **   <a name="timestream-Type-BatchLoadTask-CreationTime"></a>
The time when the Timestream batch load task was created.  
Type: Timestamp  
Required: No

 ** DatabaseName **   <a name="timestream-Type-BatchLoadTask-DatabaseName"></a>
Database name for the database into which a batch load task loads data.  
Type: String  
Required: No

 ** LastUpdatedTime **   <a name="timestream-Type-BatchLoadTask-LastUpdatedTime"></a>
The time when the Timestream batch load task was last updated.  
Type: Timestamp  
Required: No

 ** ResumableUntil **   <a name="timestream-Type-BatchLoadTask-ResumableUntil"></a>
   
Type: Timestamp  
Required: No

 ** TableName **   <a name="timestream-Type-BatchLoadTask-TableName"></a>
Table name for the table into which a batch load task loads data.  
Type: String  
Required: No

 ** TaskId **   <a name="timestream-Type-BatchLoadTask-TaskId"></a>
The ID of the batch load task.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 32.  
Pattern: `[A-Z0-9]+`   
Required: No

 ** TaskStatus **   <a name="timestream-Type-BatchLoadTask-TaskStatus"></a>
Status of the batch load task.  
Type: String  
Valid Values: `CREATED | IN_PROGRESS | FAILED | SUCCEEDED | PROGRESS_STOPPED | PENDING_RESUME`   
Required: No

## See Also
<a name="API_BatchLoadTask_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/BatchLoadTask) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/BatchLoadTask) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/BatchLoadTask) 

# BatchLoadTaskDescription
<a name="API_BatchLoadTaskDescription"></a>

Details about a batch load task.

## Contents
<a name="API_BatchLoadTaskDescription_Contents"></a>

 ** CreationTime **   <a name="timestream-Type-BatchLoadTaskDescription-CreationTime"></a>
The time when the Timestream batch load task was created.  
Type: Timestamp  
Required: No

 ** DataModelConfiguration **   <a name="timestream-Type-BatchLoadTaskDescription-DataModelConfiguration"></a>
Data model configuration for a batch load task. This contains details about where a data model for a batch load task is stored.  
Type: [DataModelConfiguration](API_DataModelConfiguration.md) object  
Required: No

 ** DataSourceConfiguration **   <a name="timestream-Type-BatchLoadTaskDescription-DataSourceConfiguration"></a>
Configuration details about the data source for a batch load task.  
Type: [DataSourceConfiguration](API_DataSourceConfiguration.md) object  
Required: No

 ** ErrorMessage **   <a name="timestream-Type-BatchLoadTaskDescription-ErrorMessage"></a>
  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** LastUpdatedTime **   <a name="timestream-Type-BatchLoadTaskDescription-LastUpdatedTime"></a>
The time when the Timestream batch load task was last updated.  
Type: Timestamp  
Required: No

 ** ProgressReport **   <a name="timestream-Type-BatchLoadTaskDescription-ProgressReport"></a>
  
Type: [BatchLoadProgressReport](API_BatchLoadProgressReport.md) object  
Required: No

 ** RecordVersion **   <a name="timestream-Type-BatchLoadTaskDescription-RecordVersion"></a>
  
Type: Long  
Required: No

 ** ReportConfiguration **   <a name="timestream-Type-BatchLoadTaskDescription-ReportConfiguration"></a>
Report configuration for a batch load task. This contains details about where error reports are stored.  
Type: [ReportConfiguration](API_ReportConfiguration.md) object  
Required: No

 ** ResumableUntil **   <a name="timestream-Type-BatchLoadTaskDescription-ResumableUntil"></a>
   
Type: Timestamp  
Required: No

 ** TargetDatabaseName **   <a name="timestream-Type-BatchLoadTaskDescription-TargetDatabaseName"></a>
  
Type: String  
Required: No

 ** TargetTableName **   <a name="timestream-Type-BatchLoadTaskDescription-TargetTableName"></a>
  
Type: String  
Required: No

 ** TaskId **   <a name="timestream-Type-BatchLoadTaskDescription-TaskId"></a>
The ID of the batch load task.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 32.  
Pattern: `[A-Z0-9]+`   
Required: No

 ** TaskStatus **   <a name="timestream-Type-BatchLoadTaskDescription-TaskStatus"></a>
Status of the batch load task.  
Type: String  
Valid Values: `CREATED | IN_PROGRESS | FAILED | SUCCEEDED | PROGRESS_STOPPED | PENDING_RESUME`   
Required: No

## See Also
<a name="API_BatchLoadTaskDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/BatchLoadTaskDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/BatchLoadTaskDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/BatchLoadTaskDescription) 

# CsvConfiguration
<a name="API_CsvConfiguration"></a>

A delimited data format where the column separator can be a comma and the record separator is a newline character.

## Contents
<a name="API_CsvConfiguration_Contents"></a>

 ** ColumnSeparator **   <a name="timestream-Type-CsvConfiguration-ColumnSeparator"></a>
Column separator can be one of comma (','), pipe ('\$1), semicolon (';'), tab('/t'), or blank space (' ').   
Type: String  
Length Constraints: Fixed length of 1.  
Required: No

 ** EscapeChar **   <a name="timestream-Type-CsvConfiguration-EscapeChar"></a>
Escape character can be one of   
Type: String  
Length Constraints: Fixed length of 1.  
Required: No

 ** NullValue **   <a name="timestream-Type-CsvConfiguration-NullValue"></a>
Can be blank space (' ').  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

 ** QuoteChar **   <a name="timestream-Type-CsvConfiguration-QuoteChar"></a>
Can be single quote (') or double quote (").  
Type: String  
Length Constraints: Fixed length of 1.  
Required: No

 ** TrimWhiteSpace **   <a name="timestream-Type-CsvConfiguration-TrimWhiteSpace"></a>
Specifies to trim leading and trailing white space.  
Type: Boolean  
Required: No

## See Also
<a name="API_CsvConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/CsvConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/CsvConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/CsvConfiguration) 

# Database
<a name="API_Database"></a>

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 AWS KMS key.

## Contents
<a name="API_Database_Contents"></a>

 ** Arn **   <a name="timestream-Type-Database-Arn"></a>
The Amazon Resource Name that uniquely identifies this database.  
Type: String  
Required: No

 ** CreationTime **   <a name="timestream-Type-Database-CreationTime"></a>
The time when the database was created, calculated from the Unix epoch time.  
Type: Timestamp  
Required: No

 ** DatabaseName **   <a name="timestream-Type-Database-DatabaseName"></a>
The name of the Timestream database.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 256.  
Required: No

 ** KmsKeyId **   <a name="timestream-Type-Database-KmsKeyId"></a>
The identifier of the AWS KMS key used to encrypt the data stored in the database.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** LastUpdatedTime **   <a name="timestream-Type-Database-LastUpdatedTime"></a>
 The last time that this database was updated.   
Type: Timestamp  
Required: No

 ** TableCount **   <a name="timestream-Type-Database-TableCount"></a>
The total number of tables found within a Timestream database.   
Type: Long  
Required: No

## See Also
<a name="API_Database_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/Database) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/Database) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/Database) 

# DataModel
<a name="API_DataModel"></a>

Data model for a batch load task.

## Contents
<a name="API_DataModel_Contents"></a>

 ** DimensionMappings **   <a name="timestream-Type-DataModel-DimensionMappings"></a>
Source to target mappings for dimensions.  
Type: Array of [DimensionMapping](API_DimensionMapping.md) objects  
Array Members: Minimum number of 1 item.  
Required: Yes

 ** MeasureNameColumn **   <a name="timestream-Type-DataModel-MeasureNameColumn"></a>
  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

 ** MixedMeasureMappings **   <a name="timestream-Type-DataModel-MixedMeasureMappings"></a>
Source to target mappings for measures.  
Type: Array of [MixedMeasureMapping](API_MixedMeasureMapping.md) objects  
Array Members: Minimum number of 1 item.  
Required: No

 ** MultiMeasureMappings **   <a name="timestream-Type-DataModel-MultiMeasureMappings"></a>
Source to target mappings for multi-measure records.  
Type: [MultiMeasureMappings](API_MultiMeasureMappings.md) object  
Required: No

 ** TimeColumn **   <a name="timestream-Type-DataModel-TimeColumn"></a>
Source column to be mapped to time.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

 ** TimeUnit **   <a name="timestream-Type-DataModel-TimeUnit"></a>
 The granularity of the timestamp unit. It indicates if the time value is in seconds, milliseconds, nanoseconds, or other supported values. Default is `MILLISECONDS`.   
Type: String  
Valid Values: `MILLISECONDS | SECONDS | MICROSECONDS | NANOSECONDS`   
Required: No

## See Also
<a name="API_DataModel_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/DataModel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/DataModel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/DataModel) 

# DataModelConfiguration
<a name="API_DataModelConfiguration"></a>



## Contents
<a name="API_DataModelConfiguration_Contents"></a>

 ** DataModel **   <a name="timestream-Type-DataModelConfiguration-DataModel"></a>
  
Type: [DataModel](API_DataModel.md) object  
Required: No

 ** DataModelS3Configuration **   <a name="timestream-Type-DataModelConfiguration-DataModelS3Configuration"></a>
  
Type: [DataModelS3Configuration](API_DataModelS3Configuration.md) object  
Required: No

## See Also
<a name="API_DataModelConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/DataModelConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/DataModelConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/DataModelConfiguration) 

# DataModelS3Configuration
<a name="API_DataModelS3Configuration"></a>



## Contents
<a name="API_DataModelS3Configuration_Contents"></a>

 ** BucketName **   <a name="timestream-Type-DataModelS3Configuration-BucketName"></a>
  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 63.  
Pattern: `[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]`   
Required: No

 ** ObjectKey **   <a name="timestream-Type-DataModelS3Configuration-ObjectKey"></a>
  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `[a-zA-Z0-9|!\-_*'\(\)]([a-zA-Z0-9]|[!\-_*'\(\)\/.])+`   
Required: No

## See Also
<a name="API_DataModelS3Configuration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/DataModelS3Configuration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/DataModelS3Configuration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/DataModelS3Configuration) 

# DataSourceConfiguration
<a name="API_DataSourceConfiguration"></a>

Defines configuration details about the data source.

## Contents
<a name="API_DataSourceConfiguration_Contents"></a>

 ** DataFormat **   <a name="timestream-Type-DataSourceConfiguration-DataFormat"></a>
This is currently CSV.  
Type: String  
Valid Values: `CSV`   
Required: Yes

 ** DataSourceS3Configuration **   <a name="timestream-Type-DataSourceConfiguration-DataSourceS3Configuration"></a>
Configuration of an S3 location for a file which contains data to load.  
Type: [DataSourceS3Configuration](API_DataSourceS3Configuration.md) object  
Required: Yes

 ** CsvConfiguration **   <a name="timestream-Type-DataSourceConfiguration-CsvConfiguration"></a>
A delimited data format where the column separator can be a comma and the record separator is a newline character.  
Type: [CsvConfiguration](API_CsvConfiguration.md) object  
Required: No

## See Also
<a name="API_DataSourceConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/DataSourceConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/DataSourceConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/DataSourceConfiguration) 

# DataSourceS3Configuration
<a name="API_DataSourceS3Configuration"></a>

 

## Contents
<a name="API_DataSourceS3Configuration_Contents"></a>

 ** BucketName **   <a name="timestream-Type-DataSourceS3Configuration-BucketName"></a>
The bucket name of the customer S3 bucket.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 63.  
Pattern: `[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]`   
Required: Yes

 ** ObjectKeyPrefix **   <a name="timestream-Type-DataSourceS3Configuration-ObjectKeyPrefix"></a>
   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `[a-zA-Z0-9|!\-_*'\(\)]([a-zA-Z0-9]|[!\-_*'\(\)\/.])+`   
Required: No

## See Also
<a name="API_DataSourceS3Configuration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/DataSourceS3Configuration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/DataSourceS3Configuration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/DataSourceS3Configuration) 

# Dimension
<a name="API_Dimension"></a>

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. 

## Contents
<a name="API_Dimension_Contents"></a>

 ** Name **   <a name="timestream-Type-Dimension-Name"></a>
 Dimension 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.   
For constraints on dimension names, see [Naming Constraints](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html#limits.naming).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 60.  
Required: Yes

 ** Value **   <a name="timestream-Type-Dimension-Value"></a>
The value of the dimension.  
Type: String  
Required: Yes

 ** DimensionValueType **   <a name="timestream-Type-Dimension-DimensionValueType"></a>
The data type of the dimension for the time-series data point.  
Type: String  
Valid Values: `VARCHAR`   
Required: No

## See Also
<a name="API_Dimension_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/Dimension) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/Dimension) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/Dimension) 

# DimensionMapping
<a name="API_DimensionMapping"></a>



## Contents
<a name="API_DimensionMapping_Contents"></a>

 ** DestinationColumn **   <a name="timestream-Type-DimensionMapping-DestinationColumn"></a>
   
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

 ** SourceColumn **   <a name="timestream-Type-DimensionMapping-SourceColumn"></a>
  
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

## See Also
<a name="API_DimensionMapping_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/DimensionMapping) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/DimensionMapping) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/DimensionMapping) 

# Endpoint
<a name="API_Endpoint"></a>

Represents an available endpoint against which to make API calls against, as well as the TTL for that endpoint.

## Contents
<a name="API_Endpoint_Contents"></a>

 ** Address **   <a name="timestream-Type-Endpoint-Address"></a>
An endpoint address.  
Type: String  
Required: Yes

 ** CachePeriodInMinutes **   <a name="timestream-Type-Endpoint-CachePeriodInMinutes"></a>
The TTL for the endpoint, in minutes.  
Type: Long  
Required: Yes

## See Also
<a name="API_Endpoint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/Endpoint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/Endpoint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/Endpoint) 

# MagneticStoreRejectedDataLocation
<a name="API_MagneticStoreRejectedDataLocation"></a>

The location to write error reports for records rejected, asynchronously, during magnetic store writes.

## Contents
<a name="API_MagneticStoreRejectedDataLocation_Contents"></a>

 ** S3Configuration **   <a name="timestream-Type-MagneticStoreRejectedDataLocation-S3Configuration"></a>
Configuration of an S3 location to write error reports for records rejected, asynchronously, during magnetic store writes.  
Type: [S3Configuration](API_S3Configuration.md) object  
Required: No

## See Also
<a name="API_MagneticStoreRejectedDataLocation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/MagneticStoreRejectedDataLocation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/MagneticStoreRejectedDataLocation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/MagneticStoreRejectedDataLocation) 

# MagneticStoreWriteProperties
<a name="API_MagneticStoreWriteProperties"></a>

The set of properties on a table for configuring magnetic store writes.

## Contents
<a name="API_MagneticStoreWriteProperties_Contents"></a>

 ** EnableMagneticStoreWrites **   <a name="timestream-Type-MagneticStoreWriteProperties-EnableMagneticStoreWrites"></a>
A flag to enable magnetic store writes.  
Type: Boolean  
Required: Yes

 ** MagneticStoreRejectedDataLocation **   <a name="timestream-Type-MagneticStoreWriteProperties-MagneticStoreRejectedDataLocation"></a>
The location to write error reports for records rejected asynchronously during magnetic store writes.  
Type: [MagneticStoreRejectedDataLocation](API_MagneticStoreRejectedDataLocation.md) object  
Required: No

## See Also
<a name="API_MagneticStoreWriteProperties_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/MagneticStoreWriteProperties) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/MagneticStoreWriteProperties) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/MagneticStoreWriteProperties) 

# MeasureValue
<a name="API_MeasureValue"></a>

 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. 

 MeasureValue is only allowed for type `MULTI`. Using `MULTI` type, you can pass multiple data attributes associated with the same time series in a single record 

## Contents
<a name="API_MeasureValue_Contents"></a>

 ** Name **   <a name="timestream-Type-MeasureValue-Name"></a>
 The name of the MeasureValue.   
 For constraints on MeasureValue names, see [ Naming Constraints](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html#limits.naming) in the Amazon Timestream Developer Guide.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: Yes

 ** Type **   <a name="timestream-Type-MeasureValue-Type"></a>
Contains the data type of the MeasureValue for the time-series data point.  
Type: String  
Valid Values: `DOUBLE | BIGINT | VARCHAR | BOOLEAN | TIMESTAMP | MULTI`   
Required: Yes

 ** Value **   <a name="timestream-Type-MeasureValue-Value"></a>
 The value for the MeasureValue. For information, see [Data types](https://docs.aws.amazon.com/timestream/latest/developerguide/writes.html#writes.data-types).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: Yes

## See Also
<a name="API_MeasureValue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/MeasureValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/MeasureValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/MeasureValue) 

# MixedMeasureMapping
<a name="API_MixedMeasureMapping"></a>



## Contents
<a name="API_MixedMeasureMapping_Contents"></a>

 ** MeasureValueType **   <a name="timestream-Type-MixedMeasureMapping-MeasureValueType"></a>
  
Type: String  
Valid Values: `DOUBLE | BIGINT | VARCHAR | BOOLEAN | TIMESTAMP | MULTI`   
Required: Yes

 ** MeasureName **   <a name="timestream-Type-MixedMeasureMapping-MeasureName"></a>
  
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

 ** MultiMeasureAttributeMappings **   <a name="timestream-Type-MixedMeasureMapping-MultiMeasureAttributeMappings"></a>
  
Type: Array of [MultiMeasureAttributeMapping](API_MultiMeasureAttributeMapping.md) objects  
Array Members: Minimum number of 1 item.  
Required: No

 ** SourceColumn **   <a name="timestream-Type-MixedMeasureMapping-SourceColumn"></a>
  
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

 ** TargetMeasureName **   <a name="timestream-Type-MixedMeasureMapping-TargetMeasureName"></a>
  
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

## See Also
<a name="API_MixedMeasureMapping_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/MixedMeasureMapping) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/MixedMeasureMapping) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/MixedMeasureMapping) 

# MultiMeasureAttributeMapping
<a name="API_MultiMeasureAttributeMapping"></a>



## Contents
<a name="API_MultiMeasureAttributeMapping_Contents"></a>

 ** SourceColumn **   <a name="timestream-Type-MultiMeasureAttributeMapping-SourceColumn"></a>
  
Type: String  
Length Constraints: Minimum length of 1.  
Required: Yes

 ** MeasureValueType **   <a name="timestream-Type-MultiMeasureAttributeMapping-MeasureValueType"></a>
  
Type: String  
Valid Values: `DOUBLE | BIGINT | BOOLEAN | VARCHAR | TIMESTAMP`   
Required: No

 ** TargetMultiMeasureAttributeName **   <a name="timestream-Type-MultiMeasureAttributeMapping-TargetMultiMeasureAttributeName"></a>
  
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

## See Also
<a name="API_MultiMeasureAttributeMapping_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/MultiMeasureAttributeMapping) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/MultiMeasureAttributeMapping) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/MultiMeasureAttributeMapping) 

# MultiMeasureMappings
<a name="API_MultiMeasureMappings"></a>



## Contents
<a name="API_MultiMeasureMappings_Contents"></a>

 ** MultiMeasureAttributeMappings **   <a name="timestream-Type-MultiMeasureMappings-MultiMeasureAttributeMappings"></a>
  
Type: Array of [MultiMeasureAttributeMapping](API_MultiMeasureAttributeMapping.md) objects  
Array Members: Minimum number of 1 item.  
Required: Yes

 ** TargetMultiMeasureName **   <a name="timestream-Type-MultiMeasureMappings-TargetMultiMeasureName"></a>
  
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

## See Also
<a name="API_MultiMeasureMappings_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/MultiMeasureMappings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/MultiMeasureMappings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/MultiMeasureMappings) 

# PartitionKey
<a name="API_PartitionKey"></a>

 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\$1name' column). 

## Contents
<a name="API_PartitionKey_Contents"></a>

 ** Type **   <a name="timestream-Type-PartitionKey-Type"></a>
 The type of the partition key. Options are DIMENSION (dimension key) and MEASURE (measure key).   
Type: String  
Valid Values: `DIMENSION | MEASURE`   
Required: Yes

 ** EnforcementInRecord **   <a name="timestream-Type-PartitionKey-EnforcementInRecord"></a>
 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).   
Type: String  
Valid Values: `REQUIRED | OPTIONAL`   
Required: No

 ** Name **   <a name="timestream-Type-PartitionKey-Name"></a>
 The name of the attribute used for a dimension key.   
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

## See Also
<a name="API_PartitionKey_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/PartitionKey) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/PartitionKey) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/PartitionKey) 

# Record
<a name="API_Record"></a>

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. A record also contains the measure name, which is the name of the measure being collected (for example, the CPU utilization of an EC2 instance). Additionally, a record contains the measure value and the value type, which is the data type of the measure value. Also, the record contains the timestamp of when the measure was collected and the timestamp unit, which represents the granularity of the timestamp. 

 Records have a `Version` field, which is a 64-bit `long` 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 `Version` attribute of the record in the write request is higher than that of the existing record. Timestream defaults to a `Version` of `1` for records without the `Version` field. 

## Contents
<a name="API_Record_Contents"></a>

 ** Dimensions **   <a name="timestream-Type-Record-Dimensions"></a>
Contains the list of dimensions for time-series data points.  
Type: Array of [Dimension](API_Dimension.md) objects  
Array Members: Maximum number of 128 items.  
Required: No

 ** MeasureName **   <a name="timestream-Type-Record-MeasureName"></a>
Measure 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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

 ** MeasureValue **   <a name="timestream-Type-Record-MeasureValue"></a>
 Contains the measure value for the time-series data point.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** MeasureValues **   <a name="timestream-Type-Record-MeasureValues"></a>
 Contains the list of MeasureValue for time-series data points.   
 This is only allowed for type `MULTI`. For scalar values, use `MeasureValue` attribute of the record directly.   
Type: Array of [MeasureValue](API_MeasureValue.md) objects  
Required: No

 ** MeasureValueType **   <a name="timestream-Type-Record-MeasureValueType"></a>
 Contains the data type of the measure value for the time-series data point. Default type is `DOUBLE`. For more information, see [Data types](https://docs.aws.amazon.com/timestream/latest/developerguide/writes.html#writes.data-types).  
Type: String  
Valid Values: `DOUBLE | BIGINT | VARCHAR | BOOLEAN | TIMESTAMP | MULTI`   
Required: No

 ** Time **   <a name="timestream-Type-Record-Time"></a>
 Contains the time at which the measure value for the data point was collected. The time value plus the unit provides the time elapsed since the epoch. For example, if the time value is `12345` and the unit is `ms`, then `12345 ms` have elapsed since the epoch.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

 ** TimeUnit **   <a name="timestream-Type-Record-TimeUnit"></a>
 The granularity of the timestamp unit. It indicates if the time value is in seconds, milliseconds, nanoseconds, or other supported values. Default is `MILLISECONDS`.   
Type: String  
Valid Values: `MILLISECONDS | SECONDS | MICROSECONDS | NANOSECONDS`   
Required: No

 ** Version **   <a name="timestream-Type-Record-Version"></a>
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, `Version` will still be updated. Default value is `1`.  
 `Version` must be `1` or greater, or you will receive a `ValidationException` error.
Type: Long  
Required: No

## See Also
<a name="API_Record_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/Record) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/Record) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/Record) 

# RecordsIngested
<a name="API_RecordsIngested"></a>

Information on the records ingested by this request.

## Contents
<a name="API_RecordsIngested_Contents"></a>

 ** MagneticStore **   <a name="timestream-Type-RecordsIngested-MagneticStore"></a>
Count of records ingested into the magnetic store.  
Type: Integer  
Required: No

 ** MemoryStore **   <a name="timestream-Type-RecordsIngested-MemoryStore"></a>
Count of records ingested into the memory store.  
Type: Integer  
Required: No

 ** Total **   <a name="timestream-Type-RecordsIngested-Total"></a>
Total count of successfully ingested records.  
Type: Integer  
Required: No

## See Also
<a name="API_RecordsIngested_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/RecordsIngested) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/RecordsIngested) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/RecordsIngested) 

# RejectedRecord
<a name="API_RejectedRecord"></a>

 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. 

## Contents
<a name="API_RejectedRecord_Contents"></a>

 ** ExistingVersion **   <a name="timestream-Type-RejectedRecord-ExistingVersion"></a>
The existing version of the record. This value is populated in scenarios where an identical record exists with a higher version than the version in the write request.  
Type: Long  
Required: No

 ** Reason **   <a name="timestream-Type-RejectedRecord-Reason"></a>
 The reason why a record was not successfully inserted into Timestream. Possible causes of failure include:   
+ Records with duplicate data where there are multiple records with the same dimensions, timestamps, and measure names but: 
  + Measure values are different
  + Version is not present in the request, *or* the value of version in the new record is equal to or lower than the existing value

  If Timestream rejects data for this case, the `ExistingVersion` field in the `RejectedRecords` 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 `ExistingVersion`.
+  Records with timestamps that lie outside the retention duration of the memory store. 
**Note**  
When the retention window is updated, you will receive a `RejectedRecords` exception if you immediately try to ingest data within the new window. To avoid a `RejectedRecords` exception, wait until the duration of the new window to ingest new data. For further information, see [ Best Practices for Configuring Timestream](https://docs.aws.amazon.com/timestream/latest/developerguide/best-practices.html#configuration) and [the explanation of how storage works in Timestream](https://docs.aws.amazon.com/timestream/latest/developerguide/storage.html).
+  Records with dimensions or measures that exceed the Timestream defined limits. 
 For more information, see [Access Management](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html) in the Timestream Developer Guide.   
Type: String  
Required: No

 ** RecordIndex **   <a name="timestream-Type-RejectedRecord-RecordIndex"></a>
 The index of the record in the input request for WriteRecords. Indexes begin with 0.   
Type: Integer  
Required: No

## See Also
<a name="API_RejectedRecord_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/RejectedRecord) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/RejectedRecord) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/RejectedRecord) 

# ReportConfiguration
<a name="API_ReportConfiguration"></a>

Report configuration for a batch load task. This contains details about where error reports are stored.

## Contents
<a name="API_ReportConfiguration_Contents"></a>

 ** ReportS3Configuration **   <a name="timestream-Type-ReportConfiguration-ReportS3Configuration"></a>
Configuration of an S3 location to write error reports and events for a batch load.  
Type: [ReportS3Configuration](API_ReportS3Configuration.md) object  
Required: No

## See Also
<a name="API_ReportConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/ReportConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/ReportConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/ReportConfiguration) 

# ReportS3Configuration
<a name="API_ReportS3Configuration"></a>



## Contents
<a name="API_ReportS3Configuration_Contents"></a>

 ** BucketName **   <a name="timestream-Type-ReportS3Configuration-BucketName"></a>
  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 63.  
Pattern: `[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]`   
Required: Yes

 ** EncryptionOption **   <a name="timestream-Type-ReportS3Configuration-EncryptionOption"></a>
  
Type: String  
Valid Values: `SSE_S3 | SSE_KMS`   
Required: No

 ** KmsKeyId **   <a name="timestream-Type-ReportS3Configuration-KmsKeyId"></a>
  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** ObjectKeyPrefix **   <a name="timestream-Type-ReportS3Configuration-ObjectKeyPrefix"></a>
  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 928.  
Pattern: `[a-zA-Z0-9|!\-_*'\(\)]([a-zA-Z0-9]|[!\-_*'\(\)\/.])+`   
Required: No

## See Also
<a name="API_ReportS3Configuration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/ReportS3Configuration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/ReportS3Configuration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/ReportS3Configuration) 

# RetentionProperties
<a name="API_RetentionProperties"></a>

Retention properties contain the duration for which your time-series data must be stored in the magnetic store and the memory store. 

## Contents
<a name="API_RetentionProperties_Contents"></a>

 ** MagneticStoreRetentionPeriodInDays **   <a name="timestream-Type-RetentionProperties-MagneticStoreRetentionPeriodInDays"></a>
The duration for which data must be stored in the magnetic store.   
Type: Long  
Valid Range: Minimum value of 1. Maximum value of 73000.  
Required: Yes

 ** MemoryStoreRetentionPeriodInHours **   <a name="timestream-Type-RetentionProperties-MemoryStoreRetentionPeriodInHours"></a>
The duration for which data must be stored in the memory store.   
Type: Long  
Valid Range: Minimum value of 1. Maximum value of 8766.  
Required: Yes

## See Also
<a name="API_RetentionProperties_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/RetentionProperties) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/RetentionProperties) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/RetentionProperties) 

# S3Configuration
<a name="API_S3Configuration"></a>

The configuration that specifies an S3 location.

## Contents
<a name="API_S3Configuration_Contents"></a>

 ** BucketName **   <a name="timestream-Type-S3Configuration-BucketName"></a>
The bucket name of the customer S3 bucket.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 63.  
Pattern: `[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]`   
Required: No

 ** EncryptionOption **   <a name="timestream-Type-S3Configuration-EncryptionOption"></a>
The encryption option for the customer S3 location. Options are S3 server-side encryption with an S3 managed key or AWS managed key.  
Type: String  
Valid Values: `SSE_S3 | SSE_KMS`   
Required: No

 ** KmsKeyId **   <a name="timestream-Type-S3Configuration-KmsKeyId"></a>
The AWS KMS key ID for the customer S3 location when encrypting with an AWS managed key.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** ObjectKeyPrefix **   <a name="timestream-Type-S3Configuration-ObjectKeyPrefix"></a>
The object key preview for the customer S3 location.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 928.  
Pattern: `[a-zA-Z0-9|!\-_*'\(\)]([a-zA-Z0-9]|[!\-_*'\(\)\/.])+`   
Required: No

## See Also
<a name="API_S3Configuration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/S3Configuration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/S3Configuration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/S3Configuration) 

# Schema
<a name="API_Schema"></a>

 A Schema specifies the expected data model of the table. 

## Contents
<a name="API_Schema_Contents"></a>

 ** CompositePartitionKey **   <a name="timestream-Type-Schema-CompositePartitionKey"></a>
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.   
Type: Array of [PartitionKey](API_PartitionKey.md) objects  
Array Members: Minimum number of 1 item.  
Required: No

## See Also
<a name="API_Schema_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/Schema) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/Schema) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/Schema) 

# Table
<a name="API_Table"></a>

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. 

## Contents
<a name="API_Table_Contents"></a>

 ** Arn **   <a name="timestream-Type-Table-Arn"></a>
The Amazon Resource Name that uniquely identifies this table.  
Type: String  
Required: No

 ** CreationTime **   <a name="timestream-Type-Table-CreationTime"></a>
The time when the Timestream table was created.   
Type: Timestamp  
Required: No

 ** DatabaseName **   <a name="timestream-Type-Table-DatabaseName"></a>
The name of the Timestream database that contains this table.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 256.  
Required: No

 ** LastUpdatedTime **   <a name="timestream-Type-Table-LastUpdatedTime"></a>
The time when the Timestream table was last updated.  
Type: Timestamp  
Required: No

 ** MagneticStoreWriteProperties **   <a name="timestream-Type-Table-MagneticStoreWriteProperties"></a>
Contains properties to set on the table when enabling magnetic store writes.  
Type: [MagneticStoreWriteProperties](API_MagneticStoreWriteProperties.md) object  
Required: No

 ** RetentionProperties **   <a name="timestream-Type-Table-RetentionProperties"></a>
The retention duration for the memory store and magnetic store.  
Type: [RetentionProperties](API_RetentionProperties.md) object  
Required: No

 ** Schema **   <a name="timestream-Type-Table-Schema"></a>
 The schema of the table.   
Type: [Schema](API_Schema.md) object  
Required: No

 ** TableName **   <a name="timestream-Type-Table-TableName"></a>
The name of the Timestream table.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 256.  
Required: No

 ** TableStatus **   <a name="timestream-Type-Table-TableStatus"></a>
The current state of the table:  
+  `DELETING` - The table is being deleted.
+  `ACTIVE` - The table is ready for use.
Type: String  
Valid Values: `ACTIVE | DELETING | RESTORING`   
Required: No

## See Also
<a name="API_Table_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/Table) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/Table) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/Table) 

# Tag
<a name="API_Tag"></a>

 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. 

## Contents
<a name="API_Tag_Contents"></a>

 ** Key **   <a name="timestream-Type-Tag-Key"></a>
 The key of the tag. Tag keys are case sensitive.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: Yes

 ** Value **   <a name="timestream-Type-Tag-Value"></a>
 The value of the tag. Tag values are case-sensitive and can be null.   
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: Yes

## See Also
<a name="API_Tag_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/Tag) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/Tag) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/Tag) 

# Amazon Timestream Query
<a name="API_Types_Amazon_Timestream_Query"></a>

The following data types are supported by Amazon Timestream Query:
+  [AccountSettingsNotificationConfiguration](API_query_AccountSettingsNotificationConfiguration.md) 
+  [ColumnInfo](API_query_ColumnInfo.md) 
+  [Datum](API_query_Datum.md) 
+  [DimensionMapping](API_query_DimensionMapping.md) 
+  [Endpoint](API_query_Endpoint.md) 
+  [ErrorReportConfiguration](API_query_ErrorReportConfiguration.md) 
+  [ErrorReportLocation](API_query_ErrorReportLocation.md) 
+  [ExecutionStats](API_query_ExecutionStats.md) 
+  [LastUpdate](API_query_LastUpdate.md) 
+  [MixedMeasureMapping](API_query_MixedMeasureMapping.md) 
+  [MultiMeasureAttributeMapping](API_query_MultiMeasureAttributeMapping.md) 
+  [MultiMeasureMappings](API_query_MultiMeasureMappings.md) 
+  [NotificationConfiguration](API_query_NotificationConfiguration.md) 
+  [ParameterMapping](API_query_ParameterMapping.md) 
+  [ProvisionedCapacityRequest](API_query_ProvisionedCapacityRequest.md) 
+  [ProvisionedCapacityResponse](API_query_ProvisionedCapacityResponse.md) 
+  [QueryComputeRequest](API_query_QueryComputeRequest.md) 
+  [QueryComputeResponse](API_query_QueryComputeResponse.md) 
+  [QueryInsights](API_query_QueryInsights.md) 
+  [QueryInsightsResponse](API_query_QueryInsightsResponse.md) 
+  [QuerySpatialCoverage](API_query_QuerySpatialCoverage.md) 
+  [QuerySpatialCoverageMax](API_query_QuerySpatialCoverageMax.md) 
+  [QueryStatus](API_query_QueryStatus.md) 
+  [QueryTemporalRange](API_query_QueryTemporalRange.md) 
+  [QueryTemporalRangeMax](API_query_QueryTemporalRangeMax.md) 
+  [Row](API_query_Row.md) 
+  [S3Configuration](API_query_S3Configuration.md) 
+  [S3ReportLocation](API_query_S3ReportLocation.md) 
+  [ScheduleConfiguration](API_query_ScheduleConfiguration.md) 
+  [ScheduledQuery](API_query_ScheduledQuery.md) 
+  [ScheduledQueryDescription](API_query_ScheduledQueryDescription.md) 
+  [ScheduledQueryInsights](API_query_ScheduledQueryInsights.md) 
+  [ScheduledQueryInsightsResponse](API_query_ScheduledQueryInsightsResponse.md) 
+  [ScheduledQueryRunSummary](API_query_ScheduledQueryRunSummary.md) 
+  [SelectColumn](API_query_SelectColumn.md) 
+  [SnsConfiguration](API_query_SnsConfiguration.md) 
+  [Tag](API_query_Tag.md) 
+  [TargetConfiguration](API_query_TargetConfiguration.md) 
+  [TargetDestination](API_query_TargetDestination.md) 
+  [TimeSeriesDataPoint](API_query_TimeSeriesDataPoint.md) 
+  [TimestreamConfiguration](API_query_TimestreamConfiguration.md) 
+  [TimestreamDestination](API_query_TimestreamDestination.md) 
+  [Type](API_query_Type.md) 

# AccountSettingsNotificationConfiguration
<a name="API_query_AccountSettingsNotificationConfiguration"></a>

Configuration settings for notifications related to account settings.

## Contents
<a name="API_query_AccountSettingsNotificationConfiguration_Contents"></a>

 ** RoleArn **   <a name="timestream-Type-query_AccountSettingsNotificationConfiguration-RoleArn"></a>
An Amazon Resource Name (ARN) that grants Timestream permission to publish notifications. This field is only visible if SNS Topic is provided when updating the account settings.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: Yes

 ** SnsConfiguration **   <a name="timestream-Type-query_AccountSettingsNotificationConfiguration-SnsConfiguration"></a>
Details on SNS that are required to send the notification.  
Type: [SnsConfiguration](API_query_SnsConfiguration.md) object  
Required: No

## See Also
<a name="API_query_AccountSettingsNotificationConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/AccountSettingsNotificationConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/AccountSettingsNotificationConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/AccountSettingsNotificationConfiguration) 

# ColumnInfo
<a name="API_query_ColumnInfo"></a>

 Contains the metadata for query results such as the column names, data types, and other attributes. 

## Contents
<a name="API_query_ColumnInfo_Contents"></a>

 ** Type **   <a name="timestream-Type-query_ColumnInfo-Type"></a>
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.   
Type: [Type](API_query_Type.md) object  
Required: Yes

 ** Name **   <a name="timestream-Type-query_ColumnInfo-Name"></a>
 The name of the result set column. The name of the result set is available for columns of all data types except for arrays.   
Type: String  
Required: No

## See Also
<a name="API_query_ColumnInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/ColumnInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/ColumnInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/ColumnInfo) 

# Datum
<a name="API_query_Datum"></a>

 Datum represents a single data point in a query result. 

## Contents
<a name="API_query_Datum_Contents"></a>

 ** ArrayValue **   <a name="timestream-Type-query_Datum-ArrayValue"></a>
 Indicates if the data point is an array.   
Type: Array of [Datum](#API_query_Datum) objects  
Required: No

 ** NullValue **   <a name="timestream-Type-query_Datum-NullValue"></a>
 Indicates if the data point is null.   
Type: Boolean  
Required: No

 ** RowValue **   <a name="timestream-Type-query_Datum-RowValue"></a>
 Indicates if the data point is a row.   
Type: [Row](API_query_Row.md) object  
Required: No

 ** ScalarValue **   <a name="timestream-Type-query_Datum-ScalarValue"></a>
 Indicates if the data point is a scalar value such as integer, string, double, or Boolean.   
Type: String  
Required: No

 ** TimeSeriesValue **   <a name="timestream-Type-query_Datum-TimeSeriesValue"></a>
 Indicates if the data point is a timeseries data type.   
Type: Array of [TimeSeriesDataPoint](API_query_TimeSeriesDataPoint.md) objects  
Required: No

## See Also
<a name="API_query_Datum_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/Datum) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/Datum) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/Datum) 

# DimensionMapping
<a name="API_query_DimensionMapping"></a>

This type is used to map column(s) from the query result to a dimension in the destination table.

## Contents
<a name="API_query_DimensionMapping_Contents"></a>

 ** DimensionValueType **   <a name="timestream-Type-query_DimensionMapping-DimensionValueType"></a>
Type for the dimension.   
Type: String  
Valid Values: `VARCHAR`   
Required: Yes

 ** Name **   <a name="timestream-Type-query_DimensionMapping-Name"></a>
Column name from query result.  
Type: String  
Required: Yes

## See Also
<a name="API_query_DimensionMapping_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/DimensionMapping) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/DimensionMapping) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/DimensionMapping) 

# Endpoint
<a name="API_query_Endpoint"></a>

Represents an available endpoint against which to make API calls against, as well as the TTL for that endpoint.

## Contents
<a name="API_query_Endpoint_Contents"></a>

 ** Address **   <a name="timestream-Type-query_Endpoint-Address"></a>
An endpoint address.  
Type: String  
Required: Yes

 ** CachePeriodInMinutes **   <a name="timestream-Type-query_Endpoint-CachePeriodInMinutes"></a>
The TTL for the endpoint, in minutes.  
Type: Long  
Required: Yes

## See Also
<a name="API_query_Endpoint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/Endpoint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/Endpoint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/Endpoint) 

# ErrorReportConfiguration
<a name="API_query_ErrorReportConfiguration"></a>

Configuration required for error reporting.

## Contents
<a name="API_query_ErrorReportConfiguration_Contents"></a>

 ** S3Configuration **   <a name="timestream-Type-query_ErrorReportConfiguration-S3Configuration"></a>
The S3 configuration for the error reports.  
Type: [S3Configuration](API_query_S3Configuration.md) object  
Required: Yes

## See Also
<a name="API_query_ErrorReportConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/ErrorReportConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/ErrorReportConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/ErrorReportConfiguration) 

# ErrorReportLocation
<a name="API_query_ErrorReportLocation"></a>

This contains the location of the error report for a single scheduled query call. 

## Contents
<a name="API_query_ErrorReportLocation_Contents"></a>

 ** S3ReportLocation **   <a name="timestream-Type-query_ErrorReportLocation-S3ReportLocation"></a>
The S3 location where error reports are written.  
Type: [S3ReportLocation](API_query_S3ReportLocation.md) object  
Required: No

## See Also
<a name="API_query_ErrorReportLocation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/ErrorReportLocation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/ErrorReportLocation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/ErrorReportLocation) 

# ExecutionStats
<a name="API_query_ExecutionStats"></a>

Statistics for a single scheduled query run.

## Contents
<a name="API_query_ExecutionStats_Contents"></a>

 ** BytesMetered **   <a name="timestream-Type-query_ExecutionStats-BytesMetered"></a>
Bytes metered for a single scheduled query run.  
Type: Long  
Required: No

 ** CumulativeBytesScanned **   <a name="timestream-Type-query_ExecutionStats-CumulativeBytesScanned"></a>
Bytes scanned for a single scheduled query run.  
Type: Long  
Required: No

 ** DataWrites **   <a name="timestream-Type-query_ExecutionStats-DataWrites"></a>
Data writes metered for records ingested in a single scheduled query run.  
Type: Long  
Required: No

 ** ExecutionTimeInMillis **   <a name="timestream-Type-query_ExecutionStats-ExecutionTimeInMillis"></a>
Total time, measured in milliseconds, that was needed for the scheduled query run to complete.  
Type: Long  
Required: No

 ** QueryResultRows **   <a name="timestream-Type-query_ExecutionStats-QueryResultRows"></a>
Number of rows present in the output from running a query before ingestion to destination data source.  
Type: Long  
Required: No

 ** RecordsIngested **   <a name="timestream-Type-query_ExecutionStats-RecordsIngested"></a>
The number of records ingested for a single scheduled query run.   
Type: Long  
Required: No

## See Also
<a name="API_query_ExecutionStats_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/ExecutionStats) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/ExecutionStats) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/ExecutionStats) 

# LastUpdate
<a name="API_query_LastUpdate"></a>

Configuration object that contains the most recent account settings update, visible only if settings have been updated previously.

## Contents
<a name="API_query_LastUpdate_Contents"></a>

 ** Status **   <a name="timestream-Type-query_LastUpdate-Status"></a>
The status of the last update. Can be either `PENDING`, `FAILED`, or `SUCCEEDED`.  
Type: String  
Valid Values: `PENDING | FAILED | SUCCEEDED`   
Required: No

 ** StatusMessage **   <a name="timestream-Type-query_LastUpdate-StatusMessage"></a>
Error message describing the last account settings update status, visible only if an error occurred.  
Type: String  
Required: No

 ** TargetQueryTCU **   <a name="timestream-Type-query_LastUpdate-TargetQueryTCU"></a>
The number of TimeStream Compute Units (TCUs) requested in the last account settings update.  
Type: Integer  
Required: No

## See Also
<a name="API_query_LastUpdate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/LastUpdate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/LastUpdate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/LastUpdate) 

# MixedMeasureMapping
<a name="API_query_MixedMeasureMapping"></a>

MixedMeasureMappings are mappings that can be used to ingest data into a mixture of narrow and multi measures in the derived table.

## Contents
<a name="API_query_MixedMeasureMapping_Contents"></a>

 ** MeasureValueType **   <a name="timestream-Type-query_MixedMeasureMapping-MeasureValueType"></a>
Type of the value that is to be read from sourceColumn. If the mapping is for MULTI, use MeasureValueType.MULTI.  
Type: String  
Valid Values: `BIGINT | BOOLEAN | DOUBLE | VARCHAR | MULTI`   
Required: Yes

 ** MeasureName **   <a name="timestream-Type-query_MixedMeasureMapping-MeasureName"></a>
Refers to the value of measure\$1name in a result row. This field is required if MeasureNameColumn is provided.  
Type: String  
Required: No

 ** MultiMeasureAttributeMappings **   <a name="timestream-Type-query_MixedMeasureMapping-MultiMeasureAttributeMappings"></a>
Required when measureValueType is MULTI. Attribute mappings for MULTI value measures.  
Type: Array of [MultiMeasureAttributeMapping](API_query_MultiMeasureAttributeMapping.md) objects  
Array Members: Minimum number of 1 item.  
Required: No

 ** SourceColumn **   <a name="timestream-Type-query_MixedMeasureMapping-SourceColumn"></a>
This field refers to the source column from which measure-value is to be read for result materialization.  
Type: String  
Required: No

 ** TargetMeasureName **   <a name="timestream-Type-query_MixedMeasureMapping-TargetMeasureName"></a>
Target measure name to be used. If not provided, the target measure name by default would be measure-name if provided, or sourceColumn otherwise.   
Type: String  
Required: No

## See Also
<a name="API_query_MixedMeasureMapping_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/MixedMeasureMapping) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/MixedMeasureMapping) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/MixedMeasureMapping) 

# MultiMeasureAttributeMapping
<a name="API_query_MultiMeasureAttributeMapping"></a>

Attribute mapping for MULTI value measures.

## Contents
<a name="API_query_MultiMeasureAttributeMapping_Contents"></a>

 ** MeasureValueType **   <a name="timestream-Type-query_MultiMeasureAttributeMapping-MeasureValueType"></a>
Type of the attribute to be read from the source column.  
Type: String  
Valid Values: `BIGINT | BOOLEAN | DOUBLE | VARCHAR | TIMESTAMP`   
Required: Yes

 ** SourceColumn **   <a name="timestream-Type-query_MultiMeasureAttributeMapping-SourceColumn"></a>
Source column from where the attribute value is to be read.  
Type: String  
Required: Yes

 ** TargetMultiMeasureAttributeName **   <a name="timestream-Type-query_MultiMeasureAttributeMapping-TargetMultiMeasureAttributeName"></a>
Custom name to be used for attribute name in derived table. If not provided, source column name would be used.  
Type: String  
Required: No

## See Also
<a name="API_query_MultiMeasureAttributeMapping_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/MultiMeasureAttributeMapping) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/MultiMeasureAttributeMapping) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/MultiMeasureAttributeMapping) 

# MultiMeasureMappings
<a name="API_query_MultiMeasureMappings"></a>

Only one of MixedMeasureMappings or MultiMeasureMappings is to be provided. MultiMeasureMappings can be used to ingest data as multi measures in the derived table.

## Contents
<a name="API_query_MultiMeasureMappings_Contents"></a>

 ** MultiMeasureAttributeMappings **   <a name="timestream-Type-query_MultiMeasureMappings-MultiMeasureAttributeMappings"></a>
Required. Attribute mappings to be used for mapping query results to ingest data for multi-measure attributes.  
Type: Array of [MultiMeasureAttributeMapping](API_query_MultiMeasureAttributeMapping.md) objects  
Array Members: Minimum number of 1 item.  
Required: Yes

 ** TargetMultiMeasureName **   <a name="timestream-Type-query_MultiMeasureMappings-TargetMultiMeasureName"></a>
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.  
Type: String  
Required: No

## See Also
<a name="API_query_MultiMeasureMappings_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/MultiMeasureMappings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/MultiMeasureMappings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/MultiMeasureMappings) 

# NotificationConfiguration
<a name="API_query_NotificationConfiguration"></a>

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. 

## Contents
<a name="API_query_NotificationConfiguration_Contents"></a>

 ** SnsConfiguration **   <a name="timestream-Type-query_NotificationConfiguration-SnsConfiguration"></a>
Details about the Amazon Simple Notification Service (SNS) configuration. This field is visible only when SNS Topic is provided when updating the account settings.   
Type: [SnsConfiguration](API_query_SnsConfiguration.md) object  
Required: Yes

## See Also
<a name="API_query_NotificationConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/NotificationConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/NotificationConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/NotificationConfiguration) 

# ParameterMapping
<a name="API_query_ParameterMapping"></a>

Mapping for named parameters.

## Contents
<a name="API_query_ParameterMapping_Contents"></a>

 ** Name **   <a name="timestream-Type-query_ParameterMapping-Name"></a>
Parameter name.  
Type: String  
Required: Yes

 ** Type **   <a name="timestream-Type-query_ParameterMapping-Type"></a>
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.  
Type: [Type](API_query_Type.md) object  
Required: Yes

## See Also
<a name="API_query_ParameterMapping_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/ParameterMapping) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/ParameterMapping) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/ParameterMapping) 

# ProvisionedCapacityRequest
<a name="API_query_ProvisionedCapacityRequest"></a>

A request to update the provisioned capacity settings for querying data.

## Contents
<a name="API_query_ProvisionedCapacityRequest_Contents"></a>

 ** TargetQueryTCU **   <a name="timestream-Type-query_ProvisionedCapacityRequest-TargetQueryTCU"></a>
The target compute capacity for querying data, specified in Timestream Compute Units (TCUs).  
Type: Integer  
Required: Yes

 ** NotificationConfiguration **   <a name="timestream-Type-query_ProvisionedCapacityRequest-NotificationConfiguration"></a>
Configuration settings for notifications related to the provisioned capacity update.  
Type: [AccountSettingsNotificationConfiguration](API_query_AccountSettingsNotificationConfiguration.md) object  
Required: No

## See Also
<a name="API_query_ProvisionedCapacityRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/ProvisionedCapacityRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/ProvisionedCapacityRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/ProvisionedCapacityRequest) 

# ProvisionedCapacityResponse
<a name="API_query_ProvisionedCapacityResponse"></a>

The response to a request to update the provisioned capacity settings for querying data.

## Contents
<a name="API_query_ProvisionedCapacityResponse_Contents"></a>

 ** ActiveQueryTCU **   <a name="timestream-Type-query_ProvisionedCapacityResponse-ActiveQueryTCU"></a>
The number of Timestream Compute Units (TCUs) provisioned in the account. This field is only visible when the compute mode is `PROVISIONED`.  
Type: Integer  
Required: No

 ** LastUpdate **   <a name="timestream-Type-query_ProvisionedCapacityResponse-LastUpdate"></a>
Information about the last update to the provisioned capacity settings.  
Type: [LastUpdate](API_query_LastUpdate.md) object  
Required: No

 ** NotificationConfiguration **   <a name="timestream-Type-query_ProvisionedCapacityResponse-NotificationConfiguration"></a>
An object that contains settings for notifications that are sent whenever the provisioned capacity settings are modified. This field is only visible when the compute mode is `PROVISIONED`.  
Type: [AccountSettingsNotificationConfiguration](API_query_AccountSettingsNotificationConfiguration.md) object  
Required: No

## See Also
<a name="API_query_ProvisionedCapacityResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/ProvisionedCapacityResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/ProvisionedCapacityResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/ProvisionedCapacityResponse) 

# QueryComputeRequest
<a name="API_query_QueryComputeRequest"></a>

A request to retrieve or update the compute capacity settings for querying data. QueryCompute is available only in the Asia Pacific (Mumbai) region.

## Contents
<a name="API_query_QueryComputeRequest_Contents"></a>

 ** ComputeMode **   <a name="timestream-Type-query_QueryComputeRequest-ComputeMode"></a>
The mode in which Timestream Compute Units (TCUs) are allocated and utilized within an account. Note that in the Asia Pacific (Mumbai) region, the API operation only recognizes the value `PROVISIONED`. QueryCompute is available only in the Asia Pacific (Mumbai) region.  
Type: String  
Valid Values: `ON_DEMAND | PROVISIONED`   
Required: No

 ** ProvisionedCapacity **   <a name="timestream-Type-query_QueryComputeRequest-ProvisionedCapacity"></a>
Configuration object that contains settings for provisioned Timestream Compute Units (TCUs) in your account. QueryCompute is available only in the Asia Pacific (Mumbai) region.  
Type: [ProvisionedCapacityRequest](API_query_ProvisionedCapacityRequest.md) object  
Required: No

## See Also
<a name="API_query_QueryComputeRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/QueryComputeRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/QueryComputeRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/QueryComputeRequest) 

# QueryComputeResponse
<a name="API_query_QueryComputeResponse"></a>

The response to a request to retrieve or update the compute capacity settings for querying data. QueryCompute is available only in the Asia Pacific (Mumbai) region.

## Contents
<a name="API_query_QueryComputeResponse_Contents"></a>

 ** ComputeMode **   <a name="timestream-Type-query_QueryComputeResponse-ComputeMode"></a>
The mode in which Timestream Compute Units (TCUs) are allocated and utilized within an account. Note that in the Asia Pacific (Mumbai) region, the API operation only recognizes the value `PROVISIONED`. QueryCompute is available only in the Asia Pacific (Mumbai) region.  
Type: String  
Valid Values: `ON_DEMAND | PROVISIONED`   
Required: No

 ** ProvisionedCapacity **   <a name="timestream-Type-query_QueryComputeResponse-ProvisionedCapacity"></a>
Configuration object that contains settings for provisioned Timestream Compute Units (TCUs) in your account. QueryCompute is available only in the Asia Pacific (Mumbai) region.  
Type: [ProvisionedCapacityResponse](API_query_ProvisionedCapacityResponse.md) object  
Required: No

## See Also
<a name="API_query_QueryComputeResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/QueryComputeResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/QueryComputeResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/QueryComputeResponse) 

# QueryInsights
<a name="API_query_QueryInsights"></a>

 `QueryInsights` is a performance tuning feature that helps you optimize your queries, reducing costs and improving performance. With `QueryInsights`, you can assess the pruning efficiency of your queries and identify areas for improvement to enhance query performance. With `QueryInsights`, you can also analyze the effectiveness of your queries in terms of temporal and spatial pruning, and identify opportunities to improve performance. Specifically, you can evaluate how well your queries use time-based and partition key-based indexing strategies to optimize data retrieval. To optimize query performance, it's essential that you fine-tune both the temporal and spatial parameters that govern query execution.

The key metrics provided by `QueryInsights` are `QuerySpatialCoverage` and `QueryTemporalRange`. `QuerySpatialCoverage` indicates how much of the spatial axis the query scans, with lower values being more efficient. `QueryTemporalRange` shows the time range scanned, with narrower ranges being more performant.

 **Benefits of QueryInsights** 

The following are the key benefits of using `QueryInsights`:
+  **Identifying inefficient queries** – `QueryInsights` provides information on the time-based and attribute-based pruning of the tables accessed by the query. This information helps you identify the tables that are sub-optimally accessed.
+  **Optimizing your data model and partitioning** – You can use the `QueryInsights` information to access and fine-tune your data model and partitioning strategy.
+  **Tuning queries** – `QueryInsights` highlights opportunities to use indexes more effectively.

**Note**  
The maximum number of `Query` API requests you're allowed to make with `QueryInsights` enabled is 1 query per second (QPS). If you exceed this query rate, it might result in throttling.

## Contents
<a name="API_query_QueryInsights_Contents"></a>

 ** Mode **   <a name="timestream-Type-query_QueryInsights-Mode"></a>
Provides the following modes to enable `QueryInsights`:  
+  `ENABLED_WITH_RATE_CONTROL` – Enables `QueryInsights` for the queries being processed. This mode also includes a rate control mechanism, which limits the `QueryInsights` feature to 1 query per second (QPS).
+  `DISABLED` – Disables `QueryInsights`.
Type: String  
Valid Values: `ENABLED_WITH_RATE_CONTROL | DISABLED`   
Required: Yes

## See Also
<a name="API_query_QueryInsights_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/QueryInsights) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/QueryInsights) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/QueryInsights) 

# QueryInsightsResponse
<a name="API_query_QueryInsightsResponse"></a>

Provides various insights and metrics related to the query that you executed.

## Contents
<a name="API_query_QueryInsightsResponse_Contents"></a>

 ** OutputBytes **   <a name="timestream-Type-query_QueryInsightsResponse-OutputBytes"></a>
Indicates the size of query result set in bytes. You can use this data to validate if the result set has changed as part of the query tuning exercise.  
Type: Long  
Required: No

 ** OutputRows **   <a name="timestream-Type-query_QueryInsightsResponse-OutputRows"></a>
Indicates the total number of rows returned as part of the query result set. You can use this data to validate if the number of rows in the result set have changed as part of the query tuning exercise.  
Type: Long  
Required: No

 ** QuerySpatialCoverage **   <a name="timestream-Type-query_QueryInsightsResponse-QuerySpatialCoverage"></a>
Provides insights into the spatial coverage of the query, including the table with sub-optimal (max) spatial pruning. This information can help you identify areas for improvement in your partitioning strategy to enhance spatial pruning.   
Type: [QuerySpatialCoverage](API_query_QuerySpatialCoverage.md) object  
Required: No

 ** QueryTableCount **   <a name="timestream-Type-query_QueryInsightsResponse-QueryTableCount"></a>
Indicates the number of tables in the query.  
Type: Long  
Required: No

 ** QueryTemporalRange **   <a name="timestream-Type-query_QueryInsightsResponse-QueryTemporalRange"></a>
Provides insights into the temporal range of the query, including the table with the largest (max) time range. Following are some of the potential options for optimizing time-based pruning:  
+ Add missing time-predicates.
+ Remove functions around the time predicates.
+ Add time predicates to all the sub-queries.
Type: [QueryTemporalRange](API_query_QueryTemporalRange.md) object  
Required: No

 ** UnloadPartitionCount **   <a name="timestream-Type-query_QueryInsightsResponse-UnloadPartitionCount"></a>
Indicates the partitions created by the `Unload` operation.  
Type: Long  
Required: No

 ** UnloadWrittenBytes **   <a name="timestream-Type-query_QueryInsightsResponse-UnloadWrittenBytes"></a>
Indicates the size, in bytes, written by the `Unload` operation.  
Type: Long  
Required: No

 ** UnloadWrittenRows **   <a name="timestream-Type-query_QueryInsightsResponse-UnloadWrittenRows"></a>
Indicates the rows written by the `Unload` query.  
Type: Long  
Required: No

## See Also
<a name="API_query_QueryInsightsResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/QueryInsightsResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/QueryInsightsResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/QueryInsightsResponse) 

# QuerySpatialCoverage
<a name="API_query_QuerySpatialCoverage"></a>

Provides insights into the spatial coverage of the query, including the table with sub-optimal (max) spatial pruning. This information can help you identify areas for improvement in your partitioning strategy to enhance spatial pruning

For example, you can do the following with the `QuerySpatialCoverage` information:
+ Add measure\$1name or use [customer-defined partition key](https://docs.aws.amazon.com/timestream/latest/developerguide/customer-defined-partition-keys.html) (CDPK) predicates.
+ If you've already done the preceding action, remove functions around them or clauses, such as `LIKE`.

## Contents
<a name="API_query_QuerySpatialCoverage_Contents"></a>

 ** Max **   <a name="timestream-Type-query_QuerySpatialCoverage-Max"></a>
Provides insights into the spatial coverage of the executed query and the table with the most inefficient spatial pruning.  
+  `Value` – The maximum ratio of spatial coverage.
+  `TableArn` – The Amazon Resource Name (ARN) of the table with sub-optimal spatial pruning.
+  `PartitionKey` – The partition key used for partitioning, which can be a default `measure_name` or a CDPK.
Type: [QuerySpatialCoverageMax](API_query_QuerySpatialCoverageMax.md) object  
Required: No

## See Also
<a name="API_query_QuerySpatialCoverage_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/QuerySpatialCoverage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/QuerySpatialCoverage) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/QuerySpatialCoverage) 

# QuerySpatialCoverageMax
<a name="API_query_QuerySpatialCoverageMax"></a>

Provides insights into the table with the most sub-optimal spatial range scanned by your query.

## Contents
<a name="API_query_QuerySpatialCoverageMax_Contents"></a>

 ** PartitionKey **   <a name="timestream-Type-query_QuerySpatialCoverageMax-PartitionKey"></a>
The partition key used for partitioning, which can be a default `measure_name` or a [customer defined partition key](https://docs.aws.amazon.com/timestream/latest/developerguide/customer-defined-partition-keys.html).  
Type: Array of strings  
Required: No

 ** TableArn **   <a name="timestream-Type-query_QuerySpatialCoverageMax-TableArn"></a>
The Amazon Resource Name (ARN) of the table with the most sub-optimal spatial pruning.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** Value **   <a name="timestream-Type-query_QuerySpatialCoverageMax-Value"></a>
The maximum ratio of spatial coverage.  
Type: Double  
Required: No

## See Also
<a name="API_query_QuerySpatialCoverageMax_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/QuerySpatialCoverageMax) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/QuerySpatialCoverageMax) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/QuerySpatialCoverageMax) 

# QueryStatus
<a name="API_query_QueryStatus"></a>

Information about the status of the query, including progress and bytes scanned.

## Contents
<a name="API_query_QueryStatus_Contents"></a>

 ** CumulativeBytesMetered **   <a name="timestream-Type-query_QueryStatus-CumulativeBytesMetered"></a>
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.   
Type: Long  
Required: No

 ** CumulativeBytesScanned **   <a name="timestream-Type-query_QueryStatus-CumulativeBytesScanned"></a>
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.   
Type: Long  
Required: No

 ** ProgressPercentage **   <a name="timestream-Type-query_QueryStatus-ProgressPercentage"></a>
The progress of the query, expressed as a percentage.  
Type: Double  
Required: No

## See Also
<a name="API_query_QueryStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/QueryStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/QueryStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/QueryStatus) 

# QueryTemporalRange
<a name="API_query_QueryTemporalRange"></a>

Provides insights into the temporal range of the query, including the table with the largest (max) time range.

## Contents
<a name="API_query_QueryTemporalRange_Contents"></a>

 ** Max **   <a name="timestream-Type-query_QueryTemporalRange-Max"></a>
Encapsulates the following properties that provide insights into the most sub-optimal performing table on the temporal axis:  
+  `Value` – The maximum duration in nanoseconds between the start and end of the query.
+  `TableArn` – The Amazon Resource Name (ARN) of the table which is queried with the largest time range.
Type: [QueryTemporalRangeMax](API_query_QueryTemporalRangeMax.md) object  
Required: No

## See Also
<a name="API_query_QueryTemporalRange_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/QueryTemporalRange) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/QueryTemporalRange) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/QueryTemporalRange) 

# QueryTemporalRangeMax
<a name="API_query_QueryTemporalRangeMax"></a>

Provides insights into the table with the most sub-optimal temporal pruning scanned by your query.

## Contents
<a name="API_query_QueryTemporalRangeMax_Contents"></a>

 ** TableArn **   <a name="timestream-Type-query_QueryTemporalRangeMax-TableArn"></a>
The Amazon Resource Name (ARN) of the table which is queried with the largest time range.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** Value **   <a name="timestream-Type-query_QueryTemporalRangeMax-Value"></a>
The maximum duration in nanoseconds between the start and end of the query.  
Type: Long  
Required: No

## See Also
<a name="API_query_QueryTemporalRangeMax_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/QueryTemporalRangeMax) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/QueryTemporalRangeMax) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/QueryTemporalRangeMax) 

# Row
<a name="API_query_Row"></a>

Represents a single row in the query results.

## Contents
<a name="API_query_Row_Contents"></a>

 ** Data **   <a name="timestream-Type-query_Row-Data"></a>
List of data points in a single row of the result set.  
Type: Array of [Datum](API_query_Datum.md) objects  
Required: Yes

## See Also
<a name="API_query_Row_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/Row) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/Row) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/Row) 

# S3Configuration
<a name="API_query_S3Configuration"></a>

Details on S3 location for error reports that result from running a query. 

## Contents
<a name="API_query_S3Configuration_Contents"></a>

 ** BucketName **   <a name="timestream-Type-query_S3Configuration-BucketName"></a>
 Name of the S3 bucket under which error reports will be created.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 63.  
Pattern: `[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]`   
Required: Yes

 ** EncryptionOption **   <a name="timestream-Type-query_S3Configuration-EncryptionOption"></a>
 Encryption at rest options for the error reports. If no encryption option is specified, Timestream will choose SSE\$1S3 as default.   
Type: String  
Valid Values: `SSE_S3 | SSE_KMS`   
Required: No

 ** ObjectKeyPrefix **   <a name="timestream-Type-query_S3Configuration-ObjectKeyPrefix"></a>
 Prefix for the error report key. Timestream by default adds the following prefix to the error report path.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 896.  
Pattern: `[a-zA-Z0-9|!\-_*'\(\)]([a-zA-Z0-9]|[!\-_*'\(\)\/.])+`   
Required: No

## See Also
<a name="API_query_S3Configuration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/S3Configuration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/S3Configuration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/S3Configuration) 

# S3ReportLocation
<a name="API_query_S3ReportLocation"></a>

 S3 report location for the scheduled query run.

## Contents
<a name="API_query_S3ReportLocation_Contents"></a>

 ** BucketName **   <a name="timestream-Type-query_S3ReportLocation-BucketName"></a>
 S3 bucket name.   
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 63.  
Pattern: `[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]`   
Required: No

 ** ObjectKey **   <a name="timestream-Type-query_S3ReportLocation-ObjectKey"></a>
S3 key.   
Type: String  
Required: No

## See Also
<a name="API_query_S3ReportLocation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/S3ReportLocation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/S3ReportLocation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/S3ReportLocation) 

# ScheduleConfiguration
<a name="API_query_ScheduleConfiguration"></a>

Configuration of the schedule of the query.

## Contents
<a name="API_query_ScheduleConfiguration_Contents"></a>

 ** ScheduleExpression **   <a name="timestream-Type-query_ScheduleConfiguration-ScheduleExpression"></a>
An expression that denotes when to trigger the scheduled query run. This can be a cron expression or a rate expression.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

## See Also
<a name="API_query_ScheduleConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/ScheduleConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/ScheduleConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/ScheduleConfiguration) 

# ScheduledQuery
<a name="API_query_ScheduledQuery"></a>

Scheduled Query

## Contents
<a name="API_query_ScheduledQuery_Contents"></a>

 ** Arn **   <a name="timestream-Type-query_ScheduledQuery-Arn"></a>
The Amazon Resource Name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: Yes

 ** Name **   <a name="timestream-Type-query_ScheduledQuery-Name"></a>
The name of the scheduled query.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9|!\-_*'\(\)]([a-zA-Z0-9]|[!\-_*'\(\)\/.])+`   
Required: Yes

 ** State **   <a name="timestream-Type-query_ScheduledQuery-State"></a>
State of scheduled query.   
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: Yes

 ** CreationTime **   <a name="timestream-Type-query_ScheduledQuery-CreationTime"></a>
The creation time of the scheduled query.  
Type: Timestamp  
Required: No

 ** ErrorReportConfiguration **   <a name="timestream-Type-query_ScheduledQuery-ErrorReportConfiguration"></a>
Configuration for scheduled query error reporting.  
Type: [ErrorReportConfiguration](API_query_ErrorReportConfiguration.md) object  
Required: No

 ** LastRunStatus **   <a name="timestream-Type-query_ScheduledQuery-LastRunStatus"></a>
Status of the last scheduled query run.  
Type: String  
Valid Values: `AUTO_TRIGGER_SUCCESS | AUTO_TRIGGER_FAILURE | MANUAL_TRIGGER_SUCCESS | MANUAL_TRIGGER_FAILURE`   
Required: No

 ** NextInvocationTime **   <a name="timestream-Type-query_ScheduledQuery-NextInvocationTime"></a>
The next time the scheduled query is to be run.  
Type: Timestamp  
Required: No

 ** PreviousInvocationTime **   <a name="timestream-Type-query_ScheduledQuery-PreviousInvocationTime"></a>
The last time the scheduled query was run.  
Type: Timestamp  
Required: No

 ** TargetDestination **   <a name="timestream-Type-query_ScheduledQuery-TargetDestination"></a>
Target data source where final scheduled query result will be written.  
Type: [TargetDestination](API_query_TargetDestination.md) object  
Required: No

## See Also
<a name="API_query_ScheduledQuery_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/ScheduledQuery) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/ScheduledQuery) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/ScheduledQuery) 

# ScheduledQueryDescription
<a name="API_query_ScheduledQueryDescription"></a>

Structure that describes scheduled query.

## Contents
<a name="API_query_ScheduledQueryDescription_Contents"></a>

 ** Arn **   <a name="timestream-Type-query_ScheduledQueryDescription-Arn"></a>
Scheduled query ARN.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: Yes

 ** Name **   <a name="timestream-Type-query_ScheduledQueryDescription-Name"></a>
Name of the scheduled query.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9|!\-_*'\(\)]([a-zA-Z0-9]|[!\-_*'\(\)\/.])+`   
Required: Yes

 ** NotificationConfiguration **   <a name="timestream-Type-query_ScheduledQueryDescription-NotificationConfiguration"></a>
Notification configuration.  
Type: [NotificationConfiguration](API_query_NotificationConfiguration.md) object  
Required: Yes

 ** QueryString **   <a name="timestream-Type-query_ScheduledQueryDescription-QueryString"></a>
The query to be run.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 262144.  
Required: Yes

 ** ScheduleConfiguration **   <a name="timestream-Type-query_ScheduledQueryDescription-ScheduleConfiguration"></a>
Schedule configuration.  
Type: [ScheduleConfiguration](API_query_ScheduleConfiguration.md) object  
Required: Yes

 ** State **   <a name="timestream-Type-query_ScheduledQueryDescription-State"></a>
State of the scheduled query.   
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: Yes

 ** CreationTime **   <a name="timestream-Type-query_ScheduledQueryDescription-CreationTime"></a>
Creation time of the scheduled query.  
Type: Timestamp  
Required: No

 ** ErrorReportConfiguration **   <a name="timestream-Type-query_ScheduledQueryDescription-ErrorReportConfiguration"></a>
Error-reporting configuration for the scheduled query.  
Type: [ErrorReportConfiguration](API_query_ErrorReportConfiguration.md) object  
Required: No

 ** KmsKeyId **   <a name="timestream-Type-query_ScheduledQueryDescription-KmsKeyId"></a>
A customer provided KMS key used to encrypt the scheduled query resource.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** LastRunSummary **   <a name="timestream-Type-query_ScheduledQueryDescription-LastRunSummary"></a>
Runtime summary for the last scheduled query run.   
Type: [ScheduledQueryRunSummary](API_query_ScheduledQueryRunSummary.md) object  
Required: No

 ** NextInvocationTime **   <a name="timestream-Type-query_ScheduledQueryDescription-NextInvocationTime"></a>
The next time the scheduled query is scheduled to run.  
Type: Timestamp  
Required: No

 ** PreviousInvocationTime **   <a name="timestream-Type-query_ScheduledQueryDescription-PreviousInvocationTime"></a>
Last time the query was run.  
Type: Timestamp  
Required: No

 ** RecentlyFailedRuns **   <a name="timestream-Type-query_ScheduledQueryDescription-RecentlyFailedRuns"></a>
Runtime summary for the last five failed scheduled query runs.  
Type: Array of [ScheduledQueryRunSummary](API_query_ScheduledQueryRunSummary.md) objects  
Required: No

 ** ScheduledQueryExecutionRoleArn **   <a name="timestream-Type-query_ScheduledQueryDescription-ScheduledQueryExecutionRoleArn"></a>
IAM role that Timestream uses to run the schedule query.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** TargetConfiguration **   <a name="timestream-Type-query_ScheduledQueryDescription-TargetConfiguration"></a>
Scheduled query target store configuration.  
Type: [TargetConfiguration](API_query_TargetConfiguration.md) object  
Required: No

## See Also
<a name="API_query_ScheduledQueryDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/ScheduledQueryDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/ScheduledQueryDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/ScheduledQueryDescription) 

# ScheduledQueryInsights
<a name="API_query_ScheduledQueryInsights"></a>

Encapsulates settings for enabling `QueryInsights` on an `ExecuteScheduledQueryRequest`.

## Contents
<a name="API_query_ScheduledQueryInsights_Contents"></a>

 ** Mode **   <a name="timestream-Type-query_ScheduledQueryInsights-Mode"></a>
Provides the following modes to enable `ScheduledQueryInsights`:  
+  `ENABLED_WITH_RATE_CONTROL` – Enables `ScheduledQueryInsights` for the queries being processed. This mode also includes a rate control mechanism, which limits the `QueryInsights` feature to 1 query per second (QPS).
+  `DISABLED` – Disables `ScheduledQueryInsights`.
Type: String  
Valid Values: `ENABLED_WITH_RATE_CONTROL | DISABLED`   
Required: Yes

## See Also
<a name="API_query_ScheduledQueryInsights_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/ScheduledQueryInsights) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/ScheduledQueryInsights) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/ScheduledQueryInsights) 

# ScheduledQueryInsightsResponse
<a name="API_query_ScheduledQueryInsightsResponse"></a>

Provides various insights and metrics related to the `ExecuteScheduledQueryRequest` that was executed.

## Contents
<a name="API_query_ScheduledQueryInsightsResponse_Contents"></a>

 ** OutputBytes **   <a name="timestream-Type-query_ScheduledQueryInsightsResponse-OutputBytes"></a>
Indicates the size of query result set in bytes. You can use this data to validate if the result set has changed as part of the query tuning exercise.  
Type: Long  
Required: No

 ** OutputRows **   <a name="timestream-Type-query_ScheduledQueryInsightsResponse-OutputRows"></a>
Indicates the total number of rows returned as part of the query result set. You can use this data to validate if the number of rows in the result set have changed as part of the query tuning exercise.  
Type: Long  
Required: No

 ** QuerySpatialCoverage **   <a name="timestream-Type-query_ScheduledQueryInsightsResponse-QuerySpatialCoverage"></a>
Provides insights into the spatial coverage of the query, including the table with sub-optimal (max) spatial pruning. This information can help you identify areas for improvement in your partitioning strategy to enhance spatial pruning.  
Type: [QuerySpatialCoverage](API_query_QuerySpatialCoverage.md) object  
Required: No

 ** QueryTableCount **   <a name="timestream-Type-query_ScheduledQueryInsightsResponse-QueryTableCount"></a>
Indicates the number of tables in the query.  
Type: Long  
Required: No

 ** QueryTemporalRange **   <a name="timestream-Type-query_ScheduledQueryInsightsResponse-QueryTemporalRange"></a>
Provides insights into the temporal range of the query, including the table with the largest (max) time range. Following are some of the potential options for optimizing time-based pruning:  
+ Add missing time-predicates.
+ Remove functions around the time predicates.
+ Add time predicates to all the sub-queries.
Type: [QueryTemporalRange](API_query_QueryTemporalRange.md) object  
Required: No

## See Also
<a name="API_query_ScheduledQueryInsightsResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/ScheduledQueryInsightsResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/ScheduledQueryInsightsResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/ScheduledQueryInsightsResponse) 

# ScheduledQueryRunSummary
<a name="API_query_ScheduledQueryRunSummary"></a>

Run summary for the scheduled query

## Contents
<a name="API_query_ScheduledQueryRunSummary_Contents"></a>

 ** ErrorReportLocation **   <a name="timestream-Type-query_ScheduledQueryRunSummary-ErrorReportLocation"></a>
S3 location for error report.  
Type: [ErrorReportLocation](API_query_ErrorReportLocation.md) object  
Required: No

 ** ExecutionStats **   <a name="timestream-Type-query_ScheduledQueryRunSummary-ExecutionStats"></a>
Runtime statistics for a scheduled run.  
Type: [ExecutionStats](API_query_ExecutionStats.md) object  
Required: No

 ** FailureReason **   <a name="timestream-Type-query_ScheduledQueryRunSummary-FailureReason"></a>
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.   
Type: String  
Required: No

 ** InvocationTime **   <a name="timestream-Type-query_ScheduledQueryRunSummary-InvocationTime"></a>
InvocationTime for this run. This is the time at which the query is scheduled to run. Parameter `@scheduled_runtime` can be used in the query to get the value.   
Type: Timestamp  
Required: No

 ** QueryInsightsResponse **   <a name="timestream-Type-query_ScheduledQueryRunSummary-QueryInsightsResponse"></a>
Provides various insights and metrics related to the run summary of the scheduled query.  
Type: [ScheduledQueryInsightsResponse](API_query_ScheduledQueryInsightsResponse.md) object  
Required: No

 ** RunStatus **   <a name="timestream-Type-query_ScheduledQueryRunSummary-RunStatus"></a>
The status of a scheduled query run.  
Type: String  
Valid Values: `AUTO_TRIGGER_SUCCESS | AUTO_TRIGGER_FAILURE | MANUAL_TRIGGER_SUCCESS | MANUAL_TRIGGER_FAILURE`   
Required: No

 ** TriggerTime **   <a name="timestream-Type-query_ScheduledQueryRunSummary-TriggerTime"></a>
The actual time when the query was run.  
Type: Timestamp  
Required: No

## See Also
<a name="API_query_ScheduledQueryRunSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/ScheduledQueryRunSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/ScheduledQueryRunSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/ScheduledQueryRunSummary) 

# SelectColumn
<a name="API_query_SelectColumn"></a>

Details of the column that is returned by the query. 

## Contents
<a name="API_query_SelectColumn_Contents"></a>

 ** Aliased **   <a name="timestream-Type-query_SelectColumn-Aliased"></a>
True, if the column name was aliased by the query. False otherwise.  
Type: Boolean  
Required: No

 ** DatabaseName **   <a name="timestream-Type-query_SelectColumn-DatabaseName"></a>
 Database that has this column.  
Type: String  
Required: No

 ** Name **   <a name="timestream-Type-query_SelectColumn-Name"></a>
Name of the column.  
Type: String  
Required: No

 ** TableName **   <a name="timestream-Type-query_SelectColumn-TableName"></a>
Table within the database that has this column.   
Type: String  
Required: No

 ** Type **   <a name="timestream-Type-query_SelectColumn-Type"></a>
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.  
Type: [Type](API_query_Type.md) object  
Required: No

## See Also
<a name="API_query_SelectColumn_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/SelectColumn) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/SelectColumn) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/SelectColumn) 

# SnsConfiguration
<a name="API_query_SnsConfiguration"></a>

Details on SNS that are required to send the notification.

## Contents
<a name="API_query_SnsConfiguration_Contents"></a>

 ** TopicArn **   <a name="timestream-Type-query_SnsConfiguration-TopicArn"></a>
SNS topic ARN that the scheduled query status notifications will be sent to.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: Yes

## See Also
<a name="API_query_SnsConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/SnsConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/SnsConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/SnsConfiguration) 

# Tag
<a name="API_query_Tag"></a>

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. 

## Contents
<a name="API_query_Tag_Contents"></a>

 ** Key **   <a name="timestream-Type-query_Tag-Key"></a>
The key of the tag. Tag keys are case sensitive.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: Yes

 ** Value **   <a name="timestream-Type-query_Tag-Value"></a>
The value of the tag. Tag values are case sensitive and can be null.   
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: Yes

## See Also
<a name="API_query_Tag_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/Tag) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/Tag) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/Tag) 

# TargetConfiguration
<a name="API_query_TargetConfiguration"></a>

Configuration used for writing the output of a query.

## Contents
<a name="API_query_TargetConfiguration_Contents"></a>

 ** TimestreamConfiguration **   <a name="timestream-Type-query_TargetConfiguration-TimestreamConfiguration"></a>
Configuration needed to write data into the Timestream database and table.  
Type: [TimestreamConfiguration](API_query_TimestreamConfiguration.md) object  
Required: Yes

## See Also
<a name="API_query_TargetConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/TargetConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/TargetConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/TargetConfiguration) 

# TargetDestination
<a name="API_query_TargetDestination"></a>

Destination details to write data for a target data source. Current supported data source is Timestream.

## Contents
<a name="API_query_TargetDestination_Contents"></a>

 ** TimestreamDestination **   <a name="timestream-Type-query_TargetDestination-TimestreamDestination"></a>
Query result destination details for Timestream data source.  
Type: [TimestreamDestination](API_query_TimestreamDestination.md) object  
Required: No

## See Also
<a name="API_query_TargetDestination_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/TargetDestination) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/TargetDestination) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/TargetDestination) 

# TimeSeriesDataPoint
<a name="API_query_TimeSeriesDataPoint"></a>

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. 

## Contents
<a name="API_query_TimeSeriesDataPoint_Contents"></a>

 ** Time **   <a name="timestream-Type-query_TimeSeriesDataPoint-Time"></a>
The timestamp when the measure value was collected.  
Type: String  
Required: Yes

 ** Value **   <a name="timestream-Type-query_TimeSeriesDataPoint-Value"></a>
The measure value for the data point.  
Type: [Datum](API_query_Datum.md) object  
Required: Yes

## See Also
<a name="API_query_TimeSeriesDataPoint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/TimeSeriesDataPoint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/TimeSeriesDataPoint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/TimeSeriesDataPoint) 

# TimestreamConfiguration
<a name="API_query_TimestreamConfiguration"></a>

 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. 

## Contents
<a name="API_query_TimestreamConfiguration_Contents"></a>

 ** DatabaseName **   <a name="timestream-Type-query_TimestreamConfiguration-DatabaseName"></a>
Name of Timestream database to which the query result will be written.  
Type: String  
Required: Yes

 ** DimensionMappings **   <a name="timestream-Type-query_TimestreamConfiguration-DimensionMappings"></a>
 This is to allow mapping column(s) from the query result to the dimension in the destination table.   
Type: Array of [DimensionMapping](API_query_DimensionMapping.md) objects  
Required: Yes

 ** TableName **   <a name="timestream-Type-query_TimestreamConfiguration-TableName"></a>
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.  
Type: String  
Required: Yes

 ** TimeColumn **   <a name="timestream-Type-query_TimestreamConfiguration-TimeColumn"></a>
Column from query result that should be used as the time column in destination table. Column type for this should be TIMESTAMP.  
Type: String  
Required: Yes

 ** MeasureNameColumn **   <a name="timestream-Type-query_TimestreamConfiguration-MeasureNameColumn"></a>
Name of the measure column.  
Type: String  
Required: No

 ** MixedMeasureMappings **   <a name="timestream-Type-query_TimestreamConfiguration-MixedMeasureMappings"></a>
Specifies how to map measures to multi-measure records.  
Type: Array of [MixedMeasureMapping](API_query_MixedMeasureMapping.md) objects  
Array Members: Minimum number of 1 item.  
Required: No

 ** MultiMeasureMappings **   <a name="timestream-Type-query_TimestreamConfiguration-MultiMeasureMappings"></a>
Multi-measure mappings.  
Type: [MultiMeasureMappings](API_query_MultiMeasureMappings.md) object  
Required: No

## See Also
<a name="API_query_TimestreamConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/TimestreamConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/TimestreamConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/TimestreamConfiguration) 

# TimestreamDestination
<a name="API_query_TimestreamDestination"></a>

Destination for scheduled query.

## Contents
<a name="API_query_TimestreamDestination_Contents"></a>

 ** DatabaseName **   <a name="timestream-Type-query_TimestreamDestination-DatabaseName"></a>
Timestream database name.   
Type: String  
Required: No

 ** TableName **   <a name="timestream-Type-query_TimestreamDestination-TableName"></a>
Timestream table name.   
Type: String  
Required: No

## See Also
<a name="API_query_TimestreamDestination_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/TimestreamDestination) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/TimestreamDestination) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/TimestreamDestination) 

# Type
<a name="API_query_Type"></a>

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.

## Contents
<a name="API_query_Type_Contents"></a>

 ** ArrayColumnInfo **   <a name="timestream-Type-query_Type-ArrayColumnInfo"></a>
Indicates if the column is an array.  
Type: [ColumnInfo](API_query_ColumnInfo.md) object  
Required: No

 ** RowColumnInfo **   <a name="timestream-Type-query_Type-RowColumnInfo"></a>
Indicates if the column is a row.  
Type: Array of [ColumnInfo](API_query_ColumnInfo.md) objects  
Required: No

 ** ScalarType **   <a name="timestream-Type-query_Type-ScalarType"></a>
Indicates if the column is of type string, integer, Boolean, double, timestamp, date, time. For more information, see [Supported data types](https://docs.aws.amazon.com/timestream/latest/developerguide/supported-data-types.html).  
Type: String  
Valid Values: `VARCHAR | BOOLEAN | BIGINT | DOUBLE | TIMESTAMP | DATE | TIME | INTERVAL_DAY_TO_SECOND | INTERVAL_YEAR_TO_MONTH | UNKNOWN | INTEGER`   
Required: No

 ** TimeSeriesMeasureValueColumnInfo **   <a name="timestream-Type-query_Type-TimeSeriesMeasureValueColumnInfo"></a>
Indicates if the column is a timeseries data type.  
Type: [ColumnInfo](API_query_ColumnInfo.md) object  
Required: No

## See Also
<a name="API_query_Type_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/Type) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/Type) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/Type)