

要获得与亚马逊 Timestream 类似的功能 LiveAnalytics，可以考虑适用于 InfluxDB 的亚马逊 Timestream。适用于 InfluxDB 的 Amazon Timestream 提供简化的数据摄取和个位数毫秒级的查询响应时间，以实现实时分析。点击[此处](https://docs.aws.amazon.com//timestream/latest/developerguide/timestream-for-influxdb.html)了解更多信息。

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

# API 参考
<a name="API_Reference"></a>

本部分包含 Amazon Timestream 的 API 参考文档。

Timestream 有两个 APIs：查询和写入。
+ **写入 API** 允许您执行创建表、为资源添加标签以及向 Timestream 写入记录等操作。
+ **查询 API** 允许您执行查询操作。

**注意**  
两者都 APIs 包括动 DescribeEndpoints 作。*对于 “查询” 和 “写入”， DescribeEndpoints 操作是相同的。*

您可以在下方阅读更多关于每个 API 的信息，包括数据类型、常见错误和参数。

**注意**  
有关所有 AWS 服务的通用错误代码，请参阅 Supp [AWS ort 部分](https://docs.aws.amazon.com/awssupport/latest/APIReference/CommonErrors.html)。

**Topics**
+ [操作](API_Operations.md)
+ [数据类型](API_Types.md)
+ [常见错误](CommonErrors.md)
+ [常见参数](CommonParameters.md)

# 操作
<a name="API_Operations"></a>

Amazon Timestream 写入支持以下操作：
+  [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) 

Amazon Timestream 查询支持以下操作：
+  [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 写入
<a name="API_Operations_Amazon_Timestream_Write"></a>

Amazon Timestream 写入支持以下操作：
+  [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>

创建新的 Timestream 批量加载任务。批量加载任务处理来自 S3 位置的 CSV 源数据，并将其写入 Timestream 表。从源到目标的映射在批量加载任务中进行定义。错误和事件会写入位于 S3 位置的报告中。对于报告，如果未指定 AWS KMS 密钥，则在可选的情况下`SSE_S3`，将使用 S3 托管密钥对报告进行加密。否则，这会引发错误。有关更多信息，请参阅 [AWS 托管式密钥](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk)。[适用服务配额](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html)。有关详细信息，请参阅[代码示例](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-batch-load.html)。

## 请求语法
<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"
}
```

## 请求参数
<a name="API_CreateBatchLoadTask_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [ClientToken](#API_CreateBatchLoadTask_RequestSyntax) **   <a name="timestream-CreateBatchLoadTask-request-ClientToken"></a>
  
类型：字符串  
长度限制：最小长度为 1。长度上限为 64。  
必需：否

 ** [DataModelConfiguration](#API_CreateBatchLoadTask_RequestSyntax) **   <a name="timestream-CreateBatchLoadTask-request-DataModelConfiguration"></a>
  
类型：[DataModelConfiguration](API_DataModelConfiguration.md) 对象  
必需：否

 ** [DataSourceConfiguration](#API_CreateBatchLoadTask_RequestSyntax) **   <a name="timestream-CreateBatchLoadTask-request-DataSourceConfiguration"></a>
定义批量加载任务数据来源的配置详细信息。  
类型：[DataSourceConfiguration](API_DataSourceConfiguration.md) 对象  
是否必需：是

 ** [RecordVersion](#API_CreateBatchLoadTask_RequestSyntax) **   <a name="timestream-CreateBatchLoadTask-request-RecordVersion"></a>
  
类型：长整型  
必需：否

 ** [ReportConfiguration](#API_CreateBatchLoadTask_RequestSyntax) **   <a name="timestream-CreateBatchLoadTask-request-ReportConfiguration"></a>
批量加载任务的报告配置。这包含有关错误报告存储位置的详细信息。  
类型：[ReportConfiguration](API_ReportConfiguration.md) 对象  
是否必需：是

 ** [TargetDatabaseName](#API_CreateBatchLoadTask_RequestSyntax) **   <a name="timestream-CreateBatchLoadTask-request-TargetDatabaseName"></a>
批量加载任务的目标 Timestream 数据库。  
类型：字符串  
模式：`[a-zA-Z0-9_.-]+`  
是否必需：是

 ** [TargetTableName](#API_CreateBatchLoadTask_RequestSyntax) **   <a name="timestream-CreateBatchLoadTask-request-TargetTableName"></a>
批量加载任务的目标 Timestream 表。  
类型：字符串  
模式：`[a-zA-Z0-9_.-]+`  
必需：是

## 响应语法
<a name="API_CreateBatchLoadTask_ResponseSyntax"></a>

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

## 响应元素
<a name="API_CreateBatchLoadTask_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [TaskId](#API_CreateBatchLoadTask_ResponseSyntax) **   <a name="timestream-CreateBatchLoadTask-response-TaskId"></a>
批量加载任务的 ID。  
类型：字符串  
长度限制：最小长度为 3。最大长度为 32。  
模式：`[A-Z0-9]+`

## 错误
<a name="API_CreateBatchLoadTask_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** AccessDeniedException **   
您无权执行此操作。  
HTTP 状态代码：400

 ** ConflictException **   
Timestream 无法处理此请求，因为其中包含已存在的资源。  
HTTP 状态代码：400

 ** InternalServerException **   
 由于内部服务器错误，Timestream 无法完全处理此请求。  
HTTP 状态代码：500

 ** InvalidEndpointException **   
请求的端点无效。  
HTTP 状态代码：400

 ** ResourceNotFoundException **   
该操作试图访问不存在的资源。该资源可能未正确指定，或其状态可能不是“活动”状态。  
HTTP 状态代码：400

 ** ServiceQuotaExceededException **   
 已超出此账户的资源实例配额。  
HTTP 状态代码：400

 ** ThrottlingException **   
 用户发出的请求过多，已超出服务配额。请求已被阻止。  
HTTP 状态代码：400

 ** ValidationException **   
 请求无效或格式错误。  
HTTP 状态代码：400

## 另请参阅
<a name="API_CreateBatchLoadTask_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/CreateBatchLoadTask) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/CreateBatchLoadTask) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/CreateBatchLoadTask) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/CreateBatchLoadTask) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/CreateBatchLoadTask) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/CreateBatchLoadTask) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/CreateBatchLoadTask) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/CreateBatchLoadTask) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/CreateBatchLoadTask) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/CreateBatchLoadTask) 

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

创建新的 Timestream 数据库。如果未指定 AWS KMS 密钥，则将使用位于您账户中的 Timestream 托管 AWS KMS 密钥对数据库进行加密。有关更多信息，请参阅 [AWS 托管式密钥](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk)。[适用服务配额](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html)。有关详细信息，请参阅[代码示例](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-db.html)。

## 请求语法
<a name="API_CreateDatabase_RequestSyntax"></a>

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

## 请求参数
<a name="API_CreateDatabase_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [DatabaseName](#API_CreateDatabase_RequestSyntax) **   <a name="timestream-CreateDatabase-request-DatabaseName"></a>
Timestream 数据库的名称。  
类型：字符串  
长度限制：最小长度为 3。最大长度为 256。  
模式：`[a-zA-Z0-9_.-]+`  
是否必需：是

 ** [KmsKeyId](#API_CreateDatabase_RequestSyntax) **   <a name="timestream-CreateDatabase-request-KmsKeyId"></a>
数据库的 AWS KMS 密钥。如果未指定 AWS KMS 密钥，则将使用位于您账户中的 Timestream 托管 AWS KMS 密钥对数据库进行加密。有关更多信息，请参阅 [AWS 托管式密钥](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk)。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 2048。  
必需：否

 ** [Tags](#API_CreateDatabase_RequestSyntax) **   <a name="timestream-CreateDatabase-request-Tags"></a>
 用于标记表的键值对列表。  
类型：[Tag](API_Tag.md) 对象数组  
数组成员：最少 0 个物品。最多 200 项。  
必需：否

## 响应语法
<a name="API_CreateDatabase_ResponseSyntax"></a>

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

## 响应元素
<a name="API_CreateDatabase_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Database](#API_CreateDatabase_ResponseSyntax) **   <a name="timestream-CreateDatabase-response-Database"></a>
新创建的 Timestream 数据库。  
类型：[Database](API_Database.md) 对象

## 错误
<a name="API_CreateDatabase_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** AccessDeniedException **   
您无权执行此操作。  
HTTP 状态代码：400

 ** ConflictException **   
Timestream 无法处理此请求，因为其中包含已存在的资源。  
HTTP 状态代码：400

 ** InternalServerException **   
 由于内部服务器错误，Timestream 无法完全处理此请求。  
HTTP 状态代码：500

 ** InvalidEndpointException **   
请求的端点无效。  
HTTP 状态代码：400

 ** InvalidEndpointException **   
请求的端点无效。  
HTTP 状态代码：400

 ** ServiceQuotaExceededException **   
 已超出此账户的资源实例配额。  
HTTP 状态代码：400

 ** ThrottlingException **   
 用户发出的请求过多，已超出服务配额。请求已被阻止。  
HTTP 状态代码：400

 ** ValidationException **   
 请求无效或格式错误。  
HTTP 状态代码：400

## 另请参阅
<a name="API_CreateDatabase_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/CreateDatabase) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/CreateDatabase) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/CreateDatabase) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/CreateDatabase) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/CreateDatabase) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/CreateDatabase) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/CreateDatabase) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/CreateDatabase) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/CreateDatabase) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/CreateDatabase) 

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

将新表添加到账户中的现有数据库。在中 AWS 账户，如果表名位于同一个数据库中，则每个区域内的表名必须至少是唯一的。如果表位于单独的数据库中，则在同一区域中可能具有相同的表名称。创建表时，必须指定表名称、数据库名称和保留属性。[适用服务配额](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html)。请参阅[代码示例](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-table.html)，了解详细信息。

## 请求语法
<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"
      }
   ]
}
```

## 请求参数
<a name="API_CreateTable_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [DatabaseName](#API_CreateTable_RequestSyntax) **   <a name="timestream-CreateTable-request-DatabaseName"></a>
Timestream 数据库的名称。  
类型：字符串  
长度限制：最小长度为 3。最大长度为 256。  
模式：`[a-zA-Z0-9_.-]+`  
是否必需：是

 ** [MagneticStoreWriteProperties](#API_CreateTable_RequestSyntax) **   <a name="timestream-CreateTable-request-MagneticStoreWriteProperties"></a>
包含启用磁介质存储写入时要在表上设置的属性。  
类型：[MagneticStoreWriteProperties](API_MagneticStoreWriteProperties.md) 对象  
必需：否

 ** [RetentionProperties](#API_CreateTable_RequestSyntax) **   <a name="timestream-CreateTable-request-RetentionProperties"></a>
时间序列数据必须存储在内存存储和磁性存储中的持续时间。  
类型：[RetentionProperties](API_RetentionProperties.md) 对象  
必需：否

 ** [Schema](#API_CreateTable_RequestSyntax) **   <a name="timestream-CreateTable-request-Schema"></a>
 表的架构。  
类型：[Schema](API_Schema.md) 对象  
必需：否

 ** [TableName](#API_CreateTable_RequestSyntax) **   <a name="timestream-CreateTable-request-TableName"></a>
Timestream 表的名称。  
类型：字符串  
长度限制：最小长度为 3。最大长度为 256。  
模式：`[a-zA-Z0-9_.-]+`  
是否必需：是

 ** [Tags](#API_CreateTable_RequestSyntax) **   <a name="timestream-CreateTable-request-Tags"></a>
 用于标记表的键值对列表。  
类型：[Tag](API_Tag.md) 对象数组  
数组成员：最少 0 个物品。最多 200 项。  
必需：否

## 响应语法
<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"
   }
}
```

## 响应元素
<a name="API_CreateTable_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Table](#API_CreateTable_ResponseSyntax) **   <a name="timestream-CreateTable-response-Table"></a>
新创建的 Timestream 表。  
类型：[Table](API_Table.md) 对象

## 错误
<a name="API_CreateTable_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** AccessDeniedException **   
您无权执行此操作。  
HTTP 状态代码：400

 ** ConflictException **   
Timestream 无法处理此请求，因为其中包含已存在的资源。  
HTTP 状态代码：400

 ** InternalServerException **   
 由于内部服务器错误，Timestream 无法完全处理此请求。  
HTTP 状态代码：500

 ** InvalidEndpointException **   
请求的端点无效。  
HTTP 状态代码：400

 ** InvalidEndpointException **   
请求的端点无效。  
HTTP 状态代码：400

 ** ResourceNotFoundException **   
该操作试图访问不存在的资源。该资源可能未正确指定，或其状态可能不是“活动”状态。  
HTTP 状态代码：400

 ** ServiceQuotaExceededException **   
 已超出此账户的资源实例配额。  
HTTP 状态代码：400

 ** ThrottlingException **   
 用户发出的请求过多，已超出服务配额。请求已被阻止。  
HTTP 状态代码：400

 ** ValidationException **   
 请求无效或格式错误。  
HTTP 状态代码：400

## 另请参阅
<a name="API_CreateTable_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/CreateTable) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/CreateTable) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/CreateTable) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/CreateTable) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/CreateTable) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/CreateTable) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/CreateTable) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/CreateTable) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/CreateTable) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/CreateTable) 

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

删除给定的 Timestream 数据库。*此操作不可逆。删除数据库后，其表中的时间序列数据将无法恢复。*

**注意**  
必须先删除数据库中的所有表，否则将引发 ValidationException 错误。  
由于分布式重试的性质，该操作可以返回 success 或。 ResourceNotFoundException客户端应将其视为同等。

请参阅[代码示例](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.delete-db.html)，了解详细信息。

## 请求语法
<a name="API_DeleteDatabase_RequestSyntax"></a>

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

## 请求参数
<a name="API_DeleteDatabase_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [DatabaseName](#API_DeleteDatabase_RequestSyntax) **   <a name="timestream-DeleteDatabase-request-DatabaseName"></a>
要删除的 Timestream 数据库名称。  
类型：字符串  
长度限制：最小长度为 3。最大长度为 256。  
是否必需：是

## 响应元素
<a name="API_DeleteDatabase_ResponseElements"></a>

如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。

## 错误
<a name="API_DeleteDatabase_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** AccessDeniedException **   
您无权执行此操作。  
HTTP 状态代码：400

 ** InternalServerException **   
 由于内部服务器错误，Timestream 无法完全处理此请求。  
HTTP 状态代码：500

 ** InvalidEndpointException **   
请求的端点无效。  
HTTP 状态代码：400

 ** ResourceNotFoundException **   
该操作试图访问不存在的资源。该资源可能未正确指定，或其状态可能不是“活动”状态。  
HTTP 状态代码：400

 ** ThrottlingException **   
 用户发出的请求过多，已超出服务配额。请求已被阻止。  
HTTP 状态代码：400

 ** ValidationException **   
 请求无效或格式错误。  
HTTP 状态代码：400

## 另请参阅
<a name="API_DeleteDatabase_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/DeleteDatabase) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/DeleteDatabase) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/DeleteDatabase) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/DeleteDatabase) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/DeleteDatabase) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/DeleteDatabase) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/DeleteDatabase) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/DeleteDatabase) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/DeleteDatabase) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/DeleteDatabase) 

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

删除给定的 Timestream 表。此操作不可逆。删除 Timestream 数据库表后，该表中存储的时间序列数据无法恢复。

**注意**  
由于分布式重试的性质，该操作可以返回 success 或。 ResourceNotFoundException客户端应将其视为同等。

请参阅[代码示例](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.delete-table.html)，了解详细信息。

## 请求语法
<a name="API_DeleteTable_RequestSyntax"></a>

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

## 请求参数
<a name="API_DeleteTable_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [DatabaseName](#API_DeleteTable_RequestSyntax) **   <a name="timestream-DeleteTable-request-DatabaseName"></a>
要删除其中 Timestream 数据库的数据库名称。  
类型：字符串  
长度限制：最小长度为 3。最大长度为 256。  
是否必需：是

 ** [TableName](#API_DeleteTable_RequestSyntax) **   <a name="timestream-DeleteTable-request-TableName"></a>
要删除的 Timestream 表名称。  
类型：字符串  
长度限制：最小长度为 3。最大长度为 256。  
是否必需：是

## 响应元素
<a name="API_DeleteTable_ResponseElements"></a>

如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。

## 错误
<a name="API_DeleteTable_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** AccessDeniedException **   
您无权执行此操作。  
HTTP 状态代码：400

 ** InternalServerException **   
 由于内部服务器错误，Timestream 无法完全处理此请求。  
HTTP 状态代码：500

 ** InvalidEndpointException **   
请求的端点无效。  
HTTP 状态代码：400

 ** ResourceNotFoundException **   
该操作试图访问不存在的资源。该资源可能未正确指定，或其状态可能不是“活动”状态。  
HTTP 状态代码：400

 ** ThrottlingException **   
 用户发出的请求过多，已超出服务配额。请求已被阻止。  
HTTP 状态代码：400

 ** ValidationException **   
 请求无效或格式错误。  
HTTP 状态代码：400

## 另请参阅
<a name="API_DeleteTable_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/DeleteTable) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/DeleteTable) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/DeleteTable) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/DeleteTable) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/DeleteTable) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/DeleteTable) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/DeleteTable) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/DeleteTable) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/DeleteTable) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/DeleteTable) 

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

返回有关批量加载任务的信息，包括配置、映射、过程及其他详细信息。[适用服务配额](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html)。请参阅[代码示例](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-batch-load.html)，了解详细信息。

## 请求语法
<a name="API_DescribeBatchLoadTask_RequestSyntax"></a>

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

## 请求参数
<a name="API_DescribeBatchLoadTask_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [TaskId](#API_DescribeBatchLoadTask_RequestSyntax) **   <a name="timestream-DescribeBatchLoadTask-request-TaskId"></a>
批量加载任务的 ID。  
类型：字符串  
长度限制：最小长度为 3。最大长度为 32。  
模式：`[A-Z0-9]+`  
必需：是

## 响应语法
<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"
   }
}
```

## 响应元素
<a name="API_DescribeBatchLoadTask_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [BatchLoadTaskDescription](#API_DescribeBatchLoadTask_ResponseSyntax) **   <a name="timestream-DescribeBatchLoadTask-response-BatchLoadTaskDescription"></a>
批量加载任务的描述。  
类型：[BatchLoadTaskDescription](API_BatchLoadTaskDescription.md) 对象

## 错误
<a name="API_DescribeBatchLoadTask_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** AccessDeniedException **   
您无权执行此操作。  
HTTP 状态代码：400

 ** InternalServerException **   
 由于内部服务器错误，Timestream 无法完全处理此请求。  
HTTP 状态代码：500

 ** InvalidEndpointException **   
请求的端点无效。  
HTTP 状态代码：400

 ** ResourceNotFoundException **   
该操作试图访问不存在的资源。该资源可能未正确指定，或其状态可能不是“活动”状态。  
HTTP 状态代码：400

 ** ThrottlingException **   
 用户发出的请求过多，已超出服务配额。请求已被阻止。  
HTTP 状态代码：400

## 另请参阅
<a name="API_DescribeBatchLoadTask_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/DescribeBatchLoadTask) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/DescribeBatchLoadTask) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/DescribeBatchLoadTask) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/DescribeBatchLoadTask) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/DescribeBatchLoadTask) 
+  [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/DescribeBatchLoadTask) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/DescribeBatchLoadTask) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/DescribeBatchLoadTask) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/DescribeBatchLoadTask) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/DescribeBatchLoadTask) 

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

返回有关数据库的信息，包括数据库名称、数据库创建的时间以及可在数据库中查找的表总数。[适用服务配额](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html)。请参阅[代码示例](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-db.html)，了解详细信息。

## 请求语法
<a name="API_DescribeDatabase_RequestSyntax"></a>

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

## 请求参数
<a name="API_DescribeDatabase_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [DatabaseName](#API_DescribeDatabase_RequestSyntax) **   <a name="timestream-DescribeDatabase-request-DatabaseName"></a>
Timestream 数据库的名称。  
类型：字符串  
长度限制：最小长度为 3。最大长度为 256。  
是否必需：是

## 响应语法
<a name="API_DescribeDatabase_ResponseSyntax"></a>

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

## 响应元素
<a name="API_DescribeDatabase_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Database](#API_DescribeDatabase_ResponseSyntax) **   <a name="timestream-DescribeDatabase-response-Database"></a>
Timestream 表的名称。  
类型：[Database](API_Database.md) 对象

## 错误
<a name="API_DescribeDatabase_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** AccessDeniedException **   
您无权执行此操作。  
HTTP 状态代码：400

 ** InternalServerException **   
 由于内部服务器错误，Timestream 无法完全处理此请求。  
HTTP 状态代码：500

 ** InvalidEndpointException **   
请求的端点无效。  
HTTP 状态代码：400

 ** ResourceNotFoundException **   
该操作试图访问不存在的资源。该资源可能未正确指定，或其状态可能不是“活动”状态。  
HTTP 状态代码：400

 ** ThrottlingException **   
 用户发出的请求过多，已超出服务配额。请求已被阻止。  
HTTP 状态代码：400

 ** ValidationException **   
 请求无效或格式错误。  
HTTP 状态代码：400

## 另请参阅
<a name="API_DescribeDatabase_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/DescribeDatabase) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/DescribeDatabase) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/DescribeDatabase) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/DescribeDatabase) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/DescribeDatabase) 
+  [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/DescribeDatabase) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/DescribeDatabase) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/DescribeDatabase) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/DescribeDatabase) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/DescribeDatabase) 

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

返回用于发起 Timestream API 调用的可用端点列表。此 API 操作可通过写入和查询获得 APIs。

由于 Timestream SDKs 旨在透明地与服务的架构（包括服务端点的管理和映射）配合使用，因此*我们不建议您使用此 API 操作*，除非：
+ 您正在将 [VPC 端点（AWS PrivateLink）和 Timestream 结合使用](https://docs.aws.amazon.com/timestream/latest/developerguide/VPCEndpoints) 
+ 应用程序使用的编程语言尚不支持 SDK
+ 需要对客户端实现进行更有效的控制

有关如何以及何时使用和实施的详细信息 DescribeEndpoints，请参阅[端点发现模式](https://docs.aws.amazon.com/timestream/latest/developerguide/Using.API.html#Using-API.endpoint-discovery)。

## 响应语法
<a name="API_DescribeEndpoints_ResponseSyntax"></a>

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

## 响应元素
<a name="API_DescribeEndpoints_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Endpoints](#API_DescribeEndpoints_ResponseSyntax) **   <a name="timestream-DescribeEndpoints-response-Endpoints"></a>
`DescribeEndpoints` 请求发出时会返回 `Endpoints` 对象。  
类型：[Endpoint](API_Endpoint.md) 对象数组

## 错误
<a name="API_DescribeEndpoints_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** InternalServerException **   
 由于内部服务器错误，Timestream 无法完全处理此请求。  
HTTP 状态代码：500

 ** ThrottlingException **   
 用户发出的请求过多，已超出服务配额。请求已被阻止。  
HTTP 状态代码：400

 ** ValidationException **   
 请求无效或格式错误。  
HTTP 状态代码：400

## 另请参阅
<a name="API_DescribeEndpoints_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/DescribeEndpoints) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/DescribeEndpoints) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/DescribeEndpoints) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/DescribeEndpoints) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/DescribeEndpoints) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/DescribeEndpoints) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/DescribeEndpoints) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/DescribeEndpoints) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/DescribeEndpoints) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/DescribeEndpoints) 

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

返回有关表的信息，包括表名称、数据库名称、内存存储和磁介质存储的保留持续时间。[适用服务配额](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html)。请参阅[代码示例](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-table.html)，了解详细信息。

## 请求语法
<a name="API_DescribeTable_RequestSyntax"></a>

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

## 请求参数
<a name="API_DescribeTable_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [DatabaseName](#API_DescribeTable_RequestSyntax) **   <a name="timestream-DescribeTable-request-DatabaseName"></a>
Timestream 数据库的名称。  
类型：字符串  
长度限制：最小长度为 3。最大长度为 256。  
是否必需：是

 ** [TableName](#API_DescribeTable_RequestSyntax) **   <a name="timestream-DescribeTable-request-TableName"></a>
Timestream 表的名称。  
类型：字符串  
长度限制：最小长度为 3。最大长度为 256。  
是否必需：是

## 响应语法
<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"
   }
}
```

## 响应元素
<a name="API_DescribeTable_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Table](#API_DescribeTable_ResponseSyntax) **   <a name="timestream-DescribeTable-response-Table"></a>
Timestream 表。  
类型：[Table](API_Table.md) 对象

## 错误
<a name="API_DescribeTable_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** AccessDeniedException **   
您无权执行此操作。  
HTTP 状态代码：400

 ** InternalServerException **   
 由于内部服务器错误，Timestream 无法完全处理此请求。  
HTTP 状态代码：500

 ** InvalidEndpointException **   
请求的端点无效。  
HTTP 状态代码：400

 ** ResourceNotFoundException **   
该操作试图访问不存在的资源。该资源可能未正确指定，或其状态可能不是“活动”状态。  
HTTP 状态代码：400

 ** ThrottlingException **   
 用户发出的请求过多，已超出服务配额。请求已被阻止。  
HTTP 状态代码：400

 ** ValidationException **   
 请求无效或格式错误。  
HTTP 状态代码：400

## 另请参阅
<a name="API_DescribeTable_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/DescribeTable) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/DescribeTable) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/DescribeTable) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/DescribeTable) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/DescribeTable) 
+  [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/DescribeTable) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/DescribeTable) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/DescribeTable) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/DescribeTable) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/DescribeTable) 

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

提供批量加载任务的列表，以及名称、状态、任务可恢复截止时间和其他详细信息。请参阅[代码示例](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-batch-load-tasks.html)，了解详细信息。

## 请求语法
<a name="API_ListBatchLoadTasks_RequestSyntax"></a>

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

## 请求参数
<a name="API_ListBatchLoadTasks_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [MaxResults](#API_ListBatchLoadTasks_RequestSyntax) **   <a name="timestream-ListBatchLoadTasks-request-MaxResults"></a>
输出中要返回的项总数。如果可用项目总数大于指定值，则输出中会提供 a NextToken 。要恢复分页，请提供该 NextToken 值作为后续 API 调用的参数。  
类型：整数  
有效范围：最小值为 1。最大值为 100。  
必需：否

 ** [NextToken](#API_ListBatchLoadTasks_RequestSyntax) **   <a name="timestream-ListBatchLoadTasks-request-NextToken"></a>
指定从何处开始分页的令牌。这是之前截 NextToken 断的响应。  
类型：字符串  
必需：否

 ** [TaskStatus](#API_ListBatchLoadTasks_RequestSyntax) **   <a name="timestream-ListBatchLoadTasks-request-TaskStatus"></a>
批量加载任务的状态。  
类型：字符串  
有效值：`CREATED | IN_PROGRESS | FAILED | SUCCEEDED | PROGRESS_STOPPED | PENDING_RESUME`  
必需：否

## 响应语法
<a name="API_ListBatchLoadTasks_ResponseSyntax"></a>

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

## 响应元素
<a name="API_ListBatchLoadTasks_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [BatchLoadTasks](#API_ListBatchLoadTasks_ResponseSyntax) **   <a name="timestream-ListBatchLoadTasks-response-BatchLoadTasks"></a>
批量加载任务详细信息的列表。  
类型：[BatchLoadTask](API_BatchLoadTask.md) 对象数组

 ** [NextToken](#API_ListBatchLoadTasks_ResponseSyntax) **   <a name="timestream-ListBatchLoadTasks-response-NextToken"></a>
指定从何处开始分页的令牌。提供下一个 ListBatchLoadTasksRequest。  
类型：字符串

## 错误
<a name="API_ListBatchLoadTasks_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** AccessDeniedException **   
您无权执行此操作。  
HTTP 状态代码：400

 ** InternalServerException **   
 由于内部服务器错误，Timestream 无法完全处理此请求。  
HTTP 状态代码：500

 ** InvalidEndpointException **   
请求的端点无效。  
HTTP 状态代码：400

 ** ThrottlingException **   
 用户发出的请求过多，已超出服务配额。请求已被阻止。  
HTTP 状态代码：400

 ** ValidationException **   
 请求无效或格式错误。  
HTTP 状态代码：400

## 另请参阅
<a name="API_ListBatchLoadTasks_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/ListBatchLoadTasks) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/ListBatchLoadTasks) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/ListBatchLoadTasks) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/ListBatchLoadTasks) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/ListBatchLoadTasks) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/ListBatchLoadTasks) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/ListBatchLoadTasks) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/ListBatchLoadTasks) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/ListBatchLoadTasks) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/ListBatchLoadTasks) 

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

返回 Timestream 数据库的列表。[适用服务配额](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html)。请参阅[代码示例](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-db.html)，了解详细信息。

## 请求语法
<a name="API_ListDatabases_RequestSyntax"></a>

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

## 请求参数
<a name="API_ListDatabases_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [MaxResults](#API_ListDatabases_RequestSyntax) **   <a name="timestream-ListDatabases-request-MaxResults"></a>
输出中要返回的项总数。如果可用项目总数大于指定值，则输出中会提供 a NextToken 。要恢复分页，请提供该 NextToken 值作为后续 API 调用的参数。  
类型：整数  
有效范围：最小值为 1。最大值为 20。  
必需：否

 ** [NextToken](#API_ListDatabases_RequestSyntax) **   <a name="timestream-ListDatabases-request-NextToken"></a>
分页令牌。要恢复分页，请提供该 NextToken 值作为后续 API 调用的参数。  
类型：字符串  
必需：否

## 响应语法
<a name="API_ListDatabases_ResponseSyntax"></a>

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

## 响应元素
<a name="API_ListDatabases_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Databases](#API_ListDatabases_ResponseSyntax) **   <a name="timestream-ListDatabases-response-Databases"></a>
数据库名称的列表。  
类型：[Database](API_Database.md) 对象数组

 ** [NextToken](#API_ListDatabases_ResponseSyntax) **   <a name="timestream-ListDatabases-response-NextToken"></a>
分页令牌。当响应截断时返回此参数。  
类型：字符串

## 错误
<a name="API_ListDatabases_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** AccessDeniedException **   
您无权执行此操作。  
HTTP 状态代码：400

 ** InternalServerException **   
 由于内部服务器错误，Timestream 无法完全处理此请求。  
HTTP 状态代码：500

 ** InvalidEndpointException **   
请求的端点无效。  
HTTP 状态代码：400

 ** ThrottlingException **   
 用户发出的请求过多，已超出服务配额。请求已被阻止。  
HTTP 状态代码：400

 ** ValidationException **   
 请求无效或格式错误。  
HTTP 状态代码：400

## 另请参阅
<a name="API_ListDatabases_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/ListDatabases) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/ListDatabases) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/ListDatabases) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/ListDatabases) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/ListDatabases) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/ListDatabases) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/ListDatabases) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/ListDatabases) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/ListDatabases) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/ListDatabases) 

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

提供表的列表，以及每个表的名称、状态和保留属性。请参阅[代码示例](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-table.html)，了解详细信息。

## 请求语法
<a name="API_ListTables_RequestSyntax"></a>

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

## 请求参数
<a name="API_ListTables_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [DatabaseName](#API_ListTables_RequestSyntax) **   <a name="timestream-ListTables-request-DatabaseName"></a>
Timestream 数据库的名称。  
类型：字符串  
长度限制：最小长度为 3。长度上限为 256。  
必需：否

 ** [MaxResults](#API_ListTables_RequestSyntax) **   <a name="timestream-ListTables-request-MaxResults"></a>
输出中要返回的项总数。如果可用项目总数大于指定值，则输出中会提供 a NextToken 。要恢复分页，请提供该 NextToken 值作为后续 API 调用的参数。  
类型：整数  
有效范围：最小值为 1。最大值为 20。  
必需：否

 ** [NextToken](#API_ListTables_RequestSyntax) **   <a name="timestream-ListTables-request-NextToken"></a>
分页令牌。要恢复分页，请提供该 NextToken 值作为后续 API 调用的参数。  
类型：字符串  
必需：否

## 响应语法
<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"
      }
   ]
}
```

## 响应元素
<a name="API_ListTables_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [NextToken](#API_ListTables_ResponseSyntax) **   <a name="timestream-ListTables-response-NextToken"></a>
指定从何处开始分页的令牌。这是之前截 NextToken 断的响应。  
类型：字符串

 ** [Tables](#API_ListTables_ResponseSyntax) **   <a name="timestream-ListTables-response-Tables"></a>
表的列表。  
类型：[Table](API_Table.md) 对象数组

## 错误
<a name="API_ListTables_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** AccessDeniedException **   
您无权执行此操作。  
HTTP 状态代码：400

 ** InternalServerException **   
 由于内部服务器错误，Timestream 无法完全处理此请求。  
HTTP 状态代码：500

 ** InvalidEndpointException **   
请求的端点无效。  
HTTP 状态代码：400

 ** ResourceNotFoundException **   
该操作试图访问不存在的资源。该资源可能未正确指定，或其状态可能不是“活动”状态。  
HTTP 状态代码：400

 ** ThrottlingException **   
 用户发出的请求过多，已超出服务配额。请求已被阻止。  
HTTP 状态代码：400

 ** ValidationException **   
 请求无效或格式错误。  
HTTP 状态代码：400

## 另请参阅
<a name="API_ListTables_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/ListTables) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/ListTables) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/ListTables) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/ListTables) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/ListTables) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/ListTables) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/ListTables) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/ListTables) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/ListTables) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/ListTables) 

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

 列出 Timestream 资源上的所有标签。

## 请求语法
<a name="API_ListTagsForResource_RequestSyntax"></a>

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

## 请求参数
<a name="API_ListTagsForResource_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [ResourceARN](#API_ListTagsForResource_RequestSyntax) **   <a name="timestream-ListTagsForResource-request-ResourceARN"></a>
 带有待列出标签的 Timestream 资源。此值是 Amazon 资源名称（ARN）。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 1011。  
是否必需：是

## 响应语法
<a name="API_ListTagsForResource_ResponseSyntax"></a>

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

## 响应元素
<a name="API_ListTagsForResource_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Tags](#API_ListTagsForResource_ResponseSyntax) **   <a name="timestream-ListTagsForResource-response-Tags"></a>
 当前与 Timestream 资源相关联的标签。  
类型：[Tag](API_Tag.md) 对象数组  
数组成员：最少 0 个物品。最多 200 项。

## 错误
<a name="API_ListTagsForResource_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** InvalidEndpointException **   
请求的端点无效。  
HTTP 状态代码：400

 ** ResourceNotFoundException **   
该操作试图访问不存在的资源。该资源可能未正确指定，或其状态可能不是“活动”状态。  
HTTP 状态代码：400

 ** ThrottlingException **   
 用户发出的请求过多，已超出服务配额。请求已被阻止。  
HTTP 状态代码：400

 ** ValidationException **   
 请求无效或格式错误。  
HTTP 状态代码：400

## 另请参阅
<a name="API_ListTagsForResource_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/ListTagsForResource) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/ListTagsForResource) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/ListTagsForResource) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/ListTagsForResource) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/ListTagsForResource) 
+  [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/ListTagsForResource) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/ListTagsForResource) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/ListTagsForResource) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/ListTagsForResource) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/ListTagsForResource) 

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

 

## 请求语法
<a name="API_ResumeBatchLoadTask_RequestSyntax"></a>

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

## 请求参数
<a name="API_ResumeBatchLoadTask_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [TaskId](#API_ResumeBatchLoadTask_RequestSyntax) **   <a name="timestream-ResumeBatchLoadTask-request-TaskId"></a>
要恢复的批量加载任务的 ID。  
类型：字符串  
长度限制：最小长度为 3。最大长度为 32。  
模式：`[A-Z0-9]+`  
是否必需：是

## 响应元素
<a name="API_ResumeBatchLoadTask_ResponseElements"></a>

如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。

## 错误
<a name="API_ResumeBatchLoadTask_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** AccessDeniedException **   
您无权执行此操作。  
HTTP 状态代码：400

 ** InternalServerException **   
 由于内部服务器错误，Timestream 无法完全处理此请求。  
HTTP 状态代码：500

 ** InvalidEndpointException **   
请求的端点无效。  
HTTP 状态代码：400

 ** ResourceNotFoundException **   
该操作试图访问不存在的资源。该资源可能未正确指定，或其状态可能不是“活动”状态。  
HTTP 状态代码：400

 ** ThrottlingException **   
 用户发出的请求过多，已超出服务配额。请求已被阻止。  
HTTP 状态代码：400

 ** ValidationException **   
 请求无效或格式错误。  
HTTP 状态代码：400

## 另请参阅
<a name="API_ResumeBatchLoadTask_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/ResumeBatchLoadTask) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/ResumeBatchLoadTask) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/ResumeBatchLoadTask) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/ResumeBatchLoadTask) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/ResumeBatchLoadTask) 
+  [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/ResumeBatchLoadTask) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/ResumeBatchLoadTask) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/ResumeBatchLoadTask) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/ResumeBatchLoadTask) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/ResumeBatchLoadTask) 

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

 将一组标签与 Timestream 资源关联。然后，您可以激活这些用户定义的标签，以便在账单和成本管理控制台上显示这些标签，从而进行成本分配跟踪。

## 请求语法
<a name="API_TagResource_RequestSyntax"></a>

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

## 请求参数
<a name="API_TagResource_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [ResourceARN](#API_TagResource_RequestSyntax) **   <a name="timestream-TagResource-request-ResourceARN"></a>
 标识应向其添加标签的 Timestream 资源。此值是 Amazon 资源名称（ARN）。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 1011。  
是否必需：是

 ** [Tags](#API_TagResource_RequestSyntax) **   <a name="timestream-TagResource-request-Tags"></a>
 要分配给 Timestream 资源的标签。  
类型：[Tag](API_Tag.md) 对象数组  
数组成员：最少 0 个物品。最多 200 项。  
是否必需：是

## 响应元素
<a name="API_TagResource_ResponseElements"></a>

如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。

## 错误
<a name="API_TagResource_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** InvalidEndpointException **   
请求的端点无效。  
HTTP 状态代码：400

 ** ResourceNotFoundException **   
该操作试图访问不存在的资源。该资源可能未正确指定，或其状态可能不是“活动”状态。  
HTTP 状态代码：400

 ** ServiceQuotaExceededException **   
 已超出此账户的资源实例配额。  
HTTP 状态代码：400

 ** ThrottlingException **   
 用户发出的请求过多，已超出服务配额。请求已被阻止。  
HTTP 状态代码：400

 ** ValidationException **   
 请求无效或格式错误。  
HTTP 状态代码：400

## 另请参阅
<a name="API_TagResource_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/TagResource) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/TagResource) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/TagResource) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/TagResource) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/TagResource) 
+  [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/TagResource) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/TagResource) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/TagResource) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/TagResource) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/TagResource) 

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

 从 Timestream 资源中删除标签的关联。

## 请求语法
<a name="API_UntagResource_RequestSyntax"></a>

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

## 请求参数
<a name="API_UntagResource_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [ResourceARN](#API_UntagResource_RequestSyntax) **   <a name="timestream-UntagResource-request-ResourceARN"></a>
 将从其中移除标签的 Timestream 资源。此值是 Amazon 资源名称（ARN）。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 1011。  
是否必需：是

 ** [TagKeys](#API_UntagResource_RequestSyntax) **   <a name="timestream-UntagResource-request-TagKeys"></a>
 标签键的列表。键属于此列表的资源现有标签将从 Timestream 资源中移除。  
类型：字符串数组  
数组成员：最少 0 个物品。最多 200 项。  
长度限制：最小长度为 1。最大长度为 128。  
是否必需：是

## 响应元素
<a name="API_UntagResource_ResponseElements"></a>

如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。

## 错误
<a name="API_UntagResource_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** InvalidEndpointException **   
请求的端点无效。  
HTTP 状态代码：400

 ** ResourceNotFoundException **   
该操作试图访问不存在的资源。该资源可能未正确指定，或其状态可能不是“活动”状态。  
HTTP 状态代码：400

 ** ServiceQuotaExceededException **   
 已超出此账户的资源实例配额。  
HTTP 状态代码：400

 ** ThrottlingException **   
 用户发出的请求过多，已超出服务配额。请求已被阻止。  
HTTP 状态代码：400

 ** ValidationException **   
 请求无效或格式错误。  
HTTP 状态代码：400

## 另请参阅
<a name="API_UntagResource_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/UntagResource) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/UntagResource) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/UntagResource) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/UntagResource) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/UntagResource) 
+  [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/UntagResource) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/UntagResource) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/UntagResource) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/UntagResource) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/UntagResource) 

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

 修改现有数据库的 AWS KMS 密钥。更新数据库时，必须指定数据库名称和要使用的新 AWS KMS 密钥的标识符 (`KmsKeyId`)。如果存在任何并发 `UpdateDatabase` 请求，则首位写入者胜出。

请参阅[代码示例](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.update-db.html)，了解详细信息。

## 请求语法
<a name="API_UpdateDatabase_RequestSyntax"></a>

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

## 请求参数
<a name="API_UpdateDatabase_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [DatabaseName](#API_UpdateDatabase_RequestSyntax) **   <a name="timestream-UpdateDatabase-request-DatabaseName"></a>
 数据库的名称。  
类型：字符串  
长度限制：最小长度为 3。最大长度为 256。  
是否必需：是

 ** [KmsKeyId](#API_UpdateDatabase_RequestSyntax) **   <a name="timestream-UpdateDatabase-request-KmsKeyId"></a>
 用于加密存储在数据库中的数据的新 AWS KMS 密钥 (`KmsKeyId`) 的标识符。如果数据库中当前注册的 `KmsKeyId` 与请求中的 `KmsKeyId` 相同，则不会进行任何更新。  
您可以使用以下任一项指定 `KmsKeyId`：  
+ 密钥 ID：`1234abcd-12ab-34cd-56ef-1234567890ab`
+ 密钥 ARN：`arn:aws:kms:us-east-1:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
+ 别名：`alias/ExampleAlias`
+ 别名 ARN：`arn:aws:kms:us-east-1:111122223333:alias/ExampleAlias`
类型：字符串  
长度限制：最小长度为 1。最大长度为 2048。  
是否必需：是

## 响应语法
<a name="API_UpdateDatabase_ResponseSyntax"></a>

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

## 响应元素
<a name="API_UpdateDatabase_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Database](#API_UpdateDatabase_ResponseSyntax) **   <a name="timestream-UpdateDatabase-response-Database"></a>
表的顶级容器。数据库和表是 Amazon Timestream 中的基本管理概念。数据库中的所有表都使用相同的 AWS KMS 密钥进行加密。  
类型：[Database](API_Database.md) 对象

## 错误
<a name="API_UpdateDatabase_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** AccessDeniedException **   
您无权执行此操作。  
HTTP 状态代码：400

 ** InternalServerException **   
 由于内部服务器错误，Timestream 无法完全处理此请求。  
HTTP 状态代码：500

 ** InvalidEndpointException **   
请求的端点无效。  
HTTP 状态代码：400

 ** ResourceNotFoundException **   
该操作试图访问不存在的资源。该资源可能未正确指定，或其状态可能不是“活动”状态。  
HTTP 状态代码：400

 ** ServiceQuotaExceededException **   
 已超出此账户的资源实例配额。  
HTTP 状态代码：400

 ** ThrottlingException **   
 用户发出的请求过多，已超出服务配额。请求已被阻止。  
HTTP 状态代码：400

 ** ValidationException **   
 请求无效或格式错误。  
HTTP 状态代码：400

## 另请参阅
<a name="API_UpdateDatabase_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/UpdateDatabase) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/UpdateDatabase) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/UpdateDatabase) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/UpdateDatabase) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/UpdateDatabase) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/UpdateDatabase) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/UpdateDatabase) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/UpdateDatabase) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/UpdateDatabase) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/UpdateDatabase) 

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

修改 Timestream 表的内存存储和磁性存储的保留持续时间。请注意，保留持续时间的更改会立即生效。例如，如果内存存储的保留期最初设置为 2 小时，随后更改为 24 小时，则内存存储将能够保存 24 小时的数据，但在此更改执行后 22 小时将填充 24 小时的数据。Timestream 不会从磁性存储中检索数据以填充内存存储。

请参阅[代码示例](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.update-table.html)，了解详细信息。

## 请求语法
<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"
}
```

## 请求参数
<a name="API_UpdateTable_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [DatabaseName](#API_UpdateTable_RequestSyntax) **   <a name="timestream-UpdateTable-request-DatabaseName"></a>
Timestream 数据库的名称。  
类型：字符串  
长度限制：最小长度为 3。最大长度为 256。  
是否必需：是

 ** [MagneticStoreWriteProperties](#API_UpdateTable_RequestSyntax) **   <a name="timestream-UpdateTable-request-MagneticStoreWriteProperties"></a>
包含启用磁介质存储写入时要在表上设置的属性。  
类型：[MagneticStoreWriteProperties](API_MagneticStoreWriteProperties.md) 对象  
必需：否

 ** [RetentionProperties](#API_UpdateTable_RequestSyntax) **   <a name="timestream-UpdateTable-request-RetentionProperties"></a>
内存存储和磁性存储的保留持续时间。  
类型：[RetentionProperties](API_RetentionProperties.md) 对象  
必需：否

 ** [Schema](#API_UpdateTable_RequestSyntax) **   <a name="timestream-UpdateTable-request-Schema"></a>
 表的架构。  
类型：[Schema](API_Schema.md) 对象  
必需：否

 ** [TableName](#API_UpdateTable_RequestSyntax) **   <a name="timestream-UpdateTable-request-TableName"></a>
Timestream 表的名称。  
类型：字符串  
长度限制：最小长度为 3。最大长度为 256。  
是否必需：是

## 响应语法
<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"
   }
}
```

## 响应元素
<a name="API_UpdateTable_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Table](#API_UpdateTable_ResponseSyntax) **   <a name="timestream-UpdateTable-response-Table"></a>
更新后的 Timestream 表。  
类型：[Table](API_Table.md) 对象

## 错误
<a name="API_UpdateTable_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** AccessDeniedException **   
您无权执行此操作。  
HTTP 状态代码：400

 ** InternalServerException **   
 由于内部服务器错误，Timestream 无法完全处理此请求。  
HTTP 状态代码：500

 ** InvalidEndpointException **   
请求的端点无效。  
HTTP 状态代码：400

 ** ResourceNotFoundException **   
该操作试图访问不存在的资源。该资源可能未正确指定，或其状态可能不是“活动”状态。  
HTTP 状态代码：400

 ** ThrottlingException **   
 用户发出的请求过多，已超出服务配额。请求已被阻止。  
HTTP 状态代码：400

 ** ValidationException **   
 请求无效或格式错误。  
HTTP 状态代码：400

## 另请参阅
<a name="API_UpdateTable_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/UpdateTable) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/UpdateTable) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/UpdateTable) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/UpdateTable) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/UpdateTable) 
+  [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/UpdateTable) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/UpdateTable) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/UpdateTable) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/UpdateTable) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/UpdateTable) 

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

让您能够将时间序列数据写入 Timestream。您可以指定要插入系统的单个数据点或批量数据点。Timestream 提供灵活的架构，能够根据您在调用数据库写入操作时指定的数据点维度名称和数据类型，自动检测 Timestream 表的列名和数据类型。

Timestream 支持最终一致性读取语义。这意味着，如果您将批量数据写入 Timestream 后立即查询数据，查询结果可能不会反映最近完成的写入操作结果。结果可能还包含某些陈旧数据。如果您在短时间后重复查询请求，结果将返回最新的数据。[适用服务配额](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html)。

请参阅[代码示例](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.write.html)，了解详细信息。

 **更新插入** 

您可以在 `WriteRecords` 请求中使用 `Version` 参数，以更新数据点。Timestream 会跟踪每条记录的版本号。当请求中没有为记录指定版本号时，`Version` 默认为 `1`。当 Timestream 接收到针对某条记录具有更高 `Version` 号的写入请求时，会更新该记录的度量值及其 `Version`。当 Timestream 收到更新请求时，如果该请求的度量值与现有记录相同，只要该值大于 `Version` 的现有值，Timestream 仍会更新 `Version`。只要 `Version` 的值不断增加，即可根据需要多次更新数据点。

 例如，假设您写入新记录，但没有在请求中注明 `Version`。Timestream 会存储此记录，并将 `Version` 设置为 `1`。现在，假设您尝试使用具有不同度量值的相同记录的 `WriteRecords` 请求更新此记录，但与之前一样，没有提供 `Version`。在此情况下，Timestream 将拒绝此更新，并显示 `RejectedRecordsException`，因为已更新记录的版本不大于“版本”的现有值。

然而，如果您重新发送更新请求时将 `Version` 设置为 `2`，Timestream 将成功更新该记录的值，并将 `Version` 设置为 `2`。接下来，假设您发送的 `WriteRecords` 请求具有相同的记录和相同的度量值，但将 `Version` 设置为 `3`。在此情况下，Timestream 仅会将 `Version` 更新为 `3`。任何进一步的更新都需要发送大于 `3` 的版本号，否则更新请求将收到 `RejectedRecordsException`。

## 请求语法
<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"
}
```

## 请求参数
<a name="API_WriteRecords_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [CommonAttributes](#API_WriteRecords_RequestSyntax) **   <a name="timestream-WriteRecords-request-CommonAttributes"></a>
一条记录，包含请求中所有记录共享的常用度量、维度、时间和版本属性。当数据写入 Timestream 时，指定的度量和维度属性将与记录对象中的度量和维度属性进行合并。维度不得重叠，否则将抛出 `ValidationException`。换言之，记录必须包含具有唯一名称的维度。  
类型：[Record](API_Record.md) 对象  
必需：否

 ** [DatabaseName](#API_WriteRecords_RequestSyntax) **   <a name="timestream-WriteRecords-request-DatabaseName"></a>
Timestream 数据库的名称。  
类型：字符串  
长度限制：最小长度为 3。最大长度为 256。  
是否必需：是

 ** [Records](#API_WriteRecords_RequestSyntax) **   <a name="timestream-WriteRecords-request-Records"></a>
记录的数组，包含每个时间序列数据点的唯一度量、维度、时间和版本属性。  
类型：[Record](API_Record.md) 对象数组  
数组成员：最少 1 个项目。最多 100 个项目。  
是否必需：是

 ** [TableName](#API_WriteRecords_RequestSyntax) **   <a name="timestream-WriteRecords-request-TableName"></a>
Timestream 表的名称。  
类型：字符串  
长度限制：最小长度为 3。最大长度为 256。  
是否必需：是

## 响应语法
<a name="API_WriteRecords_ResponseSyntax"></a>

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

## 响应元素
<a name="API_WriteRecords_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [RecordsIngested](#API_WriteRecords_ResponseSyntax) **   <a name="timestream-WriteRecords-response-RecordsIngested"></a>
有关此请求所摄取记录的信息。  
类型：[RecordsIngested](API_RecordsIngested.md) 对象

## 错误
<a name="API_WriteRecords_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** AccessDeniedException **   
您无权执行此操作。  
HTTP 状态代码：400

 ** InternalServerException **   
 由于内部服务器错误，Timestream 无法完全处理此请求。  
HTTP 状态代码：500

 ** InvalidEndpointException **   
请求的端点无效。  
HTTP 状态代码：400

 ** RejectedRecordsException **   
 WriteRecords 在以下情况下会抛出这个异常：  
+ 包含重复数据的记录，即存在多个具有相同维度、时间戳和度量名称的记录，但：
  + 度量值不同
  + 请求中未包含版本信息，*或*新记录的版本值等于或小于现有值

   在此情况下，如果 Timestream 拒绝数据，则 `RejectedRecords` 响应中的 `ExistingVersion` 字段将指示当前记录的版本。如需强制执行更新，您可以重新发送请求，并将该记录的版本设置为大于 `ExistingVersion` 的值。
+  记录的时间戳超出内存存储的保留期限。
+  维度或度量超过 Timestream 所定义限制的记录。
 有关更多信息，请参阅《Amazon Timestream 开发人员指南》中的[限额](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html)。    
 ** RejectedRecords **   
 
HTTP 状态代码：400

 ** ResourceNotFoundException **   
该操作试图访问不存在的资源。该资源可能未正确指定，或其状态可能不是“活动”状态。  
HTTP 状态代码：400

 ** ThrottlingException **   
 用户发出的请求过多，已超出服务配额。请求已被阻止。  
HTTP 状态代码：400

 ** ValidationException **   
 请求无效或格式错误。  
HTTP 状态代码：400

## 另请参阅
<a name="API_WriteRecords_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/WriteRecords) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/WriteRecords) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/WriteRecords) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/WriteRecords) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/WriteRecords) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/WriteRecords) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/WriteRecords) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/WriteRecords) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/WriteRecords) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/WriteRecords) 

# Amazon Timestream 查询
<a name="API_Operations_Amazon_Timestream_Query"></a>

Amazon Timestream 查询支持以下操作：
+  [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>

 取消已发出的查询。仅当在发出取消请求之前查询尚未完成运行时，才会提供取消功能。由于取消是幂等性操作，因此后续的取消请求将返回 `CancellationMessage`，表示查询已被取消。请参阅[代码示例](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.cancel-query.html)，了解详细信息。

## 请求语法
<a name="API_query_CancelQuery_RequestSyntax"></a>

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

## 请求参数
<a name="API_query_CancelQuery_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [QueryId](#API_query_CancelQuery_RequestSyntax) **   <a name="timestream-query_CancelQuery-request-QueryId"></a>
 需要取消的查询 ID。`QueryID` 作为查询结果的一部分返回。  
类型：字符串  
长度限制：最小长度为 1。长度上限为 64。  
模式：`[a-zA-Z0-9]+`  
必需：是

## 响应语法
<a name="API_query_CancelQuery_ResponseSyntax"></a>

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

## 响应元素
<a name="API_query_CancelQuery_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [CancellationMessage](#API_query_CancelQuery_ResponseSyntax) **   <a name="timestream-query_CancelQuery-response-CancellationMessage"></a>
 当针对 `QueryId` 指定的查询已发出 `CancelQuery` 请求时，返回 `CancellationMessage`。  
类型：字符串

## 错误
<a name="API_query_CancelQuery_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** AccessDeniedException **   
您没有访问账户设置所需的权限。  
HTTP 状态代码：400

 ** InternalServerException **   
处理请求时发生的内部服务器错误。  
HTTP 状态代码：400

 ** InvalidEndpointException **   
请求的端点无效。  
HTTP 状态代码：400

 ** ThrottlingException **   
该请求因请求过多而受到限制。  
HTTP 状态代码：400

 ** ValidationException **   
 请求无效或格式错误。  
HTTP 状态代码：400

## 另请参阅
<a name="API_query_CancelQuery_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/CancelQuery) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/CancelQuery) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/CancelQuery) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/CancelQuery) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/CancelQuery) 
+  [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/CancelQuery) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/CancelQuery) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/CancelQuery) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/CancelQuery) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/CancelQuery) 

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

 创建一个计划查询，该查询将按照配置的计划代表您运行。Timestream 担任执行角色（作为 `ScheduledQueryExecutionRoleArn` 参数的一部分提供）以运行查询。您可以使用 `NotificationConfiguration` 参数为计划的查询操作配置通知。

## 请求语法
<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"
      }
   }
}
```

## 请求参数
<a name="API_query_CreateScheduledQuery_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [ClientToken](#API_query_CreateScheduledQuery_RequestSyntax) **   <a name="timestream-query_CreateScheduledQuery-request-ClientToken"></a>
使用 a ClientToken 会调用 CreateScheduledQuery idempotent，换句话说，重复发出相同的请求将产生相同的结果。发出多个相同的 CreateScheduledQuery 请求与发出单个请求的效果相同。  
+  如果 CreateScheduledQuery 调用时不带有`ClientToken`，则 Query SDK 会`ClientToken`代表您生成。
+  8 小时后，具有相同 `ClientToken` 的任何请求都将视为新请求。
类型：字符串  
长度限制：最小长度为 32。最大长度为 128。  
必需：否

 ** [ErrorReportConfiguration](#API_query_CreateScheduledQuery_RequestSyntax) **   <a name="timestream-query_CreateScheduledQuery-request-ErrorReportConfiguration"></a>
错误报告的配置。如果写入查询结果时遇到问题，将生成错误报告。  
类型：[ErrorReportConfiguration](API_query_ErrorReportConfiguration.md) 对象  
是否必需：是

 ** [KmsKeyId](#API_query_CreateScheduledQuery_RequestSyntax) **   <a name="timestream-query_CreateScheduledQuery-request-KmsKeyId"></a>
用于静态加密计划查询资源的 Amazon KMS 密钥。如果未指定 Amazon KMS 密钥，则计划查询资源将使用 Timestream 拥有的 Amazon KMS 密钥进行加密。要指定 KMS 密钥，请使用密钥 ID、密钥 ARN、别名名称或别名 ARN。使用别名时，应为名称加上 *alias/*前缀   
如果`SSE_KMS`用作加密类型，则 ErrorReportConfiguration 使用相同的 KmsKeyId 加密类型对错误报告进行静态加密。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 2048。  
必需：否

 ** [Name](#API_query_CreateScheduledQuery_RequestSyntax) **   <a name="timestream-query_CreateScheduledQuery-request-Name"></a>
计划查询的名称。  
类型：字符串  
长度限制：最小长度为 1。长度上限为 64。  
模式：`[a-zA-Z0-9|!\-_*'\(\)]([a-zA-Z0-9]|[!\-_*'\(\)\/.])+`  
是否必需：是

 ** [NotificationConfiguration](#API_query_CreateScheduledQuery_RequestSyntax) **   <a name="timestream-query_CreateScheduledQuery-request-NotificationConfiguration"></a>
计划查询的通知配置。查询运行完成、状态更新或您将其删除时，Timestream 将发送通知。  
类型：[NotificationConfiguration](API_query_NotificationConfiguration.md) 对象  
是否必需：是

 ** [QueryString](#API_query_CreateScheduledQuery_RequestSyntax) **   <a name="timestream-query_CreateScheduledQuery-request-QueryString"></a>
要运行的查询字符串。参数名称可以采用查询字符串 `@` 字符后跟标识符的形式指定。指定的参数 `@scheduled_runtime` 将保留，并可在查询中使用，以获取查询计划运行的时间。  
根据 ScheduleConfiguration 参数计算的时间戳将是每次查询运行的 p `@scheduled_runtime` aramater 的值。例如，考虑在 2021-12-01 00:00:00 执行的计划查询的实例。对于此实例，`@scheduled_runtime` 参数在调用查询时初始化的时间戳为 2021-12-01 00:00:00。  
类型：字符串  
长度限制：最小长度为 1。长度上限为 262144。  
是否必需：是

 ** [ScheduleConfiguration](#API_query_CreateScheduledQuery_RequestSyntax) **   <a name="timestream-query_CreateScheduledQuery-request-ScheduleConfiguration"></a>
查询的计划配置。  
类型：[ScheduleConfiguration](API_query_ScheduleConfiguration.md) 对象  
是否必需：是

 ** [ScheduledQueryExecutionRoleArn](#API_query_CreateScheduledQuery_RequestSyntax) **   <a name="timestream-query_CreateScheduledQuery-request-ScheduledQueryExecutionRoleArn"></a>
Timestream 在运行计划查询时将担任的 IAM 角色的 ARN。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 2048。  
是否必需：是

 ** [Tags](#API_query_CreateScheduledQuery_RequestSyntax) **   <a name="timestream-query_CreateScheduledQuery-request-Tags"></a>
用于标记计划查询的键值对列表。  
类型：[Tag](API_query_Tag.md) 对象数组  
数组成员：最少 0 个物品。最多 200 项。  
必需：否

 ** [TargetConfiguration](#API_query_CreateScheduledQuery_RequestSyntax) **   <a name="timestream-query_CreateScheduledQuery-request-TargetConfiguration"></a>
用于写入查询结果的配置。  
类型：[TargetConfiguration](API_query_TargetConfiguration.md) 对象  
必需：否

## 响应语法
<a name="API_query_CreateScheduledQuery_ResponseSyntax"></a>

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

## 响应元素
<a name="API_query_CreateScheduledQuery_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Arn](#API_query_CreateScheduledQuery_ResponseSyntax) **   <a name="timestream-query_CreateScheduledQuery-response-Arn"></a>
已创建计划查询的 ARN。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 2048。

## 错误
<a name="API_query_CreateScheduledQuery_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** AccessDeniedException **   
您没有访问账户设置所需的权限。  
HTTP 状态代码：400

 ** ConflictException **   
 无法获取已取消查询的轮询结果。  
HTTP 状态代码：400

 ** InternalServerException **   
处理请求时发生的内部服务器错误。  
HTTP 状态代码：400

 ** InvalidEndpointException **   
请求的端点无效。  
HTTP 状态代码：400

 ** ServiceQuotaExceededException **   
已超出服务配额。  
HTTP 状态代码：400

 ** ThrottlingException **   
该请求因请求过多而受到限制。  
HTTP 状态代码：400

 ** ValidationException **   
 请求无效或格式错误。  
HTTP 状态代码：400

## 另请参阅
<a name="API_query_CreateScheduledQuery_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/CreateScheduledQuery) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/CreateScheduledQuery) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/CreateScheduledQuery) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/CreateScheduledQuery) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/CreateScheduledQuery) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/CreateScheduledQuery) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/CreateScheduledQuery) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/CreateScheduledQuery) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/CreateScheduledQuery) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/CreateScheduledQuery) 

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

删除给定的计划查询。此操作不可逆。

## 请求语法
<a name="API_query_DeleteScheduledQuery_RequestSyntax"></a>

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

## 请求参数
<a name="API_query_DeleteScheduledQuery_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [ScheduledQueryArn](#API_query_DeleteScheduledQuery_RequestSyntax) **   <a name="timestream-query_DeleteScheduledQuery-request-ScheduledQueryArn"></a>
计划查询的 ARN。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 2048。  
是否必需：是

## 响应元素
<a name="API_query_DeleteScheduledQuery_ResponseElements"></a>

如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。

## 错误
<a name="API_query_DeleteScheduledQuery_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** AccessDeniedException **   
您没有访问账户设置所需的权限。  
HTTP 状态代码：400

 ** InternalServerException **   
处理请求时发生的内部服务器错误。  
HTTP 状态代码：400

 ** InvalidEndpointException **   
请求的端点无效。  
HTTP 状态代码：400

 ** ResourceNotFoundException **   
找不到请求的资源。    
 ** ScheduledQueryArn **   
计划查询的 ARN。
HTTP 状态代码：400

 ** ThrottlingException **   
该请求因请求过多而受到限制。  
HTTP 状态代码：400

 ** ValidationException **   
 请求无效或格式错误。  
HTTP 状态代码：400

## 另请参阅
<a name="API_query_DeleteScheduledQuery_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/DeleteScheduledQuery) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/DeleteScheduledQuery) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/DeleteScheduledQuery) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/DeleteScheduledQuery) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/DeleteScheduledQuery) 
+  [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/DeleteScheduledQuery) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/DeleteScheduledQuery) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/DeleteScheduledQuery) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/DeleteScheduledQuery) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/DeleteScheduledQuery) 

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

描述您的账户的设置，包括查询定价模型以及 TCUs 该服务可用于您的查询工作负载的配置的最大值。

仅需为工作负载使用的计算单位持续时间付费。

## 响应语法
<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"
}
```

## 响应元素
<a name="API_query_DescribeAccountSettings_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [MaxQueryTCU](#API_query_DescribeAccountSettings_ResponseSyntax) **   <a name="timestream-query_DescribeAccountSettings-response-MaxQueryTCU"></a>
该服务在任何[时间点为你的查询提供服务时将使用的最大 Timestream 计算单元](https://docs.aws.amazon.com/timestream/latest/developerguide/tcu.html) (TCUs) 数。要运行查询，必须将最小容量设置为 4 TCU。可将 TCU 的最大数量设置为 4 的倍数，例如 4、8、16、32 等。此配置仅适用于 (TCUs) 的按需使用。  
类型：整数

 ** [QueryCompute](#API_query_DescribeAccountSettings_ResponseSyntax) **   <a name="timestream-query_DescribeAccountSettings-response-QueryCompute"></a>
一个对象，其中包含您的账户中查询工作负载的 Timestream 计算单位 (TCUs) 的使用设置。 QueryCompute 仅在亚太地区（孟买）区域可用。  
类型：[QueryComputeResponse](API_query_QueryComputeResponse.md) 对象

 ** [QueryPricingModel](#API_query_DescribeAccountSettings_ResponseSyntax) **   <a name="timestream-query_DescribeAccountSettings-response-QueryPricingModel"></a>
账户中查询的定价模式。  
`QueryPricingModel` 参数由多个 Timestream 操作使用；然而，`UpdateAccountSettings` API 操作无法识别除 `COMPUTE_UNITS` 之外的任何值。
类型：字符串  
有效值：`BYTES_SCANNED | COMPUTE_UNITS`

## 错误
<a name="API_query_DescribeAccountSettings_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** AccessDeniedException **   
您没有访问账户设置所需的权限。  
HTTP 状态代码：400

 ** InternalServerException **   
处理请求时发生的内部服务器错误。  
HTTP 状态代码：400

 ** InvalidEndpointException **   
请求的端点无效。  
HTTP 状态代码：400

 ** ThrottlingException **   
该请求因请求过多而受到限制。  
HTTP 状态代码：400

## 另请参阅
<a name="API_query_DescribeAccountSettings_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/DescribeAccountSettings) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/DescribeAccountSettings) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/DescribeAccountSettings) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/DescribeAccountSettings) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/DescribeAccountSettings) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/DescribeAccountSettings) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/DescribeAccountSettings) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/DescribeAccountSettings) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/DescribeAccountSettings) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/DescribeAccountSettings) 

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

DescribeEndpoints 返回用于调用 Timestream API 的可用端点列表。此 API 可通过写入和查询实现。

由于 Timestream SDKs 旨在透明地与服务的架构（包括服务端点的管理和映射）配合使用，*因此不建议您使用此 API*，除非：
+ 您正在将 [VPC 端点（AWS PrivateLink）和 Timestream 结合使用](https://docs.aws.amazon.com/timestream/latest/developerguide/VPCEndpoints) 
+ 应用程序使用的编程语言尚不支持 SDK
+ 需要对客户端实现进行更有效的控制

有关如何以及何时使用和实施的详细信息 DescribeEndpoints，请参阅[端点发现模式](https://docs.aws.amazon.com/timestream/latest/developerguide/Using.API.html#Using-API.endpoint-discovery)。

## 响应语法
<a name="API_query_DescribeEndpoints_ResponseSyntax"></a>

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

## 响应元素
<a name="API_query_DescribeEndpoints_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Endpoints](#API_query_DescribeEndpoints_ResponseSyntax) **   <a name="timestream-query_DescribeEndpoints-response-Endpoints"></a>
`DescribeEndpoints` 请求发出时会返回 `Endpoints` 对象。  
类型：[Endpoint](API_query_Endpoint.md) 对象数组

## 错误
<a name="API_query_DescribeEndpoints_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** InternalServerException **   
处理请求时发生的内部服务器错误。  
HTTP 状态代码：400

 ** ThrottlingException **   
该请求因请求过多而受到限制。  
HTTP 状态代码：400

 ** ValidationException **   
 请求无效或格式错误。  
HTTP 状态代码：400

## 另请参阅
<a name="API_query_DescribeEndpoints_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/DescribeEndpoints) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/DescribeEndpoints) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/DescribeEndpoints) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/DescribeEndpoints) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/DescribeEndpoints) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/DescribeEndpoints) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/DescribeEndpoints) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/DescribeEndpoints) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/DescribeEndpoints) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/DescribeEndpoints) 

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

提供有关计划查询的详细信息。

## 请求语法
<a name="API_query_DescribeScheduledQuery_RequestSyntax"></a>

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

## 请求参数
<a name="API_query_DescribeScheduledQuery_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [ScheduledQueryArn](#API_query_DescribeScheduledQuery_RequestSyntax) **   <a name="timestream-query_DescribeScheduledQuery-request-ScheduledQueryArn"></a>
计划查询的 ARN。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 2048。  
是否必需：是

## 响应语法
<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"
         }
      }
   }
}
```

## 响应元素
<a name="API_query_DescribeScheduledQuery_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [ScheduledQuery](#API_query_DescribeScheduledQuery_ResponseSyntax) **   <a name="timestream-query_DescribeScheduledQuery-response-ScheduledQuery"></a>
计划查询。  
类型：[ScheduledQueryDescription](API_query_ScheduledQueryDescription.md) 对象

## 错误
<a name="API_query_DescribeScheduledQuery_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** AccessDeniedException **   
您没有访问账户设置所需的权限。  
HTTP 状态代码：400

 ** InternalServerException **   
处理请求时发生的内部服务器错误。  
HTTP 状态代码：400

 ** InvalidEndpointException **   
请求的端点无效。  
HTTP 状态代码：400

 ** ResourceNotFoundException **   
找不到请求的资源。    
 ** ScheduledQueryArn **   
计划查询的 ARN。
HTTP 状态代码：400

 ** ThrottlingException **   
该请求因请求过多而受到限制。  
HTTP 状态代码：400

 ** ValidationException **   
 请求无效或格式错误。  
HTTP 状态代码：400

## 另请参阅
<a name="API_query_DescribeScheduledQuery_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/DescribeScheduledQuery) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/DescribeScheduledQuery) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/DescribeScheduledQuery) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/DescribeScheduledQuery) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/DescribeScheduledQuery) 
+  [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/DescribeScheduledQuery) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/DescribeScheduledQuery) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/DescribeScheduledQuery) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/DescribeScheduledQuery) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/DescribeScheduledQuery) 

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

 可使用此 API 手动运行计划查询。

如果已启用 `QueryInsights`，此 API 还会返回与您在 Amazon SNS 通知中所执行查询相关的见解和指标。`QueryInsights` 有助于调整查询的性能。有关 `QueryInsights` 的更多信息，请参阅[使用查询见解优化 Amazon Timestream 中的查询](https://docs.aws.amazon.com/timestream/latest/developerguide/using-query-insights.html)。

## 请求语法
<a name="API_query_ExecuteScheduledQuery_RequestSyntax"></a>

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

## 请求参数
<a name="API_query_ExecuteScheduledQuery_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [ClientToken](#API_query_ExecuteScheduledQuery_RequestSyntax) **   <a name="timestream-query_ExecuteScheduledQuery-request-ClientToken"></a>
未使用。  
类型：字符串  
长度限制：最小长度为 32。最大长度为 128。  
必需：否

 ** [InvocationTime](#API_query_ExecuteScheduledQuery_RequestSyntax) **   <a name="timestream-query_ExecuteScheduledQuery-request-InvocationTime"></a>
UTC 中的时间戳。查询将以该时间戳被调用的形式运行。  
类型：时间戳  
是否必需：是

 ** [QueryInsights](#API_query_ExecuteScheduledQuery_RequestSyntax) **   <a name="timestream-query_ExecuteScheduledQuery-request-QueryInsights"></a>
封装用于启用 `QueryInsights` 的设置。  
启用 `QueryInsights` 返回见解和指标，作为所执行查询的 Amazon SNS 通知的一部分。可使用 `QueryInsights` 以调整查询性能和成本。  
类型：[ScheduledQueryInsights](API_query_ScheduledQueryInsights.md) 对象  
必需：否

 ** [ScheduledQueryArn](#API_query_ExecuteScheduledQuery_RequestSyntax) **   <a name="timestream-query_ExecuteScheduledQuery-request-ScheduledQueryArn"></a>
计划查询的 ARN。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 2048。  
是否必需：是

## 响应元素
<a name="API_query_ExecuteScheduledQuery_ResponseElements"></a>

如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。

## 错误
<a name="API_query_ExecuteScheduledQuery_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** AccessDeniedException **   
您没有访问账户设置所需的权限。  
HTTP 状态代码：400

 ** InternalServerException **   
处理请求时发生的内部服务器错误。  
HTTP 状态代码：400

 ** InvalidEndpointException **   
请求的端点无效。  
HTTP 状态代码：400

 ** ResourceNotFoundException **   
找不到请求的资源。    
 ** ScheduledQueryArn **   
计划查询的 ARN。
HTTP 状态代码：400

 ** ThrottlingException **   
该请求因请求过多而受到限制。  
HTTP 状态代码：400

 ** ValidationException **   
 请求无效或格式错误。  
HTTP 状态代码：400

## 示例
<a name="API_query_ExecuteScheduledQuery_Examples"></a>

### ENABLED\$1WITH\$1RATE\$1CONTROL 模式的计划查询通知消息
<a name="API_query_ExecuteScheduledQuery_Example_1"></a>

以下示例显示 `QueryInsights` 参数 `ENABLED_WITH_RATE_CONTROL` 模式下成功的计划查询通知消息。

```
"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
        }
    }
}
```

### DISABLED 模式的计划查询通知消息
<a name="API_query_ExecuteScheduledQuery_Example_2"></a>

以下示例显示 `QueryInsights` 参数 `DISABLED` 模式下成功的计划查询通知消息。

```
"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
        }
    }
}
```

### ENABLED\$1WITH\$1RATE\$1CONTROL 模式的失败通知消息
<a name="API_query_ExecuteScheduledQuery_Example_3"></a>

以下示例显示 `QueryInsights` 参数 `ENABLED_WITH_RATE_CONTROL` 模式下失败的计划查询通知消息。

```
"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"
    }
}
```

### DISABLED 模式的失败通知消息
<a name="API_query_ExecuteScheduledQuery_Example_4"></a>

以下示例显示 `QueryInsights` 参数 `DISABLED` 模式下失败的计划查询通知消息。

```
"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"
    }
}
```

## 另请参阅
<a name="API_query_ExecuteScheduledQuery_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/ExecuteScheduledQuery) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/ExecuteScheduledQuery) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/ExecuteScheduledQuery) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/ExecuteScheduledQuery) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/ExecuteScheduledQuery) 
+  [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/ExecuteScheduledQuery) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/ExecuteScheduledQuery) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/ExecuteScheduledQuery) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/ExecuteScheduledQuery) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/ExecuteScheduledQuery) 

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

获取调用方 Amazon 账户和区域中所有计划查询的列表。`ListScheduledQueries` 具有最终一致性。

## 请求语法
<a name="API_query_ListScheduledQueries_RequestSyntax"></a>

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

## 请求参数
<a name="API_query_ListScheduledQueries_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [MaxResults](#API_query_ListScheduledQueries_RequestSyntax) **   <a name="timestream-query_ListScheduledQueries-request-MaxResults"></a>
输出中要返回的项目最大数量。如果可用的总项目数超过指定的值，则会在输出中提供 `NextToken`。要恢复分页，请在后续对 `ListScheduledQueriesRequest` 的调用中将 `NextToken` 值作为参数提供。  
类型：整数  
有效范围：最小值为 1。最大值为 1000。  
必需：否

 ** [NextToken](#API_query_ListScheduledQueries_RequestSyntax) **   <a name="timestream-query_ListScheduledQueries-request-NextToken"></a>
 用于恢复分页的分页令牌。  
类型：字符串  
必需：否

## 响应语法
<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"
            }
         }
      }
   ]
}
```

## 响应元素
<a name="API_query_ListScheduledQueries_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [NextToken](#API_query_ListScheduledQueries_ResponseSyntax) **   <a name="timestream-query_ListScheduledQueries-response-NextToken"></a>
指定从何处开始分页的令牌。这是之前截 NextToken 断的响应。  
类型：字符串

 ** [ScheduledQueries](#API_query_ListScheduledQueries_ResponseSyntax) **   <a name="timestream-query_ListScheduledQueries-response-ScheduledQueries"></a>
计划查询的列表。  
类型：[ScheduledQuery](API_query_ScheduledQuery.md) 对象数组

## 错误
<a name="API_query_ListScheduledQueries_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** AccessDeniedException **   
您没有访问账户设置所需的权限。  
HTTP 状态代码：400

 ** InternalServerException **   
处理请求时发生的内部服务器错误。  
HTTP 状态代码：400

 ** InvalidEndpointException **   
请求的端点无效。  
HTTP 状态代码：400

 ** ThrottlingException **   
该请求因请求过多而受到限制。  
HTTP 状态代码：400

 ** ValidationException **   
 请求无效或格式错误。  
HTTP 状态代码：400

## 另请参阅
<a name="API_query_ListScheduledQueries_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/ListScheduledQueries) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/ListScheduledQueries) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/ListScheduledQueries) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/ListScheduledQueries) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/ListScheduledQueries) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/ListScheduledQueries) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/ListScheduledQueries) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/ListScheduledQueries) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/ListScheduledQueries) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/ListScheduledQueries) 

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

列出 Timestream 查询资源上的所有标签。

## 请求语法
<a name="API_query_ListTagsForResource_RequestSyntax"></a>

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

## 请求参数
<a name="API_query_ListTagsForResource_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [MaxResults](#API_query_ListTagsForResource_RequestSyntax) **   <a name="timestream-query_ListTagsForResource-request-MaxResults"></a>
要返回标签的最大数。  
类型：整数  
有效范围：最小值为 1。最大值为 200。  
必需：否

 ** [NextToken](#API_query_ListTagsForResource_RequestSyntax) **   <a name="timestream-query_ListTagsForResource-request-NextToken"></a>
用于恢复分页的分页令牌。  
类型：字符串  
必需：否

 ** [ResourceARN](#API_query_ListTagsForResource_RequestSyntax) **   <a name="timestream-query_ListTagsForResource-request-ResourceARN"></a>
带有待列出标签的 Timestream 资源。此值是 Amazon 资源名称（ARN）。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 2048。  
是否必需：是

## 响应语法
<a name="API_query_ListTagsForResource_ResponseSyntax"></a>

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

## 响应元素
<a name="API_query_ListTagsForResource_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [NextToken](#API_query_ListTagsForResource_ResponseSyntax) **   <a name="timestream-query_ListTagsForResource-response-NextToken"></a>
分页令牌，用于在后续对 `ListTagsForResourceResponse` 的调用时恢复分页。  
类型：字符串

 ** [Tags](#API_query_ListTagsForResource_ResponseSyntax) **   <a name="timestream-query_ListTagsForResource-response-Tags"></a>
当前与 Timestream 资源相关联的标签。  
类型：[Tag](API_query_Tag.md) 对象数组  
数组成员：最少 0 个物品。最多 200 项。

## 错误
<a name="API_query_ListTagsForResource_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** InvalidEndpointException **   
请求的端点无效。  
HTTP 状态代码：400

 ** ResourceNotFoundException **   
找不到请求的资源。    
 ** ScheduledQueryArn **   
计划查询的 ARN。
HTTP 状态代码：400

 ** ThrottlingException **   
该请求因请求过多而受到限制。  
HTTP 状态代码：400

 ** ValidationException **   
 请求无效或格式错误。  
HTTP 状态代码：400

## 另请参阅
<a name="API_query_ListTagsForResource_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/ListTagsForResource) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/ListTagsForResource) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/ListTagsForResource) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/ListTagsForResource) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/ListTagsForResource) 
+  [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/ListTagsForResource) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/ListTagsForResource) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/ListTagsForResource) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/ListTagsForResource) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/ListTagsForResource) 

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

一种同步操作，允许您提交带参数的查询，这些参数将由 Timestream 存储以便后续运行。Timestream 仅支持当 `ValidateOnly` 设置为 `true` 时使用此操作。

## 请求语法
<a name="API_query_PrepareQuery_RequestSyntax"></a>

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

## 请求参数
<a name="API_query_PrepareQuery_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [QueryString](#API_query_PrepareQuery_RequestSyntax) **   <a name="timestream-query_PrepareQuery-request-QueryString"></a>
希望用作准备语句的 Timestream 查询字符串。参数名称可以采用查询字符串 `@` 字符后跟标识符的形式指定。  
类型：字符串  
长度限制：最小长度为 1。长度上限为 262144。  
是否必需：是

 ** [ValidateOnly](#API_query_PrepareQuery_RequestSyntax) **   <a name="timestream-query_PrepareQuery-request-ValidateOnly"></a>
通过将此值设置为 `true`，Timestream 将仅验证查询字符串是否为有效的 Timestream 查询，而不会存储准备查询以供日后使用。  
类型：布尔值  
必需：否

## 响应语法
<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"
}
```

## 响应元素
<a name="API_query_PrepareQuery_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Columns](#API_query_PrepareQuery_ResponseSyntax) **   <a name="timestream-query_PrepareQuery-response-Columns"></a>
已提交查询字符串的 SELECT 子句列的列表。  
类型：[SelectColumn](API_query_SelectColumn.md) 对象数组

 ** [Parameters](#API_query_PrepareQuery_ResponseSyntax) **   <a name="timestream-query_PrepareQuery-response-Parameters"></a>
已提交查询字符串中使用的参数列表。  
类型：[ParameterMapping](API_query_ParameterMapping.md) 对象数组

 ** [QueryString](#API_query_PrepareQuery_ResponseSyntax) **   <a name="timestream-query_PrepareQuery-response-QueryString"></a>
希望准备的查询字符串。  
类型：字符串  
长度限制：最小长度为 1。长度上限为 262144。

## 错误
<a name="API_query_PrepareQuery_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** AccessDeniedException **   
您没有访问账户设置所需的权限。  
HTTP 状态代码：400

 ** InternalServerException **   
处理请求时发生的内部服务器错误。  
HTTP 状态代码：400

 ** InvalidEndpointException **   
请求的端点无效。  
HTTP 状态代码：400

 ** ThrottlingException **   
该请求因请求过多而受到限制。  
HTTP 状态代码：400

 ** ValidationException **   
 请求无效或格式错误。  
HTTP 状态代码：400

## 另请参阅
<a name="API_query_PrepareQuery_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/PrepareQuery) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/PrepareQuery) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/PrepareQuery) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/PrepareQuery) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/PrepareQuery) 
+  [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/PrepareQuery) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/PrepareQuery) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/PrepareQuery) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/PrepareQuery) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/PrepareQuery) 

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

 `Query` 是一种同步操作，可让您对 Amazon Timestream 数据运行查询。

如果已启用 `QueryInsights`，此 API 还会返回与所执行查询相关的见解和指标。`QueryInsights` 有助于调整查询的性能。有关 `QueryInsights` 的更多信息，请参阅[使用查询见解优化 Amazon Timestream 中的查询](https://docs.aws.amazon.com/timestream/latest/developerguide/using-query-insights.html)。

**注意**  
`QueryInsights` 启用后，允许发出的最大 `Query` API 请求数为每秒 1 次查询（QPS）。如果超过此查询速率，可能会导致节流。

 `Query` 将在 60 秒后超时。必须更新 SDK 中的默认超时，以支持 60 秒的超时。请参阅[代码示例](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.run-query.html)，以了解详细信息。

在以下情况下，您的查询请求将失败：
+  如果在 5 分钟的幂等性时段之外使用相同的客户端令牌提交 `Query` 请求。
+  如果在 5 分钟的幂等性时段内使用相同的客户端令牌提交 `Query` 请求，但更改其他参数。
+  如果行的大小（包括查询元数据）超过 1MB，则查询将失败并显示以下错误消息：

   `Query aborted as max page response size has been exceeded by the output result row` 
+  如果查询发起者和结果读取器的 IAM 委托人不相同 and/or ，查询发起者和结果读取器在查询请求中没有相同的查询字符串，则查询将失败并出现错误。`Invalid pagination token`

## 请求语法
<a name="API_query_Query_RequestSyntax"></a>

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

## 请求参数
<a name="API_query_Query_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [ClientToken](#API_query_Query_RequestSyntax) **   <a name="timestream-query_Query-request-ClientToken"></a>
 发送 `Query` 请求时指定、最多包含 64 个 ASCII 字符的唯一且区分大小写的字符串。提供 `ClientToken` 使对 `Query` 的调用具有*幂等性*。这意味着重复运行相同的查询将产生相同的结果。换言之，发出多个相同的 `Query` 请求与发出单个请求具有相同的效果。在查询中使用 `ClientToken` 时，请注意以下事项：  
+  如果在没有 `ClientToken` 的情况下实例化查询 API，则查询 SDK 将为您自动生成 `ClientToken`。
+ 如果 `Query` 调用仅包含 `ClientToken` 但不包含 `NextToken`，则对 `Query` 的调用视作新运行的查询。
+ 如果调用包含 `NextToken`，则该特定调用视作对查询 API 先前调用的后续调用，并返回结果集。
+  4 小时后，任何具有相同请求的请求`ClientToken`都将被视为新请求。
类型：字符串  
长度限制：最小长度为 32。最大长度为 128。  
必需：否

 ** [MaxRows](#API_query_Query_RequestSyntax) **   <a name="timestream-query_Query-request-MaxRows"></a>
 `Query` 输出中要返回的行总数。使用指定的 `MaxRows` 值初始运行 `Query` 将返回查询结果集，具体分为两种情况：  
+ 结果的大小小于 `1MB`。
+ 结果集中的行数小于 `maxRows` 的值。
否则，对 `Query` 的初始调用仅返回 `NextToken`，随后可用于后续调用以获取结果集。要恢复分页，请在后续命令中提供 `NextToken` 值。  
如果行大小较大（例如，行包含许多列），Timestream 可能会返回较少行数，以防响应大小超过 1MB 的限制。如果未提供 `MaxRows`，Timestream 将发送必要的行数，以满足 1MB 的限制。  
类型：整数  
有效范围：最小值为 1。最大值为 1000。  
必需：否

 ** [NextToken](#API_query_Query_RequestSyntax) **   <a name="timestream-query_Query-request-NextToken"></a>
 用于检索结果集的分页令牌。当使用 `Query` 调用 `NextToken` API 时，该特定调用视作对 `Query` 先前调用的后续调用，并返回结果集。然而，如果 `Query` 调用仅包含 `ClientToken`，则对 `Query` 的调用视作新运行的查询。  
在查询 NextToken 中使用时，请注意以下几点：  
+ 分页令牌最多可用于五次 `Query` 调用，或持续使用长达 1 小时（以先到者为准）。
+ 使用相同的 `NextToken` 将返回相同的记录集。要继续对结果集进行分页，则必须使用最新的 `nextToken`。
+ 假设 `Query` 调用返回两个 `NextToken` 值，`TokenA` 和 `TokenB`。如果在后续 `Query` 调用中使用 `TokenB`，则 `TokenA` 会失效且无法重复使用。
+ 在分页开始后，如需请求查询的先前结果集，则必须重新调用查询 API。
+ 应使用最新的 `NextToken` 进行分页，直至返回 `null`，此时应使用新的 `NextToken`。
+  如果查询发起者和结果读取器的 IAM 委托人不相同 and/or ，查询发起者和结果读取器在查询请求中没有相同的查询字符串，则查询将失败并出现错误。`Invalid pagination token`
类型：字符串  
长度限制：最小长度为 1。最大长度为 2048。  
必需：否

 ** [QueryInsights](#API_query_Query_RequestSyntax) **   <a name="timestream-query_Query-request-QueryInsights"></a>
封装用于启用 `QueryInsights` 的设置。  
启用 `QueryInsights`，除所执行查询的查询结果以外，还会返回见解和指标。可使用 `QueryInsights` 以调整查询性能。  
类型：[QueryInsights](API_query_QueryInsights.md) 对象  
必需：否

 ** [QueryString](#API_query_Query_RequestSyntax) **   <a name="timestream-query_Query-request-QueryString"></a>
 由 Timestream 运行的查询。  
类型：字符串  
长度限制：最小长度为 1。长度上限为 262144。  
是否必需：是

## 响应语法
<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"
                  }
               ]
            }
         ]
      }
   ]
}
```

## 响应元素
<a name="API_query_Query_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [ColumnInfo](#API_query_Query_ResponseSyntax) **   <a name="timestream-query_Query-response-ColumnInfo"></a>
 已返回结果集的列数据类型。  
类型：[ColumnInfo](API_query_ColumnInfo.md) 对象数组

 ** [NextToken](#API_query_Query_ResponseSyntax) **   <a name="timestream-query_Query-response-NextToken"></a>
 分页令牌，可在 `Query` 调用中再次使用以获取下一组结果。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 2048。

 ** [QueryId](#API_query_Query_ResponseSyntax) **   <a name="timestream-query_Query-response-QueryId"></a>
 给定查询的唯一 ID。  
类型：字符串  
长度限制：最小长度为 1。长度上限为 64。  
模式：`[a-zA-Z0-9]+`

 ** [QueryInsightsResponse](#API_query_Query_ResponseSyntax) **   <a name="timestream-query_Query-response-QueryInsightsResponse"></a>
封装包含与所执行查询相关见解和指标的 `QueryInsights`。  
类型：[QueryInsightsResponse](API_query_QueryInsightsResponse.md) 对象

 ** [QueryStatus](#API_query_Query_ResponseSyntax) **   <a name="timestream-query_Query-response-QueryStatus"></a>
有关查询状态的信息，包括进度和已扫描的字节数。  
类型：[QueryStatus](API_query_QueryStatus.md) 对象

 ** [Rows](#API_query_Query_ResponseSyntax) **   <a name="timestream-query_Query-response-Rows"></a>
 查询返回的结果集行数。  
类型：[Row](API_query_Row.md) 对象数组

## 错误
<a name="API_query_Query_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** AccessDeniedException **   
您没有访问账户设置所需的权限。  
HTTP 状态代码：400

 ** ConflictException **   
 无法获取已取消查询的轮询结果。  
HTTP 状态代码：400

 ** InternalServerException **   
处理请求时发生的内部服务器错误。  
HTTP 状态代码：400

 ** InvalidEndpointException **   
请求的端点无效。  
HTTP 状态代码：400

 ** QueryExecutionException **   
 Timestream 未能成功运行查询。  
HTTP 状态代码：400

 ** ThrottlingException **   
该请求因请求过多而受到限制。  
HTTP 状态代码：400

 ** ValidationException **   
 请求无效或格式错误。  
HTTP 状态代码：400

## 另请参阅
<a name="API_query_Query_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/Query) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/Query) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/Query) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/Query) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/Query) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/Query) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/Query) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/Query) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/Query) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/Query) 

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

将一组标签与 Timestream 资源关联。然后，您可以激活这些用户定义的标签，以便在账单和成本管理控制台上显示这些标签，从而进行成本分配跟踪。

## 请求语法
<a name="API_query_TagResource_RequestSyntax"></a>

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

## 请求参数
<a name="API_query_TagResource_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [ResourceARN](#API_query_TagResource_RequestSyntax) **   <a name="timestream-query_TagResource-request-ResourceARN"></a>
标识应向其添加标签的 Timestream 资源。此值是 Amazon 资源名称（ARN）。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 2048。  
是否必需：是

 ** [Tags](#API_query_TagResource_RequestSyntax) **   <a name="timestream-query_TagResource-request-Tags"></a>
要分配给 Timestream 资源的标签。  
类型：[Tag](API_query_Tag.md) 对象数组  
数组成员：最少 0 个物品。最多 200 项。  
是否必需：是

## 响应元素
<a name="API_query_TagResource_ResponseElements"></a>

如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。

## 错误
<a name="API_query_TagResource_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** InvalidEndpointException **   
请求的端点无效。  
HTTP 状态代码：400

 ** ResourceNotFoundException **   
找不到请求的资源。    
 ** ScheduledQueryArn **   
计划查询的 ARN。
HTTP 状态代码：400

 ** ServiceQuotaExceededException **   
已超出服务配额。  
HTTP 状态代码：400

 ** ThrottlingException **   
该请求因请求过多而受到限制。  
HTTP 状态代码：400

 ** ValidationException **   
 请求无效或格式错误。  
HTTP 状态代码：400

## 另请参阅
<a name="API_query_TagResource_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/TagResource) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/TagResource) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/TagResource) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/TagResource) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/TagResource) 
+  [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/TagResource) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/TagResource) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/TagResource) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/TagResource) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/TagResource) 

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

从 Timestream 查询资源中删除标签的关联。

## 请求语法
<a name="API_query_UntagResource_RequestSyntax"></a>

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

## 请求参数
<a name="API_query_UntagResource_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [ResourceARN](#API_query_UntagResource_RequestSyntax) **   <a name="timestream-query_UntagResource-request-ResourceARN"></a>
将从其中移除标签的 Timestream 资源。此值是 Amazon 资源名称（ARN）。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 2048。  
是否必需：是

 ** [TagKeys](#API_query_UntagResource_RequestSyntax) **   <a name="timestream-query_UntagResource-request-TagKeys"></a>
标签键的列表。键属于此列表的资源现有标签将从 Timestream 资源中移除。  
类型：字符串数组  
数组成员：最少 0 个物品。最多 200 项。  
长度限制：最小长度为 1。最大长度为 128。  
是否必需：是

## 响应元素
<a name="API_query_UntagResource_ResponseElements"></a>

如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。

## 错误
<a name="API_query_UntagResource_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** InvalidEndpointException **   
请求的端点无效。  
HTTP 状态代码：400

 ** ResourceNotFoundException **   
找不到请求的资源。    
 ** ScheduledQueryArn **   
计划查询的 ARN。
HTTP 状态代码：400

 ** ThrottlingException **   
该请求因请求过多而受到限制。  
HTTP 状态代码：400

 ** ValidationException **   
 请求无效或格式错误。  
HTTP 状态代码：400

## 另请参阅
<a name="API_query_UntagResource_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/UntagResource) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/UntagResource) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/UntagResource) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/UntagResource) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/UntagResource) 
+  [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/UntagResource) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/UntagResource) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/UntagResource) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/UntagResource) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/UntagResource) 

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

转换您的账户以 TCUs 用于查询定价，并修改您配置的最大查询计算单位。如果将 `MaxQueryTCU` 的值减少至所需配置，则新值可能需要长达 24 小时才能生效。

**注意**  
在将账户过渡到 TCUs 用于查询定价之后，您就无法过渡到使用扫描字节来进行查询定价。

## 请求语法
<a name="API_query_UpdateAccountSettings_RequestSyntax"></a>

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

## 请求参数
<a name="API_query_UpdateAccountSettings_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [MaxQueryTCU](#API_query_UpdateAccountSettings_RequestSyntax) **   <a name="timestream-query_UpdateAccountSettings-request-MaxQueryTCU"></a>
该服务在任何时间点为处理查询所使用的最大计算单位数量。要运行查询，必须将最小容量设置为 4 TCU。可将 TCU 的最大数量设置为 4 的倍数，例如 4、8、16、32 等。`MaxQueryTCU` 支持的最大值为 1000。要申请提高此软限制，请联系 Su AWS pport。有关 maxQueryTCU 默认限额的信息，请参阅默认限额。此配置仅适用于 Timestream 计算单元 (TCUs) 的按需使用。  
`MaxQueryTCU` 支持的最大值为 1000。要申请提高此软限制，请联系 Su AWS pport。有关 `maxQueryTCU` 默认限额的信息，请参阅[默认限额](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html#limits.default)。  
类型：整数  
必需：否

 ** [QueryCompute](#API_query_UpdateAccountSettings_RequestSyntax) **   <a name="timestream-query_UpdateAccountSettings-request-QueryCompute"></a>
修改您的账户中配置的查询计算设置，包括查询定价模型和账户中预配置的 Timestream 计算单位 (TCUs)。 QueryCompute 仅在亚太地区（孟买）区域可用。  
此 API 具有幂等性，这意味着多次发出相同请求的效果与发出一次请求的效果相同。
类型：[QueryComputeRequest](API_query_QueryComputeRequest.md) 对象  
必需：否

 ** [QueryPricingModel](#API_query_UpdateAccountSettings_RequestSyntax) **   <a name="timestream-query_UpdateAccountSettings-request-QueryPricingModel"></a>
账户中查询的定价模式。  
`QueryPricingModel` 参数由多个 Timestream 操作使用；然而，`UpdateAccountSettings` API 操作无法识别除 `COMPUTE_UNITS` 之外的任何值。
类型：字符串  
有效值：`BYTES_SCANNED | COMPUTE_UNITS`  
必需：否

## 响应语法
<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"
}
```

## 响应元素
<a name="API_query_UpdateAccountSettings_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [MaxQueryTCU](#API_query_UpdateAccountSettings_ResponseSyntax) **   <a name="timestream-query_UpdateAccountSettings-response-MaxQueryTCU"></a>
该服务在任何时间点为处理查询所使用的最大已配置计算单位数量。  
类型：整数

 ** [QueryCompute](#API_query_UpdateAccountSettings_ResponseSyntax) **   <a name="timestream-query_UpdateAccountSettings-response-QueryCompute"></a>
确认已更新账户设置，用于查询账户中的数据。 QueryCompute 仅在亚太地区（孟买）区域可用。  
类型：[QueryComputeResponse](API_query_QueryComputeResponse.md) 对象

 ** [QueryPricingModel](#API_query_UpdateAccountSettings_ResponseSyntax) **   <a name="timestream-query_UpdateAccountSettings-response-QueryPricingModel"></a>
账户的定价模式。  
类型：字符串  
有效值：`BYTES_SCANNED | COMPUTE_UNITS`

## 错误
<a name="API_query_UpdateAccountSettings_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** AccessDeniedException **   
您没有访问账户设置所需的权限。  
HTTP 状态代码：400

 ** InternalServerException **   
处理请求时发生的内部服务器错误。  
HTTP 状态代码：400

 ** InvalidEndpointException **   
请求的端点无效。  
HTTP 状态代码：400

 ** ThrottlingException **   
该请求因请求过多而受到限制。  
HTTP 状态代码：400

 ** ValidationException **   
 请求无效或格式错误。  
HTTP 状态代码：400

## 另请参阅
<a name="API_query_UpdateAccountSettings_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/UpdateAccountSettings) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/UpdateAccountSettings) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/UpdateAccountSettings) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/UpdateAccountSettings) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/UpdateAccountSettings) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/UpdateAccountSettings) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/UpdateAccountSettings) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/UpdateAccountSettings) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/UpdateAccountSettings) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/UpdateAccountSettings) 

# UpdateScheduledQuery
<a name="API_query_UpdateScheduledQuery"></a>

更新计划查询。

## 请求语法
<a name="API_query_UpdateScheduledQuery_RequestSyntax"></a>

```
{
   "ScheduledQueryArn": "string",
   "State": "string"
}
```

## 请求参数
<a name="API_query_UpdateScheduledQuery_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [ScheduledQueryArn](#API_query_UpdateScheduledQuery_RequestSyntax) **   <a name="timestream-query_UpdateScheduledQuery-request-ScheduledQueryArn"></a>
计划查询的 ARN。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 2048。  
是否必需：是

 ** [State](#API_query_UpdateScheduledQuery_RequestSyntax) **   <a name="timestream-query_UpdateScheduledQuery-request-State"></a>
计划查询的状态。  
类型：字符串  
有效值：`ENABLED | DISABLED`  
是否必需：是

## 响应元素
<a name="API_query_UpdateScheduledQuery_ResponseElements"></a>

如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。

## 错误
<a name="API_query_UpdateScheduledQuery_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** AccessDeniedException **   
您没有访问账户设置所需的权限。  
HTTP 状态代码：400

 ** InternalServerException **   
处理请求时发生的内部服务器错误。  
HTTP 状态代码：400

 ** InvalidEndpointException **   
请求的端点无效。  
HTTP 状态代码：400

 ** ResourceNotFoundException **   
找不到请求的资源。    
 ** ScheduledQueryArn **   
计划查询的 ARN。
HTTP 状态代码：400

 ** ThrottlingException **   
该请求因请求过多而受到限制。  
HTTP 状态代码：400

 ** ValidationException **   
 请求无效或格式错误。  
HTTP 状态代码：400

## 另请参阅
<a name="API_query_UpdateScheduledQuery_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/UpdateScheduledQuery) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/UpdateScheduledQuery) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/UpdateScheduledQuery) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/UpdateScheduledQuery) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/UpdateScheduledQuery) 
+  [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/UpdateScheduledQuery) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/UpdateScheduledQuery) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/UpdateScheduledQuery) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/UpdateScheduledQuery) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/UpdateScheduledQuery) 

# 数据类型
<a name="API_Types"></a>

Amazon Timestream 写入支持以下数据类型：
+  [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) 

Amazon Timestream 查询支持以下数据类型：
+  [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 写入
<a name="API_Types_Amazon_Timestream_Write"></a>

Amazon Timestream 写入支持以下数据类型：
+  [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>

批量加载任务进度的详细信息。

## 内容
<a name="API_BatchLoadProgressReport_Contents"></a>

 ** BytesMetered **   <a name="timestream-Type-BatchLoadProgressReport-BytesMetered"></a>
  
类型：长整型  
必需：否

 ** FileFailures **   <a name="timestream-Type-BatchLoadProgressReport-FileFailures"></a>
  
类型：长整型  
必需：否

 ** ParseFailures **   <a name="timestream-Type-BatchLoadProgressReport-ParseFailures"></a>
  
类型：长整型  
必需：否

 ** RecordIngestionFailures **   <a name="timestream-Type-BatchLoadProgressReport-RecordIngestionFailures"></a>
  
类型：长整型  
必需：否

 ** RecordsIngested **   <a name="timestream-Type-BatchLoadProgressReport-RecordsIngested"></a>
  
类型：长整型  
必需：否

 ** RecordsProcessed **   <a name="timestream-Type-BatchLoadProgressReport-RecordsProcessed"></a>
  
类型：长整型  
必需：否

## 另请参阅
<a name="API_BatchLoadProgressReport_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/BatchLoadProgressReport) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/BatchLoadProgressReport) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/BatchLoadProgressReport) 

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

批量加载任务的详细信息。

## 内容
<a name="API_BatchLoadTask_Contents"></a>

 ** CreationTime **   <a name="timestream-Type-BatchLoadTask-CreationTime"></a>
创建 Timestream 批量加载任务的时间。  
类型：时间戳  
必需：否

 ** DatabaseName **   <a name="timestream-Type-BatchLoadTask-DatabaseName"></a>
批量加载任务将数据加载到其中的数据库名称。  
类型：字符串  
必需：否

 ** LastUpdatedTime **   <a name="timestream-Type-BatchLoadTask-LastUpdatedTime"></a>
上次更新 Timestream 批量加载任务的时间。  
类型：时间戳  
必需：否

 ** ResumableUntil **   <a name="timestream-Type-BatchLoadTask-ResumableUntil"></a>
   
类型：时间戳  
必需：否

 ** TableName **   <a name="timestream-Type-BatchLoadTask-TableName"></a>
批量加载任务将数据加载到其中的表名称。  
类型：字符串  
必需：否

 ** TaskId **   <a name="timestream-Type-BatchLoadTask-TaskId"></a>
批量加载任务的 ID。  
类型：字符串  
长度约束：最小长度为 3。最大长度为 32。  
模式：`[A-Z0-9]+`  
必需：否

 ** TaskStatus **   <a name="timestream-Type-BatchLoadTask-TaskStatus"></a>
批量加载任务的状态。  
类型：字符串  
有效值：`CREATED | IN_PROGRESS | FAILED | SUCCEEDED | PROGRESS_STOPPED | PENDING_RESUME`  
必需：否

## 另请参阅
<a name="API_BatchLoadTask_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/BatchLoadTask) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/BatchLoadTask) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/BatchLoadTask) 

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

批量加载任务的详细信息。

## 内容
<a name="API_BatchLoadTaskDescription_Contents"></a>

 ** CreationTime **   <a name="timestream-Type-BatchLoadTaskDescription-CreationTime"></a>
创建 Timestream 批量加载任务的时间。  
类型：时间戳  
必需：否

 ** DataModelConfiguration **   <a name="timestream-Type-BatchLoadTaskDescription-DataModelConfiguration"></a>
批量加载任务的数据模型配置。这包含有关批量加载任务数据模型存储位置的详细信息。  
类型：[DataModelConfiguration](API_DataModelConfiguration.md) 对象  
必需：否

 ** DataSourceConfiguration **   <a name="timestream-Type-BatchLoadTaskDescription-DataSourceConfiguration"></a>
批量加载任务数据来源的配置详细信息。  
类型：[DataSourceConfiguration](API_DataSourceConfiguration.md) 对象  
必需：否

 ** ErrorMessage **   <a name="timestream-Type-BatchLoadTaskDescription-ErrorMessage"></a>
  
类型：字符串  
长度限制：最小长度为 0。最大长度为 2048。  
必需：否

 ** LastUpdatedTime **   <a name="timestream-Type-BatchLoadTaskDescription-LastUpdatedTime"></a>
上次更新 Timestream 批量加载任务的时间。  
类型：时间戳  
必需：否

 ** ProgressReport **   <a name="timestream-Type-BatchLoadTaskDescription-ProgressReport"></a>
  
类型：[BatchLoadProgressReport](API_BatchLoadProgressReport.md) 对象  
必需：否

 ** RecordVersion **   <a name="timestream-Type-BatchLoadTaskDescription-RecordVersion"></a>
  
类型：长整型  
必需：否

 ** ReportConfiguration **   <a name="timestream-Type-BatchLoadTaskDescription-ReportConfiguration"></a>
批量加载任务的报告配置。这包含有关错误报告存储位置的详细信息。  
类型：[ReportConfiguration](API_ReportConfiguration.md) 对象  
必需：否

 ** ResumableUntil **   <a name="timestream-Type-BatchLoadTaskDescription-ResumableUntil"></a>
   
类型：时间戳  
必需：否

 ** TargetDatabaseName **   <a name="timestream-Type-BatchLoadTaskDescription-TargetDatabaseName"></a>
  
类型：字符串  
必需：否

 ** TargetTableName **   <a name="timestream-Type-BatchLoadTaskDescription-TargetTableName"></a>
  
类型：字符串  
必需：否

 ** TaskId **   <a name="timestream-Type-BatchLoadTaskDescription-TaskId"></a>
批量加载任务的 ID。  
类型：字符串  
长度约束：最小长度为 3。最大长度为 32。  
模式：`[A-Z0-9]+`  
必需：否

 ** TaskStatus **   <a name="timestream-Type-BatchLoadTaskDescription-TaskStatus"></a>
批量加载任务的状态。  
类型：字符串  
有效值：`CREATED | IN_PROGRESS | FAILED | SUCCEEDED | PROGRESS_STOPPED | PENDING_RESUME`  
必需：否

## 另请参阅
<a name="API_BatchLoadTaskDescription_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/BatchLoadTaskDescription) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/BatchLoadTaskDescription) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/BatchLoadTaskDescription) 

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

一种分隔的数据格式，其中列分隔符可以是逗号，记录分隔符是换行符。

## 内容
<a name="API_CsvConfiguration_Contents"></a>

 ** ColumnSeparator **   <a name="timestream-Type-CsvConfiguration-ColumnSeparator"></a>
列分隔符可以是逗号（“,”）、竖线（“\$1”）、分号（“;”）、制表符（“/t”）或空格（“ ”）其中之一。  
类型：字符串  
长度限制：固定长度为 1。  
必需：否

 ** EscapeChar **   <a name="timestream-Type-CsvConfiguration-EscapeChar"></a>
转义字符可以是以下其中之一   
类型：字符串  
长度限制：固定长度为 1。  
必需：否

 ** NullValue **   <a name="timestream-Type-CsvConfiguration-NullValue"></a>
可以是空格（“ ”）。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 256。  
必需：否

 ** QuoteChar **   <a name="timestream-Type-CsvConfiguration-QuoteChar"></a>
可以是单引号（'），也可以是双引号（"）。  
类型：字符串  
长度限制：固定长度为 1。  
必需：否

 ** TrimWhiteSpace **   <a name="timestream-Type-CsvConfiguration-TrimWhiteSpace"></a>
指定剪裁前导和尾随空格。  
类型：布尔值  
必需：否

## 另请参阅
<a name="API_CsvConfiguration_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/CsvConfiguration) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/CsvConfiguration) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/CsvConfiguration) 

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

表的顶级容器。数据库和表是 Amazon Timestream 中的基本管理概念。数据库中的所有表都使用相同的 AWS KMS 密钥进行加密。

## 内容
<a name="API_Database_Contents"></a>

 ** Arn **   <a name="timestream-Type-Database-Arn"></a>
唯一标识此数据库的 Amazon 资源名称。  
类型：字符串  
必需：否

 ** CreationTime **   <a name="timestream-Type-Database-CreationTime"></a>
创建数据库的时间，从 Unix epoch 时间开始计算。  
类型：时间戳  
必需：否

 ** DatabaseName **   <a name="timestream-Type-Database-DatabaseName"></a>
Timestream 数据库的名称。  
类型：字符串  
长度约束：最小长度为 3。长度上限为 256。  
必需：否

 ** KmsKeyId **   <a name="timestream-Type-Database-KmsKeyId"></a>
用于加密存储在数据库中的数据的 AWS KMS 密钥的标识符。  
类型：字符串  
长度限制：最小长度为 0。最大长度为 2048。  
必需：否

 ** LastUpdatedTime **   <a name="timestream-Type-Database-LastUpdatedTime"></a>
 上次更新此数据库的时间。  
类型：时间戳  
必需：否

 ** TableCount **   <a name="timestream-Type-Database-TableCount"></a>
在 Timestream 数据库中查找到的表总数。  
类型：长整型  
必需：否

## 另请参阅
<a name="API_Database_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/Database) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/Database) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/Database) 

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

批量加载任务的数据模型。

## 内容
<a name="API_DataModel_Contents"></a>

 ** DimensionMappings **   <a name="timestream-Type-DataModel-DimensionMappings"></a>
维度的源到目标映射。  
类型：[DimensionMapping](API_DimensionMapping.md) 对象数组  
数组成员：最少 1 个物品。  
必需：是

 ** MeasureNameColumn **   <a name="timestream-Type-DataModel-MeasureNameColumn"></a>
  
类型：字符串  
长度限制：最小长度为 1。最大长度为 256。  
必需：否

 ** MixedMeasureMappings **   <a name="timestream-Type-DataModel-MixedMeasureMappings"></a>
度量的源到目标映射。  
类型：[MixedMeasureMapping](API_MixedMeasureMapping.md) 对象数组  
数组成员：最少 1 个物品。  
必需：否

 ** MultiMeasureMappings **   <a name="timestream-Type-DataModel-MultiMeasureMappings"></a>
多度量记录的源到目标映射。  
类型：[MultiMeasureMappings](API_MultiMeasureMappings.md) 对象  
必需：否

 ** TimeColumn **   <a name="timestream-Type-DataModel-TimeColumn"></a>
要映射到时间的源列。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 256。  
必需：否

 ** TimeUnit **   <a name="timestream-Type-DataModel-TimeUnit"></a>
 时间戳单位的粒度。这指示时间值的单位是秒、毫秒、纳秒还是其他支持的值。默认值为 `MILLISECONDS`。  
类型：字符串  
有效值：`MILLISECONDS | SECONDS | MICROSECONDS | NANOSECONDS`  
必需：否

## 另请参阅
<a name="API_DataModel_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/DataModel) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/DataModel) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/DataModel) 

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



## 内容
<a name="API_DataModelConfiguration_Contents"></a>

 ** DataModel **   <a name="timestream-Type-DataModelConfiguration-DataModel"></a>
  
类型：[DataModel](API_DataModel.md) 对象  
必需：否

 ** DataModelS3Configuration **   <a name="timestream-Type-DataModelConfiguration-DataModelS3Configuration"></a>
  
类型：[DataModelS3Configuration](API_DataModelS3Configuration.md) 对象  
必需：否

## 另请参阅
<a name="API_DataModelConfiguration_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/DataModelConfiguration) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/DataModelConfiguration) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/DataModelConfiguration) 

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



## 内容
<a name="API_DataModelS3Configuration_Contents"></a>

 ** BucketName **   <a name="timestream-Type-DataModelS3Configuration-BucketName"></a>
  
类型：字符串  
长度约束：最小长度为 3。最大长度为 63。  
模式：`[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]`  
必需：否

 ** ObjectKey **   <a name="timestream-Type-DataModelS3Configuration-ObjectKey"></a>
  
类型：字符串  
长度限制：长度下限为 1。长度上限为 1024。  
模式：`[a-zA-Z0-9|!\-_*'\(\)]([a-zA-Z0-9]|[!\-_*'\(\)\/.])+`  
必需：否

## 另请参阅
<a name="API_DataModelS3Configuration_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/DataModelS3Configuration) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/DataModelS3Configuration) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/DataModelS3Configuration) 

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

定义有关数据来源的配置详细信息。

## 内容
<a name="API_DataSourceConfiguration_Contents"></a>

 ** DataFormat **   <a name="timestream-Type-DataSourceConfiguration-DataFormat"></a>
这是当前的 CSV。  
类型：字符串  
有效值：`CSV`  
必需：是

 ** DataSourceS3Configuration **   <a name="timestream-Type-DataSourceConfiguration-DataSourceS3Configuration"></a>
为包含要加载数据的文件配置 S3 位置。  
类型：[DataSourceS3Configuration](API_DataSourceS3Configuration.md) 对象  
必需：是

 ** CsvConfiguration **   <a name="timestream-Type-DataSourceConfiguration-CsvConfiguration"></a>
一种分隔的数据格式，其中列分隔符可以是逗号，记录分隔符是换行符。  
类型：[CsvConfiguration](API_CsvConfiguration.md) 对象  
必需：否

## 另请参阅
<a name="API_DataSourceConfiguration_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/DataSourceConfiguration) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/DataSourceConfiguration) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/DataSourceConfiguration) 

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

 

## 内容
<a name="API_DataSourceS3Configuration_Contents"></a>

 ** BucketName **   <a name="timestream-Type-DataSourceS3Configuration-BucketName"></a>
客户 S3 存储桶的名称。  
类型：字符串  
长度约束：最小长度为 3。最大长度为 63。  
模式：`[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]`  
必需：是

 ** ObjectKeyPrefix **   <a name="timestream-Type-DataSourceS3Configuration-ObjectKeyPrefix"></a>
   
类型：字符串  
长度限制：长度下限为 1。长度上限为 1024。  
模式：`[a-zA-Z0-9|!\-_*'\(\)]([a-zA-Z0-9]|[!\-_*'\(\)\/.])+`  
必需：否

## 另请参阅
<a name="API_DataSourceS3Configuration_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/DataSourceS3Configuration) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/DataSourceS3Configuration) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/DataSourceS3Configuration) 

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

表示时间序列的元数据属性。例如，EC2 实例的名称和可用区或风力涡轮机制造商的名称都是维度。

## 内容
<a name="API_Dimension_Contents"></a>

 ** Name **   <a name="timestream-Type-Dimension-Name"></a>
 维度表示时间序列的元数据属性。例如，EC2 实例的名称和可用区或风力涡轮机制造商的名称都是维度。  
有关维度名称的限制，请参阅[命名约束](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html#limits.naming)。  
类型：字符串  
长度限制：长度下限为 1。最大长度为 60。  
必需：是

 ** Value **   <a name="timestream-Type-Dimension-Value"></a>
维度的值。  
类型：字符串  
必需：是

 ** DimensionValueType **   <a name="timestream-Type-Dimension-DimensionValueType"></a>
时间序列数据点的维度数据类型。  
类型：字符串  
有效值：`VARCHAR`  
必需：否

## 另请参阅
<a name="API_Dimension_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/Dimension) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/Dimension) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/Dimension) 

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



## 内容
<a name="API_DimensionMapping_Contents"></a>

 ** DestinationColumn **   <a name="timestream-Type-DimensionMapping-DestinationColumn"></a>
   
类型：字符串  
长度限制：长度下限为 1。  
必需：否

 ** SourceColumn **   <a name="timestream-Type-DimensionMapping-SourceColumn"></a>
  
类型：字符串  
长度限制：长度下限为 1。  
必需：否

## 另请参阅
<a name="API_DimensionMapping_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/DimensionMapping) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/DimensionMapping) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/DimensionMapping) 

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

表示可发出 API 调用的可用端点，以及该端点的 TTL。

## 内容
<a name="API_Endpoint_Contents"></a>

 ** Address **   <a name="timestream-Type-Endpoint-Address"></a>
端点地址。  
类型：字符串  
必需：是

 ** CachePeriodInMinutes **   <a name="timestream-Type-Endpoint-CachePeriodInMinutes"></a>
端点的 TTL（以分钟为单位）。  
类型：长整型  
必需：是

## 另请参阅
<a name="API_Endpoint_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/Endpoint) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/Endpoint) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/Endpoint) 

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

在磁存储写入期间，为异步拒绝的记录写入错误报告的位置。

## 内容
<a name="API_MagneticStoreRejectedDataLocation_Contents"></a>

 ** S3Configuration **   <a name="timestream-Type-MagneticStoreRejectedDataLocation-S3Configuration"></a>
配置 S3 位置在磁存储写入期间，为异步拒绝的记录写入错误报告。  
类型：[S3Configuration](API_S3Configuration.md) 对象  
必需：否

## 另请参阅
<a name="API_MagneticStoreRejectedDataLocation_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/MagneticStoreRejectedDataLocation) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/MagneticStoreRejectedDataLocation) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/MagneticStoreRejectedDataLocation) 

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

表上用于配置磁存储写入的一组属性。

## 内容
<a name="API_MagneticStoreWriteProperties_Contents"></a>

 ** EnableMagneticStoreWrites **   <a name="timestream-Type-MagneticStoreWriteProperties-EnableMagneticStoreWrites"></a>
启用磁性存储写入的标志。  
类型：布尔值  
必需：是

 ** MagneticStoreRejectedDataLocation **   <a name="timestream-Type-MagneticStoreWriteProperties-MagneticStoreRejectedDataLocation"></a>
在磁存储写入期间，为异步拒绝的记录写入错误报告的位置。  
类型：[MagneticStoreRejectedDataLocation](API_MagneticStoreRejectedDataLocation.md) 对象  
必需：否

## 另请参阅
<a name="API_MagneticStoreWriteProperties_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/MagneticStoreWriteProperties) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/MagneticStoreWriteProperties) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/MagneticStoreWriteProperties) 

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

 表示时间序列的数据属性。例如，EC2 实例的 CPU 利用率或风力涡轮机的 RPM 都是度量。MeasureValue 同时包含名称和值。

 MeasureValue 仅允许用于类型 `MULTI`。使用 `MULTI` 类型，可在单个记录中传递与相同时间序列关联的多个数据属性 

## 内容
<a name="API_MeasureValue_Contents"></a>

 ** Name **   <a name="timestream-Type-MeasureValue-Name"></a>
 MeasureValue 的名称。  
 有关 MeasureValue 名称的限制，请参阅《Amazon Timestream 开发人员指南》中的[命名限制](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html#limits.naming)。  
类型：字符串  
长度限制：长度下限为 1。  
必需：是

 ** Type **   <a name="timestream-Type-MeasureValue-Type"></a>
包含时间序列数据点的 MeasureValue 数据类型。  
类型：字符串  
有效值：`DOUBLE | BIGINT | VARCHAR | BOOLEAN | TIMESTAMP | MULTI`  
必需：是

 ** Value **   <a name="timestream-Type-MeasureValue-Value"></a>
 MeasureValue 的值。有关信息，请参阅[数据类型](https://docs.aws.amazon.com/timestream/latest/developerguide/writes.html#writes.data-types)。  
类型：字符串  
长度限制：最小长度为 0。最大长度为 2048。  
必需：是

## 另请参阅
<a name="API_MeasureValue_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/MeasureValue) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/MeasureValue) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/MeasureValue) 

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



## 内容
<a name="API_MixedMeasureMapping_Contents"></a>

 ** MeasureValueType **   <a name="timestream-Type-MixedMeasureMapping-MeasureValueType"></a>
  
类型：字符串  
有效值：`DOUBLE | BIGINT | VARCHAR | BOOLEAN | TIMESTAMP | MULTI`  
必需：是

 ** MeasureName **   <a name="timestream-Type-MixedMeasureMapping-MeasureName"></a>
  
类型：字符串  
长度限制：长度下限为 1。  
必需：否

 ** MultiMeasureAttributeMappings **   <a name="timestream-Type-MixedMeasureMapping-MultiMeasureAttributeMappings"></a>
  
类型：[MultiMeasureAttributeMapping](API_MultiMeasureAttributeMapping.md) 对象数组  
数组成员：最少 1 个物品。  
必需：否

 ** SourceColumn **   <a name="timestream-Type-MixedMeasureMapping-SourceColumn"></a>
  
类型：字符串  
长度限制：长度下限为 1。  
必需：否

 ** TargetMeasureName **   <a name="timestream-Type-MixedMeasureMapping-TargetMeasureName"></a>
  
类型：字符串  
长度限制：长度下限为 1。  
必需：否

## 另请参阅
<a name="API_MixedMeasureMapping_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/MixedMeasureMapping) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/MixedMeasureMapping) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/MixedMeasureMapping) 

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



## 内容
<a name="API_MultiMeasureAttributeMapping_Contents"></a>

 ** SourceColumn **   <a name="timestream-Type-MultiMeasureAttributeMapping-SourceColumn"></a>
  
类型：字符串  
长度限制：长度下限为 1。  
必需：是

 ** MeasureValueType **   <a name="timestream-Type-MultiMeasureAttributeMapping-MeasureValueType"></a>
  
类型：字符串  
有效值：`DOUBLE | BIGINT | BOOLEAN | VARCHAR | TIMESTAMP`  
必需：否

 ** TargetMultiMeasureAttributeName **   <a name="timestream-Type-MultiMeasureAttributeMapping-TargetMultiMeasureAttributeName"></a>
  
类型：字符串  
长度限制：长度下限为 1。  
必需：否

## 另请参阅
<a name="API_MultiMeasureAttributeMapping_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/MultiMeasureAttributeMapping) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/MultiMeasureAttributeMapping) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/MultiMeasureAttributeMapping) 

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



## 内容
<a name="API_MultiMeasureMappings_Contents"></a>

 ** MultiMeasureAttributeMappings **   <a name="timestream-Type-MultiMeasureMappings-MultiMeasureAttributeMappings"></a>
  
类型：[MultiMeasureAttributeMapping](API_MultiMeasureAttributeMapping.md) 对象数组  
数组成员：最少 1 个物品。  
必需：是

 ** TargetMultiMeasureName **   <a name="timestream-Type-MultiMeasureMappings-TargetMultiMeasureName"></a>
  
类型：字符串  
长度限制：长度下限为 1。  
必需：否

## 另请参阅
<a name="API_MultiMeasureMappings_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/MultiMeasureMappings) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/MultiMeasureMappings) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/MultiMeasureMappings) 

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

 用于对表中数据进行分区的属性。维度键使用维度名称指定的维度值作为分区键对数据进行分区，而度量键则使用度量名称（即“measure\$1name”列的值）对数据进行分区。

## 内容
<a name="API_PartitionKey_Contents"></a>

 ** Type **   <a name="timestream-Type-PartitionKey-Type"></a>
 分区键的类型。选项包括 DIMENSION（维度键）和 MEASURE（度量键）。  
类型：字符串  
有效值：`DIMENSION | MEASURE`  
必需：是

 ** EnforcementInRecord **   <a name="timestream-Type-PartitionKey-EnforcementInRecord"></a>
 对摄取记录中维度键规范的强制执行级别。选项包括 REQUIRED（必须指定维度键）和 OPTIONAL（无需指定维度键）。  
类型：字符串  
有效值：`REQUIRED | OPTIONAL`  
必需：否

 ** Name **   <a name="timestream-Type-PartitionKey-Name"></a>
 维度键所使用属性的名称。  
类型：字符串  
长度限制：长度下限为 1。  
必需：否

## 另请参阅
<a name="API_PartitionKey_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/PartitionKey) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/PartitionKey) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/PartitionKey) 

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

表示将写入 Timestream 的时间序列数据点。每条记录均包含维度数组。维度表示时间序列数据点的元数据属性，例如 EC2 实例的实例名称或可用区。记录还包含度量名称，即正在收集的度量名称（例如，EC2 实例的 CPU 利用率）。此外，记录还包含度量值及值类型，即度量值的数据类型。此外，记录包含收集度量的时间戳及时间戳单位，后者表示时间戳的粒度。

 记录包含 `Version` 字段，该字段是 64 位 `long`，可用于更新数据点。写入具有相同维度、时间戳和度量名称但度量值不同的重复记录时，仅当写入请求中记录的 `Version` 属性高于现有记录时才会成功。对于没有 `Version` 字段的记录，Timestream 默认使用 `1` 的 `Version`。

## 内容
<a name="API_Record_Contents"></a>

 ** Dimensions **   <a name="timestream-Type-Record-Dimensions"></a>
包含时间序列数据点的维度列表。  
类型：[Dimension](API_Dimension.md) 对象数组  
数组成员：最多 128 项。  
必需：否

 ** MeasureName **   <a name="timestream-Type-Record-MeasureName"></a>
度量表示时间序列的数据属性。例如，EC2 实例的 CPU 利用率或风力涡轮机的 RPM 都是度量。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 256。  
必需：否

 ** MeasureValue **   <a name="timestream-Type-Record-MeasureValue"></a>
 包含时间序列数据点的度量值。  
类型：字符串  
长度限制：最小长度为 0。最大长度为 2048。  
必需：否

 ** MeasureValues **   <a name="timestream-Type-Record-MeasureValues"></a>
 包含时间序列数据的 MeasureValue 列表。  
 这仅限于类型 `MULTI`。对于标量值，直接使用记录的 `MeasureValue` 属性。  
类型：[MeasureValue](API_MeasureValue.md) 对象数组  
必需：否

 ** MeasureValueType **   <a name="timestream-Type-Record-MeasureValueType"></a>
 包含时间序列数据点的度量值数据类型。默认类型为 `DOUBLE`。有关更多信息，请参阅[数据类型](https://docs.aws.amazon.com/timestream/latest/developerguide/writes.html#writes.data-types)。  
类型：字符串  
有效值：`DOUBLE | BIGINT | VARCHAR | BOOLEAN | TIMESTAMP | MULTI`  
必需：否

 ** Time **   <a name="timestream-Type-Record-Time"></a>
 包含收集数据点度量值的时间。时间值加上单位即为自 epoch 以来经过的时间。例如，如果时间值为 `12345`，单位为 `ms`，则自 epoch 以来已经过 `12345 ms`。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 256。  
必需：否

 ** TimeUnit **   <a name="timestream-Type-Record-TimeUnit"></a>
 时间戳单位的粒度。这指示时间值的单位是秒、毫秒、纳秒还是其他支持的值。默认值为 `MILLISECONDS`。  
类型：字符串  
有效值：`MILLISECONDS | SECONDS | MICROSECONDS | NANOSECONDS`  
必需：否

 ** Version **   <a name="timestream-Type-Record-Version"></a>
用于更新记录的 64 位属性。具有更高版本号的重复数据写入请求将更新现有度量值和版本。如果度量值相同，`Version` 仍会进行更新。默认值为 `1`。  
 `Version` 必须等于或大于 `1`，否则将收到 `ValidationException` 错误。
类型：长整型  
必需：否

## 另请参阅
<a name="API_Record_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/Record) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/Record) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/Record) 

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

有关此请求所摄取记录的信息。

## 内容
<a name="API_RecordsIngested_Contents"></a>

 ** MagneticStore **   <a name="timestream-Type-RecordsIngested-MagneticStore"></a>
摄取到磁性存储的记录计数。  
类型：整数  
必需：否

 ** MemoryStore **   <a name="timestream-Type-RecordsIngested-MemoryStore"></a>
摄取到内存存储的记录计数。  
类型：整数  
必需：否

 ** Total **   <a name="timestream-Type-RecordsIngested-Total"></a>
成功摄取的记录总计数。  
类型：整数  
必需：否

## 另请参阅
<a name="API_RecordsIngested_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/RecordsIngested) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/RecordsIngested) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/RecordsIngested) 

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

 表示因数据验证问题未能成功插入 Timestream 的记录，必须解决这些问题后才能将时间序列数据重新插入系统。

## 内容
<a name="API_RejectedRecord_Contents"></a>

 ** ExistingVersion **   <a name="timestream-Type-RejectedRecord-ExistingVersion"></a>
记录的现有版本。如果存在版本号高于写入请求版本号的相同记录，则会填充此值。  
类型：长整型  
必需：否

 ** Reason **   <a name="timestream-Type-RejectedRecord-Reason"></a>
 记录未成功插入 Timestream 的原因。失败的可能原因包括：  
+ 包含重复数据的记录，即存在多个具有相同维度、时间戳和度量名称的记录，但：
  + 度量值不同
  + 请求中未包含版本信息，*或*新记录的版本值等于或小于现有值

  如果 Timestream 拒绝此案例的数据，则 `RejectedRecords` 响应中的 `ExistingVersion` 字段将指示当前记录的版本。如需强制执行更新，您可以重新发送请求，并将该记录的版本设置为大于 `ExistingVersion` 的值。
+  记录的时间戳超出内存存储的保留期限。
**注意**  
当更新保留窗口时，如果立即尝试在新窗口内摄取数据，将收到 `RejectedRecords` 异常消息。为避免 `RejectedRecords` 异常，请等待新窗口的持续时间结束后再摄取新数据。有关更多信息，请参阅[配置 Timestream 的最佳实践](https://docs.aws.amazon.com/timestream/latest/developerguide/best-practices.html#configuration)以及[关于 Timestream 中存储工作原理的说明](https://docs.aws.amazon.com/timestream/latest/developerguide/storage.html)。
+  维度或度量超过 Timestream 所定义限制的记录。
 有关更多信息，请参阅《Timestream 开发人员指南》中的[访问管理](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html)。  
类型：字符串  
必需：否

 ** RecordIndex **   <a name="timestream-Type-RejectedRecord-RecordIndex"></a>
 WriteRecords 输入请求中记录的索引。索引从 0 开始。  
类型：整数  
必需：否

## 另请参阅
<a name="API_RejectedRecord_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/RejectedRecord) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/RejectedRecord) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/RejectedRecord) 

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

批量加载任务的报告配置。这包含有关错误报告存储位置的详细信息。

## 内容
<a name="API_ReportConfiguration_Contents"></a>

 ** ReportS3Configuration **   <a name="timestream-Type-ReportConfiguration-ReportS3Configuration"></a>
配置 S3 位置，用于写入批量加载的错误报告和事件。  
类型：[ReportS3Configuration](API_ReportS3Configuration.md) 对象  
必需：否

## 另请参阅
<a name="API_ReportConfiguration_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/ReportConfiguration) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/ReportConfiguration) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/ReportConfiguration) 

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



## 内容
<a name="API_ReportS3Configuration_Contents"></a>

 ** BucketName **   <a name="timestream-Type-ReportS3Configuration-BucketName"></a>
  
类型：字符串  
长度约束：最小长度为 3。最大长度为 63。  
模式：`[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]`  
必需：是

 ** EncryptionOption **   <a name="timestream-Type-ReportS3Configuration-EncryptionOption"></a>
  
类型：字符串  
有效值：`SSE_S3 | SSE_KMS`  
必需：否

 ** KmsKeyId **   <a name="timestream-Type-ReportS3Configuration-KmsKeyId"></a>
  
类型：字符串  
长度限制：最小长度为 0。最大长度为 2048。  
必需：否

 ** ObjectKeyPrefix **   <a name="timestream-Type-ReportS3Configuration-ObjectKeyPrefix"></a>
  
类型：字符串  
长度限制：长度下限为 1。最大长度为 928。  
模式：`[a-zA-Z0-9|!\-_*'\(\)]([a-zA-Z0-9]|[!\-_*'\(\)\/.])+`  
必需：否

## 另请参阅
<a name="API_ReportS3Configuration_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/ReportS3Configuration) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/ReportS3Configuration) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/ReportS3Configuration) 

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

保留属性包含您的时间序列数据必须存储在磁存储和内存存储中的持续时间。

## 内容
<a name="API_RetentionProperties_Contents"></a>

 ** MagneticStoreRetentionPeriodInDays **   <a name="timestream-Type-RetentionProperties-MagneticStoreRetentionPeriodInDays"></a>
数据必须存储在磁存储中的持续时间。  
类型：长整型  
有效范围：最小值为 1。最大值为 73000。  
必需：是

 ** MemoryStoreRetentionPeriodInHours **   <a name="timestream-Type-RetentionProperties-MemoryStoreRetentionPeriodInHours"></a>
数据必须存储在内存存储中的持续时间。  
类型：长整型  
有效范围：最小值为 1。最大值为 8766。  
必需：是

## 另请参阅
<a name="API_RetentionProperties_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/RetentionProperties) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/RetentionProperties) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/RetentionProperties) 

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

指定 S3 位置的配置。

## 内容
<a name="API_S3Configuration_Contents"></a>

 ** BucketName **   <a name="timestream-Type-S3Configuration-BucketName"></a>
客户 S3 存储桶的名称。  
类型：字符串  
长度约束：最小长度为 3。最大长度为 63。  
模式：`[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]`  
必需：否

 ** EncryptionOption **   <a name="timestream-Type-S3Configuration-EncryptionOption"></a>
客户 S3 位置的加密选项。选项为使用 S3 托管密钥或 AWS 托管密钥进行 S3 服务器端加密。  
类型：字符串  
有效值：`SSE_S3 | SSE_KMS`  
必需：否

 ** KmsKeyId **   <a name="timestream-Type-S3Configuration-KmsKeyId"></a>
使用 AWS 托管密钥加密时客户 S3 位置的 AWS KMS 密钥 ID。  
类型：字符串  
长度限制：最小长度为 0。最大长度为 2048。  
必需：否

 ** ObjectKeyPrefix **   <a name="timestream-Type-S3Configuration-ObjectKeyPrefix"></a>
客户 S3 位置的对象键预览。  
类型：字符串  
长度限制：长度下限为 1。最大长度为 928。  
模式：`[a-zA-Z0-9|!\-_*'\(\)]([a-zA-Z0-9]|[!\-_*'\(\)\/.])+`  
必需：否

## 另请参阅
<a name="API_S3Configuration_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/S3Configuration) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/S3Configuration) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/S3Configuration) 

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

 架构指定表的预期数据模型。

## 内容
<a name="API_Schema_Contents"></a>

 ** CompositePartitionKey **   <a name="timestream-Type-Schema-CompositePartitionKey"></a>
非空的分区键列表，定义用于对表数据进行分区的属性。列表的顺序决定分区层次结构。创建表后，每个分区键的名称、类型以及分区键顺序均不可更改。然而，可更改每个分区键的强制级别。  
类型：[PartitionKey](API_PartitionKey.md) 对象数组  
数组成员：最少 1 个物品。  
必需：否

## 另请参阅
<a name="API_Schema_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/Schema) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/Schema) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/Schema) 

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

表示 Timestream 中的数据库表。表包含一个或多个相关的时间序列。可以修改表的内存存储和磁性存储的保留持续时间。

## 内容
<a name="API_Table_Contents"></a>

 ** Arn **   <a name="timestream-Type-Table-Arn"></a>
唯一标识此表的 Amazon 资源名称。  
类型：字符串  
必需：否

 ** CreationTime **   <a name="timestream-Type-Table-CreationTime"></a>
Timestream 表创建的时间。  
类型：时间戳  
必需：否

 ** DatabaseName **   <a name="timestream-Type-Table-DatabaseName"></a>
包含此表的 Timestream 数据库的名称。  
类型：字符串  
长度约束：最小长度为 3。长度上限为 256。  
必需：否

 ** LastUpdatedTime **   <a name="timestream-Type-Table-LastUpdatedTime"></a>
上次更新 Timestream 表的时间。  
类型：时间戳  
必需：否

 ** MagneticStoreWriteProperties **   <a name="timestream-Type-Table-MagneticStoreWriteProperties"></a>
包含启用磁存储写入时要在表上设置的属性。  
类型：[MagneticStoreWriteProperties](API_MagneticStoreWriteProperties.md) 对象  
必需：否

 ** RetentionProperties **   <a name="timestream-Type-Table-RetentionProperties"></a>
内存存储和磁性存储的保留持续时间。  
类型：[RetentionProperties](API_RetentionProperties.md) 对象  
必需：否

 ** Schema **   <a name="timestream-Type-Table-Schema"></a>
 表的架构。  
类型：[Schema](API_Schema.md) 对象  
必需：否

 ** TableName **   <a name="timestream-Type-Table-TableName"></a>
Timestream 表的名称。  
类型：字符串  
长度约束：最小长度为 3。长度上限为 256。  
必需：否

 ** TableStatus **   <a name="timestream-Type-Table-TableStatus"></a>
表的当前状态：  
+  `DELETING`：正在删除表。
+  `ACTIVE`：表已准备就绪，可供使用。
类型：字符串  
有效值：`ACTIVE | DELETING | RESTORING`  
必需：否

## 另请参阅
<a name="API_Table_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/Table) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/Table) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/Table) 

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

 标签是指为 Timestream 数据库和/或表分配的标识。每个标签都包含定义的一个键和一个可选值。使用标签，可按用途、所有者或环境对数据库和/或表进行分类。

## 内容
<a name="API_Tag_Contents"></a>

 ** Key **   <a name="timestream-Type-Tag-Key"></a>
 标签的密钥。标签键区分大小写。  
类型：字符串  
长度限制：长度下限为 1。最大长度为 128。  
必需：是

 ** Value **   <a name="timestream-Type-Tag-Value"></a>
 标签的值。标签值区分大小写，可以为 null。  
类型：字符串  
长度约束：最小长度为 0。最大长度为 256。  
必需：是

## 另请参阅
<a name="API_Tag_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/Tag) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/Tag) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/Tag) 

# Amazon Timestream 查询
<a name="API_Types_Amazon_Timestream_Query"></a>

Amazon Timestream 查询支持以下数据类型：
+  [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>

账户设置相关通知的配置设置。

## 内容
<a name="API_query_AccountSettingsNotificationConfiguration_Contents"></a>

 ** RoleArn **   <a name="timestream-Type-query_AccountSettingsNotificationConfiguration-RoleArn"></a>
授予 Timestream 发布通知权限的 Amazon 资源名称（ARN）。仅当更新账户设置时提供 SNS 主题的情况下，此字段才会显示。  
类型：字符串  
长度限制：最小长度为 0。最大长度为 2048。  
必需：是

 ** SnsConfiguration **   <a name="timestream-Type-query_AccountSettingsNotificationConfiguration-SnsConfiguration"></a>
发送通知所需的 SNS 的详细信息。  
类型：[SnsConfiguration](API_query_SnsConfiguration.md) 对象  
必需：否

## 另请参阅
<a name="API_query_AccountSettingsNotificationConfiguration_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/AccountSettingsNotificationConfiguration) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/AccountSettingsNotificationConfiguration) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/AccountSettingsNotificationConfiguration) 

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

 包含查询结果的元数据，例如列名称、数据类型以及其他属性。

## 内容
<a name="API_query_ColumnInfo_Contents"></a>

 ** Type **   <a name="timestream-Type-query_ColumnInfo-Type"></a>
结果集列的数据类型。数据类型可以是标量，也可以是复数。标量数据类型包括整数、字符串、双精度、布尔值及其他类型。复数数据类型包括数组、行及其他类型。  
类型：[Type](API_query_Type.md) 对象  
必需：是

 ** Name **   <a name="timestream-Type-query_ColumnInfo-Name"></a>
 结果集列的名称。除数组外，所有数据类型的列均可使用结果集的名称。  
类型：字符串  
必需：否

## 另请参阅
<a name="API_query_ColumnInfo_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/ColumnInfo) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/ColumnInfo) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/ColumnInfo) 

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

 Datum 表示查询结果中的单个数据点。

## 内容
<a name="API_query_Datum_Contents"></a>

 ** ArrayValue **   <a name="timestream-Type-query_Datum-ArrayValue"></a>
 指示数据点是否为数组。  
类型：[Datum](#API_query_Datum) 对象数组  
必需：否

 ** NullValue **   <a name="timestream-Type-query_Datum-NullValue"></a>
 指示数据点是否为 null。  
类型：布尔值  
必需：否

 ** RowValue **   <a name="timestream-Type-query_Datum-RowValue"></a>
 指示数据点是否为行。  
类型：[Row](API_query_Row.md) 对象  
必需：否

 ** ScalarValue **   <a name="timestream-Type-query_Datum-ScalarValue"></a>
 指示数据点是否为标量值，例如整数、字符串、双精度或布尔值。  
类型：字符串  
必需：否

 ** TimeSeriesValue **   <a name="timestream-Type-query_Datum-TimeSeriesValue"></a>
 指示数据点是否为时间序列数据类型。  
类型：[TimeSeriesDataPoint](API_query_TimeSeriesDataPoint.md) 对象数组  
必需：否

## 另请参阅
<a name="API_query_Datum_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/Datum) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/Datum) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/Datum) 

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

此类型用于将查询结果中的列映射到目标表中的维度。

## 内容
<a name="API_query_DimensionMapping_Contents"></a>

 ** DimensionValueType **   <a name="timestream-Type-query_DimensionMapping-DimensionValueType"></a>
维度的类型。  
类型：字符串  
有效值：`VARCHAR`  
必需：是

 ** Name **   <a name="timestream-Type-query_DimensionMapping-Name"></a>
查询结果中的列名。  
类型：字符串  
必需：是

## 另请参阅
<a name="API_query_DimensionMapping_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/DimensionMapping) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/DimensionMapping) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/DimensionMapping) 

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

表示可发出 API 调用的可用端点，以及该端点的 TTL。

## 内容
<a name="API_query_Endpoint_Contents"></a>

 ** Address **   <a name="timestream-Type-query_Endpoint-Address"></a>
端点地址。  
类型：字符串  
必需：是

 ** CachePeriodInMinutes **   <a name="timestream-Type-query_Endpoint-CachePeriodInMinutes"></a>
端点的 TTL（以分钟为单位）。  
类型：长整型  
必需：是

## 另请参阅
<a name="API_query_Endpoint_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/Endpoint) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/Endpoint) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/Endpoint) 

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

错误报告所需的配置。

## 内容
<a name="API_query_ErrorReportConfiguration_Contents"></a>

 ** S3Configuration **   <a name="timestream-Type-query_ErrorReportConfiguration-S3Configuration"></a>
错误报告的 S3 配置。  
类型：[S3Configuration](API_query_S3Configuration.md) 对象  
必需：是

## 另请参阅
<a name="API_query_ErrorReportConfiguration_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/ErrorReportConfiguration) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/ErrorReportConfiguration) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/ErrorReportConfiguration) 

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

这包含针对单个计划查询调用的错误报告位置。

## 内容
<a name="API_query_ErrorReportLocation_Contents"></a>

 ** S3ReportLocation **   <a name="timestream-Type-query_ErrorReportLocation-S3ReportLocation"></a>
用于写入错误报告的 S3 位置。  
类型：[S3ReportLocation](API_query_S3ReportLocation.md) 对象  
必需：否

## 另请参阅
<a name="API_query_ErrorReportLocation_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/ErrorReportLocation) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/ErrorReportLocation) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/ErrorReportLocation) 

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

单个计划查询运行的统计数据。

## 内容
<a name="API_query_ExecutionStats_Contents"></a>

 ** BytesMetered **   <a name="timestream-Type-query_ExecutionStats-BytesMetered"></a>
单个计划查询运行计量的字节数。  
类型：长整型  
必需：否

 ** CumulativeBytesScanned **   <a name="timestream-Type-query_ExecutionStats-CumulativeBytesScanned"></a>
单个计划查询运行扫描的字节数。  
类型：长整型  
必需：否

 ** DataWrites **   <a name="timestream-Type-query_ExecutionStats-DataWrites"></a>
按单个计划查询运行中摄取记录计量的数据写入量。  
类型：长整型  
必需：否

 ** ExecutionTimeInMillis **   <a name="timestream-Type-query_ExecutionStats-ExecutionTimeInMillis"></a>
完成计划查询运行所需的总时间，以毫秒为单位。  
类型：长整型  
必需：否

 ** QueryResultRows **   <a name="timestream-Type-query_ExecutionStats-QueryResultRows"></a>
将查询摄取到目标数据来源之前，运行查询所产生输出中显示的行数。  
类型：长整型  
必需：否

 ** RecordsIngested **   <a name="timestream-Type-query_ExecutionStats-RecordsIngested"></a>
单个计划查询运行摄取的记录数。  
类型：长整型  
必需：否

## 另请参阅
<a name="API_query_ExecutionStats_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/ExecutionStats) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/ExecutionStats) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/ExecutionStats) 

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

包含最近一次账户设置更新的配置对象，仅在先前进行过设置更新时显示。

## 内容
<a name="API_query_LastUpdate_Contents"></a>

 ** Status **   <a name="timestream-Type-query_LastUpdate-Status"></a>
上次更新的状态。可以是 `PENDING`、`FAILED` 或 `SUCCEEDED`。  
类型：字符串  
有效值：`PENDING | FAILED | SUCCEEDED`  
必需：否

 ** StatusMessage **   <a name="timestream-Type-query_LastUpdate-StatusMessage"></a>
描述上次账户设置更新状态的错误消息，仅在发生错误时显示。  
类型：字符串  
必需：否

 ** TargetQueryTCU **   <a name="timestream-Type-query_LastUpdate-TargetQueryTCU"></a>
上次账户设置更新中请求的 TimeStream 计算单位（TCU）数量。  
类型：整数  
必需：否

## 另请参阅
<a name="API_query_LastUpdate_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/LastUpdate) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/LastUpdate) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/LastUpdate) 

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

MixedMeasureMappings 是可用于将数据提取到派生表中的窄度量和多度量混合中的映射。

## 内容
<a name="API_query_MixedMeasureMapping_Contents"></a>

 ** MeasureValueType **   <a name="timestream-Type-query_MixedMeasureMapping-MeasureValueType"></a>
要从 sourceColumn 读取的值的类型。如果映射适用于 MULTI，请使用 MeasureValueType.MULTI。  
类型：字符串  
有效值：`BIGINT | BOOLEAN | DOUBLE | VARCHAR | MULTI`  
必需：是

 ** MeasureName **   <a name="timestream-Type-query_MixedMeasureMapping-MeasureName"></a>
指结果行中 measure\$1name 的值。如果提供了 MeasureNameColumn，则此字段是必需的。  
类型：字符串  
必需：否

 ** MultiMeasureAttributeMappings **   <a name="timestream-Type-query_MixedMeasureMapping-MultiMeasureAttributeMappings"></a>
measureValueType 为 MULTI 时需要。MULTI 值度量的属性映射。  
类型：[MultiMeasureAttributeMapping](API_query_MultiMeasureAttributeMapping.md) 对象数组  
数组成员：最少 1 个物品。  
必需：否

 ** SourceColumn **   <a name="timestream-Type-query_MixedMeasureMapping-SourceColumn"></a>
此字段指的是要从中读取度量值以实现结果具体化的源列。  
类型：字符串  
必需：否

 ** TargetMeasureName **   <a name="timestream-Type-query_MixedMeasureMapping-TargetMeasureName"></a>
要使用的目标度量名称。如果未提供，则目标度量名称默认为 measure-name（如果提供），否则为 sourceColumn。  
类型：字符串  
必需：否

## 另请参阅
<a name="API_query_MixedMeasureMapping_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/MixedMeasureMapping) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/MixedMeasureMapping) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/MixedMeasureMapping) 

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

MULTI 值度量的属性映射。

## 内容
<a name="API_query_MultiMeasureAttributeMapping_Contents"></a>

 ** MeasureValueType **   <a name="timestream-Type-query_MultiMeasureAttributeMapping-MeasureValueType"></a>
要从源列中读取的属性的类型。  
类型：字符串  
有效值：`BIGINT | BOOLEAN | DOUBLE | VARCHAR | TIMESTAMP`  
必需：是

 ** SourceColumn **   <a name="timestream-Type-query_MultiMeasureAttributeMapping-SourceColumn"></a>
要从中读取属性值的源列。  
类型：字符串  
必需：是

 ** TargetMultiMeasureAttributeName **   <a name="timestream-Type-query_MultiMeasureAttributeMapping-TargetMultiMeasureAttributeName"></a>
用于派生表中属性名称的自定义名称。如果未提供，将使用源列名称。  
类型：字符串  
必需：否

## 另请参阅
<a name="API_query_MultiMeasureAttributeMapping_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/MultiMeasureAttributeMapping) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/MultiMeasureAttributeMapping) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/MultiMeasureAttributeMapping) 

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

仅提供 MixedMeasureMappings 或 MultiMeasureMappings 之一。MultiMeasureMappings 可用于提取数据作为派生表中的多度量。

## 内容
<a name="API_query_MultiMeasureMappings_Contents"></a>

 ** MultiMeasureAttributeMappings **   <a name="timestream-Type-query_MultiMeasureMappings-MultiMeasureAttributeMappings"></a>
必需。用于将查询结果映射到多度量属性提取数据的属性映射。  
类型：[MultiMeasureAttributeMapping](API_query_MultiMeasureAttributeMapping.md) 对象数组  
数组成员：最少 1 个物品。  
必需：是

 ** TargetMultiMeasureName **   <a name="timestream-Type-query_MultiMeasureMappings-TargetMultiMeasureName"></a>
派生表中目标多度量名称的名称。未提供 measureNameColumn 时需要此输入。如果提供了 MeasureNameColumn，则该列中的值将用作多度量名称。  
类型：字符串  
必需：否

## 另请参阅
<a name="API_query_MultiMeasureMappings_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/MultiMeasureMappings) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/MultiMeasureMappings) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/MultiMeasureMappings) 

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

计划查询的通知配置。创建计划查询、更新其状态或删除该查询时，Timestream 将发送通知。

## 内容
<a name="API_query_NotificationConfiguration_Contents"></a>

 ** SnsConfiguration **   <a name="timestream-Type-query_NotificationConfiguration-SnsConfiguration"></a>
有关 Amazon Simple Notification Service（SNS）配置的详细信息。仅当更新账户设置时提供 SNS 主题的情况下，此字段才会显示。  
类型：[SnsConfiguration](API_query_SnsConfiguration.md) 对象  
必需：是

## 另请参阅
<a name="API_query_NotificationConfiguration_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/NotificationConfiguration) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/NotificationConfiguration) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/NotificationConfiguration) 

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

命名参数的映射。

## 内容
<a name="API_query_ParameterMapping_Contents"></a>

 ** Name **   <a name="timestream-Type-query_ParameterMapping-Name"></a>
参数名称。  
类型：字符串  
必需：是

 ** Type **   <a name="timestream-Type-query_ParameterMapping-Type"></a>
包含查询结果集中列的数据类型。数据类型可以是标量，也可以是复数。支持的标量数据类型包括整数、布尔值、字符串、双精度、时间戳、日期、时间和间隔。支持的复数数据类型包括数组、行和时间序列。  
类型：[Type](API_query_Type.md) 对象  
必需：是

## 另请参阅
<a name="API_query_ParameterMapping_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/ParameterMapping) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/ParameterMapping) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/ParameterMapping) 

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

用于更新查询数据预置容量设置的请求。

## 内容
<a name="API_query_ProvisionedCapacityRequest_Contents"></a>

 ** TargetQueryTCU **   <a name="timestream-Type-query_ProvisionedCapacityRequest-TargetQueryTCU"></a>
用于查询数据的目标计算能力，以 Timestream 计算单元（TCU）为单位进行指定。  
类型：整数  
必需：是

 ** NotificationConfiguration **   <a name="timestream-Type-query_ProvisionedCapacityRequest-NotificationConfiguration"></a>
已预置容量更新相关通知的配置设置。  
类型：[AccountSettingsNotificationConfiguration](API_query_AccountSettingsNotificationConfiguration.md) 对象  
必需：否

## 另请参阅
<a name="API_query_ProvisionedCapacityRequest_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/ProvisionedCapacityRequest) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/ProvisionedCapacityRequest) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/ProvisionedCapacityRequest) 

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

对更新查询数据预置容量设置请求的响应。

## 内容
<a name="API_query_ProvisionedCapacityResponse_Contents"></a>

 ** ActiveQueryTCU **   <a name="timestream-Type-query_ProvisionedCapacityResponse-ActiveQueryTCU"></a>
账户中预置的 Timestream 计算单位（TCU）数量。仅当计算模式为 `PROVISIONED` 时，此字段才显示。  
类型：整数  
必需：否

 ** LastUpdate **   <a name="timestream-Type-query_ProvisionedCapacityResponse-LastUpdate"></a>
有关预置容量设置上次更新的信息。  
类型：[LastUpdate](API_query_LastUpdate.md) 对象  
必需：否

 ** NotificationConfiguration **   <a name="timestream-Type-query_ProvisionedCapacityResponse-NotificationConfiguration"></a>
包含通知设置的对象，当预置容量设置发生修改时，该对象会发送通知。仅当计算模式为 `PROVISIONED` 时，此字段才显示。  
类型：[AccountSettingsNotificationConfiguration](API_query_AccountSettingsNotificationConfiguration.md) 对象  
必需：否

## 另请参阅
<a name="API_query_ProvisionedCapacityResponse_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/ProvisionedCapacityResponse) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/ProvisionedCapacityResponse) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/ProvisionedCapacityResponse) 

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

用于检索或更新查询数据计算容量设置的请求。QueryCompute 仅在亚太地区（孟买）区域提供。

## 内容
<a name="API_query_QueryComputeRequest_Contents"></a>

 ** ComputeMode **   <a name="timestream-Type-query_QueryComputeRequest-ComputeMode"></a>
在账户内分配和使用 Timestream 计算单位（TCU）的模式。请注意，在亚太地区（孟买）区域，API 操作仅识别 `PROVISIONED` 值。QueryCompute 仅在亚太地区（孟买）区域提供。  
类型：字符串  
有效值：`ON_DEMAND | PROVISIONED`  
必需：否

 ** ProvisionedCapacity **   <a name="timestream-Type-query_QueryComputeRequest-ProvisionedCapacity"></a>
包含账户中预置 Timestream 计算单位（TCU）设置的配置对象。QueryCompute 仅在亚太地区（孟买）区域提供。  
类型：[ProvisionedCapacityRequest](API_query_ProvisionedCapacityRequest.md) 对象  
必需：否

## 另请参阅
<a name="API_query_QueryComputeRequest_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/QueryComputeRequest) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/QueryComputeRequest) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/QueryComputeRequest) 

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

对检索或更新计算数据预置容量设置请求的响应。QueryCompute 仅在亚太地区（孟买）区域提供。

## 内容
<a name="API_query_QueryComputeResponse_Contents"></a>

 ** ComputeMode **   <a name="timestream-Type-query_QueryComputeResponse-ComputeMode"></a>
在账户内分配和使用 Timestream 计算单位（TCU）的模式。请注意，在亚太地区（孟买）区域，API 操作仅识别 `PROVISIONED` 值。QueryCompute 仅在亚太地区（孟买）区域提供。  
类型：字符串  
有效值：`ON_DEMAND | PROVISIONED`  
必需：否

 ** ProvisionedCapacity **   <a name="timestream-Type-query_QueryComputeResponse-ProvisionedCapacity"></a>
包含账户中预置 Timestream 计算单位（TCU）设置的配置对象。QueryCompute 仅在亚太地区（孟买）区域提供。  
类型：[ProvisionedCapacityResponse](API_query_ProvisionedCapacityResponse.md) 对象  
必需：否

## 另请参阅
<a name="API_query_QueryComputeResponse_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/QueryComputeResponse) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/QueryComputeResponse) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/QueryComputeResponse) 

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

 `QueryInsights` 是一项性能调优功能，可帮助优化查询、降低成本以及提升性能。借助 `QueryInsights`，您可以评测查询的修剪效率，确定需要改进的领域，以提升查询性能。借助 `QueryInsights`，您还可以通过时间和空间修剪分析查询的有效性，并确定提升性能的机会。具体而言，您可以评估查询在多大程度上使用基于时间和基于分区键的索引策略以优化数据检索。如需优化查询性能，必须对控制查询执行的时间和空间参数进行微调。

`QueryInsights` 提供的关键指标包括 `QuerySpatialCoverage` 和 `QueryTemporalRange`。`QuerySpatialCoverage` 表示查询扫描的空间轴比例，值越低效率越高。`QueryTemporalRange` 显示扫描的时间范围，范围越窄性能越优。

 **QueryInsights 的优势** 

使用 `QueryInsights` 具有以下主要优势：
+  **识别效率低下的查询**：`QueryInsights` 提供有关对查询所访问表进行基于时间和基于属性的修剪的信息。这些信息有助于您识别访问效率不佳的表。
+  **优化数据模型和分区**：您可以使用 `QueryInsights` 信息访问和微调数据模型和分区策略。
+  **调优查询**：`QueryInsights` 突出显示如何更有效地使用索引。

**注意**  
`QueryInsights` 启用后，允许发出的最大 `Query` API 请求数为每秒 1 次查询（QPS）。如果超过此查询速率，可能会导致节流。

## 内容
<a name="API_query_QueryInsights_Contents"></a>

 ** Mode **   <a name="timestream-Type-query_QueryInsights-Mode"></a>
提供以下模式以启用 `QueryInsights`：  
+  `ENABLED_WITH_RATE_CONTROL`：为正在处理的查询启用 `QueryInsights`。此模式还包括速率控制机制，该机制将 `QueryInsights` 功能限制为每秒 1 次查询（QPS）。
+  `DISABLED`：禁用 `QueryInsights`。
类型：字符串  
有效值：`ENABLED_WITH_RATE_CONTROL | DISABLED`  
必需：是

## 另请参阅
<a name="API_query_QueryInsights_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/QueryInsights) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/QueryInsights) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/QueryInsights) 

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

提供与所执行查询相关的多种见解和指标。

## 内容
<a name="API_query_QueryInsightsResponse_Contents"></a>

 ** OutputBytes **   <a name="timestream-Type-query_QueryInsightsResponse-OutputBytes"></a>
表示查询结果集的大小（以字节为单位）。作为查询调优练习的一部分，您可以使用这些数据验证结果集是否已发生更改。  
类型：长整型  
必需：否

 ** OutputRows **   <a name="timestream-Type-query_QueryInsightsResponse-OutputRows"></a>
表示作为查询结果集一部分返回的总行数。作为查询调优练习的一部分，您可以使用这些数据验证结果集中的行数是否已发生更改。  
类型：长整型  
必需：否

 ** QuerySpatialCoverage **   <a name="timestream-Type-query_QueryInsightsResponse-QuerySpatialCoverage"></a>
提供有关查询空间覆盖范围的见解，包括具有次优（最大）空间修剪的表。这些信息可帮助您识别分区策略中需要改进的领域，从而增强空间剪枝效果。  
类型：[QuerySpatialCoverage](API_query_QuerySpatialCoverage.md) 对象  
必需：否

 ** QueryTableCount **   <a name="timestream-Type-query_QueryInsightsResponse-QueryTableCount"></a>
表示查询中的表数量。  
类型：长整型  
必需：否

 ** QueryTemporalRange **   <a name="timestream-Type-query_QueryInsightsResponse-QueryTemporalRange"></a>
提供有关查询时间范围的见解，包括具有最长（最大）时间范围的表。以下是一些可行方案，用于优化基于时间的修剪：  
+ 添加缺失的时间谓词。
+ 移除时间谓词周围的函数。
+ 向所有子查询添加时间谓词。
类型：[QueryTemporalRange](API_query_QueryTemporalRange.md) 对象  
必需：否

 ** UnloadPartitionCount **   <a name="timestream-Type-query_QueryInsightsResponse-UnloadPartitionCount"></a>
表示 `Unload` 操作创建的分区。  
类型：长整型  
必需：否

 ** UnloadWrittenBytes **   <a name="timestream-Type-query_QueryInsightsResponse-UnloadWrittenBytes"></a>
表示 `Unload` 操作写入的大小（以字节为单位）。  
类型：长整型  
必需：否

 ** UnloadWrittenRows **   <a name="timestream-Type-query_QueryInsightsResponse-UnloadWrittenRows"></a>
表示 `Unload` 查询写入的行。  
类型：长整型  
必需：否

## 另请参阅
<a name="API_query_QueryInsightsResponse_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/QueryInsightsResponse) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/QueryInsightsResponse) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/QueryInsightsResponse) 

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

提供有关查询空间覆盖范围的见解，包括具有次优（最大）空间修剪的表。这些信息可帮助您识别分区策略中需要改进的领域，从而增强空间剪枝效果

例如，可使用 `QuerySpatialCoverage` 信息执行以下操作：
+ 添加 measure\$1name 或使用[客户定义的分区键](https://docs.aws.amazon.com/timestream/latest/developerguide/customer-defined-partition-keys.html)（CDPK）谓词。
+ 如果已完成上述操作，请移除谓词或子句周围的函数，例如 `LIKE`。

## 内容
<a name="API_query_QuerySpatialCoverage_Contents"></a>

 ** Max **   <a name="timestream-Type-query_QuerySpatialCoverage-Max"></a>
提供有关已执行查询空间覆盖范围以及空间修剪效率最低的表的见解。  
+  `Value`：空间覆盖的最大比率。
+  `TableArn`：具有次优空间修剪的表的 Amazon 资源名称（ARN）。
+  `PartitionKey`：用于分区的分区键，可以是默认 `measure_name`，也可以是 CDPK。
类型：[QuerySpatialCoverageMax](API_query_QuerySpatialCoverageMax.md) 对象  
必需：否

## 另请参阅
<a name="API_query_QuerySpatialCoverage_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/QuerySpatialCoverage) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/QuerySpatialCoverage) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/QuerySpatialCoverage) 

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

通过查询扫描到的最次优空间范围，提供对表的见解。

## 内容
<a name="API_query_QuerySpatialCoverageMax_Contents"></a>

 ** PartitionKey **   <a name="timestream-Type-query_QuerySpatialCoverageMax-PartitionKey"></a>
用于分区的分区键，可以是默认 `measure_name`，也可以是[客户定义的分区键](https://docs.aws.amazon.com/timestream/latest/developerguide/customer-defined-partition-keys.html)。  
类型：字符串数组  
必需：否

 ** TableArn **   <a name="timestream-Type-query_QuerySpatialCoverageMax-TableArn"></a>
具有最次优空间修剪的表的 Amazon 资源名称（ARN）。  
类型：字符串  
长度限制：最小长度为 0。最大长度为 2048。  
必需：否

 ** Value **   <a name="timestream-Type-query_QuerySpatialCoverageMax-Value"></a>
空间覆盖的最大比率。  
类型：双精度  
必需：否

## 另请参阅
<a name="API_query_QuerySpatialCoverageMax_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/QuerySpatialCoverageMax) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/QuerySpatialCoverageMax) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/QuerySpatialCoverageMax) 

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

有关查询状态的信息，包括进度和已扫描的字节数。

## 内容
<a name="API_query_QueryStatus_Contents"></a>

 ** CumulativeBytesMetered **   <a name="timestream-Type-query_QueryStatus-CumulativeBytesMetered"></a>
查询已扫描的数据量（以字节为单位），您将为此支付费用。这是累积总和，表示自查询开始以来您需要支付费用的总数据量。该费用仅收取一次，在查询完成运行时或者在查询被取消时收取。  
类型：长整型  
必需：否

 ** CumulativeBytesScanned **   <a name="timestream-Type-query_QueryStatus-CumulativeBytesScanned"></a>
查询已扫描的数据量（以字节为单位）。这是累积总和，表示自查询开始以来扫描的总字节数。  
类型：长整型  
必需：否

 ** ProgressPercentage **   <a name="timestream-Type-query_QueryStatus-ProgressPercentage"></a>
查询进度，以百分比表示。  
类型：双精度  
必需：否

## 另请参阅
<a name="API_query_QueryStatus_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/QueryStatus) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/QueryStatus) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/QueryStatus) 

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

提供有关查询时间范围的见解，包括具有最长（最大）时间范围的表。

## 内容
<a name="API_query_QueryTemporalRange_Contents"></a>

 ** Max **   <a name="timestream-Type-query_QueryTemporalRange-Max"></a>
封装以下属性，这些属性可深入了解时间轴上表现最差的表：  
+  `Value`：查询开始和结束之间的最大持续时长（以纳秒为单位）。
+  `TableArn`：查询时使用最大时间范围的表的 Amazon 资源名称（ARN）。
类型：[QueryTemporalRangeMax](API_query_QueryTemporalRangeMax.md) 对象  
必需：否

## 另请参阅
<a name="API_query_QueryTemporalRange_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/QueryTemporalRange) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/QueryTemporalRange) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/QueryTemporalRange) 

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

通过查询扫描到的最次优时间修剪，提供对表的见解。

## 内容
<a name="API_query_QueryTemporalRangeMax_Contents"></a>

 ** TableArn **   <a name="timestream-Type-query_QueryTemporalRangeMax-TableArn"></a>
查询时使用最大时间范围的表的 Amazon 资源名称（ARN）。  
类型：字符串  
长度限制：最小长度为 0。最大长度为 2048。  
必需：否

 ** Value **   <a name="timestream-Type-query_QueryTemporalRangeMax-Value"></a>
查询开始和结束之间的最大持续时长（以纳秒为单位）。  
类型：长整型  
必需：否

## 另请参阅
<a name="API_query_QueryTemporalRangeMax_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/QueryTemporalRangeMax) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/QueryTemporalRangeMax) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/QueryTemporalRangeMax) 

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

代表查询结果中的一行。

## 内容
<a name="API_query_Row_Contents"></a>

 ** Data **   <a name="timestream-Type-query_Row-Data"></a>
结果集单行中的数据点列表。  
类型：[Datum](API_query_Datum.md) 对象数组  
必需：是

## 另请参阅
<a name="API_query_Row_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/Row) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/Row) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/Row) 

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

有关运行查询导致的错误报告的 S3 位置的详细信息。

## 内容
<a name="API_query_S3Configuration_Contents"></a>

 ** BucketName **   <a name="timestream-Type-query_S3Configuration-BucketName"></a>
 将在其下创建错误报告的 S3 桶的名称。  
类型：字符串  
长度约束：最小长度为 3。最大长度为 63。  
模式：`[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]`  
必需：是

 ** EncryptionOption **   <a name="timestream-Type-query_S3Configuration-EncryptionOption"></a>
 错误报告的静态加密选项。如果未指定加密选项，Timestream 将选择 SSE\$1S3 作为默认值。  
类型：字符串  
有效值：`SSE_S3 | SSE_KMS`  
必需：否

 ** ObjectKeyPrefix **   <a name="timestream-Type-query_S3Configuration-ObjectKeyPrefix"></a>
 错误报告密钥的前缀。默认情况下，Timestream 将在错误报告路径中添加以下前缀。  
类型：字符串  
长度限制：长度下限为 1。最大长度为 896。  
模式：`[a-zA-Z0-9|!\-_*'\(\)]([a-zA-Z0-9]|[!\-_*'\(\)\/.])+`  
必需：否

## 另请参阅
<a name="API_query_S3Configuration_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/S3Configuration) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/S3Configuration) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/S3Configuration) 

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

 用于运行计划查询的 S3 报告位置。

## 内容
<a name="API_query_S3ReportLocation_Contents"></a>

 ** BucketName **   <a name="timestream-Type-query_S3ReportLocation-BucketName"></a>
 S3 桶名称。  
类型：字符串  
长度约束：最小长度为 3。最大长度为 63。  
模式：`[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]`  
必需：否

 ** ObjectKey **   <a name="timestream-Type-query_S3ReportLocation-ObjectKey"></a>
S3 密钥。  
类型：字符串  
必需：否

## 另请参阅
<a name="API_query_S3ReportLocation_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/S3ReportLocation) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/S3ReportLocation) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/S3ReportLocation) 

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

查询计划的配置。

## 内容
<a name="API_query_ScheduleConfiguration_Contents"></a>

 ** ScheduleExpression **   <a name="timestream-Type-query_ScheduleConfiguration-ScheduleExpression"></a>
表示何时触发计划查询运行的表达式。此项可以是 cron 表达式或 rate 表达式。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 256。  
必需：是

## 另请参阅
<a name="API_query_ScheduleConfiguration_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/ScheduleConfiguration) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/ScheduleConfiguration) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/ScheduleConfiguration) 

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

计划查询

## 内容
<a name="API_query_ScheduledQuery_Contents"></a>

 ** Arn **   <a name="timestream-Type-query_ScheduledQuery-Arn"></a>
Amazon 资源名称（ARN）。  
类型：字符串  
长度限制：最小长度为 0。最大长度为 2048。  
必需：是

 ** Name **   <a name="timestream-Type-query_ScheduledQuery-Name"></a>
计划查询的名称。  
类型：字符串  
长度限制：长度下限为 1。长度上限为 64。  
模式：`[a-zA-Z0-9|!\-_*'\(\)]([a-zA-Z0-9]|[!\-_*'\(\)\/.])+`  
必需：是

 ** State **   <a name="timestream-Type-query_ScheduledQuery-State"></a>
计划查询的状态。  
类型：字符串  
有效值：`ENABLED | DISABLED`  
必需：是

 ** CreationTime **   <a name="timestream-Type-query_ScheduledQuery-CreationTime"></a>
计划查询的创建时间。  
类型：时间戳  
必需：否

 ** ErrorReportConfiguration **   <a name="timestream-Type-query_ScheduledQuery-ErrorReportConfiguration"></a>
计划查询错误报告的配置。  
类型：[ErrorReportConfiguration](API_query_ErrorReportConfiguration.md) 对象  
必需：否

 ** LastRunStatus **   <a name="timestream-Type-query_ScheduledQuery-LastRunStatus"></a>
上次计划查询运行的状态。  
类型：字符串  
有效值：`AUTO_TRIGGER_SUCCESS | AUTO_TRIGGER_FAILURE | MANUAL_TRIGGER_SUCCESS | MANUAL_TRIGGER_FAILURE`  
必需：否

 ** NextInvocationTime **   <a name="timestream-Type-query_ScheduledQuery-NextInvocationTime"></a>
计划查询下次运行的时间。  
类型：时间戳  
必需：否

 ** PreviousInvocationTime **   <a name="timestream-Type-query_ScheduledQuery-PreviousInvocationTime"></a>
计划查询上次运行的时间。  
类型：时间戳  
必需：否

 ** TargetDestination **   <a name="timestream-Type-query_ScheduledQuery-TargetDestination"></a>
最终写入计划查询结果的目标数据来源。  
类型：[TargetDestination](API_query_TargetDestination.md) 对象  
必需：否

## 另请参阅
<a name="API_query_ScheduledQuery_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/ScheduledQuery) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/ScheduledQuery) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/ScheduledQuery) 

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

描述计划查询的结构。

## 内容
<a name="API_query_ScheduledQueryDescription_Contents"></a>

 ** Arn **   <a name="timestream-Type-query_ScheduledQueryDescription-Arn"></a>
计划查询 ARN。  
类型：字符串  
长度限制：最小长度为 0。最大长度为 2048。  
必需：是

 ** Name **   <a name="timestream-Type-query_ScheduledQueryDescription-Name"></a>
计划查询的名称。  
类型：字符串  
长度限制：长度下限为 1。长度上限为 64。  
模式：`[a-zA-Z0-9|!\-_*'\(\)]([a-zA-Z0-9]|[!\-_*'\(\)\/.])+`  
必需：是

 ** NotificationConfiguration **   <a name="timestream-Type-query_ScheduledQueryDescription-NotificationConfiguration"></a>
通知配置。  
类型：[NotificationConfiguration](API_query_NotificationConfiguration.md) 对象  
必需：是

 ** QueryString **   <a name="timestream-Type-query_ScheduledQueryDescription-QueryString"></a>
要运行的查询。  
类型：字符串  
长度限制：长度下限为 1。长度上限为 262144。  
必需：是

 ** ScheduleConfiguration **   <a name="timestream-Type-query_ScheduledQueryDescription-ScheduleConfiguration"></a>
计划配置。  
类型：[ScheduleConfiguration](API_query_ScheduleConfiguration.md) 对象  
必需：是

 ** State **   <a name="timestream-Type-query_ScheduledQueryDescription-State"></a>
计划查询的状态。  
类型：字符串  
有效值：`ENABLED | DISABLED`  
必需：是

 ** CreationTime **   <a name="timestream-Type-query_ScheduledQueryDescription-CreationTime"></a>
计划查询的创建时间。  
类型：时间戳  
必需：否

 ** ErrorReportConfiguration **   <a name="timestream-Type-query_ScheduledQueryDescription-ErrorReportConfiguration"></a>
计划查询的错误报告配置。  
类型：[ErrorReportConfiguration](API_query_ErrorReportConfiguration.md) 对象  
必需：否

 ** KmsKeyId **   <a name="timestream-Type-query_ScheduledQueryDescription-KmsKeyId"></a>
客户提供的 KMS 密钥，用于加密计划查询资源。  
类型：字符串  
长度限制：最小长度为 0。最大长度为 2048。  
必需：否

 ** LastRunSummary **   <a name="timestream-Type-query_ScheduledQueryDescription-LastRunSummary"></a>
上次计划查询运行的运行时摘要。  
类型：[ScheduledQueryRunSummary](API_query_ScheduledQueryRunSummary.md) 对象  
必需：否

 ** NextInvocationTime **   <a name="timestream-Type-query_ScheduledQueryDescription-NextInvocationTime"></a>
计划查询下次计划运行的时间。  
类型：时间戳  
必需：否

 ** PreviousInvocationTime **   <a name="timestream-Type-query_ScheduledQueryDescription-PreviousInvocationTime"></a>
查询上次运行的时间。  
类型：时间戳  
必需：否

 ** RecentlyFailedRuns **   <a name="timestream-Type-query_ScheduledQueryDescription-RecentlyFailedRuns"></a>
最近五次计划查询运行失败的运行时摘要。  
类型：[ScheduledQueryRunSummary](API_query_ScheduledQueryRunSummary.md) 对象数组  
必需：否

 ** ScheduledQueryExecutionRoleArn **   <a name="timestream-Type-query_ScheduledQueryDescription-ScheduledQueryExecutionRoleArn"></a>
Timestream 用于运行计划查询的 IAM 角色。  
类型：字符串  
长度限制：最小长度为 0。最大长度为 2048。  
必需：否

 ** TargetConfiguration **   <a name="timestream-Type-query_ScheduledQueryDescription-TargetConfiguration"></a>
计划查询目标存储配置。  
类型：[TargetConfiguration](API_query_TargetConfiguration.md) 对象  
必需：否

## 另请参阅
<a name="API_query_ScheduledQueryDescription_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/ScheduledQueryDescription) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/ScheduledQueryDescription) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/ScheduledQueryDescription) 

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

封装用于在 `ExecuteScheduledQueryRequest` 上启用 `QueryInsights` 的设置。

## 内容
<a name="API_query_ScheduledQueryInsights_Contents"></a>

 ** Mode **   <a name="timestream-Type-query_ScheduledQueryInsights-Mode"></a>
提供以下模式以启用 `ScheduledQueryInsights`：  
+  `ENABLED_WITH_RATE_CONTROL`：为正在处理的查询启用 `ScheduledQueryInsights`。此模式还包括速率控制机制，该机制将 `QueryInsights` 功能限制为每秒 1 次查询（QPS）。
+  `DISABLED`：禁用 `ScheduledQueryInsights`。
类型：字符串  
有效值：`ENABLED_WITH_RATE_CONTROL | DISABLED`  
必需：是

## 另请参阅
<a name="API_query_ScheduledQueryInsights_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/ScheduledQueryInsights) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/ScheduledQueryInsights) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/ScheduledQueryInsights) 

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

提供与已执行 `ExecuteScheduledQueryRequest` 相关的多种见解和指标。

## 内容
<a name="API_query_ScheduledQueryInsightsResponse_Contents"></a>

 ** OutputBytes **   <a name="timestream-Type-query_ScheduledQueryInsightsResponse-OutputBytes"></a>
表示查询结果集的大小（以字节为单位）。作为查询调优练习的一部分，您可以使用这些数据验证结果集是否已发生更改。  
类型：长整型  
必需：否

 ** OutputRows **   <a name="timestream-Type-query_ScheduledQueryInsightsResponse-OutputRows"></a>
表示作为查询结果集一部分返回的总行数。作为查询调优练习的一部分，您可以使用这些数据验证结果集中的行数是否已发生更改。  
类型：长整型  
必需：否

 ** QuerySpatialCoverage **   <a name="timestream-Type-query_ScheduledQueryInsightsResponse-QuerySpatialCoverage"></a>
提供有关查询空间覆盖范围的见解，包括具有次优（最大）空间修剪的表。这些信息可帮助您识别分区策略中需要改进的领域，从而增强空间剪枝效果。  
类型：[QuerySpatialCoverage](API_query_QuerySpatialCoverage.md) 对象  
必需：否

 ** QueryTableCount **   <a name="timestream-Type-query_ScheduledQueryInsightsResponse-QueryTableCount"></a>
表示查询中的表数量。  
类型：长整型  
必需：否

 ** QueryTemporalRange **   <a name="timestream-Type-query_ScheduledQueryInsightsResponse-QueryTemporalRange"></a>
提供有关查询时间范围的见解，包括具有最长（最大）时间范围的表。以下是一些可行方案，用于优化基于时间的修剪：  
+ 添加缺失的时间谓词。
+ 移除时间谓词周围的函数。
+ 向所有子查询添加时间谓词。
类型：[QueryTemporalRange](API_query_QueryTemporalRange.md) 对象  
必需：否

## 另请参阅
<a name="API_query_ScheduledQueryInsightsResponse_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/ScheduledQueryInsightsResponse) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/ScheduledQueryInsightsResponse) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/ScheduledQueryInsightsResponse) 

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

计划查询的运行摘要

## 内容
<a name="API_query_ScheduledQueryRunSummary_Contents"></a>

 ** ErrorReportLocation **   <a name="timestream-Type-query_ScheduledQueryRunSummary-ErrorReportLocation"></a>
错误报告的 S3 位置。  
类型：[ErrorReportLocation](API_query_ErrorReportLocation.md) 对象  
必需：否

 ** ExecutionStats **   <a name="timestream-Type-query_ScheduledQueryRunSummary-ExecutionStats"></a>
计划运行的运行时统计信息。  
类型：[ExecutionStats](API_query_ExecutionStats.md) 对象  
必需：否

 ** FailureReason **   <a name="timestream-Type-query_ScheduledQueryRunSummary-FailureReason"></a>
计划查询失败时的错误消息。您可能需要查看错误报告以获取更详细的错误原因。  
类型：字符串  
必需：否

 ** InvocationTime **   <a name="timestream-Type-query_ScheduledQueryRunSummary-InvocationTime"></a>
此次运行的 InvocationTime。这是查询计划运行的时间。可在查询中使用参数 `@scheduled_runtime` 以获取值。  
类型：时间戳  
必需：否

 ** QueryInsightsResponse **   <a name="timestream-Type-query_ScheduledQueryRunSummary-QueryInsightsResponse"></a>
提供与计划查询运行摘要相关的多种见解和指标。  
类型：[ScheduledQueryInsightsResponse](API_query_ScheduledQueryInsightsResponse.md) 对象  
必需：否

 ** RunStatus **   <a name="timestream-Type-query_ScheduledQueryRunSummary-RunStatus"></a>
计划查询运行的状态。  
类型：字符串  
有效值：`AUTO_TRIGGER_SUCCESS | AUTO_TRIGGER_FAILURE | MANUAL_TRIGGER_SUCCESS | MANUAL_TRIGGER_FAILURE`  
必需：否

 ** TriggerTime **   <a name="timestream-Type-query_ScheduledQueryRunSummary-TriggerTime"></a>
查询运行的实际时间。  
类型：时间戳  
必需：否

## 另请参阅
<a name="API_query_ScheduledQueryRunSummary_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/ScheduledQueryRunSummary) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/ScheduledQueryRunSummary) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/ScheduledQueryRunSummary) 

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

查询返回的列详细信息。

## 内容
<a name="API_query_SelectColumn_Contents"></a>

 ** Aliased **   <a name="timestream-Type-query_SelectColumn-Aliased"></a>
如果查询给列名添加别名，则返回 true。否则返回 false。  
类型：布尔值  
必需：否

 ** DatabaseName **   <a name="timestream-Type-query_SelectColumn-DatabaseName"></a>
 包含此列的数据库。  
类型：字符串  
必需：否

 ** Name **   <a name="timestream-Type-query_SelectColumn-Name"></a>
列的名称。  
类型：字符串  
必需：否

 ** TableName **   <a name="timestream-Type-query_SelectColumn-TableName"></a>
数据库中包含此列的表。  
类型：字符串  
必需：否

 ** Type **   <a name="timestream-Type-query_SelectColumn-Type"></a>
包含查询结果集中列的数据类型。数据类型可以是标量，也可以是复数。支持的标量数据类型包括整数、布尔值、字符串、双精度、时间戳、日期、时间和间隔。支持的复数数据类型包括数组、行和时间序列。  
类型：[Type](API_query_Type.md) 对象  
必需：否

## 另请参阅
<a name="API_query_SelectColumn_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/SelectColumn) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/SelectColumn) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/SelectColumn) 

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

发送通知所需的 SNS 的详细信息。

## 内容
<a name="API_query_SnsConfiguration_Contents"></a>

 ** TopicArn **   <a name="timestream-Type-query_SnsConfiguration-TopicArn"></a>
计划查询状态通知将发送到的 SNS 主题 ARN。  
类型：字符串  
长度限制：最小长度为 0。最大长度为 2048。  
必需：是

## 另请参阅
<a name="API_query_SnsConfiguration_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/SnsConfiguration) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/SnsConfiguration) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/SnsConfiguration) 

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

标签是指为 Timestream 数据库和/或表分配的标识。每个标签都包含定义的一个键和一个可选值。标签允许按用途、所有者或环境等对数据库和/或表进行分类。

## 内容
<a name="API_query_Tag_Contents"></a>

 ** Key **   <a name="timestream-Type-query_Tag-Key"></a>
标签的密钥。标签键区分大小写。  
类型：字符串  
长度限制：长度下限为 1。最大长度为 128。  
必需：是

 ** Value **   <a name="timestream-Type-query_Tag-Value"></a>
标签的值。标签值区分大小写，可以为空值。  
类型：字符串  
长度约束：最小长度为 0。最大长度为 256。  
必需：是

## 另请参阅
<a name="API_query_Tag_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/Tag) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/Tag) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/Tag) 

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

用于写入查询输出的配置。

## 内容
<a name="API_query_TargetConfiguration_Contents"></a>

 ** TimestreamConfiguration **   <a name="timestream-Type-query_TargetConfiguration-TimestreamConfiguration"></a>
将数据写入 Timestream 数据库和表所需的配置。  
类型：[TimestreamConfiguration](API_query_TimestreamConfiguration.md) 对象  
必需：是

## 另请参阅
<a name="API_query_TargetConfiguration_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/TargetConfiguration) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/TargetConfiguration) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/TargetConfiguration) 

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

为目标数据来源写入数据的目标详细信息。当前支持的数据来源为 Timestream。

## 内容
<a name="API_query_TargetDestination_Contents"></a>

 ** TimestreamDestination **   <a name="timestream-Type-query_TargetDestination-TimestreamDestination"></a>
Timestream 数据来源的查询结果目标详细信息。  
类型：[TimestreamDestination](API_query_TimestreamDestination.md) 对象  
必需：否

## 另请参阅
<a name="API_query_TargetDestination_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/TargetDestination) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/TargetDestination) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/TargetDestination) 

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

时间序列数据类型表示一段时间内的度量值。时间序列是由时间戳和度量值组成的行数组，其中各行按时间升序进行排列。TimeSeriesDataPoint 是时间序列中的单个数据点。表示时间序列中的元组（时间，度量值）。

## 内容
<a name="API_query_TimeSeriesDataPoint_Contents"></a>

 ** Time **   <a name="timestream-Type-query_TimeSeriesDataPoint-Time"></a>
采集度量值的时间戳。  
类型：字符串  
必需：是

 ** Value **   <a name="timestream-Type-query_TimeSeriesDataPoint-Value"></a>
数据点的度量值。  
类型：[Datum](API_query_Datum.md) 对象  
必需：是

## 另请参阅
<a name="API_query_TimeSeriesDataPoint_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/TimeSeriesDataPoint) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/TimeSeriesDataPoint) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/TimeSeriesDataPoint) 

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

 将数据写入 Timestream 数据库和表的配置。此配置允许用户将查询结果选择列映射到目标表列。

## 内容
<a name="API_query_TimestreamConfiguration_Contents"></a>

 ** DatabaseName **   <a name="timestream-Type-query_TimestreamConfiguration-DatabaseName"></a>
将写入查询结果的 Timestream 数据库的名称。  
类型：字符串  
必需：是

 ** DimensionMappings **   <a name="timestream-Type-query_TimestreamConfiguration-DimensionMappings"></a>
 此项允许将查询结果中的列映射到目标表中的维度。  
类型：[DimensionMapping](API_query_DimensionMapping.md) 对象数组  
必需：是

 ** TableName **   <a name="timestream-Type-query_TimestreamConfiguration-TableName"></a>
将写入查询结果的 Timestream 表的名称。该表应位于 Timestream 配置中提供的同一数据库。  
类型：字符串  
必需：是

 ** TimeColumn **   <a name="timestream-Type-query_TimestreamConfiguration-TimeColumn"></a>
查询结果中的列，应用作目标表中的时间列。此项的列类型应为 TIMESTAMP。  
类型：字符串  
必需：是

 ** MeasureNameColumn **   <a name="timestream-Type-query_TimestreamConfiguration-MeasureNameColumn"></a>
度量列的名称。  
类型：字符串  
必需：否

 ** MixedMeasureMappings **   <a name="timestream-Type-query_TimestreamConfiguration-MixedMeasureMappings"></a>
指定如何将度量映射到多度量记录。  
类型：[MixedMeasureMapping](API_query_MixedMeasureMapping.md) 对象数组  
数组成员：最少 1 个物品。  
必需：否

 ** MultiMeasureMappings **   <a name="timestream-Type-query_TimestreamConfiguration-MultiMeasureMappings"></a>
多度量映射。  
类型：[MultiMeasureMappings](API_query_MultiMeasureMappings.md) 对象  
必需：否

## 另请参阅
<a name="API_query_TimestreamConfiguration_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/TimestreamConfiguration) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/TimestreamConfiguration) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/TimestreamConfiguration) 

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

计划查询的目标。

## 内容
<a name="API_query_TimestreamDestination_Contents"></a>

 ** DatabaseName **   <a name="timestream-Type-query_TimestreamDestination-DatabaseName"></a>
Timestream 数据库名称。  
类型：字符串  
必需：否

 ** TableName **   <a name="timestream-Type-query_TimestreamDestination-TableName"></a>
Timestream 表名称。  
类型：字符串  
必需：否

## 另请参阅
<a name="API_query_TimestreamDestination_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/TimestreamDestination) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/TimestreamDestination) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/TimestreamDestination) 

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

包含查询结果集中列的数据类型。数据类型可以是标量，也可以是复数。支持的标量数据类型包括整数、布尔值、字符串、双精度、时间戳、日期、时间和间隔。支持的复数数据类型包括数组、行和时间序列。

## 内容
<a name="API_query_Type_Contents"></a>

 ** ArrayColumnInfo **   <a name="timestream-Type-query_Type-ArrayColumnInfo"></a>
指示列是否为数组。  
类型：[ColumnInfo](API_query_ColumnInfo.md) 对象  
必需：否

 ** RowColumnInfo **   <a name="timestream-Type-query_Type-RowColumnInfo"></a>
指示列是否为行。  
类型：[ColumnInfo](API_query_ColumnInfo.md) 对象数组  
必需：否

 ** ScalarType **   <a name="timestream-Type-query_Type-ScalarType"></a>
指示列的类型是否为字符串、整数、布尔值、双精度、时间戳、日期、时间。有关更多信息，请参阅[支持的数据类型](https://docs.aws.amazon.com/timestream/latest/developerguide/supported-data-types.html)。  
类型：字符串  
有效值：`VARCHAR | BOOLEAN | BIGINT | DOUBLE | TIMESTAMP | DATE | TIME | INTERVAL_DAY_TO_SECOND | INTERVAL_YEAR_TO_MONTH | UNKNOWN | INTEGER`  
必需：否

 ** TimeSeriesMeasureValueColumnInfo **   <a name="timestream-Type-query_Type-TimeSeriesMeasureValueColumnInfo"></a>
指示列是否为时间序列数据类型。  
类型：[ColumnInfo](API_query_ColumnInfo.md) 对象  
必需：否

## 另请参阅
<a name="API_query_Type_SeeAlso"></a>

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/Type) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/Type) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/Type) 

# 常见错误
<a name="CommonErrors"></a>

本部分列出了所有 AWS 服务的常见 API 操作错误。对于特定于此服务的 API 操作的错误，请参阅该 API 操作的主题。

 **AccessDeniedException**   
您没有足够的访问权限，无法执行该操作。  
HTTP 状态代码：400

 **IncompleteSignature**   
请求签名不符合 AWS 标准。  
HTTP 状态代码：400

 **InternalFailure**   <a name="CommonErrors-InternalFailure"></a>
由于未知错误、异常或故障，请求处理失败。  
HTTP 状态代码：500

 **InvalidAction**   <a name="CommonErrors-InvalidAction"></a>
所请求的操作无效。确认正确键入了操作。  
HTTP 状态代码：400

 **InvalidClientTokenId**   <a name="CommonErrors-InvalidClientTokenId"></a>
在我们的记录中没有所提供的 X.509 证书或 AWS 访问密钥 ID。  
HTTP 状态代码：403

 **NotAuthorized**   <a name="CommonErrors-NotAuthorized"></a>
您无权执行此操作。  
HTTP 状态代码：400

 **OptInRequired**   <a name="CommonErrors-OptInRequired"></a>
AWS 访问密钥 ID 需要订阅服务。  
HTTP 状态代码：403

 **RequestExpired**   <a name="CommonErrors-RequestExpired"></a>
请求到达服务的时间超过请求上的日期戳 15 分钟或超过请求到期日期 15 分钟（例如，对于预签名 URL），或者请求上的日期戳比当前时间晚了 15 分钟以上。  
HTTP 状态代码：400

 **ServiceUnavailable**   <a name="CommonErrors-ServiceUnavailable"></a>
由于服务器发生临时故障而导致请求失败。  
HTTP 状态代码：503

 **ThrottlingException**   <a name="CommonErrors-ThrottlingException"></a>
由于请求限制而导致请求被拒绝。  
HTTP 状态代码：400

 **ValidationError**   <a name="CommonErrors-ValidationError"></a>
输入未能满足 AWS 服务指定的约束。  
HTTP 状态代码：400

# 常见参数
<a name="CommonParameters"></a>

以下列表包含所有操作用于使用查询字符串对 Signature Version 4 请求进行签名的参数。任何特定于操作的参数都列在该操作的主题中。有关 Signature Version 4 的更多信息，请参阅《IAM 用户指南》**中的[签署 AWS API 请求](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html)。

 **Action**   <a name="CommonParameters-Action"></a>
要执行的操作。  
类型：字符串。  
必需：是

 **Version**   <a name="CommonParameters-Version"></a>
编写请求所针对的 API 版本，格式为 YYYY-MM-DD。  
类型：字符串。  
必需：是

 **X-Amz-Algorithm**   <a name="CommonParameters-X-Amz-Algorithm"></a>
您用于创建请求签名的哈希算法。  
条件：当您在查询字符串中而不是 HTTP 授权标头中包括身份验证信息时，请指定此参数。  
类型：字符串  
有效值：`AWS4-HMAC-SHA256`  
必需：有条件

 **X-Amz-Credential**   <a name="CommonParameters-X-Amz-Credential"></a>
凭证范围值，该值是一个字符串，其中包含您的访问密钥、日期、您要定位的区域、您请求的服务以及终止字符串（“aws4\$1request”）。值采用以下格式表示：*access\$1key*/*YYYYMMDD*/*region*/*service*/aws4\$1request。  
有关更多信息，请参阅《IAM 用户指南》**中的[创建已签名的 AWS API 请求](https://docs.aws.amazon.com/IAM/latest/UserGuide/create-signed-request.html)。  
条件：当您在查询字符串中而不是 HTTP 授权标头中包括身份验证信息时，请指定此参数。  
类型：字符串  
必需：有条件

 **X-Amz-Date**   <a name="CommonParameters-X-Amz-Date"></a>
用于创建签名的日期。格式必须为 ISO 8601 基本格式 (YYYYMMDD'T'HHMMSS'Z')。例如，以下日期时间是有效的 X-Amz-Date 值：`20120325T120000Z`。  
条件：X-Amz-Date 对于所有请求都是可选的；它可以用于覆盖对请求签名所使用的日期。如果以 ISO 8601 基本格式指定 Date 标头，则不需要 X-Amz-Date。使用 X-Amz-Date 时，它始终会覆盖 Date 标头的值。有关更多信息，请参阅《IAM 用户指南》**中的 [AWS API 请求签名的元素](https://docs.aws.amazon.com/IAM/latest/UserGuide/signing-elements.html)。  
类型：字符串  
必需：有条件

 **X-Amz-Security-Token**   <a name="CommonParameters-X-Amz-Security-Token"></a>
通过调用 AWS Security Token Service（AWS STS）获得的临时安全令牌。有关支持来自 AWS STS 的临时安全凭证的服务列表，请参阅《IAM 用户指南》**中的[使用 IAM 的 AWS 服务](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html)。  
条件：如果您使用来自 AWS STS 的临时安全凭证，则必须包含安全令牌。  
类型：字符串  
必需：有条件

 **X-Amz-Signature**   <a name="CommonParameters-X-Amz-Signature"></a>
指定从要签名的字符串和派生的签名密钥计算的十六进制编码签名。  
条件：当您在查询字符串中而不是 HTTP 授权标头中包括身份验证信息时，请指定此参数。  
类型：字符串  
必需：有条件

 **X-Amz-SignedHeaders**   <a name="CommonParameters-X-Amz-SignedHeaders"></a>
指定作为规范请求的一部分包含的所有 HTTP 标头。有关指定已签名标头的更多信息，请参阅《IAM 用户指南》**中的[创建已签名的 AWS API 请求](https://docs.aws.amazon.com/IAM/latest/UserGuide/create-signed-request.html)。  
条件：当您在查询字符串中而不是 HTTP 授权标头中包括身份验证信息时，请指定此参数。  
类型：字符串  
必需：有条件