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).

# API reference
<a name="API_Reference"></a>

This section contains the API Reference documentation for Amazon Timestream. 

Timestream has two APIs: Query and Write.
+ The **Write API** allows you to perform operations like table creation, resource tagging, and writing of records to Timestream.
+ The **Query API** allows you to perform query operations.

**Note**  
Both APIs include the DescribeEndpoints action. *For both Query and Write, the DescribeEndpoints action are identical.*

You can read more about each API below, along with data types, common errors and parameters.

**Note**  
For error codes common to all AWS services, see the [AWS Support section](https://docs.aws.amazon.com/awssupport/latest/APIReference/CommonErrors.html). 

**Topics**
+ [Actions](API_Operations.md)
+ [Data Types](API_Types.md)
+ [Common Error Types](CommonErrors.md)
+ [Common Parameters](CommonParameters.md)

# Actions
<a name="API_Operations"></a>

The following actions are supported by Amazon Timestream Write:
+  [CreateBatchLoadTask](API_CreateBatchLoadTask.md) 
+  [CreateDatabase](API_CreateDatabase.md) 
+  [CreateTable](API_CreateTable.md) 
+  [DeleteDatabase](API_DeleteDatabase.md) 
+  [DeleteTable](API_DeleteTable.md) 
+  [DescribeBatchLoadTask](API_DescribeBatchLoadTask.md) 
+  [DescribeDatabase](API_DescribeDatabase.md) 
+  [DescribeEndpoints](API_DescribeEndpoints.md) 
+  [DescribeTable](API_DescribeTable.md) 
+  [ListBatchLoadTasks](API_ListBatchLoadTasks.md) 
+  [ListDatabases](API_ListDatabases.md) 
+  [ListTables](API_ListTables.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [ResumeBatchLoadTask](API_ResumeBatchLoadTask.md) 
+  [TagResource](API_TagResource.md) 
+  [UntagResource](API_UntagResource.md) 
+  [UpdateDatabase](API_UpdateDatabase.md) 
+  [UpdateTable](API_UpdateTable.md) 
+  [WriteRecords](API_WriteRecords.md) 

The following actions are supported by Amazon Timestream Query:
+  [CancelQuery](API_query_CancelQuery.md) 
+  [CreateScheduledQuery](API_query_CreateScheduledQuery.md) 
+  [DeleteScheduledQuery](API_query_DeleteScheduledQuery.md) 
+  [DescribeAccountSettings](API_query_DescribeAccountSettings.md) 
+  [DescribeEndpoints](API_query_DescribeEndpoints.md) 
+  [DescribeScheduledQuery](API_query_DescribeScheduledQuery.md) 
+  [ExecuteScheduledQuery](API_query_ExecuteScheduledQuery.md) 
+  [ListScheduledQueries](API_query_ListScheduledQueries.md) 
+  [ListTagsForResource](API_query_ListTagsForResource.md) 
+  [PrepareQuery](API_query_PrepareQuery.md) 
+  [Query](API_query_Query.md) 
+  [TagResource](API_query_TagResource.md) 
+  [UntagResource](API_query_UntagResource.md) 
+  [UpdateAccountSettings](API_query_UpdateAccountSettings.md) 
+  [UpdateScheduledQuery](API_query_UpdateScheduledQuery.md) 

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

The following actions are supported by Amazon Timestream Write:
+  [CreateBatchLoadTask](API_CreateBatchLoadTask.md) 
+  [CreateDatabase](API_CreateDatabase.md) 
+  [CreateTable](API_CreateTable.md) 
+  [DeleteDatabase](API_DeleteDatabase.md) 
+  [DeleteTable](API_DeleteTable.md) 
+  [DescribeBatchLoadTask](API_DescribeBatchLoadTask.md) 
+  [DescribeDatabase](API_DescribeDatabase.md) 
+  [DescribeEndpoints](API_DescribeEndpoints.md) 
+  [DescribeTable](API_DescribeTable.md) 
+  [ListBatchLoadTasks](API_ListBatchLoadTasks.md) 
+  [ListDatabases](API_ListDatabases.md) 
+  [ListTables](API_ListTables.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [ResumeBatchLoadTask](API_ResumeBatchLoadTask.md) 
+  [TagResource](API_TagResource.md) 
+  [UntagResource](API_UntagResource.md) 
+  [UpdateDatabase](API_UpdateDatabase.md) 
+  [UpdateTable](API_UpdateTable.md) 
+  [WriteRecords](API_WriteRecords.md) 

# CreateBatchLoadTask
<a name="API_CreateBatchLoadTask"></a>

Creates a new Timestream batch load task. A batch load task processes data from a CSV source in an S3 location and writes to a Timestream table. A mapping from source to target is defined in a batch load task. Errors and events are written to a report at an S3 location. For the report, if the AWS KMS key is not specified, the report will be encrypted with an S3 managed key when `SSE_S3` is the option. Otherwise an error is thrown. For more information, see [AWS managed keys](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk). [Service quotas apply](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html). For details, see [code sample](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-batch-load.html).

## Request Syntax
<a name="API_CreateBatchLoadTask_RequestSyntax"></a>

```
{
   "ClientToken": "string",
   "DataModelConfiguration": { 
      "DataModel": { 
         "DimensionMappings": [ 
            { 
               "DestinationColumn": "string",
               "SourceColumn": "string"
            }
         ],
         "MeasureNameColumn": "string",
         "MixedMeasureMappings": [ 
            { 
               "MeasureName": "string",
               "MeasureValueType": "string",
               "MultiMeasureAttributeMappings": [ 
                  { 
                     "MeasureValueType": "string",
                     "SourceColumn": "string",
                     "TargetMultiMeasureAttributeName": "string"
                  }
               ],
               "SourceColumn": "string",
               "TargetMeasureName": "string"
            }
         ],
         "MultiMeasureMappings": { 
            "MultiMeasureAttributeMappings": [ 
               { 
                  "MeasureValueType": "string",
                  "SourceColumn": "string",
                  "TargetMultiMeasureAttributeName": "string"
               }
            ],
            "TargetMultiMeasureName": "string"
         },
         "TimeColumn": "string",
         "TimeUnit": "string"
      },
      "DataModelS3Configuration": { 
         "BucketName": "string",
         "ObjectKey": "string"
      }
   },
   "DataSourceConfiguration": { 
      "CsvConfiguration": { 
         "ColumnSeparator": "string",
         "EscapeChar": "string",
         "NullValue": "string",
         "QuoteChar": "string",
         "TrimWhiteSpace": boolean
      },
      "DataFormat": "string",
      "DataSourceS3Configuration": { 
         "BucketName": "string",
         "ObjectKeyPrefix": "string"
      }
   },
   "RecordVersion": number,
   "ReportConfiguration": { 
      "ReportS3Configuration": { 
         "BucketName": "string",
         "EncryptionOption": "string",
         "KmsKeyId": "string",
         "ObjectKeyPrefix": "string"
      }
   },
   "TargetDatabaseName": "string",
   "TargetTableName": "string"
}
```

## Request Parameters
<a name="API_CreateBatchLoadTask_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ClientToken](#API_CreateBatchLoadTask_RequestSyntax) **   <a name="timestream-CreateBatchLoadTask-request-ClientToken"></a>
  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: No

 ** [DataModelConfiguration](#API_CreateBatchLoadTask_RequestSyntax) **   <a name="timestream-CreateBatchLoadTask-request-DataModelConfiguration"></a>
  
Type: [DataModelConfiguration](API_DataModelConfiguration.md) object  
Required: No

 ** [DataSourceConfiguration](#API_CreateBatchLoadTask_RequestSyntax) **   <a name="timestream-CreateBatchLoadTask-request-DataSourceConfiguration"></a>
Defines configuration details about the data source for a batch load task.  
Type: [DataSourceConfiguration](API_DataSourceConfiguration.md) object  
Required: Yes

 ** [RecordVersion](#API_CreateBatchLoadTask_RequestSyntax) **   <a name="timestream-CreateBatchLoadTask-request-RecordVersion"></a>
  
Type: Long  
Required: No

 ** [ReportConfiguration](#API_CreateBatchLoadTask_RequestSyntax) **   <a name="timestream-CreateBatchLoadTask-request-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: Yes

 ** [TargetDatabaseName](#API_CreateBatchLoadTask_RequestSyntax) **   <a name="timestream-CreateBatchLoadTask-request-TargetDatabaseName"></a>
Target Timestream database for a batch load task.  
Type: String  
Pattern: `[a-zA-Z0-9_.-]+`   
Required: Yes

 ** [TargetTableName](#API_CreateBatchLoadTask_RequestSyntax) **   <a name="timestream-CreateBatchLoadTask-request-TargetTableName"></a>
Target Timestream table for a batch load task.  
Type: String  
Pattern: `[a-zA-Z0-9_.-]+`   
Required: Yes

## Response Syntax
<a name="API_CreateBatchLoadTask_ResponseSyntax"></a>

```
{
   "TaskId": "string"
}
```

## Response Elements
<a name="API_CreateBatchLoadTask_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [TaskId](#API_CreateBatchLoadTask_ResponseSyntax) **   <a name="timestream-CreateBatchLoadTask-response-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]+` 

## Errors
<a name="API_CreateBatchLoadTask_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You are not authorized to perform this action.  
HTTP Status Code: 400

 ** ConflictException **   
Timestream was unable to process this request because it contains resource that already exists.  
HTTP Status Code: 400

 ** InternalServerException **   
 Timestream was unable to fully process this request because of an internal server error.  
HTTP Status Code: 500

 ** InvalidEndpointException **   
The requested endpoint was not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.  
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
 The instance quota of resource exceeded for this account.  
HTTP Status Code: 400

 ** ThrottlingException **   
 Too many requests were made by a user and they exceeded the service quotas. The request was throttled.  
HTTP Status Code: 400

 ** ValidationException **   
 An invalid or malformed request.  
HTTP Status Code: 400

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/CreateBatchLoadTask) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/CreateBatchLoadTask) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/CreateBatchLoadTask) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/CreateBatchLoadTask) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/CreateBatchLoadTask) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/CreateBatchLoadTask) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/CreateBatchLoadTask) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/CreateBatchLoadTask) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/CreateBatchLoadTask) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/CreateBatchLoadTask) 

# CreateDatabase
<a name="API_CreateDatabase"></a>

Creates a new Timestream database. If the AWS KMS key is not specified, the database will be encrypted with a Timestream managed AWS KMS key located in your account. For more information, see [AWS managed keys](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk). [Service quotas apply](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html). For details, see [code sample](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-db.html). 

## Request Syntax
<a name="API_CreateDatabase_RequestSyntax"></a>

```
{
   "DatabaseName": "string",
   "KmsKeyId": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_CreateDatabase_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DatabaseName](#API_CreateDatabase_RequestSyntax) **   <a name="timestream-CreateDatabase-request-DatabaseName"></a>
The name of the Timestream database.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 256.  
Pattern: `[a-zA-Z0-9_.-]+`   
Required: Yes

 ** [KmsKeyId](#API_CreateDatabase_RequestSyntax) **   <a name="timestream-CreateDatabase-request-KmsKeyId"></a>
The AWS KMS key for the database. If the AWS KMS key is not specified, the database will be encrypted with a Timestream managed AWS KMS key located in your account. For more information, see [AWS managed keys](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** [Tags](#API_CreateDatabase_RequestSyntax) **   <a name="timestream-CreateDatabase-request-Tags"></a>
 A list of key-value pairs to label the table.   
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Required: No

## Response Syntax
<a name="API_CreateDatabase_ResponseSyntax"></a>

```
{
   "Database": { 
      "Arn": "string",
      "CreationTime": number,
      "DatabaseName": "string",
      "KmsKeyId": "string",
      "LastUpdatedTime": number,
      "TableCount": number
   }
}
```

## Response Elements
<a name="API_CreateDatabase_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Database](#API_CreateDatabase_ResponseSyntax) **   <a name="timestream-CreateDatabase-response-Database"></a>
The newly created Timestream database.  
Type: [Database](API_Database.md) object

## Errors
<a name="API_CreateDatabase_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You are not authorized to perform this action.  
HTTP Status Code: 400

 ** ConflictException **   
Timestream was unable to process this request because it contains resource that already exists.  
HTTP Status Code: 400

 ** InternalServerException **   
 Timestream was unable to fully process this request because of an internal server error.  
HTTP Status Code: 500

 ** InvalidEndpointException **   
The requested endpoint was not valid.  
HTTP Status Code: 400

 ** InvalidEndpointException **   
The requested endpoint was not valid.  
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
 The instance quota of resource exceeded for this account.  
HTTP Status Code: 400

 ** ThrottlingException **   
 Too many requests were made by a user and they exceeded the service quotas. The request was throttled.  
HTTP Status Code: 400

 ** ValidationException **   
 An invalid or malformed request.  
HTTP Status Code: 400

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/CreateDatabase) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/CreateDatabase) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/CreateDatabase) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/CreateDatabase) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/CreateDatabase) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/CreateDatabase) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/CreateDatabase) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/CreateDatabase) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/CreateDatabase) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/CreateDatabase) 

# CreateTable
<a name="API_CreateTable"></a>

Adds a new table to an existing database in your account. In an AWS account, table names must be at least unique within each Region if they are in the same database. You might have identical table names in the same Region if the tables are in separate databases. While creating the table, you must specify the table name, database name, and the retention properties. [Service quotas apply](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html). See [code sample](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-table.html) for details. 

## Request Syntax
<a name="API_CreateTable_RequestSyntax"></a>

```
{
   "DatabaseName": "string",
   "MagneticStoreWriteProperties": { 
      "EnableMagneticStoreWrites": boolean,
      "MagneticStoreRejectedDataLocation": { 
         "S3Configuration": { 
            "BucketName": "string",
            "EncryptionOption": "string",
            "KmsKeyId": "string",
            "ObjectKeyPrefix": "string"
         }
      }
   },
   "RetentionProperties": { 
      "MagneticStoreRetentionPeriodInDays": number,
      "MemoryStoreRetentionPeriodInHours": number
   },
   "Schema": { 
      "CompositePartitionKey": [ 
         { 
            "EnforcementInRecord": "string",
            "Name": "string",
            "Type": "string"
         }
      ]
   },
   "TableName": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_CreateTable_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DatabaseName](#API_CreateTable_RequestSyntax) **   <a name="timestream-CreateTable-request-DatabaseName"></a>
The name of the Timestream database.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 256.  
Pattern: `[a-zA-Z0-9_.-]+`   
Required: Yes

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

 ** [RetentionProperties](#API_CreateTable_RequestSyntax) **   <a name="timestream-CreateTable-request-RetentionProperties"></a>
The duration for which your time-series data must be stored in the memory store and the magnetic store.  
Type: [RetentionProperties](API_RetentionProperties.md) object  
Required: No

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

 ** [TableName](#API_CreateTable_RequestSyntax) **   <a name="timestream-CreateTable-request-TableName"></a>
The name of the Timestream table.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 256.  
Pattern: `[a-zA-Z0-9_.-]+`   
Required: Yes

 ** [Tags](#API_CreateTable_RequestSyntax) **   <a name="timestream-CreateTable-request-Tags"></a>
 A list of key-value pairs to label the table.   
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Required: No

## Response Syntax
<a name="API_CreateTable_ResponseSyntax"></a>

```
{
   "Table": { 
      "Arn": "string",
      "CreationTime": number,
      "DatabaseName": "string",
      "LastUpdatedTime": number,
      "MagneticStoreWriteProperties": { 
         "EnableMagneticStoreWrites": boolean,
         "MagneticStoreRejectedDataLocation": { 
            "S3Configuration": { 
               "BucketName": "string",
               "EncryptionOption": "string",
               "KmsKeyId": "string",
               "ObjectKeyPrefix": "string"
            }
         }
      },
      "RetentionProperties": { 
         "MagneticStoreRetentionPeriodInDays": number,
         "MemoryStoreRetentionPeriodInHours": number
      },
      "Schema": { 
         "CompositePartitionKey": [ 
            { 
               "EnforcementInRecord": "string",
               "Name": "string",
               "Type": "string"
            }
         ]
      },
      "TableName": "string",
      "TableStatus": "string"
   }
}
```

## Response Elements
<a name="API_CreateTable_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Table](#API_CreateTable_ResponseSyntax) **   <a name="timestream-CreateTable-response-Table"></a>
The newly created Timestream table.  
Type: [Table](API_Table.md) object

## Errors
<a name="API_CreateTable_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You are not authorized to perform this action.  
HTTP Status Code: 400

 ** ConflictException **   
Timestream was unable to process this request because it contains resource that already exists.  
HTTP Status Code: 400

 ** InternalServerException **   
 Timestream was unable to fully process this request because of an internal server error.  
HTTP Status Code: 500

 ** InvalidEndpointException **   
The requested endpoint was not valid.  
HTTP Status Code: 400

 ** InvalidEndpointException **   
The requested endpoint was not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.  
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
 The instance quota of resource exceeded for this account.  
HTTP Status Code: 400

 ** ThrottlingException **   
 Too many requests were made by a user and they exceeded the service quotas. The request was throttled.  
HTTP Status Code: 400

 ** ValidationException **   
 An invalid or malformed request.  
HTTP Status Code: 400

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/CreateTable) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/CreateTable) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/CreateTable) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/CreateTable) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/CreateTable) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/CreateTable) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/CreateTable) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/CreateTable) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/CreateTable) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/CreateTable) 

# DeleteDatabase
<a name="API_DeleteDatabase"></a>

Deletes a given Timestream database. *This is an irreversible operation. After a database is deleted, the time-series data from its tables cannot be recovered.* 

**Note**  
All tables in the database must be deleted first, or a ValidationException error will be thrown.   
Due to the nature of distributed retries, the operation can return either success or a ResourceNotFoundException. Clients should consider them equivalent.

See [code sample](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.delete-db.html) for details.

## Request Syntax
<a name="API_DeleteDatabase_RequestSyntax"></a>

```
{
   "DatabaseName": "string"
}
```

## Request Parameters
<a name="API_DeleteDatabase_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DatabaseName](#API_DeleteDatabase_RequestSyntax) **   <a name="timestream-DeleteDatabase-request-DatabaseName"></a>
The name of the Timestream database to be deleted.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 256.  
Required: Yes

## Response Elements
<a name="API_DeleteDatabase_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteDatabase_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You are not authorized to perform this action.  
HTTP Status Code: 400

 ** InternalServerException **   
 Timestream was unable to fully process this request because of an internal server error.  
HTTP Status Code: 500

 ** InvalidEndpointException **   
The requested endpoint was not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.  
HTTP Status Code: 400

 ** ThrottlingException **   
 Too many requests were made by a user and they exceeded the service quotas. The request was throttled.  
HTTP Status Code: 400

 ** ValidationException **   
 An invalid or malformed request.  
HTTP Status Code: 400

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/DeleteDatabase) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/DeleteDatabase) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/DeleteDatabase) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/DeleteDatabase) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/DeleteDatabase) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/DeleteDatabase) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/DeleteDatabase) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/DeleteDatabase) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/DeleteDatabase) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/DeleteDatabase) 

# DeleteTable
<a name="API_DeleteTable"></a>

Deletes a given Timestream table. This is an irreversible operation. After a Timestream database table is deleted, the time-series data stored in the table cannot be recovered. 

**Note**  
Due to the nature of distributed retries, the operation can return either success or a ResourceNotFoundException. Clients should consider them equivalent.

See [code sample](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.delete-table.html) for details.

## Request Syntax
<a name="API_DeleteTable_RequestSyntax"></a>

```
{
   "DatabaseName": "string",
   "TableName": "string"
}
```

## Request Parameters
<a name="API_DeleteTable_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DatabaseName](#API_DeleteTable_RequestSyntax) **   <a name="timestream-DeleteTable-request-DatabaseName"></a>
The name of the database where the Timestream database is to be deleted.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 256.  
Required: Yes

 ** [TableName](#API_DeleteTable_RequestSyntax) **   <a name="timestream-DeleteTable-request-TableName"></a>
The name of the Timestream table to be deleted.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 256.  
Required: Yes

## Response Elements
<a name="API_DeleteTable_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteTable_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You are not authorized to perform this action.  
HTTP Status Code: 400

 ** InternalServerException **   
 Timestream was unable to fully process this request because of an internal server error.  
HTTP Status Code: 500

 ** InvalidEndpointException **   
The requested endpoint was not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.  
HTTP Status Code: 400

 ** ThrottlingException **   
 Too many requests were made by a user and they exceeded the service quotas. The request was throttled.  
HTTP Status Code: 400

 ** ValidationException **   
 An invalid or malformed request.  
HTTP Status Code: 400

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/DeleteTable) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/DeleteTable) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/DeleteTable) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/DeleteTable) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/DeleteTable) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/DeleteTable) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/DeleteTable) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/DeleteTable) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/DeleteTable) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/DeleteTable) 

# DescribeBatchLoadTask
<a name="API_DescribeBatchLoadTask"></a>

Returns information about the batch load task, including configurations, mappings, progress, and other details. [Service quotas apply](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html). See [code sample](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-batch-load.html) for details.

## Request Syntax
<a name="API_DescribeBatchLoadTask_RequestSyntax"></a>

```
{
   "TaskId": "string"
}
```

## Request Parameters
<a name="API_DescribeBatchLoadTask_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [TaskId](#API_DescribeBatchLoadTask_RequestSyntax) **   <a name="timestream-DescribeBatchLoadTask-request-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: Yes

## Response Syntax
<a name="API_DescribeBatchLoadTask_ResponseSyntax"></a>

```
{
   "BatchLoadTaskDescription": { 
      "CreationTime": number,
      "DataModelConfiguration": { 
         "DataModel": { 
            "DimensionMappings": [ 
               { 
                  "DestinationColumn": "string",
                  "SourceColumn": "string"
               }
            ],
            "MeasureNameColumn": "string",
            "MixedMeasureMappings": [ 
               { 
                  "MeasureName": "string",
                  "MeasureValueType": "string",
                  "MultiMeasureAttributeMappings": [ 
                     { 
                        "MeasureValueType": "string",
                        "SourceColumn": "string",
                        "TargetMultiMeasureAttributeName": "string"
                     }
                  ],
                  "SourceColumn": "string",
                  "TargetMeasureName": "string"
               }
            ],
            "MultiMeasureMappings": { 
               "MultiMeasureAttributeMappings": [ 
                  { 
                     "MeasureValueType": "string",
                     "SourceColumn": "string",
                     "TargetMultiMeasureAttributeName": "string"
                  }
               ],
               "TargetMultiMeasureName": "string"
            },
            "TimeColumn": "string",
            "TimeUnit": "string"
         },
         "DataModelS3Configuration": { 
            "BucketName": "string",
            "ObjectKey": "string"
         }
      },
      "DataSourceConfiguration": { 
         "CsvConfiguration": { 
            "ColumnSeparator": "string",
            "EscapeChar": "string",
            "NullValue": "string",
            "QuoteChar": "string",
            "TrimWhiteSpace": boolean
         },
         "DataFormat": "string",
         "DataSourceS3Configuration": { 
            "BucketName": "string",
            "ObjectKeyPrefix": "string"
         }
      },
      "ErrorMessage": "string",
      "LastUpdatedTime": number,
      "ProgressReport": { 
         "BytesMetered": number,
         "FileFailures": number,
         "ParseFailures": number,
         "RecordIngestionFailures": number,
         "RecordsIngested": number,
         "RecordsProcessed": number
      },
      "RecordVersion": number,
      "ReportConfiguration": { 
         "ReportS3Configuration": { 
            "BucketName": "string",
            "EncryptionOption": "string",
            "KmsKeyId": "string",
            "ObjectKeyPrefix": "string"
         }
      },
      "ResumableUntil": number,
      "TargetDatabaseName": "string",
      "TargetTableName": "string",
      "TaskId": "string",
      "TaskStatus": "string"
   }
}
```

## Response Elements
<a name="API_DescribeBatchLoadTask_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [BatchLoadTaskDescription](#API_DescribeBatchLoadTask_ResponseSyntax) **   <a name="timestream-DescribeBatchLoadTask-response-BatchLoadTaskDescription"></a>
Description of the batch load task.  
Type: [BatchLoadTaskDescription](API_BatchLoadTaskDescription.md) object

## Errors
<a name="API_DescribeBatchLoadTask_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You are not authorized to perform this action.  
HTTP Status Code: 400

 ** InternalServerException **   
 Timestream was unable to fully process this request because of an internal server error.  
HTTP Status Code: 500

 ** InvalidEndpointException **   
The requested endpoint was not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.  
HTTP Status Code: 400

 ** ThrottlingException **   
 Too many requests were made by a user and they exceeded the service quotas. The request was throttled.  
HTTP Status Code: 400

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/DescribeBatchLoadTask) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/DescribeBatchLoadTask) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/DescribeBatchLoadTask) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/DescribeBatchLoadTask) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/DescribeBatchLoadTask) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/DescribeBatchLoadTask) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/DescribeBatchLoadTask) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/DescribeBatchLoadTask) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/DescribeBatchLoadTask) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/DescribeBatchLoadTask) 

# DescribeDatabase
<a name="API_DescribeDatabase"></a>

Returns information about the database, including the database name, time that the database was created, and the total number of tables found within the database. [Service quotas apply](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html). See [code sample](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-db.html) for details.

## Request Syntax
<a name="API_DescribeDatabase_RequestSyntax"></a>

```
{
   "DatabaseName": "string"
}
```

## Request Parameters
<a name="API_DescribeDatabase_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DatabaseName](#API_DescribeDatabase_RequestSyntax) **   <a name="timestream-DescribeDatabase-request-DatabaseName"></a>
The name of the Timestream database.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 256.  
Required: Yes

## Response Syntax
<a name="API_DescribeDatabase_ResponseSyntax"></a>

```
{
   "Database": { 
      "Arn": "string",
      "CreationTime": number,
      "DatabaseName": "string",
      "KmsKeyId": "string",
      "LastUpdatedTime": number,
      "TableCount": number
   }
}
```

## Response Elements
<a name="API_DescribeDatabase_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Database](#API_DescribeDatabase_ResponseSyntax) **   <a name="timestream-DescribeDatabase-response-Database"></a>
The name of the Timestream table.  
Type: [Database](API_Database.md) object

## Errors
<a name="API_DescribeDatabase_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You are not authorized to perform this action.  
HTTP Status Code: 400

 ** InternalServerException **   
 Timestream was unable to fully process this request because of an internal server error.  
HTTP Status Code: 500

 ** InvalidEndpointException **   
The requested endpoint was not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.  
HTTP Status Code: 400

 ** ThrottlingException **   
 Too many requests were made by a user and they exceeded the service quotas. The request was throttled.  
HTTP Status Code: 400

 ** ValidationException **   
 An invalid or malformed request.  
HTTP Status Code: 400

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/DescribeDatabase) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/DescribeDatabase) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/DescribeDatabase) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/DescribeDatabase) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/DescribeDatabase) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/DescribeDatabase) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/DescribeDatabase) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/DescribeDatabase) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/DescribeDatabase) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/DescribeDatabase) 

# DescribeEndpoints
<a name="API_DescribeEndpoints"></a>

Returns a list of available endpoints to make Timestream API calls against. This API operation is available through both the Write and Query APIs.

Because the Timestream SDKs are designed to transparently work with the service’s architecture, including the management and mapping of the service endpoints, *we don't recommend that you use this API operation unless*:
+ You are using [VPC endpoints (AWS PrivateLink) with Timestream](https://docs.aws.amazon.com/timestream/latest/developerguide/VPCEndpoints) 
+ Your application uses a programming language that does not yet have SDK support
+ You require better control over the client-side implementation

For detailed information on how and when to use and implement DescribeEndpoints, see [The Endpoint Discovery Pattern](https://docs.aws.amazon.com/timestream/latest/developerguide/Using.API.html#Using-API.endpoint-discovery).

## Response Syntax
<a name="API_DescribeEndpoints_ResponseSyntax"></a>

```
{
   "Endpoints": [ 
      { 
         "Address": "string",
         "CachePeriodInMinutes": number
      }
   ]
}
```

## Response Elements
<a name="API_DescribeEndpoints_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Endpoints](#API_DescribeEndpoints_ResponseSyntax) **   <a name="timestream-DescribeEndpoints-response-Endpoints"></a>
An `Endpoints` object is returned when a `DescribeEndpoints` request is made.  
Type: Array of [Endpoint](API_Endpoint.md) objects

## Errors
<a name="API_DescribeEndpoints_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
 Timestream was unable to fully process this request because of an internal server error.  
HTTP Status Code: 500

 ** ThrottlingException **   
 Too many requests were made by a user and they exceeded the service quotas. The request was throttled.  
HTTP Status Code: 400

 ** ValidationException **   
 An invalid or malformed request.  
HTTP Status Code: 400

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/DescribeEndpoints) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/DescribeEndpoints) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/DescribeEndpoints) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/DescribeEndpoints) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/DescribeEndpoints) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/DescribeEndpoints) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/DescribeEndpoints) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/DescribeEndpoints) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/DescribeEndpoints) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/DescribeEndpoints) 

# DescribeTable
<a name="API_DescribeTable"></a>

Returns information about the table, including the table name, database name, retention duration of the memory store and the magnetic store. [Service quotas apply](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html). See [code sample](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-table.html) for details. 

## Request Syntax
<a name="API_DescribeTable_RequestSyntax"></a>

```
{
   "DatabaseName": "string",
   "TableName": "string"
}
```

## Request Parameters
<a name="API_DescribeTable_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DatabaseName](#API_DescribeTable_RequestSyntax) **   <a name="timestream-DescribeTable-request-DatabaseName"></a>
The name of the Timestream database.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 256.  
Required: Yes

 ** [TableName](#API_DescribeTable_RequestSyntax) **   <a name="timestream-DescribeTable-request-TableName"></a>
The name of the Timestream table.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 256.  
Required: Yes

## Response Syntax
<a name="API_DescribeTable_ResponseSyntax"></a>

```
{
   "Table": { 
      "Arn": "string",
      "CreationTime": number,
      "DatabaseName": "string",
      "LastUpdatedTime": number,
      "MagneticStoreWriteProperties": { 
         "EnableMagneticStoreWrites": boolean,
         "MagneticStoreRejectedDataLocation": { 
            "S3Configuration": { 
               "BucketName": "string",
               "EncryptionOption": "string",
               "KmsKeyId": "string",
               "ObjectKeyPrefix": "string"
            }
         }
      },
      "RetentionProperties": { 
         "MagneticStoreRetentionPeriodInDays": number,
         "MemoryStoreRetentionPeriodInHours": number
      },
      "Schema": { 
         "CompositePartitionKey": [ 
            { 
               "EnforcementInRecord": "string",
               "Name": "string",
               "Type": "string"
            }
         ]
      },
      "TableName": "string",
      "TableStatus": "string"
   }
}
```

## Response Elements
<a name="API_DescribeTable_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Table](#API_DescribeTable_ResponseSyntax) **   <a name="timestream-DescribeTable-response-Table"></a>
The Timestream table.  
Type: [Table](API_Table.md) object

## Errors
<a name="API_DescribeTable_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You are not authorized to perform this action.  
HTTP Status Code: 400

 ** InternalServerException **   
 Timestream was unable to fully process this request because of an internal server error.  
HTTP Status Code: 500

 ** InvalidEndpointException **   
The requested endpoint was not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.  
HTTP Status Code: 400

 ** ThrottlingException **   
 Too many requests were made by a user and they exceeded the service quotas. The request was throttled.  
HTTP Status Code: 400

 ** ValidationException **   
 An invalid or malformed request.  
HTTP Status Code: 400

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/DescribeTable) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/DescribeTable) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/DescribeTable) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/DescribeTable) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/DescribeTable) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/DescribeTable) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/DescribeTable) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/DescribeTable) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/DescribeTable) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/DescribeTable) 

# ListBatchLoadTasks
<a name="API_ListBatchLoadTasks"></a>

Provides a list of batch load tasks, along with the name, status, when the task is resumable until, and other details. See [code sample](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-batch-load-tasks.html) for details.

## Request Syntax
<a name="API_ListBatchLoadTasks_RequestSyntax"></a>

```
{
   "MaxResults": number,
   "NextToken": "string",
   "TaskStatus": "string"
}
```

## Request Parameters
<a name="API_ListBatchLoadTasks_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [MaxResults](#API_ListBatchLoadTasks_RequestSyntax) **   <a name="timestream-ListBatchLoadTasks-request-MaxResults"></a>
The total number of items to return in the output. If the total number of items available is more than the value specified, a NextToken is provided in the output. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_ListBatchLoadTasks_RequestSyntax) **   <a name="timestream-ListBatchLoadTasks-request-NextToken"></a>
A token to specify where to start paginating. This is the NextToken from a previously truncated response.  
Type: String  
Required: No

 ** [TaskStatus](#API_ListBatchLoadTasks_RequestSyntax) **   <a name="timestream-ListBatchLoadTasks-request-TaskStatus"></a>
Status of the batch load task.  
Type: String  
Valid Values: `CREATED | IN_PROGRESS | FAILED | SUCCEEDED | PROGRESS_STOPPED | PENDING_RESUME`   
Required: No

## Response Syntax
<a name="API_ListBatchLoadTasks_ResponseSyntax"></a>

```
{
   "BatchLoadTasks": [ 
      { 
         "CreationTime": number,
         "DatabaseName": "string",
         "LastUpdatedTime": number,
         "ResumableUntil": number,
         "TableName": "string",
         "TaskId": "string",
         "TaskStatus": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListBatchLoadTasks_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [BatchLoadTasks](#API_ListBatchLoadTasks_ResponseSyntax) **   <a name="timestream-ListBatchLoadTasks-response-BatchLoadTasks"></a>
A list of batch load task details.  
Type: Array of [BatchLoadTask](API_BatchLoadTask.md) objects

 ** [NextToken](#API_ListBatchLoadTasks_ResponseSyntax) **   <a name="timestream-ListBatchLoadTasks-response-NextToken"></a>
A token to specify where to start paginating. Provide the next ListBatchLoadTasksRequest.  
Type: String

## Errors
<a name="API_ListBatchLoadTasks_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You are not authorized to perform this action.  
HTTP Status Code: 400

 ** InternalServerException **   
 Timestream was unable to fully process this request because of an internal server error.  
HTTP Status Code: 500

 ** InvalidEndpointException **   
The requested endpoint was not valid.  
HTTP Status Code: 400

 ** ThrottlingException **   
 Too many requests were made by a user and they exceeded the service quotas. The request was throttled.  
HTTP Status Code: 400

 ** ValidationException **   
 An invalid or malformed request.  
HTTP Status Code: 400

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/ListBatchLoadTasks) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/ListBatchLoadTasks) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/ListBatchLoadTasks) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/ListBatchLoadTasks) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/ListBatchLoadTasks) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/ListBatchLoadTasks) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/ListBatchLoadTasks) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/ListBatchLoadTasks) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/ListBatchLoadTasks) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/ListBatchLoadTasks) 

# ListDatabases
<a name="API_ListDatabases"></a>

Returns a list of your Timestream databases. [Service quotas apply](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html). See [code sample](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-db.html) for details. 

## Request Syntax
<a name="API_ListDatabases_RequestSyntax"></a>

```
{
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListDatabases_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [MaxResults](#API_ListDatabases_RequestSyntax) **   <a name="timestream-ListDatabases-request-MaxResults"></a>
The total number of items to return in the output. If the total number of items available is more than the value specified, a NextToken is provided in the output. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 20.  
Required: No

 ** [NextToken](#API_ListDatabases_RequestSyntax) **   <a name="timestream-ListDatabases-request-NextToken"></a>
The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.  
Type: String  
Required: No

## Response Syntax
<a name="API_ListDatabases_ResponseSyntax"></a>

```
{
   "Databases": [ 
      { 
         "Arn": "string",
         "CreationTime": number,
         "DatabaseName": "string",
         "KmsKeyId": "string",
         "LastUpdatedTime": number,
         "TableCount": number
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListDatabases_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Databases](#API_ListDatabases_ResponseSyntax) **   <a name="timestream-ListDatabases-response-Databases"></a>
A list of database names.  
Type: Array of [Database](API_Database.md) objects

 ** [NextToken](#API_ListDatabases_ResponseSyntax) **   <a name="timestream-ListDatabases-response-NextToken"></a>
The pagination token. This parameter is returned when the response is truncated.  
Type: String

## Errors
<a name="API_ListDatabases_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You are not authorized to perform this action.  
HTTP Status Code: 400

 ** InternalServerException **   
 Timestream was unable to fully process this request because of an internal server error.  
HTTP Status Code: 500

 ** InvalidEndpointException **   
The requested endpoint was not valid.  
HTTP Status Code: 400

 ** ThrottlingException **   
 Too many requests were made by a user and they exceeded the service quotas. The request was throttled.  
HTTP Status Code: 400

 ** ValidationException **   
 An invalid or malformed request.  
HTTP Status Code: 400

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/ListDatabases) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/ListDatabases) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/ListDatabases) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/ListDatabases) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/ListDatabases) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/ListDatabases) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/ListDatabases) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/ListDatabases) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/ListDatabases) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/ListDatabases) 

# ListTables
<a name="API_ListTables"></a>

Provides a list of tables, along with the name, status, and retention properties of each table. See [code sample](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-table.html) for details. 

## Request Syntax
<a name="API_ListTables_RequestSyntax"></a>

```
{
   "DatabaseName": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListTables_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DatabaseName](#API_ListTables_RequestSyntax) **   <a name="timestream-ListTables-request-DatabaseName"></a>
The name of the Timestream database.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 256.  
Required: No

 ** [MaxResults](#API_ListTables_RequestSyntax) **   <a name="timestream-ListTables-request-MaxResults"></a>
The total number of items to return in the output. If the total number of items available is more than the value specified, a NextToken is provided in the output. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 20.  
Required: No

 ** [NextToken](#API_ListTables_RequestSyntax) **   <a name="timestream-ListTables-request-NextToken"></a>
The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.  
Type: String  
Required: No

## Response Syntax
<a name="API_ListTables_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "Tables": [ 
      { 
         "Arn": "string",
         "CreationTime": number,
         "DatabaseName": "string",
         "LastUpdatedTime": number,
         "MagneticStoreWriteProperties": { 
            "EnableMagneticStoreWrites": boolean,
            "MagneticStoreRejectedDataLocation": { 
               "S3Configuration": { 
                  "BucketName": "string",
                  "EncryptionOption": "string",
                  "KmsKeyId": "string",
                  "ObjectKeyPrefix": "string"
               }
            }
         },
         "RetentionProperties": { 
            "MagneticStoreRetentionPeriodInDays": number,
            "MemoryStoreRetentionPeriodInHours": number
         },
         "Schema": { 
            "CompositePartitionKey": [ 
               { 
                  "EnforcementInRecord": "string",
                  "Name": "string",
                  "Type": "string"
               }
            ]
         },
         "TableName": "string",
         "TableStatus": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListTables_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListTables_ResponseSyntax) **   <a name="timestream-ListTables-response-NextToken"></a>
A token to specify where to start paginating. This is the NextToken from a previously truncated response.  
Type: String

 ** [Tables](#API_ListTables_ResponseSyntax) **   <a name="timestream-ListTables-response-Tables"></a>
A list of tables.  
Type: Array of [Table](API_Table.md) objects

## Errors
<a name="API_ListTables_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You are not authorized to perform this action.  
HTTP Status Code: 400

 ** InternalServerException **   
 Timestream was unable to fully process this request because of an internal server error.  
HTTP Status Code: 500

 ** InvalidEndpointException **   
The requested endpoint was not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.  
HTTP Status Code: 400

 ** ThrottlingException **   
 Too many requests were made by a user and they exceeded the service quotas. The request was throttled.  
HTTP Status Code: 400

 ** ValidationException **   
 An invalid or malformed request.  
HTTP Status Code: 400

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/ListTables) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/ListTables) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/ListTables) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/ListTables) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/ListTables) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/ListTables) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/ListTables) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/ListTables) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/ListTables) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/ListTables) 

# ListTagsForResource
<a name="API_ListTagsForResource"></a>

 Lists all tags on a Timestream resource. 

## Request Syntax
<a name="API_ListTagsForResource_RequestSyntax"></a>

```
{
   "ResourceARN": "string"
}
```

## Request Parameters
<a name="API_ListTagsForResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ResourceARN](#API_ListTagsForResource_RequestSyntax) **   <a name="timestream-ListTagsForResource-request-ResourceARN"></a>
 The Timestream resource with tags to be listed. This value is an Amazon Resource Name (ARN).   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Required: Yes

## Response Syntax
<a name="API_ListTagsForResource_ResponseSyntax"></a>

```
{
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListTagsForResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Tags](#API_ListTagsForResource_ResponseSyntax) **   <a name="timestream-ListTagsForResource-response-Tags"></a>
 The tags currently associated with the Timestream resource.   
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.

## Errors
<a name="API_ListTagsForResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidEndpointException **   
The requested endpoint was not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.  
HTTP Status Code: 400

 ** ThrottlingException **   
 Too many requests were made by a user and they exceeded the service quotas. The request was throttled.  
HTTP Status Code: 400

 ** ValidationException **   
 An invalid or malformed request.  
HTTP Status Code: 400

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/ListTagsForResource) 

# ResumeBatchLoadTask
<a name="API_ResumeBatchLoadTask"></a>

 

## Request Syntax
<a name="API_ResumeBatchLoadTask_RequestSyntax"></a>

```
{
   "TaskId": "string"
}
```

## Request Parameters
<a name="API_ResumeBatchLoadTask_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [TaskId](#API_ResumeBatchLoadTask_RequestSyntax) **   <a name="timestream-ResumeBatchLoadTask-request-TaskId"></a>
The ID of the batch load task to resume.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 32.  
Pattern: `[A-Z0-9]+`   
Required: Yes

## Response Elements
<a name="API_ResumeBatchLoadTask_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_ResumeBatchLoadTask_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You are not authorized to perform this action.  
HTTP Status Code: 400

 ** InternalServerException **   
 Timestream was unable to fully process this request because of an internal server error.  
HTTP Status Code: 500

 ** InvalidEndpointException **   
The requested endpoint was not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.  
HTTP Status Code: 400

 ** ThrottlingException **   
 Too many requests were made by a user and they exceeded the service quotas. The request was throttled.  
HTTP Status Code: 400

 ** ValidationException **   
 An invalid or malformed request.  
HTTP Status Code: 400

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/ResumeBatchLoadTask) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/ResumeBatchLoadTask) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/ResumeBatchLoadTask) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/ResumeBatchLoadTask) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/ResumeBatchLoadTask) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/ResumeBatchLoadTask) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/ResumeBatchLoadTask) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/ResumeBatchLoadTask) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/ResumeBatchLoadTask) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/ResumeBatchLoadTask) 

# TagResource
<a name="API_TagResource"></a>

 Associates a set of tags with a Timestream resource. You can then activate these user-defined tags so that they appear on the Billing and Cost Management console for cost allocation tracking. 

## Request Syntax
<a name="API_TagResource_RequestSyntax"></a>

```
{
   "ResourceARN": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_TagResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ResourceARN](#API_TagResource_RequestSyntax) **   <a name="timestream-TagResource-request-ResourceARN"></a>
 Identifies the Timestream resource to which tags should be added. This value is an Amazon Resource Name (ARN).   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Required: Yes

 ** [Tags](#API_TagResource_RequestSyntax) **   <a name="timestream-TagResource-request-Tags"></a>
 The tags to be assigned to the Timestream resource.   
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Required: Yes

## Response Elements
<a name="API_TagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_TagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidEndpointException **   
The requested endpoint was not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.  
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
 The instance quota of resource exceeded for this account.  
HTTP Status Code: 400

 ** ThrottlingException **   
 Too many requests were made by a user and they exceeded the service quotas. The request was throttled.  
HTTP Status Code: 400

 ** ValidationException **   
 An invalid or malformed request.  
HTTP Status Code: 400

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/TagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/TagResource) 

# UntagResource
<a name="API_UntagResource"></a>

 Removes the association of tags from a Timestream resource. 

## Request Syntax
<a name="API_UntagResource_RequestSyntax"></a>

```
{
   "ResourceARN": "string",
   "TagKeys": [ "string" ]
}
```

## Request Parameters
<a name="API_UntagResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ResourceARN](#API_UntagResource_RequestSyntax) **   <a name="timestream-UntagResource-request-ResourceARN"></a>
 The Timestream resource that the tags will be removed from. This value is an Amazon Resource Name (ARN).   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Required: Yes

 ** [TagKeys](#API_UntagResource_RequestSyntax) **   <a name="timestream-UntagResource-request-TagKeys"></a>
 A list of tags keys. Existing tags of the resource whose keys are members of this list will be removed from the Timestream resource.   
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: Yes

## Response Elements
<a name="API_UntagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UntagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidEndpointException **   
The requested endpoint was not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.  
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
 The instance quota of resource exceeded for this account.  
HTTP Status Code: 400

 ** ThrottlingException **   
 Too many requests were made by a user and they exceeded the service quotas. The request was throttled.  
HTTP Status Code: 400

 ** ValidationException **   
 An invalid or malformed request.  
HTTP Status Code: 400

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/UntagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/UntagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/UntagResource) 

# UpdateDatabase
<a name="API_UpdateDatabase"></a>

 Modifies the AWS KMS key for an existing database. While updating the database, you must specify the database name and the identifier of the new AWS KMS key to be used (`KmsKeyId`). If there are any concurrent `UpdateDatabase` requests, first writer wins. 

See [code sample](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.update-db.html) for details.

## Request Syntax
<a name="API_UpdateDatabase_RequestSyntax"></a>

```
{
   "DatabaseName": "string",
   "KmsKeyId": "string"
}
```

## Request Parameters
<a name="API_UpdateDatabase_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DatabaseName](#API_UpdateDatabase_RequestSyntax) **   <a name="timestream-UpdateDatabase-request-DatabaseName"></a>
 The name of the database.   
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 256.  
Required: Yes

 ** [KmsKeyId](#API_UpdateDatabase_RequestSyntax) **   <a name="timestream-UpdateDatabase-request-KmsKeyId"></a>
 The identifier of the new AWS KMS key (`KmsKeyId`) to be used to encrypt the data stored in the database. If the `KmsKeyId` currently registered with the database is the same as the `KmsKeyId` in the request, there will not be any update.   
You can specify the `KmsKeyId` using any of the following:  
+ Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab` 
+ Key ARN: `arn:aws:kms:us-east-1:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab` 
+ Alias name: `alias/ExampleAlias` 
+ Alias ARN: `arn:aws:kms:us-east-1:111122223333:alias/ExampleAlias` 
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: Yes

## Response Syntax
<a name="API_UpdateDatabase_ResponseSyntax"></a>

```
{
   "Database": { 
      "Arn": "string",
      "CreationTime": number,
      "DatabaseName": "string",
      "KmsKeyId": "string",
      "LastUpdatedTime": number,
      "TableCount": number
   }
}
```

## Response Elements
<a name="API_UpdateDatabase_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Database](#API_UpdateDatabase_ResponseSyntax) **   <a name="timestream-UpdateDatabase-response-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.  
Type: [Database](API_Database.md) object

## Errors
<a name="API_UpdateDatabase_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You are not authorized to perform this action.  
HTTP Status Code: 400

 ** InternalServerException **   
 Timestream was unable to fully process this request because of an internal server error.  
HTTP Status Code: 500

 ** InvalidEndpointException **   
The requested endpoint was not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.  
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
 The instance quota of resource exceeded for this account.  
HTTP Status Code: 400

 ** ThrottlingException **   
 Too many requests were made by a user and they exceeded the service quotas. The request was throttled.  
HTTP Status Code: 400

 ** ValidationException **   
 An invalid or malformed request.  
HTTP Status Code: 400

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/UpdateDatabase) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/UpdateDatabase) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/UpdateDatabase) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/UpdateDatabase) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/UpdateDatabase) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/UpdateDatabase) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/UpdateDatabase) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/UpdateDatabase) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/UpdateDatabase) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/UpdateDatabase) 

# UpdateTable
<a name="API_UpdateTable"></a>

Modifies the retention duration of the memory store and magnetic store for your Timestream table. Note that the change in retention duration takes effect immediately. For example, if the retention period of the memory store was initially set to 2 hours and then changed to 24 hours, the memory store will be capable of holding 24 hours of data, but will be populated with 24 hours of data 22 hours after this change was made. Timestream does not retrieve data from the magnetic store to populate the memory store. 

See [code sample](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.update-table.html) for details.

## Request Syntax
<a name="API_UpdateTable_RequestSyntax"></a>

```
{
   "DatabaseName": "string",
   "MagneticStoreWriteProperties": { 
      "EnableMagneticStoreWrites": boolean,
      "MagneticStoreRejectedDataLocation": { 
         "S3Configuration": { 
            "BucketName": "string",
            "EncryptionOption": "string",
            "KmsKeyId": "string",
            "ObjectKeyPrefix": "string"
         }
      }
   },
   "RetentionProperties": { 
      "MagneticStoreRetentionPeriodInDays": number,
      "MemoryStoreRetentionPeriodInHours": number
   },
   "Schema": { 
      "CompositePartitionKey": [ 
         { 
            "EnforcementInRecord": "string",
            "Name": "string",
            "Type": "string"
         }
      ]
   },
   "TableName": "string"
}
```

## Request Parameters
<a name="API_UpdateTable_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DatabaseName](#API_UpdateTable_RequestSyntax) **   <a name="timestream-UpdateTable-request-DatabaseName"></a>
The name of the Timestream database.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 256.  
Required: Yes

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

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

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

 ** [TableName](#API_UpdateTable_RequestSyntax) **   <a name="timestream-UpdateTable-request-TableName"></a>
The name of the Timestream table.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 256.  
Required: Yes

## Response Syntax
<a name="API_UpdateTable_ResponseSyntax"></a>

```
{
   "Table": { 
      "Arn": "string",
      "CreationTime": number,
      "DatabaseName": "string",
      "LastUpdatedTime": number,
      "MagneticStoreWriteProperties": { 
         "EnableMagneticStoreWrites": boolean,
         "MagneticStoreRejectedDataLocation": { 
            "S3Configuration": { 
               "BucketName": "string",
               "EncryptionOption": "string",
               "KmsKeyId": "string",
               "ObjectKeyPrefix": "string"
            }
         }
      },
      "RetentionProperties": { 
         "MagneticStoreRetentionPeriodInDays": number,
         "MemoryStoreRetentionPeriodInHours": number
      },
      "Schema": { 
         "CompositePartitionKey": [ 
            { 
               "EnforcementInRecord": "string",
               "Name": "string",
               "Type": "string"
            }
         ]
      },
      "TableName": "string",
      "TableStatus": "string"
   }
}
```

## Response Elements
<a name="API_UpdateTable_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Table](#API_UpdateTable_ResponseSyntax) **   <a name="timestream-UpdateTable-response-Table"></a>
The updated Timestream table.  
Type: [Table](API_Table.md) object

## Errors
<a name="API_UpdateTable_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You are not authorized to perform this action.  
HTTP Status Code: 400

 ** InternalServerException **   
 Timestream was unable to fully process this request because of an internal server error.  
HTTP Status Code: 500

 ** InvalidEndpointException **   
The requested endpoint was not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.  
HTTP Status Code: 400

 ** ThrottlingException **   
 Too many requests were made by a user and they exceeded the service quotas. The request was throttled.  
HTTP Status Code: 400

 ** ValidationException **   
 An invalid or malformed request.  
HTTP Status Code: 400

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/UpdateTable) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/UpdateTable) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/UpdateTable) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/UpdateTable) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/UpdateTable) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/UpdateTable) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/UpdateTable) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/UpdateTable) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/UpdateTable) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/UpdateTable) 

# WriteRecords
<a name="API_WriteRecords"></a>

Enables you to write your time-series data into Timestream. You can specify a single data point or a batch of data points to be inserted into the system. Timestream offers you a flexible schema that auto detects the column names and data types for your Timestream tables based on the dimension names and data types of the data points you specify when invoking writes into the database. 

Timestream supports eventual consistency read semantics. This means that when you query data immediately after writing a batch of data into Timestream, the query results might not reflect the results of a recently completed write operation. The results may also include some stale data. If you repeat the query request after a short time, the results should return the latest data. [Service quotas apply](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html). 

See [code sample](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.write.html) for details.

 **Upserts** 

You can use the `Version` parameter in a `WriteRecords` request to update data points. Timestream tracks a version number with each record. `Version` defaults to `1` when it's not specified for the record in the request. Timestream updates an existing record’s measure value along with its `Version` when it receives a write request with a higher `Version` number for that record. When it receives an update request where the measure value is the same as that of the existing record, Timestream still updates `Version`, if it is greater than the existing value of `Version`. You can update a data point as many times as desired, as long as the value of `Version` continuously increases. 

 For example, suppose you write a new record without indicating `Version` in the request. Timestream stores this record, and set `Version` to `1`. Now, suppose you try to update this record with a `WriteRecords` request of the same record with a different measure value but, like before, do not provide `Version`. In this case, Timestream will reject this update with a `RejectedRecordsException` since the updated record’s version is not greater than the existing value of Version. 

However, if you were to resend the update request with `Version` set to `2`, Timestream would then succeed in updating the record’s value, and the `Version` would be set to `2`. Next, suppose you sent a `WriteRecords` request with this same record and an identical measure value, but with `Version` set to `3`. In this case, Timestream would only update `Version` to `3`. Any further updates would need to send a version number greater than `3`, or the update requests would receive a `RejectedRecordsException`. 

## Request Syntax
<a name="API_WriteRecords_RequestSyntax"></a>

```
{
   "CommonAttributes": { 
      "Dimensions": [ 
         { 
            "DimensionValueType": "string",
            "Name": "string",
            "Value": "string"
         }
      ],
      "MeasureName": "string",
      "MeasureValue": "string",
      "MeasureValues": [ 
         { 
            "Name": "string",
            "Type": "string",
            "Value": "string"
         }
      ],
      "MeasureValueType": "string",
      "Time": "string",
      "TimeUnit": "string",
      "Version": number
   },
   "DatabaseName": "string",
   "Records": [ 
      { 
         "Dimensions": [ 
            { 
               "DimensionValueType": "string",
               "Name": "string",
               "Value": "string"
            }
         ],
         "MeasureName": "string",
         "MeasureValue": "string",
         "MeasureValues": [ 
            { 
               "Name": "string",
               "Type": "string",
               "Value": "string"
            }
         ],
         "MeasureValueType": "string",
         "Time": "string",
         "TimeUnit": "string",
         "Version": number
      }
   ],
   "TableName": "string"
}
```

## Request Parameters
<a name="API_WriteRecords_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [CommonAttributes](#API_WriteRecords_RequestSyntax) **   <a name="timestream-WriteRecords-request-CommonAttributes"></a>
A record that contains the common measure, dimension, time, and version attributes shared across all the records in the request. The measure and dimension attributes specified will be merged with the measure and dimension attributes in the records object when the data is written into Timestream. Dimensions may not overlap, or a `ValidationException` will be thrown. In other words, a record must contain dimensions with unique names.   
Type: [Record](API_Record.md) object  
Required: No

 ** [DatabaseName](#API_WriteRecords_RequestSyntax) **   <a name="timestream-WriteRecords-request-DatabaseName"></a>
The name of the Timestream database.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 256.  
Required: Yes

 ** [Records](#API_WriteRecords_RequestSyntax) **   <a name="timestream-WriteRecords-request-Records"></a>
An array of records that contain the unique measure, dimension, time, and version attributes for each time-series data point.  
Type: Array of [Record](API_Record.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 100 items.  
Required: Yes

 ** [TableName](#API_WriteRecords_RequestSyntax) **   <a name="timestream-WriteRecords-request-TableName"></a>
The name of the Timestream table.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 256.  
Required: Yes

## Response Syntax
<a name="API_WriteRecords_ResponseSyntax"></a>

```
{
   "RecordsIngested": { 
      "MagneticStore": number,
      "MemoryStore": number,
      "Total": number
   }
}
```

## Response Elements
<a name="API_WriteRecords_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [RecordsIngested](#API_WriteRecords_ResponseSyntax) **   <a name="timestream-WriteRecords-response-RecordsIngested"></a>
Information on the records ingested by this request.  
Type: [RecordsIngested](API_RecordsIngested.md) object

## Errors
<a name="API_WriteRecords_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You are not authorized to perform this action.  
HTTP Status Code: 400

 ** InternalServerException **   
 Timestream was unable to fully process this request because of an internal server error.  
HTTP Status Code: 500

 ** InvalidEndpointException **   
The requested endpoint was not valid.  
HTTP Status Code: 400

 ** RejectedRecordsException **   
 WriteRecords would throw this exception in the following cases:   
+ 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

   In this case, if Timestream rejects data, 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. 
+  Records with dimensions or measures that exceed the Timestream defined limits. 
 For more information, see [Quotas](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html) in the Amazon Timestream Developer Guide.     
 ** RejectedRecords **   
 
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.  
HTTP Status Code: 400

 ** ThrottlingException **   
 Too many requests were made by a user and they exceeded the service quotas. The request was throttled.  
HTTP Status Code: 400

 ** ValidationException **   
 An invalid or malformed request.  
HTTP Status Code: 400

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/WriteRecords) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/WriteRecords) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/WriteRecords) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/WriteRecords) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/WriteRecords) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/WriteRecords) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/WriteRecords) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/WriteRecords) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/WriteRecords) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/WriteRecords) 

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

The following actions are supported by Amazon Timestream Query:
+  [CancelQuery](API_query_CancelQuery.md) 
+  [CreateScheduledQuery](API_query_CreateScheduledQuery.md) 
+  [DeleteScheduledQuery](API_query_DeleteScheduledQuery.md) 
+  [DescribeAccountSettings](API_query_DescribeAccountSettings.md) 
+  [DescribeEndpoints](API_query_DescribeEndpoints.md) 
+  [DescribeScheduledQuery](API_query_DescribeScheduledQuery.md) 
+  [ExecuteScheduledQuery](API_query_ExecuteScheduledQuery.md) 
+  [ListScheduledQueries](API_query_ListScheduledQueries.md) 
+  [ListTagsForResource](API_query_ListTagsForResource.md) 
+  [PrepareQuery](API_query_PrepareQuery.md) 
+  [Query](API_query_Query.md) 
+  [TagResource](API_query_TagResource.md) 
+  [UntagResource](API_query_UntagResource.md) 
+  [UpdateAccountSettings](API_query_UpdateAccountSettings.md) 
+  [UpdateScheduledQuery](API_query_UpdateScheduledQuery.md) 

# CancelQuery
<a name="API_query_CancelQuery"></a>

 Cancels a query that has been issued. Cancellation is provided only if the query has not completed running before the cancellation request was issued. Because cancellation is an idempotent operation, subsequent cancellation requests will return a `CancellationMessage`, indicating that the query has already been canceled. See [code sample](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.cancel-query.html) for details. 

## Request Syntax
<a name="API_query_CancelQuery_RequestSyntax"></a>

```
{
   "QueryId": "string"
}
```

## Request Parameters
<a name="API_query_CancelQuery_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [QueryId](#API_query_CancelQuery_RequestSyntax) **   <a name="timestream-query_CancelQuery-request-QueryId"></a>
 The ID of the query that needs to be cancelled. `QueryID` is returned as part of the query result.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9]+`   
Required: Yes

## Response Syntax
<a name="API_query_CancelQuery_ResponseSyntax"></a>

```
{
   "CancellationMessage": "string"
}
```

## Response Elements
<a name="API_query_CancelQuery_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [CancellationMessage](#API_query_CancelQuery_ResponseSyntax) **   <a name="timestream-query_CancelQuery-response-CancellationMessage"></a>
 A `CancellationMessage` is returned when a `CancelQuery` request for the query specified by `QueryId` has already been issued.   
Type: String

## Errors
<a name="API_query_CancelQuery_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have the necessary permissions to access the account settings.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request.  
HTTP Status Code: 400

 ** InvalidEndpointException **   
The requested endpoint is invalid.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to excessive requests.  
HTTP Status Code: 400

 ** ValidationException **   
 Invalid or malformed request.   
HTTP Status Code: 400

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/CancelQuery) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/CancelQuery) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/CancelQuery) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/CancelQuery) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/CancelQuery) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/CancelQuery) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/CancelQuery) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/CancelQuery) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/CancelQuery) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/CancelQuery) 

# CreateScheduledQuery
<a name="API_query_CreateScheduledQuery"></a>

 Create a scheduled query that will be run on your behalf at the configured schedule. Timestream assumes the execution role provided as part of the `ScheduledQueryExecutionRoleArn` parameter to run the query. You can use the `NotificationConfiguration` parameter to configure notification for your scheduled query operations.

## Request Syntax
<a name="API_query_CreateScheduledQuery_RequestSyntax"></a>

```
{
   "ClientToken": "string",
   "ErrorReportConfiguration": { 
      "S3Configuration": { 
         "BucketName": "string",
         "EncryptionOption": "string",
         "ObjectKeyPrefix": "string"
      }
   },
   "KmsKeyId": "string",
   "Name": "string",
   "NotificationConfiguration": { 
      "SnsConfiguration": { 
         "TopicArn": "string"
      }
   },
   "QueryString": "string",
   "ScheduleConfiguration": { 
      "ScheduleExpression": "string"
   },
   "ScheduledQueryExecutionRoleArn": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "TargetConfiguration": { 
      "TimestreamConfiguration": { 
         "DatabaseName": "string",
         "DimensionMappings": [ 
            { 
               "DimensionValueType": "string",
               "Name": "string"
            }
         ],
         "MeasureNameColumn": "string",
         "MixedMeasureMappings": [ 
            { 
               "MeasureName": "string",
               "MeasureValueType": "string",
               "MultiMeasureAttributeMappings": [ 
                  { 
                     "MeasureValueType": "string",
                     "SourceColumn": "string",
                     "TargetMultiMeasureAttributeName": "string"
                  }
               ],
               "SourceColumn": "string",
               "TargetMeasureName": "string"
            }
         ],
         "MultiMeasureMappings": { 
            "MultiMeasureAttributeMappings": [ 
               { 
                  "MeasureValueType": "string",
                  "SourceColumn": "string",
                  "TargetMultiMeasureAttributeName": "string"
               }
            ],
            "TargetMultiMeasureName": "string"
         },
         "TableName": "string",
         "TimeColumn": "string"
      }
   }
}
```

## Request Parameters
<a name="API_query_CreateScheduledQuery_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ClientToken](#API_query_CreateScheduledQuery_RequestSyntax) **   <a name="timestream-query_CreateScheduledQuery-request-ClientToken"></a>
Using a ClientToken makes the call to CreateScheduledQuery idempotent, in other words, making the same request repeatedly will produce the same result. Making multiple identical CreateScheduledQuery requests has the same effect as making a single request.   
+  If CreateScheduledQuery is called without a `ClientToken`, the Query SDK generates a `ClientToken` on your behalf.
+  After 8 hours, any request with the same `ClientToken` is treated as a new request. 
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 128.  
Required: No

 ** [ErrorReportConfiguration](#API_query_CreateScheduledQuery_RequestSyntax) **   <a name="timestream-query_CreateScheduledQuery-request-ErrorReportConfiguration"></a>
Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.   
Type: [ErrorReportConfiguration](API_query_ErrorReportConfiguration.md) object  
Required: Yes

 ** [KmsKeyId](#API_query_CreateScheduledQuery_RequestSyntax) **   <a name="timestream-query_CreateScheduledQuery-request-KmsKeyId"></a>
The Amazon KMS key used to encrypt the scheduled query resource, at-rest. If the Amazon KMS key is not specified, the scheduled query resource will be encrypted with a Timestream owned Amazon KMS key. To specify a KMS key, use the key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix the name with *alias/*   
If ErrorReportConfiguration uses `SSE_KMS` as encryption type, the same KmsKeyId is used to encrypt the error report at rest.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** [Name](#API_query_CreateScheduledQuery_RequestSyntax) **   <a name="timestream-query_CreateScheduledQuery-request-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](#API_query_CreateScheduledQuery_RequestSyntax) **   <a name="timestream-query_CreateScheduledQuery-request-NotificationConfiguration"></a>
Notification configuration for the scheduled query. A notification is sent by Timestream when a query run finishes, when the state is updated or when you delete it.   
Type: [NotificationConfiguration](API_query_NotificationConfiguration.md) object  
Required: Yes

 ** [QueryString](#API_query_CreateScheduledQuery_RequestSyntax) **   <a name="timestream-query_CreateScheduledQuery-request-QueryString"></a>
The query string to run. Parameter names can be specified in the query string `@` character followed by an identifier. The named Parameter `@scheduled_runtime` is reserved and can be used in the query to get the time at which the query is scheduled to run.  
The timestamp calculated according to the ScheduleConfiguration parameter, will be the value of `@scheduled_runtime` paramater for each query run. For example, consider an instance of a scheduled query executing on 2021-12-01 00:00:00. For this instance, the `@scheduled_runtime` parameter is initialized to the timestamp 2021-12-01 00:00:00 when invoking the query.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 262144.  
Required: Yes

 ** [ScheduleConfiguration](#API_query_CreateScheduledQuery_RequestSyntax) **   <a name="timestream-query_CreateScheduledQuery-request-ScheduleConfiguration"></a>
The schedule configuration for the query.  
Type: [ScheduleConfiguration](API_query_ScheduleConfiguration.md) object  
Required: Yes

 ** [ScheduledQueryExecutionRoleArn](#API_query_CreateScheduledQuery_RequestSyntax) **   <a name="timestream-query_CreateScheduledQuery-request-ScheduledQueryExecutionRoleArn"></a>
The ARN for the IAM role that Timestream will assume when running the scheduled query.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: Yes

 ** [Tags](#API_query_CreateScheduledQuery_RequestSyntax) **   <a name="timestream-query_CreateScheduledQuery-request-Tags"></a>
A list of key-value pairs to label the scheduled query.  
Type: Array of [Tag](API_query_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Required: No

 ** [TargetConfiguration](#API_query_CreateScheduledQuery_RequestSyntax) **   <a name="timestream-query_CreateScheduledQuery-request-TargetConfiguration"></a>
Configuration used for writing the result of a query.  
Type: [TargetConfiguration](API_query_TargetConfiguration.md) object  
Required: No

## Response Syntax
<a name="API_query_CreateScheduledQuery_ResponseSyntax"></a>

```
{
   "Arn": "string"
}
```

## Response Elements
<a name="API_query_CreateScheduledQuery_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_query_CreateScheduledQuery_ResponseSyntax) **   <a name="timestream-query_CreateScheduledQuery-response-Arn"></a>
ARN for the created scheduled query.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Errors
<a name="API_query_CreateScheduledQuery_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have the necessary permissions to access the account settings.  
HTTP Status Code: 400

 ** ConflictException **   
 Unable to poll results for a cancelled query.   
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request.  
HTTP Status Code: 400

 ** InvalidEndpointException **   
The requested endpoint is invalid.  
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
You have exceeded the service quota.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to excessive requests.  
HTTP Status Code: 400

 ** ValidationException **   
 Invalid or malformed request.   
HTTP Status Code: 400

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/CreateScheduledQuery) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/CreateScheduledQuery) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/CreateScheduledQuery) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/CreateScheduledQuery) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/CreateScheduledQuery) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/CreateScheduledQuery) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/CreateScheduledQuery) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/CreateScheduledQuery) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/CreateScheduledQuery) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/CreateScheduledQuery) 

# DeleteScheduledQuery
<a name="API_query_DeleteScheduledQuery"></a>

Deletes a given scheduled query. This is an irreversible operation. 

## Request Syntax
<a name="API_query_DeleteScheduledQuery_RequestSyntax"></a>

```
{
   "ScheduledQueryArn": "string"
}
```

## Request Parameters
<a name="API_query_DeleteScheduledQuery_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ScheduledQueryArn](#API_query_DeleteScheduledQuery_RequestSyntax) **   <a name="timestream-query_DeleteScheduledQuery-request-ScheduledQueryArn"></a>
The ARN of the scheduled query.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: Yes

## Response Elements
<a name="API_query_DeleteScheduledQuery_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_query_DeleteScheduledQuery_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have the necessary permissions to access the account settings.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request.  
HTTP Status Code: 400

 ** InvalidEndpointException **   
The requested endpoint is invalid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource could not be found.    
 ** ScheduledQueryArn **   
The ARN of the scheduled query.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to excessive requests.  
HTTP Status Code: 400

 ** ValidationException **   
 Invalid or malformed request.   
HTTP Status Code: 400

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/DeleteScheduledQuery) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/DeleteScheduledQuery) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/DeleteScheduledQuery) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/DeleteScheduledQuery) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/DeleteScheduledQuery) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/DeleteScheduledQuery) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/DeleteScheduledQuery) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/DeleteScheduledQuery) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/DeleteScheduledQuery) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/DeleteScheduledQuery) 

# DescribeAccountSettings
<a name="API_query_DescribeAccountSettings"></a>

Describes the settings for your account that include the query pricing model and the configured maximum TCUs the service can use for your query workload.

You're charged only for the duration of compute units used for your workloads.

## Response Syntax
<a name="API_query_DescribeAccountSettings_ResponseSyntax"></a>

```
{
   "MaxQueryTCU": number,
   "QueryCompute": { 
      "ComputeMode": "string",
      "ProvisionedCapacity": { 
         "ActiveQueryTCU": number,
         "LastUpdate": { 
            "Status": "string",
            "StatusMessage": "string",
            "TargetQueryTCU": number
         },
         "NotificationConfiguration": { 
            "RoleArn": "string",
            "SnsConfiguration": { 
               "TopicArn": "string"
            }
         }
      }
   },
   "QueryPricingModel": "string"
}
```

## Response Elements
<a name="API_query_DescribeAccountSettings_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [MaxQueryTCU](#API_query_DescribeAccountSettings_ResponseSyntax) **   <a name="timestream-query_DescribeAccountSettings-response-MaxQueryTCU"></a>
The maximum number of [Timestream compute units](https://docs.aws.amazon.com/timestream/latest/developerguide/tcu.html) (TCUs) the service will use at any point in time to serve your queries. To run queries, you must set a minimum capacity of 4 TCU. You can set the maximum number of TCU in multiples of 4, for example, 4, 8, 16, 32, and so on. This configuration is applicable only for on-demand usage of (TCUs).   
Type: Integer

 ** [QueryCompute](#API_query_DescribeAccountSettings_ResponseSyntax) **   <a name="timestream-query_DescribeAccountSettings-response-QueryCompute"></a>
An object that contains the usage settings for Timestream Compute Units (TCUs) in your account for the query workload. QueryCompute is available only in the Asia Pacific (Mumbai) region.  
Type: [QueryComputeResponse](API_query_QueryComputeResponse.md) object

 ** [QueryPricingModel](#API_query_DescribeAccountSettings_ResponseSyntax) **   <a name="timestream-query_DescribeAccountSettings-response-QueryPricingModel"></a>
The pricing model for queries in your account.  
The `QueryPricingModel` parameter is used by several Timestream operations; however, the `UpdateAccountSettings` API operation doesn't recognize any values other than `COMPUTE_UNITS`.
Type: String  
Valid Values: `BYTES_SCANNED | COMPUTE_UNITS` 

## Errors
<a name="API_query_DescribeAccountSettings_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have the necessary permissions to access the account settings.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request.  
HTTP Status Code: 400

 ** InvalidEndpointException **   
The requested endpoint is invalid.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to excessive requests.  
HTTP Status Code: 400

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/DescribeAccountSettings) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/DescribeAccountSettings) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/DescribeAccountSettings) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/DescribeAccountSettings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/DescribeAccountSettings) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/DescribeAccountSettings) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/DescribeAccountSettings) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/DescribeAccountSettings) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/DescribeAccountSettings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/DescribeAccountSettings) 

# DescribeEndpoints
<a name="API_query_DescribeEndpoints"></a>

DescribeEndpoints returns a list of available endpoints to make Timestream API calls against. This API is available through both Write and Query.

Because the Timestream SDKs are designed to transparently work with the service’s architecture, including the management and mapping of the service endpoints, *it is not recommended that you use this API unless*:
+ You are using [VPC endpoints (AWS PrivateLink) with Timestream ](https://docs.aws.amazon.com/timestream/latest/developerguide/VPCEndpoints) 
+ Your application uses a programming language that does not yet have SDK support
+ You require better control over the client-side implementation

For detailed information on how and when to use and implement DescribeEndpoints, see [The Endpoint Discovery Pattern](https://docs.aws.amazon.com/timestream/latest/developerguide/Using.API.html#Using-API.endpoint-discovery).

## Response Syntax
<a name="API_query_DescribeEndpoints_ResponseSyntax"></a>

```
{
   "Endpoints": [ 
      { 
         "Address": "string",
         "CachePeriodInMinutes": number
      }
   ]
}
```

## Response Elements
<a name="API_query_DescribeEndpoints_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Endpoints](#API_query_DescribeEndpoints_ResponseSyntax) **   <a name="timestream-query_DescribeEndpoints-response-Endpoints"></a>
An `Endpoints` object is returned when a `DescribeEndpoints` request is made.  
Type: Array of [Endpoint](API_query_Endpoint.md) objects

## Errors
<a name="API_query_DescribeEndpoints_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
An internal server error occurred while processing the request.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to excessive requests.  
HTTP Status Code: 400

 ** ValidationException **   
 Invalid or malformed request.   
HTTP Status Code: 400

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/DescribeEndpoints) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/DescribeEndpoints) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/DescribeEndpoints) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/DescribeEndpoints) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/DescribeEndpoints) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/DescribeEndpoints) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/DescribeEndpoints) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/DescribeEndpoints) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/DescribeEndpoints) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/DescribeEndpoints) 

# DescribeScheduledQuery
<a name="API_query_DescribeScheduledQuery"></a>

Provides detailed information about a scheduled query.

## Request Syntax
<a name="API_query_DescribeScheduledQuery_RequestSyntax"></a>

```
{
   "ScheduledQueryArn": "string"
}
```

## Request Parameters
<a name="API_query_DescribeScheduledQuery_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ScheduledQueryArn](#API_query_DescribeScheduledQuery_RequestSyntax) **   <a name="timestream-query_DescribeScheduledQuery-request-ScheduledQueryArn"></a>
The ARN of the scheduled query.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: Yes

## Response Syntax
<a name="API_query_DescribeScheduledQuery_ResponseSyntax"></a>

```
{
   "ScheduledQuery": { 
      "Arn": "string",
      "CreationTime": number,
      "ErrorReportConfiguration": { 
         "S3Configuration": { 
            "BucketName": "string",
            "EncryptionOption": "string",
            "ObjectKeyPrefix": "string"
         }
      },
      "KmsKeyId": "string",
      "LastRunSummary": { 
         "ErrorReportLocation": { 
            "S3ReportLocation": { 
               "BucketName": "string",
               "ObjectKey": "string"
            }
         },
         "ExecutionStats": { 
            "BytesMetered": number,
            "CumulativeBytesScanned": number,
            "DataWrites": number,
            "ExecutionTimeInMillis": number,
            "QueryResultRows": number,
            "RecordsIngested": number
         },
         "FailureReason": "string",
         "InvocationTime": number,
         "QueryInsightsResponse": { 
            "OutputBytes": number,
            "OutputRows": number,
            "QuerySpatialCoverage": { 
               "Max": { 
                  "PartitionKey": [ "string" ],
                  "TableArn": "string",
                  "Value": number
               }
            },
            "QueryTableCount": number,
            "QueryTemporalRange": { 
               "Max": { 
                  "TableArn": "string",
                  "Value": number
               }
            }
         },
         "RunStatus": "string",
         "TriggerTime": number
      },
      "Name": "string",
      "NextInvocationTime": number,
      "NotificationConfiguration": { 
         "SnsConfiguration": { 
            "TopicArn": "string"
         }
      },
      "PreviousInvocationTime": number,
      "QueryString": "string",
      "RecentlyFailedRuns": [ 
         { 
            "ErrorReportLocation": { 
               "S3ReportLocation": { 
                  "BucketName": "string",
                  "ObjectKey": "string"
               }
            },
            "ExecutionStats": { 
               "BytesMetered": number,
               "CumulativeBytesScanned": number,
               "DataWrites": number,
               "ExecutionTimeInMillis": number,
               "QueryResultRows": number,
               "RecordsIngested": number
            },
            "FailureReason": "string",
            "InvocationTime": number,
            "QueryInsightsResponse": { 
               "OutputBytes": number,
               "OutputRows": number,
               "QuerySpatialCoverage": { 
                  "Max": { 
                     "PartitionKey": [ "string" ],
                     "TableArn": "string",
                     "Value": number
                  }
               },
               "QueryTableCount": number,
               "QueryTemporalRange": { 
                  "Max": { 
                     "TableArn": "string",
                     "Value": number
                  }
               }
            },
            "RunStatus": "string",
            "TriggerTime": number
         }
      ],
      "ScheduleConfiguration": { 
         "ScheduleExpression": "string"
      },
      "ScheduledQueryExecutionRoleArn": "string",
      "State": "string",
      "TargetConfiguration": { 
         "TimestreamConfiguration": { 
            "DatabaseName": "string",
            "DimensionMappings": [ 
               { 
                  "DimensionValueType": "string",
                  "Name": "string"
               }
            ],
            "MeasureNameColumn": "string",
            "MixedMeasureMappings": [ 
               { 
                  "MeasureName": "string",
                  "MeasureValueType": "string",
                  "MultiMeasureAttributeMappings": [ 
                     { 
                        "MeasureValueType": "string",
                        "SourceColumn": "string",
                        "TargetMultiMeasureAttributeName": "string"
                     }
                  ],
                  "SourceColumn": "string",
                  "TargetMeasureName": "string"
               }
            ],
            "MultiMeasureMappings": { 
               "MultiMeasureAttributeMappings": [ 
                  { 
                     "MeasureValueType": "string",
                     "SourceColumn": "string",
                     "TargetMultiMeasureAttributeName": "string"
                  }
               ],
               "TargetMultiMeasureName": "string"
            },
            "TableName": "string",
            "TimeColumn": "string"
         }
      }
   }
}
```

## Response Elements
<a name="API_query_DescribeScheduledQuery_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ScheduledQuery](#API_query_DescribeScheduledQuery_ResponseSyntax) **   <a name="timestream-query_DescribeScheduledQuery-response-ScheduledQuery"></a>
The scheduled query.  
Type: [ScheduledQueryDescription](API_query_ScheduledQueryDescription.md) object

## Errors
<a name="API_query_DescribeScheduledQuery_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have the necessary permissions to access the account settings.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request.  
HTTP Status Code: 400

 ** InvalidEndpointException **   
The requested endpoint is invalid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource could not be found.    
 ** ScheduledQueryArn **   
The ARN of the scheduled query.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to excessive requests.  
HTTP Status Code: 400

 ** ValidationException **   
 Invalid or malformed request.   
HTTP Status Code: 400

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/DescribeScheduledQuery) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/DescribeScheduledQuery) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/DescribeScheduledQuery) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/DescribeScheduledQuery) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/DescribeScheduledQuery) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/DescribeScheduledQuery) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/DescribeScheduledQuery) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/DescribeScheduledQuery) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/DescribeScheduledQuery) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/DescribeScheduledQuery) 

# ExecuteScheduledQuery
<a name="API_query_ExecuteScheduledQuery"></a>

 You can use this API to run a scheduled query manually. 

If you enabled `QueryInsights`, this API also returns insights and metrics related to the query that you executed as part of an Amazon SNS notification. `QueryInsights` helps with performance tuning of your query. For more information about `QueryInsights`, see [Using query insights to optimize queries in Amazon Timestream](https://docs.aws.amazon.com/timestream/latest/developerguide/using-query-insights.html).

## Request Syntax
<a name="API_query_ExecuteScheduledQuery_RequestSyntax"></a>

```
{
   "ClientToken": "string",
   "InvocationTime": number,
   "QueryInsights": { 
      "Mode": "string"
   },
   "ScheduledQueryArn": "string"
}
```

## Request Parameters
<a name="API_query_ExecuteScheduledQuery_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ClientToken](#API_query_ExecuteScheduledQuery_RequestSyntax) **   <a name="timestream-query_ExecuteScheduledQuery-request-ClientToken"></a>
Not used.   
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 128.  
Required: No

 ** [InvocationTime](#API_query_ExecuteScheduledQuery_RequestSyntax) **   <a name="timestream-query_ExecuteScheduledQuery-request-InvocationTime"></a>
The timestamp in UTC. Query will be run as if it was invoked at this timestamp.   
Type: Timestamp  
Required: Yes

 ** [QueryInsights](#API_query_ExecuteScheduledQuery_RequestSyntax) **   <a name="timestream-query_ExecuteScheduledQuery-request-QueryInsights"></a>
Encapsulates settings for enabling `QueryInsights`.  
Enabling `QueryInsights` returns insights and metrics as a part of the Amazon SNS notification for the query that you executed. You can use `QueryInsights` to tune your query performance and cost.  
Type: [ScheduledQueryInsights](API_query_ScheduledQueryInsights.md) object  
Required: No

 ** [ScheduledQueryArn](#API_query_ExecuteScheduledQuery_RequestSyntax) **   <a name="timestream-query_ExecuteScheduledQuery-request-ScheduledQueryArn"></a>
ARN of the scheduled query.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: Yes

## Response Elements
<a name="API_query_ExecuteScheduledQuery_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_query_ExecuteScheduledQuery_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have the necessary permissions to access the account settings.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request.  
HTTP Status Code: 400

 ** InvalidEndpointException **   
The requested endpoint is invalid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource could not be found.    
 ** ScheduledQueryArn **   
The ARN of the scheduled query.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to excessive requests.  
HTTP Status Code: 400

 ** ValidationException **   
 Invalid or malformed request.   
HTTP Status Code: 400

## Examples
<a name="API_query_ExecuteScheduledQuery_Examples"></a>

### Scheduled query notification message for the ENABLED\$1WITH\$1RATE\$1CONTROL mode
<a name="API_query_ExecuteScheduledQuery_Example_1"></a>

The following example shows a successful scheduled query notification message for the `ENABLED_WITH_RATE_CONTROL` mode of the `QueryInsights` parameter.

```
"SuccessNotificationMessage": {
    "type": "MANUAL_TRIGGER_SUCCESS",
    "arn": "arn:aws:timestream:<Region>:<Account>:scheduled-query/sq-test-49c6ed55-c2e7-4cc2-9956-4a0ecea13420-80e05b035236a4c3",
    "scheduledQueryRunSummary": {
        "invocationEpochSecond": 1723710546,
        "triggerTimeMillis": 1723710547490,
        "runStatus": "MANUAL_TRIGGER_SUCCESS",
        "executionStats": {
            "executionTimeInMillis": 17343,
            "dataWrites": 1024,
            "bytesMetered": 0,
            "cumulativeBytesScanned": 600,
            "recordsIngested": 1,
            "queryResultRows": 1
        },
        "queryInsightsResponse": {
            "querySpatialCoverage": {
                "max": {
                    "value": 1.0,
                    "tableArn": "arn:aws:timestream:<Region>:<Account>:database/BaseDb/table/BaseTable",
                    "partitionKey": [
                        "measure_name"
                    ]
                }
            },
            "queryTemporalRange": {
                "max": {
                    "value": 2399999999999,
                    "tableArn": "arn:aws:timestream:<Region>:<Account>:database/BaseDb/table/BaseTable"
                }
            },
            "queryTableCount": 1,
            "outputRows": 1,
            "outputBytes": 59
        }
    }
}
```

### Scheduled query notification message for the DISABLED mode
<a name="API_query_ExecuteScheduledQuery_Example_2"></a>

The following example shows a successful scheduled query notification message for the `DISABLED` mode of the `QueryInsights` parameter.

```
"SuccessNotificationMessage": {
    "type": "MANUAL_TRIGGER_SUCCESS",
    "arn": "arn:aws:timestream:<Region>:<Account>:scheduled-query/sq-test-fa109d9e-6528-4a0d-ac40-482fa05e657f-140faaeecdc5b2a7",
    "scheduledQueryRunSummary": {
        "invocationEpochSecond": 1723711401,
        "triggerTimeMillis": 1723711402144,
        "runStatus": "MANUAL_TRIGGER_SUCCESS",
        "executionStats": {
            "executionTimeInMillis": 17992,
            "dataWrites": 1024,
            "bytesMetered": 0,
            "cumulativeBytesScanned": 600,
            "recordsIngested": 1,
            "queryResultRows": 1
        }
    }
}
```

### Failure notification message for the ENABLED\$1WITH\$1RATE\$1CONTROL mode
<a name="API_query_ExecuteScheduledQuery_Example_3"></a>

The following example shows a failed scheduled query notification message for the `ENABLED_WITH_RATE_CONTROL` mode of the `QueryInsights` parameter.

```
"FailureNotificationMessage": {
    "type": "MANUAL_TRIGGER_FAILURE",
    "arn": "arn:aws:timestream:<Region>:<Account>:scheduled-query/sq-test-b261670d-790c-4116-9db5-0798071b18b1-b7e27a1d79be226d",
    "scheduledQueryRunSummary": {
        "invocationEpochSecond": 1727915513,
        "triggerTimeMillis": 1727915513894,
        "runStatus": "MANUAL_TRIGGER_FAILURE",
        "executionStats": {
            "executionTimeInMillis": 10777,
            "dataWrites": 0,
            "bytesMetered": 0,
            "cumulativeBytesScanned": 0,
            "recordsIngested": 0,
            "queryResultRows": 4
        },
        "errorReportLocation": {
            "s3ReportLocation": {
                "bucketName": "amzn-s3-demo-bucket",
                "objectKey": "4my-organization-f7a3c5d065a1a95e/1727915513/MANUAL/1727915513894/5e14b3df-b147-49f4-9331-784f749b68ae"
            }
        },
        "failureReason": "Schedule encountered some errors and is incomplete. Please take a look at error report for further details"
    }
}
```

### Failure notification message for the DISABLED mode
<a name="API_query_ExecuteScheduledQuery_Example_4"></a>

The following example shows a failed scheduled query notification message for the `DISABLED` mode of the `QueryInsights` parameter.

```
"FailureNotificationMessage": {
    "type": "MANUAL_TRIGGER_FAILURE",
    "arn": "arn:aws:timestream:<Region>:<Account>:scheduled-query/sq-test-b261670d-790c-4116-9db5-0798071b18b1-b7e27a1d79be226d",
    "scheduledQueryRunSummary": {
        "invocationEpochSecond": 1727915194,
        "triggerTimeMillis": 1727915195119,
        "runStatus": "MANUAL_TRIGGER_FAILURE",
        "executionStats": {
            "executionTimeInMillis": 10777,
            "dataWrites": 0,
            "bytesMetered": 0,
            "cumulativeBytesScanned": 0,
            "recordsIngested": 0,
            "queryResultRows": 4
        },
        "errorReportLocation": {
            "s3ReportLocation": {
                "bucketName": "amzn-s3-demo-bucket",
                "objectKey": "4my-organization-b7e27a1d79be226d/1727915194/MANUAL/1727915195119/08dea9f5-9a0a-4e63-a5f7-ded23247bb98"
            }
        },
        "failureReason": "Schedule encountered some errors and is incomplete. Please take a look at error report for further details"
    }
}
```

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/ExecuteScheduledQuery) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/ExecuteScheduledQuery) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/ExecuteScheduledQuery) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/ExecuteScheduledQuery) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/ExecuteScheduledQuery) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/ExecuteScheduledQuery) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/ExecuteScheduledQuery) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/ExecuteScheduledQuery) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/ExecuteScheduledQuery) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/ExecuteScheduledQuery) 

# ListScheduledQueries
<a name="API_query_ListScheduledQueries"></a>

Gets a list of all scheduled queries in the caller's Amazon account and Region. `ListScheduledQueries` is eventually consistent. 

## Request Syntax
<a name="API_query_ListScheduledQueries_RequestSyntax"></a>

```
{
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_query_ListScheduledQueries_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [MaxResults](#API_query_ListScheduledQueries_RequestSyntax) **   <a name="timestream-query_ListScheduledQueries-request-MaxResults"></a>
The maximum number of items to return in the output. If the total number of items available is more than the value specified, a `NextToken` is provided in the output. To resume pagination, provide the `NextToken` value as the argument to the subsequent call to `ListScheduledQueriesRequest`.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 1000.  
Required: No

 ** [NextToken](#API_query_ListScheduledQueries_RequestSyntax) **   <a name="timestream-query_ListScheduledQueries-request-NextToken"></a>
 A pagination token to resume pagination.  
Type: String  
Required: No

## Response Syntax
<a name="API_query_ListScheduledQueries_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "ScheduledQueries": [ 
      { 
         "Arn": "string",
         "CreationTime": number,
         "ErrorReportConfiguration": { 
            "S3Configuration": { 
               "BucketName": "string",
               "EncryptionOption": "string",
               "ObjectKeyPrefix": "string"
            }
         },
         "LastRunStatus": "string",
         "Name": "string",
         "NextInvocationTime": number,
         "PreviousInvocationTime": number,
         "State": "string",
         "TargetDestination": { 
            "TimestreamDestination": { 
               "DatabaseName": "string",
               "TableName": "string"
            }
         }
      }
   ]
}
```

## Response Elements
<a name="API_query_ListScheduledQueries_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_query_ListScheduledQueries_ResponseSyntax) **   <a name="timestream-query_ListScheduledQueries-response-NextToken"></a>
A token to specify where to start paginating. This is the NextToken from a previously truncated response.  
Type: String

 ** [ScheduledQueries](#API_query_ListScheduledQueries_ResponseSyntax) **   <a name="timestream-query_ListScheduledQueries-response-ScheduledQueries"></a>
A list of scheduled queries.  
Type: Array of [ScheduledQuery](API_query_ScheduledQuery.md) objects

## Errors
<a name="API_query_ListScheduledQueries_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have the necessary permissions to access the account settings.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request.  
HTTP Status Code: 400

 ** InvalidEndpointException **   
The requested endpoint is invalid.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to excessive requests.  
HTTP Status Code: 400

 ** ValidationException **   
 Invalid or malformed request.   
HTTP Status Code: 400

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/ListScheduledQueries) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/ListScheduledQueries) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/ListScheduledQueries) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/ListScheduledQueries) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/ListScheduledQueries) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/ListScheduledQueries) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/ListScheduledQueries) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/ListScheduledQueries) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/ListScheduledQueries) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/ListScheduledQueries) 

# ListTagsForResource
<a name="API_query_ListTagsForResource"></a>

List all tags on a Timestream query resource.

## Request Syntax
<a name="API_query_ListTagsForResource_RequestSyntax"></a>

```
{
   "MaxResults": number,
   "NextToken": "string",
   "ResourceARN": "string"
}
```

## Request Parameters
<a name="API_query_ListTagsForResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [MaxResults](#API_query_ListTagsForResource_RequestSyntax) **   <a name="timestream-query_ListTagsForResource-request-MaxResults"></a>
The maximum number of tags to return.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 200.  
Required: No

 ** [NextToken](#API_query_ListTagsForResource_RequestSyntax) **   <a name="timestream-query_ListTagsForResource-request-NextToken"></a>
A pagination token to resume pagination.  
Type: String  
Required: No

 ** [ResourceARN](#API_query_ListTagsForResource_RequestSyntax) **   <a name="timestream-query_ListTagsForResource-request-ResourceARN"></a>
The Timestream resource with tags to be listed. This value is an Amazon Resource Name (ARN).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: Yes

## Response Syntax
<a name="API_query_ListTagsForResource_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Response Elements
<a name="API_query_ListTagsForResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_query_ListTagsForResource_ResponseSyntax) **   <a name="timestream-query_ListTagsForResource-response-NextToken"></a>
A pagination token to resume pagination with a subsequent call to `ListTagsForResourceResponse`.  
Type: String

 ** [Tags](#API_query_ListTagsForResource_ResponseSyntax) **   <a name="timestream-query_ListTagsForResource-response-Tags"></a>
The tags currently associated with the Timestream resource.   
Type: Array of [Tag](API_query_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.

## Errors
<a name="API_query_ListTagsForResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidEndpointException **   
The requested endpoint is invalid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource could not be found.    
 ** ScheduledQueryArn **   
The ARN of the scheduled query.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to excessive requests.  
HTTP Status Code: 400

 ** ValidationException **   
 Invalid or malformed request.   
HTTP Status Code: 400

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/ListTagsForResource) 

# PrepareQuery
<a name="API_query_PrepareQuery"></a>

A synchronous operation that allows you to submit a query with parameters to be stored by Timestream for later running. Timestream only supports using this operation with `ValidateOnly` set to `true`. 

## Request Syntax
<a name="API_query_PrepareQuery_RequestSyntax"></a>

```
{
   "QueryString": "string",
   "ValidateOnly": boolean
}
```

## Request Parameters
<a name="API_query_PrepareQuery_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [QueryString](#API_query_PrepareQuery_RequestSyntax) **   <a name="timestream-query_PrepareQuery-request-QueryString"></a>
The Timestream query string that you want to use as a prepared statement. Parameter names can be specified in the query string `@` character followed by an identifier.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 262144.  
Required: Yes

 ** [ValidateOnly](#API_query_PrepareQuery_RequestSyntax) **   <a name="timestream-query_PrepareQuery-request-ValidateOnly"></a>
By setting this value to `true`, Timestream will only validate that the query string is a valid Timestream query, and not store the prepared query for later use.  
Type: Boolean  
Required: No

## Response Syntax
<a name="API_query_PrepareQuery_ResponseSyntax"></a>

```
{
   "Columns": [ 
      { 
         "Aliased": boolean,
         "DatabaseName": "string",
         "Name": "string",
         "TableName": "string",
         "Type": { 
            "ArrayColumnInfo": { 
               "Name": "string",
               "Type": "Type"
            },
            "RowColumnInfo": [ 
               { 
                  "Name": "string",
                  "Type": "Type"
               }
            ],
            "ScalarType": "string",
            "TimeSeriesMeasureValueColumnInfo": { 
               "Name": "string",
               "Type": "Type"
            }
         }
      }
   ],
   "Parameters": [ 
      { 
         "Name": "string",
         "Type": { 
            "ArrayColumnInfo": { 
               "Name": "string",
               "Type": "Type"
            },
            "RowColumnInfo": [ 
               { 
                  "Name": "string",
                  "Type": "Type"
               }
            ],
            "ScalarType": "string",
            "TimeSeriesMeasureValueColumnInfo": { 
               "Name": "string",
               "Type": "Type"
            }
         }
      }
   ],
   "QueryString": "string"
}
```

## Response Elements
<a name="API_query_PrepareQuery_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Columns](#API_query_PrepareQuery_ResponseSyntax) **   <a name="timestream-query_PrepareQuery-response-Columns"></a>
A list of SELECT clause columns of the submitted query string.   
Type: Array of [SelectColumn](API_query_SelectColumn.md) objects

 ** [Parameters](#API_query_PrepareQuery_ResponseSyntax) **   <a name="timestream-query_PrepareQuery-response-Parameters"></a>
A list of parameters used in the submitted query string.   
Type: Array of [ParameterMapping](API_query_ParameterMapping.md) objects

 ** [QueryString](#API_query_PrepareQuery_ResponseSyntax) **   <a name="timestream-query_PrepareQuery-response-QueryString"></a>
The query string that you want prepare.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 262144.

## Errors
<a name="API_query_PrepareQuery_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have the necessary permissions to access the account settings.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request.  
HTTP Status Code: 400

 ** InvalidEndpointException **   
The requested endpoint is invalid.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to excessive requests.  
HTTP Status Code: 400

 ** ValidationException **   
 Invalid or malformed request.   
HTTP Status Code: 400

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/PrepareQuery) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/PrepareQuery) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/PrepareQuery) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/PrepareQuery) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/PrepareQuery) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/PrepareQuery) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/PrepareQuery) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/PrepareQuery) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/PrepareQuery) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/PrepareQuery) 

# Query
<a name="API_query_Query"></a>

 `Query` is a synchronous operation that enables you to run a query against your Amazon Timestream data.

If you enabled `QueryInsights`, this API also returns insights and metrics related to the query that you executed. `QueryInsights` helps with performance tuning of your query. For more information about `QueryInsights`, see [Using query insights to optimize queries in Amazon Timestream](https://docs.aws.amazon.com/timestream/latest/developerguide/using-query-insights.html).

**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.

 `Query` will time out after 60 seconds. You must update the default timeout in the SDK to support a timeout of 60 seconds. See the [code sample](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.run-query.html) for details. 

Your query request will fail in the following cases:
+  If you submit a `Query` request with the same client token outside of the 5-minute idempotency window. 
+  If you submit a `Query` request with the same client token, but change other parameters, within the 5-minute idempotency window. 
+  If the size of the row (including the query metadata) exceeds 1 MB, then the query will fail with the following error message: 

   `Query aborted as max page response size has been exceeded by the output result row` 
+  If the IAM principal of the query initiator and the result reader are not the same and/or the query initiator and the result reader do not have the same query string in the query requests, the query will fail with an `Invalid pagination token` error. 

## Request Syntax
<a name="API_query_Query_RequestSyntax"></a>

```
{
   "ClientToken": "string",
   "MaxRows": number,
   "NextToken": "string",
   "QueryInsights": { 
      "Mode": "string"
   },
   "QueryString": "string"
}
```

## Request Parameters
<a name="API_query_Query_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ClientToken](#API_query_Query_RequestSyntax) **   <a name="timestream-query_Query-request-ClientToken"></a>
 Unique, case-sensitive string of up to 64 ASCII characters specified when a `Query` request is made. Providing a `ClientToken` makes the call to `Query` *idempotent*. This means that running the same query repeatedly will produce the same result. In other words, making multiple identical `Query` requests has the same effect as making a single request. When using `ClientToken` in a query, note the following:   
+  If the Query API is instantiated without a `ClientToken`, the Query SDK generates a `ClientToken` on your behalf.
+ If the `Query` invocation only contains the `ClientToken` but does not include a `NextToken`, that invocation of `Query` is assumed to be a new query run.
+ If the invocation contains `NextToken`, that particular invocation is assumed to be a subsequent invocation of a prior call to the Query API, and a result set is returned.
+  After 4 hours, any request with the same `ClientToken` is treated as a new request. 
Type: String  
Length Constraints: Minimum length of 32. Maximum length of 128.  
Required: No

 ** [MaxRows](#API_query_Query_RequestSyntax) **   <a name="timestream-query_Query-request-MaxRows"></a>
 The total number of rows to be returned in the `Query` output. The initial run of `Query` with a `MaxRows` value specified will return the result set of the query in two cases:   
+ The size of the result is less than `1MB`.
+ The number of rows in the result set is less than the value of `maxRows`.
Otherwise, the initial invocation of `Query` only returns a `NextToken`, which can then be used in subsequent calls to fetch the result set. To resume pagination, provide the `NextToken` value in the subsequent command.  
If the row size is large (e.g. a row has many columns), Timestream may return fewer rows to keep the response size from exceeding the 1 MB limit. If `MaxRows` is not provided, Timestream will send the necessary number of rows to meet the 1 MB limit.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 1000.  
Required: No

 ** [NextToken](#API_query_Query_RequestSyntax) **   <a name="timestream-query_Query-request-NextToken"></a>
 A pagination token used to return a set of results. When the `Query` API is invoked using `NextToken`, that particular invocation is assumed to be a subsequent invocation of a prior call to `Query`, and a result set is returned. However, if the `Query` invocation only contains the `ClientToken`, that invocation of `Query` is assumed to be a new query run.   
Note the following when using NextToken in a query:  
+ A pagination token can be used for up to five `Query` invocations, OR for a duration of up to 1 hour – whichever comes first.
+ Using the same `NextToken` will return the same set of records. To keep paginating through the result set, you must to use the most recent `nextToken`.
+ Suppose a `Query` invocation returns two `NextToken` values, `TokenA` and `TokenB`. If `TokenB` is used in a subsequent `Query` invocation, then `TokenA` is invalidated and cannot be reused.
+ To request a previous result set from a query after pagination has begun, you must re-invoke the Query API.
+ The latest `NextToken` should be used to paginate until `null` is returned, at which point a new `NextToken` should be used.
+  If the IAM principal of the query initiator and the result reader are not the same and/or the query initiator and the result reader do not have the same query string in the query requests, the query will fail with an `Invalid pagination token` error. 
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** [QueryInsights](#API_query_Query_RequestSyntax) **   <a name="timestream-query_Query-request-QueryInsights"></a>
Encapsulates settings for enabling `QueryInsights`.  
Enabling `QueryInsights` returns insights and metrics in addition to query results for the query that you executed. You can use `QueryInsights` to tune your query performance.  
Type: [QueryInsights](API_query_QueryInsights.md) object  
Required: No

 ** [QueryString](#API_query_Query_RequestSyntax) **   <a name="timestream-query_Query-request-QueryString"></a>
 The query to be run by Timestream.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 262144.  
Required: Yes

## Response Syntax
<a name="API_query_Query_ResponseSyntax"></a>

```
{
   "ColumnInfo": [ 
      { 
         "Name": "string",
         "Type": { 
            "ArrayColumnInfo": "ColumnInfo",
            "RowColumnInfo": [ 
               "ColumnInfo"
            ],
            "ScalarType": "string",
            "TimeSeriesMeasureValueColumnInfo": "ColumnInfo"
         }
      }
   ],
   "NextToken": "string",
   "QueryId": "string",
   "QueryInsightsResponse": { 
      "OutputBytes": number,
      "OutputRows": number,
      "QuerySpatialCoverage": { 
         "Max": { 
            "PartitionKey": [ "string" ],
            "TableArn": "string",
            "Value": number
         }
      },
      "QueryTableCount": number,
      "QueryTemporalRange": { 
         "Max": { 
            "TableArn": "string",
            "Value": number
         }
      },
      "UnloadPartitionCount": number,
      "UnloadWrittenBytes": number,
      "UnloadWrittenRows": number
   },
   "QueryStatus": { 
      "CumulativeBytesMetered": number,
      "CumulativeBytesScanned": number,
      "ProgressPercentage": number
   },
   "Rows": [ 
      { 
         "Data": [ 
            { 
               "ArrayValue": [ 
                  "Datum"
               ],
               "NullValue": boolean,
               "RowValue": "Row",
               "ScalarValue": "string",
               "TimeSeriesValue": [ 
                  { 
                     "Time": "string",
                     "Value": "Datum"
                  }
               ]
            }
         ]
      }
   ]
}
```

## Response Elements
<a name="API_query_Query_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ColumnInfo](#API_query_Query_ResponseSyntax) **   <a name="timestream-query_Query-response-ColumnInfo"></a>
 The column data types of the returned result set.   
Type: Array of [ColumnInfo](API_query_ColumnInfo.md) objects

 ** [NextToken](#API_query_Query_ResponseSyntax) **   <a name="timestream-query_Query-response-NextToken"></a>
 A pagination token that can be used again on a `Query` call to get the next set of results.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

 ** [QueryId](#API_query_Query_ResponseSyntax) **   <a name="timestream-query_Query-response-QueryId"></a>
 A unique ID for the given query.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9]+` 

 ** [QueryInsightsResponse](#API_query_Query_ResponseSyntax) **   <a name="timestream-query_Query-response-QueryInsightsResponse"></a>
Encapsulates `QueryInsights` containing insights and metrics related to the query that you executed.  
Type: [QueryInsightsResponse](API_query_QueryInsightsResponse.md) object

 ** [QueryStatus](#API_query_Query_ResponseSyntax) **   <a name="timestream-query_Query-response-QueryStatus"></a>
Information about the status of the query, including progress and bytes scanned.  
Type: [QueryStatus](API_query_QueryStatus.md) object

 ** [Rows](#API_query_Query_ResponseSyntax) **   <a name="timestream-query_Query-response-Rows"></a>
 The result set rows returned by the query.   
Type: Array of [Row](API_query_Row.md) objects

## Errors
<a name="API_query_Query_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have the necessary permissions to access the account settings.  
HTTP Status Code: 400

 ** ConflictException **   
 Unable to poll results for a cancelled query.   
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request.  
HTTP Status Code: 400

 ** InvalidEndpointException **   
The requested endpoint is invalid.  
HTTP Status Code: 400

 ** QueryExecutionException **   
 Timestream was unable to run the query successfully.   
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to excessive requests.  
HTTP Status Code: 400

 ** ValidationException **   
 Invalid or malformed request.   
HTTP Status Code: 400

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/Query) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/Query) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/Query) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/Query) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/Query) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/Query) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/Query) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/Query) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/Query) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/Query) 

# TagResource
<a name="API_query_TagResource"></a>

Associate a set of tags with a Timestream resource. You can then activate these user-defined tags so that they appear on the Billing and Cost Management console for cost allocation tracking. 

## Request Syntax
<a name="API_query_TagResource_RequestSyntax"></a>

```
{
   "ResourceARN": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_query_TagResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ResourceARN](#API_query_TagResource_RequestSyntax) **   <a name="timestream-query_TagResource-request-ResourceARN"></a>
Identifies the Timestream resource to which tags should be added. This value is an Amazon Resource Name (ARN).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: Yes

 ** [Tags](#API_query_TagResource_RequestSyntax) **   <a name="timestream-query_TagResource-request-Tags"></a>
The tags to be assigned to the Timestream resource.  
Type: Array of [Tag](API_query_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Required: Yes

## Response Elements
<a name="API_query_TagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_query_TagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidEndpointException **   
The requested endpoint is invalid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource could not be found.    
 ** ScheduledQueryArn **   
The ARN of the scheduled query.
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
You have exceeded the service quota.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to excessive requests.  
HTTP Status Code: 400

 ** ValidationException **   
 Invalid or malformed request.   
HTTP Status Code: 400

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/TagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/TagResource) 

# UntagResource
<a name="API_query_UntagResource"></a>

Removes the association of tags from a Timestream query resource.

## Request Syntax
<a name="API_query_UntagResource_RequestSyntax"></a>

```
{
   "ResourceARN": "string",
   "TagKeys": [ "string" ]
}
```

## Request Parameters
<a name="API_query_UntagResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ResourceARN](#API_query_UntagResource_RequestSyntax) **   <a name="timestream-query_UntagResource-request-ResourceARN"></a>
The Timestream resource that the tags will be removed from. This value is an Amazon Resource Name (ARN).   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: Yes

 ** [TagKeys](#API_query_UntagResource_RequestSyntax) **   <a name="timestream-query_UntagResource-request-TagKeys"></a>
A list of tags keys. Existing tags of the resource whose keys are members of this list will be removed from the Timestream resource.   
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: Yes

## Response Elements
<a name="API_query_UntagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_query_UntagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidEndpointException **   
The requested endpoint is invalid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource could not be found.    
 ** ScheduledQueryArn **   
The ARN of the scheduled query.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to excessive requests.  
HTTP Status Code: 400

 ** ValidationException **   
 Invalid or malformed request.   
HTTP Status Code: 400

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/UntagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/UntagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/UntagResource) 

# UpdateAccountSettings
<a name="API_query_UpdateAccountSettings"></a>

Transitions your account to use TCUs for query pricing and modifies the maximum query compute units that you've configured. If you reduce the value of `MaxQueryTCU` to a desired configuration, the new value can take up to 24 hours to be effective.

**Note**  
After you've transitioned your account to use TCUs for query pricing, you can't transition to using bytes scanned for query pricing.

## Request Syntax
<a name="API_query_UpdateAccountSettings_RequestSyntax"></a>

```
{
   "MaxQueryTCU": number,
   "QueryCompute": { 
      "ComputeMode": "string",
      "ProvisionedCapacity": { 
         "NotificationConfiguration": { 
            "RoleArn": "string",
            "SnsConfiguration": { 
               "TopicArn": "string"
            }
         },
         "TargetQueryTCU": number
      }
   },
   "QueryPricingModel": "string"
}
```

## Request Parameters
<a name="API_query_UpdateAccountSettings_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [MaxQueryTCU](#API_query_UpdateAccountSettings_RequestSyntax) **   <a name="timestream-query_UpdateAccountSettings-request-MaxQueryTCU"></a>
The maximum number of compute units the service will use at any point in time to serve your queries. To run queries, you must set a minimum capacity of 4 TCU. You can set the maximum number of TCU in multiples of 4, for example, 4, 8, 16, 32, and so on. The maximum value supported for `MaxQueryTCU` is 1000. To request an increase to this soft limit, contact AWS Support. For information about the default quota for maxQueryTCU, see Default quotas. This configuration is applicable only for on-demand usage of Timestream Compute Units (TCUs).  
The maximum value supported for `MaxQueryTCU` is 1000. To request an increase to this soft limit, contact AWS Support. For information about the default quota for `maxQueryTCU`, see [Default quotas](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html#limits.default).  
Type: Integer  
Required: No

 ** [QueryCompute](#API_query_UpdateAccountSettings_RequestSyntax) **   <a name="timestream-query_UpdateAccountSettings-request-QueryCompute"></a>
Modifies the query compute settings configured in your account, including the query pricing model and provisioned Timestream Compute Units (TCUs) in your account. QueryCompute is available only in the Asia Pacific (Mumbai) region.  
This API is idempotent, meaning that making the same request multiple times will have the same effect as making the request once.
Type: [QueryComputeRequest](API_query_QueryComputeRequest.md) object  
Required: No

 ** [QueryPricingModel](#API_query_UpdateAccountSettings_RequestSyntax) **   <a name="timestream-query_UpdateAccountSettings-request-QueryPricingModel"></a>
The pricing model for queries in an account.  
The `QueryPricingModel` parameter is used by several Timestream operations; however, the `UpdateAccountSettings` API operation doesn't recognize any values other than `COMPUTE_UNITS`.
Type: String  
Valid Values: `BYTES_SCANNED | COMPUTE_UNITS`   
Required: No

## Response Syntax
<a name="API_query_UpdateAccountSettings_ResponseSyntax"></a>

```
{
   "MaxQueryTCU": number,
   "QueryCompute": { 
      "ComputeMode": "string",
      "ProvisionedCapacity": { 
         "ActiveQueryTCU": number,
         "LastUpdate": { 
            "Status": "string",
            "StatusMessage": "string",
            "TargetQueryTCU": number
         },
         "NotificationConfiguration": { 
            "RoleArn": "string",
            "SnsConfiguration": { 
               "TopicArn": "string"
            }
         }
      }
   },
   "QueryPricingModel": "string"
}
```

## Response Elements
<a name="API_query_UpdateAccountSettings_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [MaxQueryTCU](#API_query_UpdateAccountSettings_ResponseSyntax) **   <a name="timestream-query_UpdateAccountSettings-response-MaxQueryTCU"></a>
The configured maximum number of compute units the service will use at any point in time to serve your queries.  
Type: Integer

 ** [QueryCompute](#API_query_UpdateAccountSettings_ResponseSyntax) **   <a name="timestream-query_UpdateAccountSettings-response-QueryCompute"></a>
Confirms the updated account settings for querying data in your account. QueryCompute is available only in the Asia Pacific (Mumbai) region.  
Type: [QueryComputeResponse](API_query_QueryComputeResponse.md) object

 ** [QueryPricingModel](#API_query_UpdateAccountSettings_ResponseSyntax) **   <a name="timestream-query_UpdateAccountSettings-response-QueryPricingModel"></a>
The pricing model for an account.  
Type: String  
Valid Values: `BYTES_SCANNED | COMPUTE_UNITS` 

## Errors
<a name="API_query_UpdateAccountSettings_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have the necessary permissions to access the account settings.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request.  
HTTP Status Code: 400

 ** InvalidEndpointException **   
The requested endpoint is invalid.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to excessive requests.  
HTTP Status Code: 400

 ** ValidationException **   
 Invalid or malformed request.   
HTTP Status Code: 400

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/UpdateAccountSettings) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/UpdateAccountSettings) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/UpdateAccountSettings) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/UpdateAccountSettings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/UpdateAccountSettings) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/UpdateAccountSettings) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/UpdateAccountSettings) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/UpdateAccountSettings) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/UpdateAccountSettings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/UpdateAccountSettings) 

# UpdateScheduledQuery
<a name="API_query_UpdateScheduledQuery"></a>

Update a scheduled query.

## Request Syntax
<a name="API_query_UpdateScheduledQuery_RequestSyntax"></a>

```
{
   "ScheduledQueryArn": "string",
   "State": "string"
}
```

## Request Parameters
<a name="API_query_UpdateScheduledQuery_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ScheduledQueryArn](#API_query_UpdateScheduledQuery_RequestSyntax) **   <a name="timestream-query_UpdateScheduledQuery-request-ScheduledQueryArn"></a>
ARN of the scheuled query.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: Yes

 ** [State](#API_query_UpdateScheduledQuery_RequestSyntax) **   <a name="timestream-query_UpdateScheduledQuery-request-State"></a>
State of the scheduled query.   
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: Yes

## Response Elements
<a name="API_query_UpdateScheduledQuery_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_query_UpdateScheduledQuery_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have the necessary permissions to access the account settings.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal server error occurred while processing the request.  
HTTP Status Code: 400

 ** InvalidEndpointException **   
The requested endpoint is invalid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The requested resource could not be found.    
 ** ScheduledQueryArn **   
The ARN of the scheduled query.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was throttled due to excessive requests.  
HTTP Status Code: 400

 ** ValidationException **   
 Invalid or malformed request.   
HTTP Status Code: 400

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/UpdateScheduledQuery) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/UpdateScheduledQuery) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/UpdateScheduledQuery) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/UpdateScheduledQuery) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/UpdateScheduledQuery) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/UpdateScheduledQuery) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/UpdateScheduledQuery) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/UpdateScheduledQuery) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/UpdateScheduledQuery) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/UpdateScheduledQuery) 

# 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) 

# Common Error Types
<a name="CommonErrors"></a>

This section lists common error types that this AWS service may return. Not all services return all error types listed here. For errors specific to an API action for this service, see the topic for that API action.

 **AccessDeniedException**   <a name="CommonErrors-AccessDeniedException"></a>
You don't have permission to perform this action. Verify that your IAM policy includes the required permissions.  
HTTP Status Code: 403

 **ExpiredTokenException**   <a name="CommonErrors-ExpiredTokenException"></a>
The security token included in the request has expired. Request a new security token and try again.  
HTTP Status Code: 403

 **IncompleteSignature**   <a name="CommonErrors-IncompleteSignature"></a>
The request signature doesn't conform to AWS standards. Verify that you're using valid AWS credentials and that your request is properly formatted. If you're using an SDK, ensure it's up to date.  
HTTP Status Code: 403

 **InternalFailure**   <a name="CommonErrors-InternalFailure"></a>
The request can't be processed right now because of an internal server issue. Try again later. If the problem persists, contact AWS Support.  
HTTP Status Code: 500

 **MalformedHttpRequestException**   <a name="CommonErrors-MalformedHttpRequestException"></a>
The request body can't be processed. This typically happens when the request body can't be decompressed using the specified content encoding algorithm. Verify that the content encoding header matches the compression format used.  
HTTP Status Code: 400

 **NotAuthorized**   <a name="CommonErrors-NotAuthorized"></a>
You don't have permissions to perform this action. Verify that your IAM policy includes the required permissions.  
HTTP Status Code: 401

 **OptInRequired**   <a name="CommonErrors-OptInRequired"></a>
Your AWS account needs a subscription for this service. Verify that you've enabled the service in your account.  
HTTP Status Code: 403

 **RequestAbortedException**   <a name="CommonErrors-RequestAbortedException"></a>
The request was aborted before a response could be returned. This typically happens when the client closes the connection.  
HTTP Status Code: 400

 **RequestEntityTooLargeException**   <a name="CommonErrors-RequestEntityTooLargeException"></a>
The request entity is too large. Reduce the size of the request body and try again.  
HTTP Status Code: 413

 **RequestTimeoutException**   <a name="CommonErrors-RequestTimeoutException"></a>
The request timed out. The server didn't receive the complete request within the expected time frame. Try again.  
HTTP Status Code: 408

 **ServiceUnavailable**   <a name="CommonErrors-ServiceUnavailable"></a>
The service is temporarily unavailable. Try again later.  
HTTP Status Code: 503

 **ThrottlingException**   <a name="CommonErrors-ThrottlingException"></a>
Your request rate is too high. The AWS SDKs automatically retry requests that receive this exception. Reduce the frequency of requests.  
HTTP Status Code: 400

 **UnknownOperationException**   <a name="CommonErrors-UnknownOperationException"></a>
The action or operation isn't recognized. Verify that the action name is spelled correctly and that it's supported by the API version you're using.  
HTTP Status Code: 404

 **UnrecognizedClientException**   <a name="CommonErrors-UnrecognizedClientException"></a>
The X.509 certificate or AWS access key ID you provided doesn't exist in our records. Verify that you're using valid credentials and that they haven't expired.  
HTTP Status Code: 403

 **ValidationError**   <a name="CommonErrors-ValidationError"></a>
The input doesn't meet the required format or constraints. Check that all required parameters are included and that values are valid.  
HTTP Status Code: 400

# Common Parameters
<a name="CommonParameters"></a>

The following list contains the parameters that all actions use for signing Signature Version 4 requests with a query string. Any action-specific parameters are listed in the topic for that action. For more information about Signature Version 4, see [Signing AWS API requests](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) in the *IAM User Guide*.

 **X-Amz-Algorithm**   <a name="CommonParameters-X-Amz-Algorithm"></a>
The hash algorithm that you used to create the request signature.  
Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header.  
Type: string  
Valid Values: `AWS4-HMAC-SHA256`   
Required: Conditional

 **X-Amz-Credential**   <a name="CommonParameters-X-Amz-Credential"></a>
The credential scope value, which is a string that includes your access key, the date, the region you are targeting, the service you are requesting, and a termination string ("aws4\$1request"). The value is expressed in the following format: *access\$1key*/*YYYYMMDD*/*region*/*service*/aws4\$1request.  
For more information, see [Create a signed AWS API request](https://docs.aws.amazon.com/IAM/latest/UserGuide/create-signed-request.html) in the *IAM User Guide*.  
Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header.  
Type: string  
Required: Conditional

 **X-Amz-Date**   <a name="CommonParameters-X-Amz-Date"></a>
The date that is used to create the signature. The format must be ISO 8601 basic format (YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value: `20120325T120000Z`.  
Condition: X-Amz-Date is optional for all requests; it can be used to override the date used for signing requests. If the Date header is specified in the ISO 8601 basic format, X-Amz-Date is not required. When X-Amz-Date is used, it always overrides the value of the Date header. For more information, see [Elements of an AWS API request signature](https://docs.aws.amazon.com/IAM/latest/UserGuide/signing-elements.html) in the *IAM User Guide*.  
Type: string  
Required: Conditional

 **X-Amz-Security-Token**   <a name="CommonParameters-X-Amz-Security-Token"></a>
The temporary security token that was obtained through a call to AWS Security Token Service (AWS STS). For a list of services that support temporary security credentials from AWS STS, see [AWS services that work with IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html) in the *IAM User Guide*.  
Condition: If you're using temporary security credentials from AWS STS, you must include the security token.  
Type: string  
Required: Conditional

 **X-Amz-Signature**   <a name="CommonParameters-X-Amz-Signature"></a>
Specifies the hex-encoded signature that was calculated from the string to sign and the derived signing key.  
Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header.  
Type: string  
Required: Conditional

 **X-Amz-SignedHeaders**   <a name="CommonParameters-X-Amz-SignedHeaders"></a>
Specifies all the HTTP headers that were included as part of the canonical request. For more information about specifying signed headers, see [Create a signed AWS API request](https://docs.aws.amazon.com/IAM/latest/UserGuide/create-signed-request.html) in the *IAM User Guide*.  
Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header.  
Type: string  
Required: Conditional