

如需與 Amazon Timestream for LiveAnalytics 類似的功能，請考慮使用 Amazon Timestream for InfluxDB。它提供簡化的資料擷取和單一位數毫秒查詢回應時間，以進行即時分析。[在這裡](https://docs.aws.amazon.com//timestream/latest/developerguide/timestream-for-influxdb.html)進一步了解。

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

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

Amazon Timestream Write 支援下列動作：
+  [CreateBatchLoadTask](API_CreateBatchLoadTask.md) 
+  [CreateDatabase](API_CreateDatabase.md) 
+  [CreateTable](API_CreateTable.md) 
+  [DeleteDatabase](API_DeleteDatabase.md) 
+  [DeleteTable](API_DeleteTable.md) 
+  [DescribeBatchLoadTask](API_DescribeBatchLoadTask.md) 
+  [DescribeDatabase](API_DescribeDatabase.md) 
+  [DescribeEndpoints](API_DescribeEndpoints.md) 
+  [DescribeTable](API_DescribeTable.md) 
+  [ListBatchLoadTasks](API_ListBatchLoadTasks.md) 
+  [ListDatabases](API_ListDatabases.md) 
+  [ListTables](API_ListTables.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [ResumeBatchLoadTask](API_ResumeBatchLoadTask.md) 
+  [TagResource](API_TagResource.md) 
+  [UntagResource](API_UntagResource.md) 
+  [UpdateDatabase](API_UpdateDatabase.md) 
+  [UpdateTable](API_UpdateTable.md) 
+  [WriteRecords](API_WriteRecords.md) 

Amazon Timestream Query 支援下列動作：
+  [CancelQuery](API_query_CancelQuery.md) 
+  [CreateScheduledQuery](API_query_CreateScheduledQuery.md) 
+  [DeleteScheduledQuery](API_query_DeleteScheduledQuery.md) 
+  [DescribeAccountSettings](API_query_DescribeAccountSettings.md) 
+  [DescribeEndpoints](API_query_DescribeEndpoints.md) 
+  [DescribeScheduledQuery](API_query_DescribeScheduledQuery.md) 
+  [ExecuteScheduledQuery](API_query_ExecuteScheduledQuery.md) 
+  [ListScheduledQueries](API_query_ListScheduledQueries.md) 
+  [ListTagsForResource](API_query_ListTagsForResource.md) 
+  [PrepareQuery](API_query_PrepareQuery.md) 
+  [Query](API_query_Query.md) 
+  [TagResource](API_query_TagResource.md) 
+  [UntagResource](API_query_UntagResource.md) 
+  [UpdateAccountSettings](API_query_UpdateAccountSettings.md) 
+  [UpdateScheduledQuery](API_query_UpdateScheduledQuery.md) 

# Amazon Timestream 寫入
<a name="API_Operations_Amazon_Timestream_Write"></a>

Amazon Timestream Write 支援下列動作：
+  [CreateBatchLoadTask](API_CreateBatchLoadTask.md) 
+  [CreateDatabase](API_CreateDatabase.md) 
+  [CreateTable](API_CreateTable.md) 
+  [DeleteDatabase](API_DeleteDatabase.md) 
+  [DeleteTable](API_DeleteTable.md) 
+  [DescribeBatchLoadTask](API_DescribeBatchLoadTask.md) 
+  [DescribeDatabase](API_DescribeDatabase.md) 
+  [DescribeEndpoints](API_DescribeEndpoints.md) 
+  [DescribeTable](API_DescribeTable.md) 
+  [ListBatchLoadTasks](API_ListBatchLoadTasks.md) 
+  [ListDatabases](API_ListDatabases.md) 
+  [ListTables](API_ListTables.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [ResumeBatchLoadTask](API_ResumeBatchLoadTask.md) 
+  [TagResource](API_TagResource.md) 
+  [UntagResource](API_UntagResource.md) 
+  [UpdateDatabase](API_UpdateDatabase.md) 
+  [UpdateTable](API_UpdateTable.md) 
+  [WriteRecords](API_WriteRecords.md) 

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

建立新的 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>

如需所有動作的一般參數資訊，請參閱《[Common Parameters](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>
  
類型：Long  
必要：否

 ** [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 **   
操作嘗試存取不存在的資源。資源可能未正確指定，或其狀態可能不是 ACTIVE。  
HTTP 狀態碼：400

 ** ServiceQuotaExceededException **   
 此帳戶超過資源的執行個體配額。  
HTTP 狀態碼：400

 ** ThrottlingException **   
 使用者提出的請求太多，而且超過服務配額。請求受到調節。  
HTTP 狀態碼：400

 ** ValidationException **   
 無效或格式不正確的請求。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_CreateBatchLoadTask_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/CreateBatchLoadTask) 
+  [AWS 適用於 .NET V4 的 SDK](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 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/CreateBatchLoadTask) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/CreateBatchLoadTask) 
+  [AWS 適用於 JavaScript V3 的 SDK](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 V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/CreateBatchLoadTask) 
+  [AWS 適用於 Python 的 SDK](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>

如需所有動作的一般參數資訊，請參閱《[Common Parameters](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>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/CreateDatabase) 
+  [AWS 適用於 .NET V4 的 SDK](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 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/CreateDatabase) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/CreateDatabase) 
+  [AWS 適用於 JavaScript V3 的 SDK](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 V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/CreateDatabase) 
+  [AWS 適用於 Python 的 SDK](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>

如需所有動作的一般參數資訊，請參閱《[Common Parameters](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 **   
操作嘗試存取不存在的資源。資源可能未正確指定，或其狀態可能不是 ACTIVE。  
HTTP 狀態碼：400

 ** ServiceQuotaExceededException **   
 此帳戶超過資源的執行個體配額。  
HTTP 狀態碼：400

 ** ThrottlingException **   
 使用者提出的請求太多，而且超過服務配額。請求受到調節。  
HTTP 狀態碼：400

 ** ValidationException **   
 無效或格式不正確的請求。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_CreateTable_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/CreateTable) 
+  [AWS 適用於 .NET V4 的 SDK](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 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/CreateTable) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/CreateTable) 
+  [AWS 適用於 JavaScript V3 的 SDK](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 V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/CreateTable) 
+  [AWS 適用於 Python 的 SDK](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 錯誤。  
由於分散式重試的性質，操作可能會傳回成功或 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>

如需所有動作的一般參數資訊，請參閱《[Common Parameters](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 **   
操作嘗試存取不存在的資源。資源可能未正確指定，或其狀態可能不是 ACTIVE。  
HTTP 狀態碼：400

 ** ThrottlingException **   
 使用者提出的請求太多，而且超過服務配額。請求受到調節。  
HTTP 狀態碼：400

 ** ValidationException **   
 無效或格式不正確的請求。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_DeleteDatabase_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/DeleteDatabase) 
+  [AWS 適用於 .NET V4 的 SDK](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 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/DeleteDatabase) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/DeleteDatabase) 
+  [AWS 適用於 JavaScript V3 的 SDK](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 V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/DeleteDatabase) 
+  [AWS 適用於 Python 的 SDK](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 資料庫資料表後，無法復原存放在資料表中的時間序列資料。

**注意**  
由於分散式重試的性質，操作可能會傳回成功或 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>

如需所有動作的一般參數資訊，請參閱《[Common Parameters](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 **   
操作嘗試存取不存在的資源。資源可能未正確指定，或其狀態可能不是 ACTIVE。  
HTTP 狀態碼：400

 ** ThrottlingException **   
 使用者提出的請求太多，而且超過服務配額。請求受到調節。  
HTTP 狀態碼：400

 ** ValidationException **   
 無效或格式不正確的請求。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_DeleteTable_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/DeleteTable) 
+  [AWS 適用於 .NET V4 的 SDK](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 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/DeleteTable) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/DeleteTable) 
+  [AWS 適用於 JavaScript V3 的 SDK](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 V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/DeleteTable) 
+  [AWS 適用於 Python 的 SDK](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>

如需所有動作的一般參數資訊，請參閱《[Common Parameters](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 **   
操作嘗試存取不存在的資源。資源可能未正確指定，或其狀態可能不是 ACTIVE。  
HTTP 狀態碼：400

 ** ThrottlingException **   
 使用者提出的請求太多，而且超過服務配額。請求受到調節。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_DescribeBatchLoadTask_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/DescribeBatchLoadTask) 
+  [AWS 適用於 .NET V4 的 SDK](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 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/DescribeBatchLoadTask) 
+  [AWS 適用於 Java V2 的 SDK](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 V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/DescribeBatchLoadTask) 
+  [AWS 適用於 Python 的 SDK](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>

如需所有動作的一般參數資訊，請參閱《[Common Parameters](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 **   
操作嘗試存取不存在的資源。資源可能未正確指定，或其狀態可能不是 ACTIVE。  
HTTP 狀態碼：400

 ** ThrottlingException **   
 使用者提出的請求太多，而且超過服務配額。請求受到調節。  
HTTP 狀態碼：400

 ** ValidationException **   
 無效或格式不正確的請求。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_DescribeDatabase_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/DescribeDatabase) 
+  [AWS 適用於 .NET V4 的 SDK](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 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/DescribeDatabase) 
+  [AWS 適用於 Java 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 V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/DescribeDatabase) 
+  [AWS 適用於 Python 的 SDK](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>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/DescribeEndpoints) 
+  [AWS 適用於 .NET V4 的 SDK](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 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/DescribeEndpoints) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/DescribeEndpoints) 
+  [AWS 適用於 JavaScript V3 的 SDK](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 V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/DescribeEndpoints) 
+  [AWS 適用於 Python 的 SDK](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>

如需所有動作的一般參數資訊，請參閱《[Common Parameters](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 **   
操作嘗試存取不存在的資源。資源可能未正確指定，或其狀態可能不是 ACTIVE。  
HTTP 狀態碼：400

 ** ThrottlingException **   
 使用者提出的請求太多，而且超過服務配額。請求受到調節。  
HTTP 狀態碼：400

 ** ValidationException **   
 無效或格式不正確的請求。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_DescribeTable_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/DescribeTable) 
+  [AWS 適用於 .NET V4 的 SDK](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 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/DescribeTable) 
+  [AWS 適用於 Java V2 的 SDK](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 V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/DescribeTable) 
+  [AWS 適用於 Python 的 SDK](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>

如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

請求接受採用 JSON 格式的下列資料。

 ** [MaxResults](#API_ListBatchLoadTasks_RequestSyntax) **   <a name="timestream-ListBatchLoadTasks-request-MaxResults"></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>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/ListBatchLoadTasks) 
+  [AWS 適用於 .NET V4 的 SDK](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 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/ListBatchLoadTasks) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/ListBatchLoadTasks) 
+  [AWS 適用於 JavaScript V3 的 SDK](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 V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/ListBatchLoadTasks) 
+  [AWS 適用於 Python 的 SDK](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>

如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

請求接受採用 JSON 格式的下列資料。

 ** [MaxResults](#API_ListDatabases_RequestSyntax) **   <a name="timestream-ListDatabases-request-MaxResults"></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>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/ListDatabases) 
+  [AWS 適用於 .NET V4 的 SDK](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 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/ListDatabases) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/ListDatabases) 
+  [AWS 適用於 JavaScript V3 的 SDK](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 V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/ListDatabases) 
+  [AWS 適用於 Python 的 SDK](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>

如需所有動作的一般參數資訊，請參閱《[Common Parameters](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>
要在輸出中傳回的項目總數。如果可用的項目總數超過指定的值，則會在輸出中提供 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 **   
操作嘗試存取不存在的資源。資源可能未正確指定，或其狀態可能不是 ACTIVE。  
HTTP 狀態碼：400

 ** ThrottlingException **   
 使用者提出的請求太多，而且超過服務配額。請求受到調節。  
HTTP 狀態碼：400

 ** ValidationException **   
 無效或格式不正確的請求。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_ListTables_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/ListTables) 
+  [AWS 適用於 .NET V4 的 SDK](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 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/ListTables) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/ListTables) 
+  [AWS 適用於 JavaScript V3 的 SDK](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 V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/ListTables) 
+  [AWS 適用於 Python 的 SDK](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>

如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

請求接受採用 JSON 格式的下列資料。

 ** [ResourceARN](#API_ListTagsForResource_RequestSyntax) **   <a name="timestream-ListTagsForResource-request-ResourceARN"></a>
 要列出標籤的 Timestream 資源。這個值是 Amazon Resource Name (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 **   
操作嘗試存取不存在的資源。資源可能未正確指定，或其狀態可能不是 ACTIVE。  
HTTP 狀態碼：400

 ** ThrottlingException **   
 使用者提出的請求太多，而且超過服務配額。請求受到調節。  
HTTP 狀態碼：400

 ** ValidationException **   
 無效或格式不正確的請求。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_ListTagsForResource_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/ListTagsForResource) 
+  [AWS 適用於 .NET V4 的 SDK](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 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/ListTagsForResource) 
+  [AWS 適用於 Java 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 V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/ListTagsForResource) 
+  [AWS 適用於 Python 的 SDK](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>

如需所有動作的一般參數資訊，請參閱《[Common Parameters](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 **   
操作嘗試存取不存在的資源。資源可能未正確指定，或其狀態可能不是 ACTIVE。  
HTTP 狀態碼：400

 ** ThrottlingException **   
 使用者提出的請求太多，而且超過服務配額。請求受到調節。  
HTTP 狀態碼：400

 ** ValidationException **   
 無效或格式不正確的請求。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_ResumeBatchLoadTask_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/ResumeBatchLoadTask) 
+  [AWS 適用於 .NET V4 的 SDK](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 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/ResumeBatchLoadTask) 
+  [AWS 適用於 Java V2 的 SDK](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 V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/ResumeBatchLoadTask) 
+  [AWS 適用於 Python 的 SDK](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 資源建立關聯。然後，您可以啟用這些使用者定義的標籤，使其顯示在 Billing and Cost Management 主控台上，以進行成本分配追蹤。

## 請求語法
<a name="API_TagResource_RequestSyntax"></a>

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

## 請求參數
<a name="API_TagResource_RequestParameters"></a>

如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

請求接受採用 JSON 格式的下列資料。

 ** [ResourceARN](#API_TagResource_RequestSyntax) **   <a name="timestream-TagResource-request-ResourceARN"></a>
 識別應新增標籤的 Timestream 資源。這個值是 Amazon Resource Name (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 **   
操作嘗試存取不存在的資源。資源可能未正確指定，或其狀態可能不是 ACTIVE。  
HTTP 狀態碼：400

 ** ServiceQuotaExceededException **   
 此帳戶超過資源的執行個體配額。  
HTTP 狀態碼：400

 ** ThrottlingException **   
 使用者提出的請求太多，而且超過服務配額。請求受到調節。  
HTTP 狀態碼：400

 ** ValidationException **   
 無效或格式不正確的請求。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_TagResource_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/TagResource) 
+  [AWS 適用於 .NET V4 的 SDK](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 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/TagResource) 
+  [AWS 適用於 Java V2 的 SDK](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 V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/TagResource) 
+  [AWS 適用於 Python 的 SDK](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>

如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

請求接受採用 JSON 格式的下列資料。

 ** [ResourceARN](#API_UntagResource_RequestSyntax) **   <a name="timestream-UntagResource-request-ResourceARN"></a>
 要從中移除標籤的 Timestream 資源。這個值是 Amazon Resource Name (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 **   
操作嘗試存取不存在的資源。資源可能未正確指定，或其狀態可能不是 ACTIVE。  
HTTP 狀態碼：400

 ** ServiceQuotaExceededException **   
 此帳戶超過資源的執行個體配額。  
HTTP 狀態碼：400

 ** ThrottlingException **   
 使用者提出的請求太多，而且超過服務配額。請求受到調節。  
HTTP 狀態碼：400

 ** ValidationException **   
 無效或格式不正確的請求。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_UntagResource_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/UntagResource) 
+  [AWS 適用於 .NET V4 的 SDK](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 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/UntagResource) 
+  [AWS 適用於 Java V2 的 SDK](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 V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/UntagResource) 
+  [AWS 適用於 Python 的 SDK](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>

如需所有動作的一般參數資訊，請參閱《[Common Parameters](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 **   
操作嘗試存取不存在的資源。資源可能未正確指定，或其狀態可能不是 ACTIVE。  
HTTP 狀態碼：400

 ** ServiceQuotaExceededException **   
 此帳戶超過資源的執行個體配額。  
HTTP 狀態碼：400

 ** ThrottlingException **   
 使用者提出的請求太多，而且超過服務配額。請求受到調節。  
HTTP 狀態碼：400

 ** ValidationException **   
 無效或格式不正確的請求。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_UpdateDatabase_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/UpdateDatabase) 
+  [AWS 適用於 .NET V4 的 SDK](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 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/UpdateDatabase) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/UpdateDatabase) 
+  [AWS 適用於 JavaScript V3 的 SDK](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 V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/UpdateDatabase) 
+  [AWS 適用於 Python 的 SDK](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>

如需所有動作的一般參數資訊，請參閱《[Common Parameters](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 **   
操作嘗試存取不存在的資源。資源可能未正確指定，或其狀態可能不是 ACTIVE。  
HTTP 狀態碼：400

 ** ThrottlingException **   
 使用者提出的請求太多，而且超過服務配額。請求受到調節。  
HTTP 狀態碼：400

 ** ValidationException **   
 無效或格式不正確的請求。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_UpdateTable_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/UpdateTable) 
+  [AWS 適用於 .NET V4 的 SDK](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 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/UpdateTable) 
+  [AWS 適用於 Java V2 的 SDK](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 V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/UpdateTable) 
+  [AWS 適用於 Python 的 SDK](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)。

 **Upserts** 

您可以在`WriteRecords`請求中使用 `Version` 參數來更新資料點。Timestream 會追蹤每個記錄的版本編號。當未在請求中為記錄指定`1`時， `Version`預設為 。Timestream 會在收到寫入請求`Version`時，更新現有記錄的度量值及其 ，該記錄的寫入請求具有較高的`Version`數字。當它收到更新請求，其中度量值與現有記錄的值相同時，如果 Timestream 大於 的現有值`Version`，則仍然會更新 `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>

如需所有動作的一般參數資訊，請參閱《[Common Parameters](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 **   
操作嘗試存取不存在的資源。資源可能未正確指定，或其狀態可能不是 ACTIVE。  
HTTP 狀態碼：400

 ** ThrottlingException **   
 使用者提出的請求太多，而且超過服務配額。請求受到調節。  
HTTP 狀態碼：400

 ** ValidationException **   
 無效或格式不正確的請求。  
HTTP 狀態碼：400

## 另請參閱
<a name="API_WriteRecords_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/WriteRecords) 
+  [AWS 適用於 .NET V4 的 SDK](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 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/WriteRecords) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/WriteRecords) 
+  [AWS 適用於 JavaScript V3 的 SDK](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 V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/WriteRecords) 
+  [AWS 適用於 Python 的 SDK](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 Query 支援下列動作：
+  [CancelQuery](API_query_CancelQuery.md) 
+  [CreateScheduledQuery](API_query_CreateScheduledQuery.md) 
+  [DeleteScheduledQuery](API_query_DeleteScheduledQuery.md) 
+  [DescribeAccountSettings](API_query_DescribeAccountSettings.md) 
+  [DescribeEndpoints](API_query_DescribeEndpoints.md) 
+  [DescribeScheduledQuery](API_query_DescribeScheduledQuery.md) 
+  [ExecuteScheduledQuery](API_query_ExecuteScheduledQuery.md) 
+  [ListScheduledQueries](API_query_ListScheduledQueries.md) 
+  [ListTagsForResource](API_query_ListTagsForResource.md) 
+  [PrepareQuery](API_query_PrepareQuery.md) 
+  [Query](API_query_Query.md) 
+  [TagResource](API_query_TagResource.md) 
+  [UntagResource](API_query_UntagResource.md) 
+  [UpdateAccountSettings](API_query_UpdateAccountSettings.md) 
+  [UpdateScheduledQuery](API_query_UpdateScheduledQuery.md) 

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

 取消已發出的查詢。只有在發出取消請求之前，查詢尚未完成執行時，才會提供取消。由於取消是等冪操作，因此後續的取消請求會傳回 `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>

如需所有動作的一般參數資訊，請參閱《[Common Parameters](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>
 當 指定的查詢`CancelQuery`請求`QueryId`已發出時，`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>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/CancelQuery) 
+  [AWS 適用於 .NET V4 的 SDK](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 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/CancelQuery) 
+  [AWS 適用於 Java 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 V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/CancelQuery) 
+  [AWS 適用於 Python 的 SDK](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>

如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

請求接受採用 JSON 格式的下列資料。

 ** [ClientToken](#API_query_CreateScheduledQuery_RequestSyntax) **   <a name="timestream-query_CreateScheduledQuery-request-ClientToken"></a>
使用 ClientToken 呼叫 CreateScheduledQuery 等冪，換句話說，重複提出相同的請求將產生相同的結果。提出多個相同的 CreateScheduledQuery 請求與提出單一請求具有相同的效果。  
+  如果在沒有 `ClientToken` 的情況下呼叫 CreateScheduledQuery，則查詢 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/* 字首。  
如果 ErrorReportConfiguration 使用 `SSE_KMS` 作為加密類型，則使用相同的 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 參數計算的時間戳記將是每次查詢執行的 `@scheduled_runtime` 參數值。例如，假設某個排程查詢執行個體是在 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>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/CreateScheduledQuery) 
+  [AWS 適用於 .NET V4 的 SDK](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 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/CreateScheduledQuery) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/CreateScheduledQuery) 
+  [AWS 適用於 JavaScript V3 的 SDK](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 V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/CreateScheduledQuery) 
+  [AWS 適用於 Python 的 SDK](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>

如需所有動作的一般參數資訊，請參閱《[Common Parameters](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>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/DeleteScheduledQuery) 
+  [AWS 適用於 .NET V4 的 SDK](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 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/DeleteScheduledQuery) 
+  [AWS 適用於 Java V2 的 SDK](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 V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/DeleteScheduledQuery) 
+  [AWS 適用於 Python 的 SDK](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。您可以在 4 的倍數中設定 TCU 數量上限，例如 4、8、16、32 等。此組態僅適用於 (TCUs的隨需用量。  
類型：整數

 ** [QueryCompute](#API_query_DescribeAccountSettings_ResponseSyntax) **   <a name="timestream-query_DescribeAccountSettings-response-QueryCompute"></a>
包含查詢工作負載之帳戶中 Timestream Compute Units (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>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/DescribeAccountSettings) 
+  [AWS 適用於 .NET V4 的 SDK](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 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/DescribeAccountSettings) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/DescribeAccountSettings) 
+  [AWS 適用於 JavaScript V3 的 SDK](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 V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/DescribeAccountSettings) 
+  [AWS 適用於 Python 的 SDK](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>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/DescribeEndpoints) 
+  [AWS 適用於 .NET V4 的 SDK](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 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/DescribeEndpoints) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/DescribeEndpoints) 
+  [AWS 適用於 JavaScript V3 的 SDK](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 V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/DescribeEndpoints) 
+  [AWS 適用於 Python 的 SDK](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>

如需所有動作的一般參數資訊，請參閱《[Common Parameters](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>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/DescribeScheduledQuery) 
+  [AWS 適用於 .NET V4 的 SDK](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 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/DescribeScheduledQuery) 
+  [AWS 適用於 Java V2 的 SDK](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 V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/DescribeScheduledQuery) 
+  [AWS 適用於 Python 的 SDK](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>

如需所有動作的一般參數資訊，請參閱《[Common Parameters](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 的時間戳記。查詢將如同在此時間戳記叫用一樣執行。  
類型：Timestamp  
必要：是

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

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/ExecuteScheduledQuery) 
+  [AWS 適用於 .NET V4 的 SDK](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 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/ExecuteScheduledQuery) 
+  [AWS 適用於 Java 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 V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/ExecuteScheduledQuery) 
+  [AWS 適用於 Python 的 SDK](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>

如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

請求接受採用 JSON 格式的下列資料。

 ** [MaxResults](#API_query_ListScheduledQueries_RequestSyntax) **   <a name="timestream-query_ListScheduledQueries-request-MaxResults"></a>
要在輸出中傳回的項目數量上限。如果可用的項目總數超過指定的值，`NextToken`則會在輸出中提供 。若要繼續分頁，請提供 `NextToken`值做為後續呼叫 的引數`ListScheduledQueriesRequest`。  
類型：整數  
有效範圍：最小值為 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>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/ListScheduledQueries) 
+  [AWS 適用於 .NET V4 的 SDK](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 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/ListScheduledQueries) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/ListScheduledQueries) 
+  [AWS 適用於 JavaScript V3 的 SDK](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 V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/ListScheduledQueries) 
+  [AWS 適用於 Python 的 SDK](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>

如需所有動作的一般參數資訊，請參閱《[Common Parameters](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 Resource Name (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>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/ListTagsForResource) 
+  [AWS 適用於 .NET V4 的 SDK](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 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/ListTagsForResource) 
+  [AWS 適用於 Java V2 的 SDK](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 V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/ListTagsForResource) 
+  [AWS 適用於 Python 的 SDK](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>

如需所有動作的一般參數資訊，請參閱《[Common Parameters](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>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/PrepareQuery) 
+  [AWS 適用於 .NET V4 的 SDK](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 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/PrepareQuery) 
+  [AWS 適用於 Java V2 的 SDK](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 V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/PrepareQuery) 
+  [AWS 適用於 Python 的 SDK](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`請求。
+  如果您使用相同的用戶端字符提交`Query`請求，但在 5 分鐘等冪時段內變更其他參數。
+  如果資料列的大小 （包括查詢中繼資料） 超過 1 MB，則查詢會失敗，並顯示下列錯誤訊息：

   `Query aborted as max page response size has been exceeded by the output result row` 
+  如果查詢啟動器和結果讀取器的 IAM 主體不同和/或查詢啟動器，且結果讀取器在查詢請求中沒有相同的查詢字串，則查詢會失敗並顯示`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>

如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

請求接受採用 JSON 格式的下列資料。

 ** [ClientToken](#API_query_Query_RequestSyntax) **   <a name="timestream-query_Query-request-ClientToken"></a>
 提出`Query`請求時，最多指定 64 個 ASCII 字元的唯一區分大小寫字串。提供 `ClientToken`會呼叫`Query`*等*冪。這表示重複執行相同的查詢會產生相同的結果。換句話說，提出多個相同的`Query`請求與提出單一請求的效果相同。在查詢`ClientToken`中使用 時，請注意下列事項：  
+  如果在沒有 的情況下執行個體化查詢 API`ClientToken`，則查詢 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`輸出中傳回的資料列總數。`Query` 具有指定`MaxRows`值的 初始執行會在兩種情況下傳回查詢的結果集：  
+ 結果的大小小於 `1MB`。
+ 結果集中的資料列數小於 的值`maxRows`。
否則， 的初始調用`Query`只會傳回 `NextToken`，然後可用於後續呼叫以擷取結果集。若要繼續分頁，請在後續命令中提供 `NextToken`值。  
如果資料列大小很大 （例如資料列有許多資料欄），Timestream 可能會傳回較少的資料列，以避免回應大小超過 1 MB 的限制。如果`MaxRows`未提供 ，Timestream 會傳送必要的資料列數，以符合 1 MB 的限制。  
類型：整數  
有效範圍：最小值為 1。最大值為 1000。  
必要：否

 ** [NextToken](#API_query_Query_RequestSyntax) **   <a name="timestream-query_Query-request-NextToken"></a>
 用於傳回一組結果的分頁字符。使用 叫用 `Query` API 時`NextToken`，會假設該特定叫用是先前呼叫 的後續叫用`Query`，並傳回結果集。不過，如果`Query`調用僅包含 `ClientToken`，則 的調用`Query`會假設為新的查詢執行。  
在查詢中使用 NextToken 時，請注意下列事項：  
+ 分頁字符最多可用於五個`Query`叫用，或長達 1 小時，以先發生者為準。
+ 使用相同的 `NextToken`會傳回相同的記錄集。若要繼續分頁結果集，您必須使用最新的 `nextToken`。
+ 假設`Query`調用會傳回兩個`NextToken`值 `TokenA`和 `TokenB`。如果 `TokenB` 在後續`Query`調用中使用 ，則 `TokenA` 會失效且無法重複使用。
+ 若要在分頁開始後從查詢請求先前的結果集，您必須重新叫用查詢 API。
+ `NextToken` 應該使用最新的 進行分頁，直到傳回`null`為止，此時`NextToken`應使用新的 。
+  如果查詢啟動器和結果讀取器的 IAM 主體不同和/或查詢啟動器，且結果讀取器在查詢請求中沒有相同的查詢字串，則查詢會失敗並顯示`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>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/Query) 
+  [AWS 適用於 .NET V4 的 SDK](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 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/Query) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/Query) 
+  [AWS 適用於 JavaScript V3 的 SDK](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 V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/Query) 
+  [AWS 適用於 Python 的 SDK](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 資源建立關聯。然後，您可以啟用這些使用者定義的標籤，使其顯示在 Billing and Cost Management 主控台上，以進行成本分配追蹤。

## 請求語法
<a name="API_query_TagResource_RequestSyntax"></a>

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

## 請求參數
<a name="API_query_TagResource_RequestParameters"></a>

如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

請求接受採用 JSON 格式的下列資料。

 ** [ResourceARN](#API_query_TagResource_RequestSyntax) **   <a name="timestream-query_TagResource-request-ResourceARN"></a>
識別應新增標籤的 Timestream 資源。這個值是 Amazon Resource Name (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>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/TagResource) 
+  [AWS 適用於 .NET V4 的 SDK](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 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/TagResource) 
+  [AWS 適用於 Java V2 的 SDK](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 V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/TagResource) 
+  [AWS 適用於 Python 的 SDK](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>

如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

請求接受採用 JSON 格式的下列資料。

 ** [ResourceARN](#API_query_UntagResource_RequestSyntax) **   <a name="timestream-query_UntagResource-request-ResourceARN"></a>
要從中移除標籤的 Timestream 資源。這個值是 Amazon Resource Name (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>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/UntagResource) 
+  [AWS 適用於 .NET V4 的 SDK](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 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/UntagResource) 
+  [AWS 適用於 Java V2 的 SDK](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 V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/UntagResource) 
+  [AWS 適用於 Python 的 SDK](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>

如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

請求接受採用 JSON 格式的下列資料。

 ** [MaxQueryTCU](#API_query_UpdateAccountSettings_RequestSyntax) **   <a name="timestream-query_UpdateAccountSettings-request-MaxQueryTCU"></a>
服務在任何時間點將用於服務查詢的運算單位數量上限。若要執行查詢，您必須將最小容量設定為 4 TCU。您可以在 4 的倍數中設定 TCU 數量上限，例如 4、8、16、32 等。支援的最大值`MaxQueryTCU`為 1000。若要請求提高此軟性限制，請聯絡 AWS Support。如需 maxQueryTCU 預設配額的相關資訊，請參閱預設配額。此組態僅適用於 Timestream Compute Units (TCUs 的隨需用量。  
支援的最大值`MaxQueryTCU`為 1000。若要請求提高此軟性限制，請聯絡 AWS Support。如需 的預設配額的相關資訊`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>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/UpdateAccountSettings) 
+  [AWS 適用於 .NET V4 的 SDK](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 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/UpdateAccountSettings) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/UpdateAccountSettings) 
+  [AWS 適用於 JavaScript V3 的 SDK](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 V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/UpdateAccountSettings) 
+  [AWS 適用於 Python 的 SDK](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>

如需所有動作的一般參數資訊，請參閱《[Common Parameters](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>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/UpdateScheduledQuery) 
+  [AWS 適用於 .NET V4 的 SDK](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 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/UpdateScheduledQuery) 
+  [AWS 適用於 Java V2 的 SDK](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 V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/UpdateScheduledQuery) 
+  [AWS 適用於 Python 的 SDK](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) 