Amazon Timestream for LiveAnalytics に類似した機能をご希望の場合は Amazon Timestream for InfluxDB をご検討ください。リアルタイム分析に適した、シンプルなデータインジェストと 1 桁ミリ秒のクエリ応答時間を特徴としています。詳細については、[こちら](https://docs.aws.amazon.com//timestream/latest/developerguide/timestream-for-influxdb.html)を参照してください。
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
# アクション
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 Write
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
新しい 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)を参照してください。
## リクエストの構文
```
{
"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"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [ClientToken](#API_CreateBatchLoadTask_RequestSyntax) **
タイプ: 文字列
長さの制約: 最小長は 1 です。最大長 64
必須: いいえ
** [DataModelConfiguration](#API_CreateBatchLoadTask_RequestSyntax) **
型: [DataModelConfiguration](API_DataModelConfiguration.md) オブジェクト
必須: いいえ
** [DataSourceConfiguration](#API_CreateBatchLoadTask_RequestSyntax) **
バッチロードタスクのデータソースに関する設定の詳細を定義します。
型: [DataSourceConfiguration](API_DataSourceConfiguration.md) オブジェクト
必須: はい
** [RecordVersion](#API_CreateBatchLoadTask_RequestSyntax) **
タイプ: Long
必須: いいえ
** [ReportConfiguration](#API_CreateBatchLoadTask_RequestSyntax) **
バッチロードタスクのレポート設定。これには、エラーレポートの保存先に関する詳細が含まれます。
型: [ReportConfiguration](API_ReportConfiguration.md) オブジェクト
必須: はい
** [TargetDatabaseName](#API_CreateBatchLoadTask_RequestSyntax) **
バッチロードタスクのターゲット Timestream データベース。
タイプ: 文字列
Pattern: `[a-zA-Z0-9_.-]+`
必須: はい
** [TargetTableName](#API_CreateBatchLoadTask_RequestSyntax) **
バッチロードタスクのターゲット Timestream テーブル。
タイプ: 文字列
Pattern: `[a-zA-Z0-9_.-]+`
必須: はい
## レスポンスの構文
```
{
"TaskId": "string"
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [TaskId](#API_CreateBatchLoadTask_ResponseSyntax) **
バッチロードタスクの ID。
タイプ: 文字列
長さの制約: 最小長は 3 です。最大長は 32 です。
パターン: `[A-Z0-9]+`
## エラー
すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](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
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/CreateBatchLoadTask)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/CreateBatchLoadTask)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/CreateBatchLoadTask)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/CreateBatchLoadTask)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/CreateBatchLoadTask)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/CreateBatchLoadTask)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/CreateBatchLoadTask)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/CreateBatchLoadTask)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/CreateBatchLoadTask)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/CreateBatchLoadTask)
# CreateDatabase
新しい 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)を参照してください。
## リクエストの構文
```
{
"DatabaseName": "string",
"KmsKeyId": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [DatabaseName](#API_CreateDatabase_RequestSyntax) **
Timestream データベースの名前。
タイプ: 文字列
長さの制約: 最小長は 3 です。最大長は 256 です。
パターン: `[a-zA-Z0-9_.-]+`
必須: はい
** [KmsKeyId](#API_CreateDatabase_RequestSyntax) **
データベースの AWS KMS キー。 AWS KMS キーが指定されていない場合、データベースはアカウントにある Timestream マネージド AWS KMS キーで暗号化されます。詳細については、[AWS マネージドキー](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk) を参照してください。
タイプ: 文字列
長さの制約: 最小長は 1 です。最大長は 2,048 です。
必須: いいえ
** [Tags](#API_CreateDatabase_RequestSyntax) **
テーブルにラベルを付けるためのキーと値のペアのリスト。
型: [Tag](API_Tag.md) オブジェクトの配列
配列メンバー: 最小数は 0 項目です。最大数は 200 項目です。
必須: いいえ
## レスポンスの構文
```
{
"Database": {
"Arn": "string",
"CreationTime": number,
"DatabaseName": "string",
"KmsKeyId": "string",
"LastUpdatedTime": number,
"TableCount": number
}
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [Database](#API_CreateDatabase_ResponseSyntax) **
新しく作成された Timestream データベース。
型: [Database](API_Database.md) オブジェクト
## エラー
すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](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
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/CreateDatabase)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/CreateDatabase)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/CreateDatabase)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/CreateDatabase)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/CreateDatabase)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/CreateDatabase)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/CreateDatabase)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/CreateDatabase)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/CreateDatabase)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/CreateDatabase)
# CreateTable
アカウントの既存のデータベースに新しいテーブルを追加します。では 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)を参照してください。
## リクエストの構文
```
{
"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"
}
]
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [DatabaseName](#API_CreateTable_RequestSyntax) **
Timestream データベースの名前。
タイプ: 文字列
長さの制約: 最小長は 3 です。最大長は 256 です。
パターン: `[a-zA-Z0-9_.-]+`
必須: はい
** [MagneticStoreWriteProperties](#API_CreateTable_RequestSyntax) **
磁気ストアの書き込みを有効にするときに表に設定するプロパティが含まれます。
型: [MagneticStoreWriteProperties](API_MagneticStoreWriteProperties.md) オブジェクト
必須: いいえ
** [RetentionProperties](#API_CreateTable_RequestSyntax) **
時系列データをマグネティックストアとメモリストアに保存する必要がある期間。
型: [RetentionProperties](API_RetentionProperties.md) オブジェクト
必須: いいえ
** [Schema](#API_CreateTable_RequestSyntax) **
テーブルのスキーマ。
型: [Schema](API_Schema.md) オブジェクト
必須: いいえ
** [TableName](#API_CreateTable_RequestSyntax) **
Timestream テーブルの名前。
タイプ: 文字列
長さの制約: 最小長は 3 です。最大長は 256 です。
パターン: `[a-zA-Z0-9_.-]+`
必須: はい
** [Tags](#API_CreateTable_RequestSyntax) **
テーブルにラベルを付けるためのキーと値のペアのリスト。
型: [Tag](API_Tag.md) オブジェクトの配列
配列メンバー: 最小数は 0 項目です。最大数は 200 項目です。
必須: いいえ
## レスポンスの構文
```
{
"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"
}
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [Table](#API_CreateTable_ResponseSyntax) **
新しく作成された Timestream テーブル。
型: [Table](API_Table.md) オブジェクト
## エラー
すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](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
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/CreateTable)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/CreateTable)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/CreateTable)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/CreateTable)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/CreateTable)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/CreateTable)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/CreateTable)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/CreateTable)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/CreateTable)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/CreateTable)
# DeleteDatabase
特定の Timestream データベースを削除します。*このオペレーションは元に戻せません。データベースを削除した後、そのテーブルの時系列データは復元できません。*
**注記**
最初に、データベース内のすべてのテーブルを削除する必要があります。そうしないと、ValidationException エラーがスローされます。
分散再試行の性質上、オペレーションは成功または ResourceNotFoundException のいずれかを返す可能性があります。クライアントはそれらを同等とみなします。
詳細については、[ コードサンプル](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.delete-db.html)を参照してください。
## リクエストの構文
```
{
"DatabaseName": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [DatabaseName](#API_DeleteDatabase_RequestSyntax) **
削除される Timestream データベースの名前。
タイプ: 文字列
長さの制約: 最小長は 3 です。最大長は 256 です。
必須: はい
## レスポンス要素
アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。
## エラー
すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。
** AccessDeniedException **
このアクションを実行する権限がありません。
HTTP ステータスコード: 400
** InternalServerException **
内部サーバーエラーのため、Timestream はこのリクエストを完全に処理できませんでした。
HTTP ステータスコード: 500
** InvalidEndpointException **
リクエストされたエンドポイントが有効ではありませんでした。
HTTP ステータスコード: 400
** ResourceNotFoundException **
オペレーションは、存在しないリソースにアクセスしようとしました。リソースが正しく指定されていないか、ステータスが ACTIVE ではない可能性があります。
HTTP ステータスコード: 400
** ThrottlingException **
ユーザーによるリクエストが多すぎたため、サービスクォータを超過しました。リクエストがスロットリングされました。
HTTP ステータスコード: 400
** ValidationException **
リクエストが無効であるか、形式が正しくありません。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/DeleteDatabase)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/DeleteDatabase)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/DeleteDatabase)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/DeleteDatabase)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/DeleteDatabase)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/DeleteDatabase)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/DeleteDatabase)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/DeleteDatabase)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/DeleteDatabase)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/DeleteDatabase)
# DeleteTable
指定された Timestream テーブルを削除します。このオペレーションは元に戻せません。Timestream データベーステーブルを削除した後、そのテーブルに保存されている時系列データは復元できません。
**注記**
分散再試行の性質上、オペレーションは成功または ResourceNotFoundException のいずれかを返す可能性があります。クライアントはそれらを同等とみなします。
詳細については、[ コードサンプル](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.delete-table.html)を参照してください。
## リクエストの構文
```
{
"DatabaseName": "string",
"TableName": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [DatabaseName](#API_DeleteTable_RequestSyntax) **
Timestream データベースが削除されるデータベースの名前。
タイプ: 文字列
長さの制約: 最小長は 3 です。最大長は 256 です。
必須: はい
** [TableName](#API_DeleteTable_RequestSyntax) **
削除される Timestream テーブルの名前。
タイプ: 文字列
長さの制約: 最小長は 3 です。最大長は 256 です。
必須: はい
## レスポンス要素
アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。
## エラー
すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。
** AccessDeniedException **
このアクションを実行する権限がありません。
HTTP ステータスコード: 400
** InternalServerException **
内部サーバーエラーのため、Timestream はこのリクエストを完全に処理できませんでした。
HTTP ステータスコード: 500
** InvalidEndpointException **
リクエストされたエンドポイントが有効ではありませんでした。
HTTP ステータスコード: 400
** ResourceNotFoundException **
オペレーションは、存在しないリソースにアクセスしようとしました。リソースが正しく指定されていないか、ステータスが ACTIVE ではない可能性があります。
HTTP ステータスコード: 400
** ThrottlingException **
ユーザーによるリクエストが多すぎたため、サービスクォータを超過しました。リクエストがスロットリングされました。
HTTP ステータスコード: 400
** ValidationException **
リクエストが無効であるか、形式が正しくありません。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/DeleteTable)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/DeleteTable)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/DeleteTable)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/DeleteTable)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/DeleteTable)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/DeleteTable)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/DeleteTable)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/DeleteTable)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/DeleteTable)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/DeleteTable)
# DescribeBatchLoadTask
設定、マッピング、進行状況、その他の詳細など、バッチロードタスクに関する情報を返します。[サービスクォータが適用されます](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)を参照してください。
## リクエストの構文
```
{
"TaskId": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [TaskId](#API_DescribeBatchLoadTask_RequestSyntax) **
バッチロードタスクの ID。
タイプ: 文字列
長さの制約: 最小長は 3 です。最大長は 32 です。
パターン: `[A-Z0-9]+`
必須: はい
## レスポンスの構文
```
{
"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"
}
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [BatchLoadTaskDescription](#API_DescribeBatchLoadTask_ResponseSyntax) **
バッチロードタスクの説明。
型: [BatchLoadTaskDescription](API_BatchLoadTaskDescription.md) オブジェクト
## エラー
すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。
** AccessDeniedException **
このアクションを実行する権限がありません。
HTTP ステータスコード: 400
** InternalServerException **
内部サーバーエラーのため、Timestream はこのリクエストを完全に処理できませんでした。
HTTP ステータスコード: 500
** InvalidEndpointException **
リクエストされたエンドポイントが有効ではありませんでした。
HTTP ステータスコード: 400
** ResourceNotFoundException **
オペレーションは、存在しないリソースにアクセスしようとしました。リソースが正しく指定されていないか、ステータスが ACTIVE ではない可能性があります。
HTTP ステータスコード: 400
** ThrottlingException **
ユーザーによるリクエストが多すぎたため、サービスクォータを超過しました。リクエストがスロットリングされました。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/DescribeBatchLoadTask)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/DescribeBatchLoadTask)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/DescribeBatchLoadTask)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/DescribeBatchLoadTask)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/DescribeBatchLoadTask)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/DescribeBatchLoadTask)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/DescribeBatchLoadTask)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/DescribeBatchLoadTask)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/DescribeBatchLoadTask)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/DescribeBatchLoadTask)
# DescribeDatabase
データベース名、データベースが作成された時刻、データベース内で見つかったテーブルの合計数など、データベースに関する情報を返します。[サービスクォータが適用されます](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html)。詳細については、[ コードサンプル](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-db.html)を参照してください。
## リクエストの構文
```
{
"DatabaseName": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [DatabaseName](#API_DescribeDatabase_RequestSyntax) **
Timestream データベースの名前。
タイプ: 文字列
長さの制約: 最小長は 3 です。最大長は 256 です。
必須: はい
## レスポンスの構文
```
{
"Database": {
"Arn": "string",
"CreationTime": number,
"DatabaseName": "string",
"KmsKeyId": "string",
"LastUpdatedTime": number,
"TableCount": number
}
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [Database](#API_DescribeDatabase_ResponseSyntax) **
Timestream テーブルの名前。
型: [Database](API_Database.md) オブジェクト
## エラー
すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。
** AccessDeniedException **
このアクションを実行する権限がありません。
HTTP ステータスコード: 400
** InternalServerException **
内部サーバーエラーのため、Timestream はこのリクエストを完全に処理できませんでした。
HTTP ステータスコード: 500
** InvalidEndpointException **
リクエストされたエンドポイントが有効ではありませんでした。
HTTP ステータスコード: 400
** ResourceNotFoundException **
オペレーションは、存在しないリソースにアクセスしようとしました。リソースが正しく指定されていないか、ステータスが ACTIVE ではない可能性があります。
HTTP ステータスコード: 400
** ThrottlingException **
ユーザーによるリクエストが多すぎたため、サービスクォータを超過しました。リクエストがスロットリングされました。
HTTP ステータスコード: 400
** ValidationException **
リクエストが無効であるか、形式が正しくありません。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/DescribeDatabase)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/DescribeDatabase)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/DescribeDatabase)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/DescribeDatabase)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/DescribeDatabase)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/DescribeDatabase)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/DescribeDatabase)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/DescribeDatabase)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/DescribeDatabase)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/DescribeDatabase)
# DescribeEndpoints
Timestream API コールを実行するために使用できるエンドポイントのリストを返します。この API オペレーションは、Write API と Query API の両方で使用できます。
Timestream SDK は、サービスエンドポイントの管理やマッピングなど、サービスのアーキテクチャと透過的に連携するように設計されているため、*以下の場合を除き、この API オペレーションを使用することは推奨されません*。
+ [Timestream で VPC エンドポイント (AWS PrivateLink)](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)」を参照してください。
## レスポンスの構文
```
{
"Endpoints": [
{
"Address": "string",
"CachePeriodInMinutes": number
}
]
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [Endpoints](#API_DescribeEndpoints_ResponseSyntax) **
`Endpoints` オブジェクトは、`DescribeEndpoints` リクエストが行われたときに返されます。
型: [Endpoint](API_Endpoint.md) オブジェクトの配列
## エラー
すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。
** InternalServerException **
内部サーバーエラーのため、Timestream はこのリクエストを完全に処理できませんでした。
HTTP ステータスコード: 500
** ThrottlingException **
ユーザーによるリクエストが多すぎたため、サービスクォータを超過しました。リクエストがスロットリングされました。
HTTP ステータスコード: 400
** ValidationException **
リクエストが無効であるか、形式が正しくありません。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/DescribeEndpoints)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/DescribeEndpoints)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/DescribeEndpoints)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/DescribeEndpoints)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/DescribeEndpoints)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/DescribeEndpoints)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/DescribeEndpoints)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/DescribeEndpoints)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/DescribeEndpoints)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/DescribeEndpoints)
# DescribeTable
テーブル名、データベース名、メモリストアの保持期間、マグネティックストアなど、テーブルに関する情報を返します。[サービスクォータが適用されます](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html)。詳細については、[ コードサンプル](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.describe-table.html)を参照してください。
## リクエストの構文
```
{
"DatabaseName": "string",
"TableName": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [DatabaseName](#API_DescribeTable_RequestSyntax) **
Timestream データベースの名前。
タイプ: 文字列
長さの制約: 最小長は 3 です。最大長は 256 です。
必須: はい
** [TableName](#API_DescribeTable_RequestSyntax) **
Timestream テーブルの名前。
タイプ: 文字列
長さの制約: 最小長は 3 です。最大長は 256 です。
必須: はい
## レスポンスの構文
```
{
"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"
}
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [Table](#API_DescribeTable_ResponseSyntax) **
Timestream テーブル。
型: [Table](API_Table.md) オブジェクト
## エラー
すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。
** AccessDeniedException **
このアクションを実行する権限がありません。
HTTP ステータスコード: 400
** InternalServerException **
内部サーバーエラーのため、Timestream はこのリクエストを完全に処理できませんでした。
HTTP ステータスコード: 500
** InvalidEndpointException **
リクエストされたエンドポイントが有効ではありませんでした。
HTTP ステータスコード: 400
** ResourceNotFoundException **
オペレーションは、存在しないリソースにアクセスしようとしました。リソースが正しく指定されていないか、ステータスが ACTIVE ではない可能性があります。
HTTP ステータスコード: 400
** ThrottlingException **
ユーザーによるリクエストが多すぎたため、サービスクォータを超過しました。リクエストがスロットリングされました。
HTTP ステータスコード: 400
** ValidationException **
リクエストが無効であるか、形式が正しくありません。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/DescribeTable)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/DescribeTable)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/DescribeTable)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/DescribeTable)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/DescribeTable)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/DescribeTable)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/DescribeTable)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/DescribeTable)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/DescribeTable)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/DescribeTable)
# ListBatchLoadTasks
バッチロードタスクのリストと、名前、ステータス、いつまでタスクが再開可能か、およびその他の詳細を提供します。詳細については、[ コードサンプル](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-batch-load-tasks.html)を参照してください。
## リクエストの構文
```
{
"MaxResults": number,
"NextToken": "string",
"TaskStatus": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [MaxResults](#API_ListBatchLoadTasks_RequestSyntax) **
出力で返される項目の総数。使用可能な項目の総数が指定値を上回る場合、出力で NextToken が提供されます。ページ分割を再開するには、後続 API 呼び出しの引数として NextToken 値を指定します。
タイプ: 整数
有効範囲: 最小値 は 1 です。最大値は 100 です。
必須: いいえ
** [NextToken](#API_ListBatchLoadTasks_RequestSyntax) **
ページ分割を始める場所を指定するトークン。これは、以前に切り詰められたレスポンスからの NextToken です。
タイプ: 文字列
必須: いいえ
** [TaskStatus](#API_ListBatchLoadTasks_RequestSyntax) **
バッチロードタスクのステータス。
型: 文字列
有効な値：`CREATED | IN_PROGRESS | FAILED | SUCCEEDED | PROGRESS_STOPPED | PENDING_RESUME`
必須：いいえ
## レスポンスの構文
```
{
"BatchLoadTasks": [
{
"CreationTime": number,
"DatabaseName": "string",
"LastUpdatedTime": number,
"ResumableUntil": number,
"TableName": "string",
"TaskId": "string",
"TaskStatus": "string"
}
],
"NextToken": "string"
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [BatchLoadTasks](#API_ListBatchLoadTasks_ResponseSyntax) **
バッチロードタスクの詳細のリスト。
型: [BatchLoadTask](API_BatchLoadTask.md) オブジェクトの配列
** [NextToken](#API_ListBatchLoadTasks_ResponseSyntax) **
ページ分割を始める場所を指定するトークン。次の ListBatchLoadTasksRequest を指定します。
タイプ: 文字列
## エラー
すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。
** AccessDeniedException **
このアクションを実行する権限がありません。
HTTP ステータスコード: 400
** InternalServerException **
内部サーバーエラーのため、Timestream はこのリクエストを完全に処理できませんでした。
HTTP ステータスコード: 500
** InvalidEndpointException **
リクエストされたエンドポイントが有効ではありませんでした。
HTTP ステータスコード: 400
** ThrottlingException **
ユーザーによるリクエストが多すぎたため、サービスクォータを超過しました。リクエストがスロットリングされました。
HTTP ステータスコード: 400
** ValidationException **
リクエストが無効であるか、形式が正しくありません。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/ListBatchLoadTasks)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/ListBatchLoadTasks)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/ListBatchLoadTasks)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/ListBatchLoadTasks)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/ListBatchLoadTasks)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/ListBatchLoadTasks)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/ListBatchLoadTasks)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/ListBatchLoadTasks)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/ListBatchLoadTasks)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/ListBatchLoadTasks)
# ListDatabases
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)を参照してください。
## リクエストの構文
```
{
"MaxResults": number,
"NextToken": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [MaxResults](#API_ListDatabases_RequestSyntax) **
出力で返される項目の総数。使用可能な項目の総数が指定値を上回る場合、出力で NextToken が提供されます。ページ分割を再開するには、後続 API 呼び出しの引数として NextToken 値を指定します。
タイプ: 整数
有効範囲: 最小値 は 1 です。最大値は 20 です。
必須: いいえ
** [NextToken](#API_ListDatabases_RequestSyntax) **
ページ分割トークン。ページ分割を再開するには、後続 API 呼び出しの引数として NextToken 値を指定します。
タイプ: 文字列
必須: いいえ
## レスポンスの構文
```
{
"Databases": [
{
"Arn": "string",
"CreationTime": number,
"DatabaseName": "string",
"KmsKeyId": "string",
"LastUpdatedTime": number,
"TableCount": number
}
],
"NextToken": "string"
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [Databases](#API_ListDatabases_ResponseSyntax) **
データベース名のリスト。
型: [Database](API_Database.md) オブジェクトの配列
** [NextToken](#API_ListDatabases_ResponseSyntax) **
ページ分割トークン。このパラメータは、レスポンスが切り捨てられたときに返されます。
タイプ: 文字列
## エラー
すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。
** AccessDeniedException **
このアクションを実行する権限がありません。
HTTP ステータスコード: 400
** InternalServerException **
内部サーバーエラーのため、Timestream はこのリクエストを完全に処理できませんでした。
HTTP ステータスコード: 500
** InvalidEndpointException **
リクエストされたエンドポイントが有効ではありませんでした。
HTTP ステータスコード: 400
** ThrottlingException **
ユーザーによるリクエストが多すぎたため、サービスクォータを超過しました。リクエストがスロットリングされました。
HTTP ステータスコード: 400
** ValidationException **
リクエストが無効であるか、形式が正しくありません。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/ListDatabases)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/ListDatabases)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/ListDatabases)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/ListDatabases)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/ListDatabases)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/ListDatabases)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/ListDatabases)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/ListDatabases)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/ListDatabases)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/ListDatabases)
# ListTables
テーブルのリストと、各テーブルの名前、ステータス、保持プロパティを提供します。詳細については、[ コードサンプル](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.list-table.html)を参照してください。
## リクエストの構文
```
{
"DatabaseName": "string",
"MaxResults": number,
"NextToken": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [DatabaseName](#API_ListTables_RequestSyntax) **
Timestream データベースの名前。
タイプ: 文字列
長さの制約: 最小長は 3 です。最大長は 256 です。
必須: いいえ
** [MaxResults](#API_ListTables_RequestSyntax) **
出力で返される項目の総数。使用可能な項目の総数が指定値を上回る場合、出力で NextToken が提供されます。ページ分割を再開するには、後続 API 呼び出しの引数として NextToken 値を指定します。
タイプ: 整数
有効範囲: 最小値 は 1 です。最大値は 20 です。
必須: いいえ
** [NextToken](#API_ListTables_RequestSyntax) **
ページ分割トークン。ページ分割を再開するには、後続 API 呼び出しの引数として NextToken 値を指定します。
タイプ: 文字列
必須: いいえ
## レスポンスの構文
```
{
"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"
}
]
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [NextToken](#API_ListTables_ResponseSyntax) **
ページ分割を始める場所を指定するトークン。これは、以前に切り詰められたレスポンスからの NextToken です。
タイプ: 文字列
** [Tables](#API_ListTables_ResponseSyntax) **
テーブルのリスト。
型: [Table](API_Table.md) オブジェクトの配列
## エラー
すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。
** AccessDeniedException **
このアクションを実行する権限がありません。
HTTP ステータスコード: 400
** InternalServerException **
内部サーバーエラーのため、Timestream はこのリクエストを完全に処理できませんでした。
HTTP ステータスコード: 500
** InvalidEndpointException **
リクエストされたエンドポイントが有効ではありませんでした。
HTTP ステータスコード: 400
** ResourceNotFoundException **
オペレーションは、存在しないリソースにアクセスしようとしました。リソースが正しく指定されていないか、ステータスが ACTIVE ではない可能性があります。
HTTP ステータスコード: 400
** ThrottlingException **
ユーザーによるリクエストが多すぎたため、サービスクォータを超過しました。リクエストがスロットリングされました。
HTTP ステータスコード: 400
** ValidationException **
リクエストが無効であるか、形式が正しくありません。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/ListTables)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/ListTables)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/ListTables)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/ListTables)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/ListTables)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/ListTables)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/ListTables)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/ListTables)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/ListTables)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/ListTables)
# ListTagsForResource
Timestream リソースのすべてのタグを一覧表示します。
## リクエストの構文
```
{
"ResourceARN": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [ResourceARN](#API_ListTagsForResource_RequestSyntax) **
一覧表示されるタグを持つ Timestream リソース。この値は Amazon リソースネーム (ARN) です。
タイプ: 文字列
長さの制約: 最小長は 1 です。最大長は 1011 です。
必須: はい
## レスポンスの構文
```
{
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [Tags](#API_ListTagsForResource_ResponseSyntax) **
Timestream リソースに現在関連付けられているタグ。
型: [Tag](API_Tag.md) オブジェクトの配列
配列メンバー: 最小数は 0 項目です。最大数は 200 項目です。
## エラー
すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。
** InvalidEndpointException **
リクエストされたエンドポイントが有効ではありませんでした。
HTTP ステータスコード: 400
** ResourceNotFoundException **
オペレーションは、存在しないリソースにアクセスしようとしました。リソースが正しく指定されていないか、ステータスが ACTIVE ではない可能性があります。
HTTP ステータスコード: 400
** ThrottlingException **
ユーザーによるリクエストが多すぎたため、サービスクォータを超過しました。リクエストがスロットリングされました。
HTTP ステータスコード: 400
** ValidationException **
リクエストが無効であるか、形式が正しくありません。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/ListTagsForResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/ListTagsForResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/ListTagsForResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/ListTagsForResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/ListTagsForResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/ListTagsForResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/ListTagsForResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/ListTagsForResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/ListTagsForResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/ListTagsForResource)
# ResumeBatchLoadTask
## リクエストの構文
```
{
"TaskId": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [TaskId](#API_ResumeBatchLoadTask_RequestSyntax) **
再開するバッチロードタスクの ID。
タイプ: 文字列
長さの制約: 最小長は 3 です。最大長は 32 です。
パターン: `[A-Z0-9]+`
必須: はい
## レスポンス要素
アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。
## エラー
すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。
** AccessDeniedException **
このアクションを実行する権限がありません。
HTTP ステータスコード: 400
** InternalServerException **
内部サーバーエラーのため、Timestream はこのリクエストを完全に処理できませんでした。
HTTP ステータスコード: 500
** InvalidEndpointException **
リクエストされたエンドポイントが有効ではありませんでした。
HTTP ステータスコード: 400
** ResourceNotFoundException **
オペレーションは、存在しないリソースにアクセスしようとしました。リソースが正しく指定されていないか、ステータスが ACTIVE ではない可能性があります。
HTTP ステータスコード: 400
** ThrottlingException **
ユーザーによるリクエストが多すぎたため、サービスクォータを超過しました。リクエストがスロットリングされました。
HTTP ステータスコード: 400
** ValidationException **
リクエストが無効であるか、形式が正しくありません。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/ResumeBatchLoadTask)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/ResumeBatchLoadTask)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/ResumeBatchLoadTask)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/ResumeBatchLoadTask)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/ResumeBatchLoadTask)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/ResumeBatchLoadTask)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/ResumeBatchLoadTask)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/ResumeBatchLoadTask)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/ResumeBatchLoadTask)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/ResumeBatchLoadTask)
# TagResource
タグのセットを Timestream リソースに関連付けます。次に、これらのユーザー定義タグをアクティブ化し、コスト配分の追跡のため、Billing and Cost Management コンソールに表示できます。
## リクエストの構文
```
{
"ResourceARN": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [ResourceARN](#API_TagResource_RequestSyntax) **
タグを追加する Timestream リソースを識別します。この値は Amazon リソースネーム (ARN) です。
タイプ: 文字列
長さの制約: 最小長は 1 です。最大長は 1011 です。
必須: はい
** [Tags](#API_TagResource_RequestSyntax) **
Timestream リソースに割り当てられるタグ。
型: [Tag](API_Tag.md) オブジェクトの配列
配列メンバー: 最小数は 0 項目です。最大数は 200 項目です。
必須: はい
## レスポンス要素
アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。
## エラー
すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。
** InvalidEndpointException **
リクエストされたエンドポイントが有効ではありませんでした。
HTTP ステータスコード: 400
** ResourceNotFoundException **
オペレーションは、存在しないリソースにアクセスしようとしました。リソースが正しく指定されていないか、ステータスが ACTIVE ではない可能性があります。
HTTP ステータスコード: 400
** ServiceQuotaExceededException **
このアカウントにおけるリソースのインスタンスクォータを超過しました。
HTTP ステータスコード: 400
** ThrottlingException **
ユーザーによるリクエストが多すぎたため、サービスクォータを超過しました。リクエストがスロットリングされました。
HTTP ステータスコード: 400
** ValidationException **
リクエストが無効であるか、形式が正しくありません。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/TagResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/TagResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/TagResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/TagResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/TagResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/TagResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/TagResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/TagResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/TagResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/TagResource)
# UntagResource
Timestream リソースからタグの関連付けを削除します。
## リクエストの構文
```
{
"ResourceARN": "string",
"TagKeys": [ "string" ]
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [ResourceARN](#API_UntagResource_RequestSyntax) **
タグを削除する Timestream リソース。この値は Amazon リソースネーム (ARN) です。
タイプ: 文字列
長さの制約: 最小長は 1 です。最大長は 1011 です。
必須: はい
** [TagKeys](#API_UntagResource_RequestSyntax) **
タグキーのリスト。このリストのメンバーであるキーを持つリソースの既存のタグは、Timestream リソースから削除されます。
型: 文字列の配列
配列メンバー: 最小数は 0 項目です。最大数は 200 項目です。
長さの制限：最小長 1、最大長は 128 です。
必須: はい
## レスポンス要素
アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。
## エラー
すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。
** InvalidEndpointException **
リクエストされたエンドポイントが有効ではありませんでした。
HTTP ステータスコード: 400
** ResourceNotFoundException **
オペレーションは、存在しないリソースにアクセスしようとしました。リソースが正しく指定されていないか、ステータスが ACTIVE ではない可能性があります。
HTTP ステータスコード: 400
** ServiceQuotaExceededException **
このアカウントにおけるリソースのインスタンスクォータを超過しました。
HTTP ステータスコード: 400
** ThrottlingException **
ユーザーによるリクエストが多すぎたため、サービスクォータを超過しました。リクエストがスロットリングされました。
HTTP ステータスコード: 400
** ValidationException **
リクエストが無効であるか、形式が正しくありません。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/UntagResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/UntagResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/UntagResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/UntagResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/UntagResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/UntagResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/UntagResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/UntagResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/UntagResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/UntagResource)
# UpdateDatabase
既存のデータベースの AWS KMS キーを変更します。データベースを更新するときは、使用する新しい AWS KMS キーのデータベース名と識別子 () を指定する必要があります`KmsKeyId`。同時 `UpdateDatabase` リクエストがある場合、first writer wins セマンティクスが適用されます。
詳細については、[ コードサンプル](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.update-db.html)を参照してください。
## リクエストの構文
```
{
"DatabaseName": "string",
"KmsKeyId": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [DatabaseName](#API_UpdateDatabase_RequestSyntax) **
データベースの名前。
タイプ: 文字列
長さの制約: 最小長は 3 です。最大長は 256 です。
必須: はい
** [KmsKeyId](#API_UpdateDatabase_RequestSyntax) **
データベースに保存されているデータの暗号化に使用される新しい 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 です。最大長は 2,048 です。
必須: はい
## レスポンスの構文
```
{
"Database": {
"Arn": "string",
"CreationTime": number,
"DatabaseName": "string",
"KmsKeyId": "string",
"LastUpdatedTime": number,
"TableCount": number
}
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [Database](#API_UpdateDatabase_ResponseSyntax) **
テーブルの最上位コンテナ。データベースとテーブルは、Amazon Timestream の基本的な管理概念です。データベース内のすべてのテーブルは、同じ AWS KMS キーで暗号化されます。
型: [Database](API_Database.md) オブジェクト
## エラー
すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](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
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/UpdateDatabase)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/UpdateDatabase)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/UpdateDatabase)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/UpdateDatabase)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/UpdateDatabase)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/UpdateDatabase)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/UpdateDatabase)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/UpdateDatabase)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/UpdateDatabase)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/UpdateDatabase)
# UpdateTable
Timestream テーブルのメモリストアとマグネティックストアの保持期間を変更します。保持期間の変更は即時に有効になることに注意してください。例えば、メモリストアの保持期間が最初に 2 時間に設定され、その後 24 時間に変更された場合、メモリストアは 24 時間分のデータを保持できますが、この変更が行われた 22 時間後に 24 時間分のデータが入力されます。Timestream は、メモリストアに入力するためにマグネティックストアからデータを取得しません。
詳細については、[ コードサンプル](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.update-table.html)を参照してください。
## リクエストの構文
```
{
"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"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [DatabaseName](#API_UpdateTable_RequestSyntax) **
Timestream データベースの名前。
タイプ: 文字列
長さの制約: 最小長は 3 です。最大長は 256 です。
必須: はい
** [MagneticStoreWriteProperties](#API_UpdateTable_RequestSyntax) **
磁気ストアの書き込みを有効にするときに表に設定するプロパティが含まれます。
型: [MagneticStoreWriteProperties](API_MagneticStoreWriteProperties.md) オブジェクト
必須: いいえ
** [RetentionProperties](#API_UpdateTable_RequestSyntax) **
メモリストアとマグネティックストアの保持期間。
型: [RetentionProperties](API_RetentionProperties.md) オブジェクト
必須: いいえ
** [Schema](#API_UpdateTable_RequestSyntax) **
テーブルのスキーマ。
型: [Schema](API_Schema.md) オブジェクト
必須: いいえ
** [TableName](#API_UpdateTable_RequestSyntax) **
Timestream テーブルの名前。
タイプ: 文字列
長さの制約: 最小長は 3 です。最大長は 256 です。
必須: はい
## レスポンスの構文
```
{
"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"
}
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [Table](#API_UpdateTable_ResponseSyntax) **
更新された Timestream テーブル。
型: [Table](API_Table.md) オブジェクト
## エラー
すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。
** AccessDeniedException **
このアクションを実行する権限がありません。
HTTP ステータスコード: 400
** InternalServerException **
内部サーバーエラーのため、Timestream はこのリクエストを完全に処理できませんでした。
HTTP ステータスコード: 500
** InvalidEndpointException **
リクエストされたエンドポイントが有効ではありませんでした。
HTTP ステータスコード: 400
** ResourceNotFoundException **
オペレーションは、存在しないリソースにアクセスしようとしました。リソースが正しく指定されていないか、ステータスが ACTIVE ではない可能性があります。
HTTP ステータスコード: 400
** ThrottlingException **
ユーザーによるリクエストが多すぎたため、サービスクォータを超過しました。リクエストがスロットリングされました。
HTTP ステータスコード: 400
** ValidationException **
リクエストが無効であるか、形式が正しくありません。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/UpdateTable)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/UpdateTable)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/UpdateTable)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/UpdateTable)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/UpdateTable)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/UpdateTable)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/UpdateTable)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/UpdateTable)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/UpdateTable)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/UpdateTable)
# WriteRecords
Timestream に時系列データを書き込むことができます。システムに挿入する単一のデータポイントまたはデータポイントのバッチを指定できます。Timestream には、データベースへの書き込みを呼び出すときに指定したデータポイントのディメンション名とデータ型に基づいて、Timestream テーブルの列名とデータ型を自動検出する柔軟なスキーマが用意されています。
Timestream は、結果整合性のある読み込みセマンティクスをサポートしています。つまり、データのバッチを Timestream に書き込んだ直後にデータをクエリする場合、クエリ結果には最近完了した書き込みオペレーションの結果が反映されていない可能性があります。また、結果に古いデータが含まれている可能性もあります。少し時間が経ってからクエリリクエストを繰り返すと、結果で最新のデータが返されます。[サービスクォータが適用されます](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html)。
詳細については、[ コードサンプル](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.write.html)を参照してください。
**アップサート**
`WriteRecords` リクエストで `Version` パラメータを使用して、データポイントを更新できます。Timestream は、各レコードのバージョン番号を追跡します。`Version` は、リクエストのレコードに対して指定されていない場合、デフォルトで `1` になります。Timestream が既存のレコードのメジャー値とその `Version` を更新するのは、そのレコードの `Version` 番号がより大きい書き込みリクエストを受信した場合です。メジャー値が既存のレコードの値と同じである更新リクエストを受信した場合、Timestream は `Version` の既存の値より大きければ `Version` を更新します。データポイントは、`Version` の値が増加し続ける限り、何度でも更新できます。
例えば、リクエストで `Version` を指定せずに新しいレコードを書き込むとします。Timestream はこのレコードを保存し、`Version` を `1` に設定します。ここで、このレコードを別のメジャー値を持つ同じレコードの `WriteRecords` リクエストで更新しようとしますが、以前と同様に `Version` を指定しないとします。この場合、更新されたレコードのバージョンが Version の既存の値以下であるため、Timestream はこの更新を `RejectedRecordsException` で拒否します。
ただし、`Version` を `2` に設定して更新リクエストを再送信すると、Timestream はレコードの値の更新に成功し、`Version` は `2` に設定されます。次に、同じレコードと同じメジャー値で、`Version` を `3` に設定して `WriteRecords` リクエストを送信したとします。この場合、Timestream は `Version` を `3` に更新するだけです。それ以降の更新では、`3` より大きいバージョン番号を送信する必要があります。そうしないと、更新リクエストで `RejectedRecordsException` がスローされます。
## リクエストの構文
```
{
"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"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [CommonAttributes](#API_WriteRecords_RequestSyntax) **
リクエスト内のすべてのレコードで共有される共通のメジャー、ディメンション、時間、バージョンの属性を含むレコード。指定されたメジャー属性とディメンション属性は、データが Timestream に書き込まれるときに、レコードオブジェクトのメジャー属性およびディメンション属性とマージされます。ディメンションが重複してはいけません。重複すると、`ValidationException` がスローされます。つまり、レコードには一意の名前のディメンションが含まれている必要があります。
型: [Record](API_Record.md) オブジェクト
必須: いいえ
** [DatabaseName](#API_WriteRecords_RequestSyntax) **
Timestream データベースの名前。
タイプ: 文字列
長さの制約: 最小長は 3 です。最大長は 256 です。
必須: はい
** [Records](#API_WriteRecords_RequestSyntax) **
各時系列データポイントにおける一意のメジャー、ディメンション、時間、バージョンの属性を含むレコードの配列。
型: [Record](API_Record.md) オブジェクトの配列
配列メンバー: 最小数は 1 項目です。最大数は 100 項目です。
必須: はい
** [TableName](#API_WriteRecords_RequestSyntax) **
Timestream テーブルの名前。
タイプ: 文字列
長さの制約: 最小長は 3 です。最大長は 256 です。
必須: はい
## レスポンスの構文
```
{
"RecordsIngested": {
"MagneticStore": number,
"MemoryStore": number,
"Total": number
}
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [RecordsIngested](#API_WriteRecords_ResponseSyntax) **
このリクエストによって取り込まれたレコードに関する情報。
型: [RecordsIngested](API_RecordsIngested.md) オブジェクト
## エラー
すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](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
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/timestream-write-2018-11-01/WriteRecords)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-write-2018-11-01/WriteRecords)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-write-2018-11-01/WriteRecords)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-write-2018-11-01/WriteRecords)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-write-2018-11-01/WriteRecords)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-write-2018-11-01/WriteRecords)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-write-2018-11-01/WriteRecords)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-write-2018-11-01/WriteRecords)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-write-2018-11-01/WriteRecords)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-write-2018-11-01/WriteRecords)
# Amazon Timestream Query
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
発行されたクエリをキャンセルします。キャンセルは、キャンセルリクエストが発行される前にクエリの実行が完了していない場合にのみ提供されます。キャンセルはべき等のオペレーションであるため、後続のキャンセルリクエストはクエリが既にキャンセルされたことを示す `CancellationMessage` を返します。詳細については、[ コードサンプル](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.cancel-query.html)を参照してください。
## リクエストの構文
```
{
"QueryId": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [QueryId](#API_query_CancelQuery_RequestSyntax) **
キャンセルする必要があるクエリの ID。`QueryID` はクエリ結果の一部として返されます。
タイプ: 文字列
長さの制約: 最小長は 1 です。最大長 64
パターン: `[a-zA-Z0-9]+`
必須: はい
## レスポンスの構文
```
{
"CancellationMessage": "string"
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [CancellationMessage](#API_query_CancelQuery_ResponseSyntax) **
`CancellationMessage` は、`QueryId` で指定されたクエリの `CancelQuery` リクエストが既に発行されている場合に返されます。
タイプ: 文字列
## エラー
すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。
** AccessDeniedException **
アカウント設定にアクセスするために必要なアクセス許可がありません。
HTTP ステータスコード: 400
** InternalServerException **
リクエストの処理中に内部サーバーエラーが発生しました。
HTTP ステータスコード: 400
** InvalidEndpointException **
リクエストされたエンドポイントが無効です。
HTTP ステータスコード: 400
** ThrottlingException **
リクエストが多すぎるため、リクエストがスロットリングされました。
HTTP ステータスコード: 400
** ValidationException **
リクエストが無効であるか、形式が正しくありません。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/CancelQuery)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/CancelQuery)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/CancelQuery)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/CancelQuery)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/CancelQuery)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/CancelQuery)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/CancelQuery)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/CancelQuery)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/CancelQuery)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/CancelQuery)
# CreateScheduledQuery
設定されたスケジュールでユーザーに代わって実行されるスケジュールされたクエリを作成します。Timestream は、`ScheduledQueryExecutionRoleArn` パラメータの一部として提供される実行ロールを引き受けて、クエリを実行します。`NotificationConfiguration` パラメータを使用して、スケジュールされたクエリ操作の通知を設定できます。
## リクエストの構文
```
{
"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"
}
}
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [ClientToken](#API_query_CreateScheduledQuery_RequestSyntax) **
ClientToken を使用すると、createCheduledQuery の呼び出しがべき等になります。つまり、同じリクエストを繰り返し実行すると同じ結果が生成されます。同じ CreateScheduledQuery リクエストを複数回実行しても、1 回実行する場合と効果は同じです。
+ CreateScheduledQuery が `ClientToken` がない状態で呼び出される場合、クエリ SDK はユーザーに代わって `ClientToken` を生成します。
+ 8 時間後、同じ `ClientToken` を持つリクエストは新しいリクエストとして処理されます。
タイプ: 文字列
長さの制限: 最小長 32。最大長は 128 です。
必須: いいえ
** [ErrorReportConfiguration](#API_query_CreateScheduledQuery_RequestSyntax) **
エラーレポートの構成。エラーレポートは、クエリ結果を書き込むときに問題が発生した場合に生成されます。
型: [ErrorReportConfiguration](API_query_ErrorReportConfiguration.md) オブジェクト
必須: はい
** [KmsKeyId](#API_query_CreateScheduledQuery_RequestSyntax) **
スケジュールされたクエリリソースを保管時に暗号化するために使用される Amazon KMS キー。Amazon KMS キーが指定されていない場合、スケジュールされたクエリリソースは、Timestream 所有の Amazon KMS キーで暗号化されます。KMS キーを指定するには、キー ID、キー ARN、エイリアス名、エイリアス ARN を使用します。エイリアス名を使用する場合は、名前にプレフィックスとして *alias/* を付けます。
ErrorReportConfiguration が暗号化タイプとして `SSE_KMS` を使用する場合、保管時にエラーレポートを暗号化するために同じ KmsKeyId が使用されます。
タイプ: 文字列
長さの制約: 最小長は 1 です。最大長は 2,048 です。
必須: いいえ
** [Name](#API_query_CreateScheduledQuery_RequestSyntax) **
スケジュールされたクエリの名前。
タイプ: 文字列
長さの制約: 最小長は 1 です。最大長 64
パターン: `[a-zA-Z0-9|!\-_*'\(\)]([a-zA-Z0-9]|[!\-_*'\(\)\/.])+`
必須: はい
** [NotificationConfiguration](#API_query_CreateScheduledQuery_RequestSyntax) **
スケジュールされたクエリの通知構成。Timestream は、クエリの実行が終了したとき、状態が更新されたとき、または削除されたときに通知を送信します。
型: [NotificationConfiguration](API_query_NotificationConfiguration.md) オブジェクト
必須: はい
** [QueryString](#API_query_CreateScheduledQuery_RequestSyntax) **
実行するクエリ文字列。パラメータ名は、クエリ文字列 `@` 文字とその後に識別子を続けることで指定できます。名前付きパラメータ `@scheduled_runtime` は予約されており、クエリの実行がスケジュールされている時刻を取得するためにクエリ内で使用できます。
scheduleConfiguration パラメータに従って計算されたタイムスタンプは、各クエリ実行の `@scheduled_runtime` パラメータの値になります。例えば、2021-12-01 00:00:00 にスケジュールされたクエリのインスタンスを実行するとします。この場合、クエリを呼び出すと、`@scheduled_runtime` パラメータはタイムスタンプ 2021-12-01 00:00:00 に初期化されます。
タイプ: 文字列
長さの制約: 最小長は 1 です。最大長は 262,144 です。
必須: はい
** [ScheduleConfiguration](#API_query_CreateScheduledQuery_RequestSyntax) **
クエリのスケジュール設定。
型: [ScheduleConfiguration](API_query_ScheduleConfiguration.md) オブジェクト
必須: はい
** [ScheduledQueryExecutionRoleArn](#API_query_CreateScheduledQuery_RequestSyntax) **
スケジュールされたクエリの実行時に Timestream が引き受ける IAM ロールの ARN。
タイプ: 文字列
長さの制約: 最小長は 1 です。最大長は 2,048 です。
必須: はい
** [Tags](#API_query_CreateScheduledQuery_RequestSyntax) **
スケジュールされたクエリにラベルを付けるためのキーと値のペアのリスト。
型: [Tag](API_query_Tag.md) オブジェクトの配列
配列メンバー: 最小数は 0 項目です。最大数は 200 項目です。
必須: いいえ
** [TargetConfiguration](#API_query_CreateScheduledQuery_RequestSyntax) **
クエリの結果を書き込むために使用される設定。
型: [TargetConfiguration](API_query_TargetConfiguration.md) オブジェクト
必須: いいえ
## レスポンスの構文
```
{
"Arn": "string"
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [Arn](#API_query_CreateScheduledQuery_ResponseSyntax) **
作成されたスケジュールされたクエリの ARN。
タイプ: 文字列
長さの制約: 最小長は 1 です。最大長は 2,048 です。
## エラー
すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。
** AccessDeniedException **
アカウント設定にアクセスするために必要なアクセス許可がありません。
HTTP ステータスコード: 400
** ConflictException **
キャンセルされたクエリの結果をポーリングできません。
HTTP ステータスコード: 400
** InternalServerException **
リクエストの処理中に内部サーバーエラーが発生しました。
HTTP ステータスコード: 400
** InvalidEndpointException **
リクエストされたエンドポイントが無効です。
HTTP ステータスコード: 400
** ServiceQuotaExceededException **
サービスクォータを超過しました。
HTTP ステータスコード: 400
** ThrottlingException **
リクエストが多すぎるため、リクエストがスロットリングされました。
HTTP ステータスコード: 400
** ValidationException **
リクエストが無効であるか、形式が正しくありません。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/CreateScheduledQuery)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/CreateScheduledQuery)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/CreateScheduledQuery)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/CreateScheduledQuery)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/CreateScheduledQuery)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/CreateScheduledQuery)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/CreateScheduledQuery)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/CreateScheduledQuery)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/CreateScheduledQuery)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/CreateScheduledQuery)
# DeleteScheduledQuery
指定したスケジュールされたクエリを削除します。このオペレーションは元に戻せません。
## リクエストの構文
```
{
"ScheduledQueryArn": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [ScheduledQueryArn](#API_query_DeleteScheduledQuery_RequestSyntax) **
スケジュールされたクエリの ARN。
タイプ: 文字列
長さの制約: 最小長は 1 です。最大長は 2,048 です。
必須: はい
## レスポンス要素
アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。
## エラー
すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。
** AccessDeniedException **
アカウント設定にアクセスするために必要なアクセス許可がありません。
HTTP ステータスコード: 400
** InternalServerException **
リクエストの処理中に内部サーバーエラーが発生しました。
HTTP ステータスコード: 400
** InvalidEndpointException **
リクエストされたエンドポイントが無効です。
HTTP ステータスコード: 400
** ResourceNotFoundException **
リクエストされたリソースが見つかりませんでした。
** ScheduledQueryArn **
スケジュールされたクエリの ARN。
HTTP ステータスコード: 400
** ThrottlingException **
リクエストが多すぎるため、リクエストがスロットリングされました。
HTTP ステータスコード: 400
** ValidationException **
リクエストが無効であるか、形式が正しくありません。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/DeleteScheduledQuery)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/DeleteScheduledQuery)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/DeleteScheduledQuery)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/DeleteScheduledQuery)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/DeleteScheduledQuery)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/DeleteScheduledQuery)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/DeleteScheduledQuery)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/DeleteScheduledQuery)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/DeleteScheduledQuery)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/DeleteScheduledQuery)
# DescribeAccountSettings
クエリ料金モデルと、サービスがクエリワークロードに使用できる構成済みの最大 TCU 数を含むアカウントの設定を説明します。
ワークロードにおけるコンピューティングユニットの使用期間に対してのみ課金されます。
## レスポンスの構文
```
{
"MaxQueryTCU": number,
"QueryCompute": {
"ComputeMode": "string",
"ProvisionedCapacity": {
"ActiveQueryTCU": number,
"LastUpdate": {
"Status": "string",
"StatusMessage": "string",
"TargetQueryTCU": number
},
"NotificationConfiguration": {
"RoleArn": "string",
"SnsConfiguration": {
"TopicArn": "string"
}
}
}
},
"QueryPricingModel": "string"
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [MaxQueryTCU](#API_query_DescribeAccountSettings_ResponseSyntax) **
サービスがクエリを処理するために任意の時点で使用する [Timestream コンピューティングユニット](https://docs.aws.amazon.com/timestream/latest/developerguide/tcu.html) (TCU) の最大数。クエリを実行するには、最小数を 4 TCU に設定する必要があります。TCU の最大数は、4 の倍数 (4、8、16、32 など) に設定できます。この設定は、TCU のオンデマンド使用にのみ適用されます。
タイプ: 整数
** [QueryCompute](#API_query_DescribeAccountSettings_ResponseSyntax) **
クエリワークロードに対するアカウントの TCU の使用設定を含むオブジェクト。QueryCompute は、アジアパシフィック (ムンバイ) リージョンでのみ使用できます。
型: [QueryComputeResponse](API_query_QueryComputeResponse.md) オブジェクト
** [QueryPricingModel](#API_query_DescribeAccountSettings_ResponseSyntax) **
アカウントにおけるクエリの料金モデル。
`QueryPricingModel` パラメータは複数の Timestream オペレーションで使用されますが、`UpdateAccountSettings` API オペレーションは `COMPUTE_UNITS` 以外の値を認識しません。
型: 文字列
有効な値：`BYTES_SCANNED | COMPUTE_UNITS`
## エラー
すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。
** AccessDeniedException **
アカウント設定にアクセスするために必要なアクセス許可がありません。
HTTP ステータスコード: 400
** InternalServerException **
リクエストの処理中に内部サーバーエラーが発生しました。
HTTP ステータスコード: 400
** InvalidEndpointException **
リクエストされたエンドポイントが無効です。
HTTP ステータスコード: 400
** ThrottlingException **
リクエストが多すぎるため、リクエストがスロットリングされました。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/DescribeAccountSettings)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/DescribeAccountSettings)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/DescribeAccountSettings)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/DescribeAccountSettings)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/DescribeAccountSettings)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/DescribeAccountSettings)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/DescribeAccountSettings)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/DescribeAccountSettings)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/DescribeAccountSettings)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/DescribeAccountSettings)
# DescribeEndpoints
DescribeEndpoints は、Timestream API コールを行うために利用可能なエンドポイントのリストを返します。この API は、書き込みとクエリの両方で使用できます。
Timestream SDK は、サービスエンドポイントの管理やマッピングなど、サービスのアーキテクチャと透過的に連携するように設計されているため、*以下の場合を除き、この API を使用することは推奨されません*。
+ [Timestream で VPC エンドポイント (AWS PrivateLink)](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)」を参照してください。
## レスポンスの構文
```
{
"Endpoints": [
{
"Address": "string",
"CachePeriodInMinutes": number
}
]
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [Endpoints](#API_query_DescribeEndpoints_ResponseSyntax) **
`Endpoints` オブジェクトは、`DescribeEndpoints` リクエストが行われたときに返されます。
型: [Endpoint](API_query_Endpoint.md) オブジェクトの配列
## エラー
すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。
** InternalServerException **
リクエストの処理中に内部サーバーエラーが発生しました。
HTTP ステータスコード: 400
** ThrottlingException **
リクエストが多すぎるため、リクエストがスロットリングされました。
HTTP ステータスコード: 400
** ValidationException **
リクエストが無効であるか、形式が正しくありません。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/DescribeEndpoints)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/DescribeEndpoints)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/DescribeEndpoints)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/DescribeEndpoints)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/DescribeEndpoints)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/DescribeEndpoints)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/DescribeEndpoints)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/DescribeEndpoints)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/DescribeEndpoints)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/DescribeEndpoints)
# DescribeScheduledQuery
スケジュールされたクエリに関する詳細情報を提供します。
## リクエストの構文
```
{
"ScheduledQueryArn": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [ScheduledQueryArn](#API_query_DescribeScheduledQuery_RequestSyntax) **
スケジュールされたクエリの ARN。
タイプ: 文字列
長さの制約: 最小長は 1 です。最大長は 2,048 です。
必須: はい
## レスポンスの構文
```
{
"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"
}
}
}
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [ScheduledQuery](#API_query_DescribeScheduledQuery_ResponseSyntax) **
スケジュールされたクエリ。
型: [ScheduledQueryDescription](API_query_ScheduledQueryDescription.md) オブジェクト
## エラー
すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。
** AccessDeniedException **
アカウント設定にアクセスするために必要なアクセス許可がありません。
HTTP ステータスコード: 400
** InternalServerException **
リクエストの処理中に内部サーバーエラーが発生しました。
HTTP ステータスコード: 400
** InvalidEndpointException **
リクエストされたエンドポイントが無効です。
HTTP ステータスコード: 400
** ResourceNotFoundException **
リクエストされたリソースが見つかりませんでした。
** ScheduledQueryArn **
スケジュールされたクエリの ARN。
HTTP ステータスコード: 400
** ThrottlingException **
リクエストが多すぎるため、リクエストがスロットリングされました。
HTTP ステータスコード: 400
** ValidationException **
リクエストが無効であるか、形式が正しくありません。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/DescribeScheduledQuery)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/DescribeScheduledQuery)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/DescribeScheduledQuery)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/DescribeScheduledQuery)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/DescribeScheduledQuery)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/DescribeScheduledQuery)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/DescribeScheduledQuery)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/DescribeScheduledQuery)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/DescribeScheduledQuery)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/DescribeScheduledQuery)
# ExecuteScheduledQuery
この API を使用して、スケジュールされたクエリを手動で実行できます。
`QueryInsights` を有効にした場合、この API は Amazon SNS 通知の一部として、実行したクエリに関連するインサイトとメトリクスも返します。`QueryInsights` はクエリのパフォーマンスチューニングに役立ちます。`QueryInsights` の詳細については、「[クエリインサイトを使用して Amazon Timestream のクエリを最適化する](https://docs.aws.amazon.com/timestream/latest/developerguide/using-query-insights.html)」を参照してください。
## リクエストの構文
```
{
"ClientToken": "string",
"InvocationTime": number,
"QueryInsights": {
"Mode": "string"
},
"ScheduledQueryArn": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [ClientToken](#API_query_ExecuteScheduledQuery_RequestSyntax) **
使用されていません。
タイプ: 文字列
長さの制限: 最小長 32。最大長は 128 です。
必須: いいえ
** [InvocationTime](#API_query_ExecuteScheduledQuery_RequestSyntax) **
UTC のタイムスタンプ。クエリは、このタイムスタンプで呼び出されたものとして実行されます。
タイプ: タイムスタンプ
必須: はい
** [QueryInsights](#API_query_ExecuteScheduledQuery_RequestSyntax) **
`QueryInsights` を有効にするための設定をカプセル化します。
`QueryInsights` を有効にすると、実行したクエリの Amazon SNS 通知の一部としてインサイトとメトリクスが返されます。`QueryInsights` を使用して、クエリのパフォーマンスとコストをチューニングできます。
型: [ScheduledQueryInsights](API_query_ScheduledQueryInsights.md) オブジェクト
必須: いいえ
** [ScheduledQueryArn](#API_query_ExecuteScheduledQuery_RequestSyntax) **
スケジュールされたクエリの ARN。
タイプ: 文字列
長さの制約: 最小長は 1 です。最大長は 2,048 です。
必須: はい
## レスポンス要素
アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。
## エラー
すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。
** AccessDeniedException **
アカウント設定にアクセスするために必要なアクセス許可がありません。
HTTP ステータスコード: 400
** InternalServerException **
リクエストの処理中に内部サーバーエラーが発生しました。
HTTP ステータスコード: 400
** InvalidEndpointException **
リクエストされたエンドポイントが無効です。
HTTP ステータスコード: 400
** ResourceNotFoundException **
リクエストされたリソースが見つかりませんでした。
** ScheduledQueryArn **
スケジュールされたクエリの ARN。
HTTP ステータスコード: 400
** ThrottlingException **
リクエストが多すぎるため、リクエストがスロットリングされました。
HTTP ステータスコード: 400
** ValidationException **
リクエストが無効であるか、形式が正しくありません。
HTTP ステータスコード: 400
## 例
### ENABLED\$1WITH\$1RATE\$1CONTROL モードのスケジュールされたクエリ通知メッセージ
次の例は、`QueryInsights` パラメータの `ENABLED_WITH_RATE_CONTROL` モードのスケジュールされたクエリ通知メッセージの成功を示しています。
```
"SuccessNotificationMessage": {
"type": "MANUAL_TRIGGER_SUCCESS",
"arn": "arn:aws:timestream:::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:::database/BaseDb/table/BaseTable",
"partitionKey": [
"measure_name"
]
}
},
"queryTemporalRange": {
"max": {
"value": 2399999999999,
"tableArn": "arn:aws:timestream:::database/BaseDb/table/BaseTable"
}
},
"queryTableCount": 1,
"outputRows": 1,
"outputBytes": 59
}
}
}
```
### DISABLED モードのスケジュールされたクエリ通知メッセージ
次の例は、`QueryInsights` パラメータの `DISABLED` モードのスケジュールされたクエリ通知メッセージの成功を示しています。
```
"SuccessNotificationMessage": {
"type": "MANUAL_TRIGGER_SUCCESS",
"arn": "arn:aws:timestream:::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 モードの失敗通知メッセージ
次の例は、`QueryInsights` パラメータの `ENABLED_WITH_RATE_CONTROL` モードのスケジュールされたクエリ通知メッセージの失敗を示しています。
```
"FailureNotificationMessage": {
"type": "MANUAL_TRIGGER_FAILURE",
"arn": "arn:aws:timestream:::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 モードの失敗通知メッセージ
次の例は、`QueryInsights` パラメータの `DISABLED` モードのスケジュールされたクエリ通知メッセージの失敗を示しています。
```
"FailureNotificationMessage": {
"type": "MANUAL_TRIGGER_FAILURE",
"arn": "arn:aws:timestream:::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"
}
}
```
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/ExecuteScheduledQuery)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/ExecuteScheduledQuery)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/ExecuteScheduledQuery)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/ExecuteScheduledQuery)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/ExecuteScheduledQuery)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/ExecuteScheduledQuery)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/ExecuteScheduledQuery)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/ExecuteScheduledQuery)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/ExecuteScheduledQuery)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/ExecuteScheduledQuery)
# ListScheduledQueries
呼び出し元の Amazon アカウントとリージョンにおけるスケジュールされたクエリすべてのリストを取得します。`ListScheduledQueries` には結果整合性があります。
## リクエストの構文
```
{
"MaxResults": number,
"NextToken": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [MaxResults](#API_query_ListScheduledQueries_RequestSyntax) **
出力で返される項目の最大数。使用可能な項目の総数が指定値を上回る場合、出力で `NextToken` が提供されます。ページ分割を再開するには、`ListScheduledQueriesRequest` への後続呼び出しの引数として `NextToken` 値を指定します。
タイプ: 整数
有効範囲: 最小値 は 1 です。最大値は 1000 です。
必須: いいえ
** [NextToken](#API_query_ListScheduledQueries_RequestSyntax) **
ページ分割を再開するためのページ分割トークン。
タイプ: 文字列
必須: いいえ
## レスポンスの構文
```
{
"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"
}
}
}
]
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [NextToken](#API_query_ListScheduledQueries_ResponseSyntax) **
ページ分割を始める場所を指定するトークン。これは、以前に切り詰められたレスポンスからの NextToken です。
タイプ: 文字列
** [ScheduledQueries](#API_query_ListScheduledQueries_ResponseSyntax) **
スケジュールされたクエリのリスト。
型: [ScheduledQuery](API_query_ScheduledQuery.md) オブジェクトの配列
## エラー
すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。
** AccessDeniedException **
アカウント設定にアクセスするために必要なアクセス許可がありません。
HTTP ステータスコード: 400
** InternalServerException **
リクエストの処理中に内部サーバーエラーが発生しました。
HTTP ステータスコード: 400
** InvalidEndpointException **
リクエストされたエンドポイントが無効です。
HTTP ステータスコード: 400
** ThrottlingException **
リクエストが多すぎるため、リクエストがスロットリングされました。
HTTP ステータスコード: 400
** ValidationException **
リクエストが無効であるか、形式が正しくありません。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/ListScheduledQueries)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/ListScheduledQueries)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/ListScheduledQueries)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/ListScheduledQueries)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/ListScheduledQueries)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/ListScheduledQueries)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/ListScheduledQueries)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/ListScheduledQueries)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/ListScheduledQueries)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/ListScheduledQueries)
# ListTagsForResource
Timestream クエリリソースのすべてのタグを一覧表示します。
## リクエストの構文
```
{
"MaxResults": number,
"NextToken": "string",
"ResourceARN": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [MaxResults](#API_query_ListTagsForResource_RequestSyntax) **
返されるタグの最大数。
タイプ: 整数
有効範囲: 最小値 は 1 です。最大値は 200 です。
必須: いいえ
** [NextToken](#API_query_ListTagsForResource_RequestSyntax) **
ページ分割を再開するためのページ分割トークン。
タイプ: 文字列
必須: いいえ
** [ResourceARN](#API_query_ListTagsForResource_RequestSyntax) **
一覧表示されるタグを持つ Timestream リソース。この値は Amazon リソースネーム (ARN) です。
タイプ: 文字列
長さの制約: 最小長は 1 です。最大長は 2,048 です。
必須: はい
## レスポンスの構文
```
{
"NextToken": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [NextToken](#API_query_ListTagsForResource_ResponseSyntax) **
`ListTagsForResourceResponse` への後続呼び出しでページ分割を再開するためのページ分割トークン。
タイプ: 文字列
** [Tags](#API_query_ListTagsForResource_ResponseSyntax) **
Timestream リソースに現在関連付けられているタグ。
型: [Tag](API_query_Tag.md) オブジェクトの配列
配列メンバー: 最小数は 0 項目です。最大数は 200 項目です。
## エラー
すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。
** InvalidEndpointException **
リクエストされたエンドポイントが無効です。
HTTP ステータスコード: 400
** ResourceNotFoundException **
リクエストされたリソースが見つかりませんでした。
** ScheduledQueryArn **
スケジュールされたクエリの ARN。
HTTP ステータスコード: 400
** ThrottlingException **
リクエストが多すぎるため、リクエストがスロットリングされました。
HTTP ステータスコード: 400
** ValidationException **
リクエストが無効であるか、形式が正しくありません。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/ListTagsForResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/ListTagsForResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/ListTagsForResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/ListTagsForResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/ListTagsForResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/ListTagsForResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/ListTagsForResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/ListTagsForResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/ListTagsForResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/ListTagsForResource)
# PrepareQuery
Timestream が後で実行するために保存するパラメータを含むクエリを送信できる同期オペレーション。Timestream は、`ValidateOnly` が `true` に設定されている場合にのみ、このオペレーションの使用をサポートします。
## リクエストの構文
```
{
"QueryString": "string",
"ValidateOnly": boolean
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [QueryString](#API_query_PrepareQuery_RequestSyntax) **
準備済みステートメントとして使用する Timestream クエリ文字列。パラメータ名は、クエリ文字列 `@` 文字とその後に識別子を続けることで指定できます。
タイプ: 文字列
長さの制約: 最小長は 1 です。最大長は 262,144 です。
必須: はい
** [ValidateOnly](#API_query_PrepareQuery_RequestSyntax) **
この値を `true` に設定すると、Timestream はクエリ文字列が有効な Timestream クエリであることを検証するのみで、準備されたクエリを後で使用するために保存しません。
タイプ: ブール値
必須: いいえ
## レスポンスの構文
```
{
"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"
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [Columns](#API_query_PrepareQuery_ResponseSyntax) **
送信されたクエリ文字列の SELECT 句列のリスト。
型: [SelectColumn](API_query_SelectColumn.md) オブジェクトの配列
** [Parameters](#API_query_PrepareQuery_ResponseSyntax) **
送信されたクエリ文字列で使用されるパラメータのリスト。
型: [ParameterMapping](API_query_ParameterMapping.md) オブジェクトの配列
** [QueryString](#API_query_PrepareQuery_ResponseSyntax) **
準備するクエリ文字列。
タイプ: 文字列
長さの制約: 最小長は 1 です。最大長は 262,144 です。
## エラー
すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。
** AccessDeniedException **
アカウント設定にアクセスするために必要なアクセス許可がありません。
HTTP ステータスコード: 400
** InternalServerException **
リクエストの処理中に内部サーバーエラーが発生しました。
HTTP ステータスコード: 400
** InvalidEndpointException **
リクエストされたエンドポイントが無効です。
HTTP ステータスコード: 400
** ThrottlingException **
リクエストが多すぎるため、リクエストがスロットリングされました。
HTTP ステータスコード: 400
** ValidationException **
リクエストが無効であるか、形式が正しくありません。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/PrepareQuery)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/PrepareQuery)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/PrepareQuery)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/PrepareQuery)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/PrepareQuery)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/PrepareQuery)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/PrepareQuery)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/PrepareQuery)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/PrepareQuery)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/PrepareQuery)
# Query
`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 秒後にタイムアウトします。60 秒のタイムアウトをサポートするには、SDK のデフォルトタイムアウトを更新する必要があります。詳細については、[コードサンプル](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.run-query.html)を参照してください。
以下のケースでは、クエリリクエストが失敗します。
+ 5 分間のべき等性期間外に同じクライアントトークンを使用して `Query` リクエストを送信する場合。
+ 5 分間のべき等性期間内に同じクライアントトークンを使用し、その他のパラメータは変更して `Query` リクエストを送信する場合。
+ 行のサイズ (クエリメタデータを含む) が 1 MB を超える場合、クエリは失敗し、次のエラーメッセージが表示されます。
`Query aborted as max page response size has been exceeded by the output result row`
+ クエリ発行元と結果読み取り先の IAM プリンシパルが同じでない場合や、クエリ発行元と結果読み取り先のクエリリクエストに同じクエリ文字列がない場合、クエリは `Invalid pagination token` エラーで失敗します。
## リクエストの構文
```
{
"ClientToken": "string",
"MaxRows": number,
"NextToken": "string",
"QueryInsights": {
"Mode": "string"
},
"QueryString": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [ClientToken](#API_query_Query_RequestSyntax) **
`Query` リクエストの実行時に指定される、最大 64 ASCII 文字の、大文字と小文字を区別する一意の文字列。`ClientToken` を指定すると、`Query` への呼び出しが*べき等*になります。これは、同じクエリを繰り返し実行すると、同じ結果が生成されることを意味します。つまり、同じ `Query` リクエストを複数作成しても、効果は 1 つのリクエストを作成する場合と同じです。クエリで `ClientToken` を使用する場合は、次の点に注意してください。
+ Query API が `ClientToken` なしでインスタンス化される場合、Query SDK がユーザーに代わって `ClientToken` を生成します。
+ `Query` 呼び出しに `ClientToken` のみが含まれ、`NextToken` が含まれていない場合、`Query` の呼び出しは新しいクエリ実行とみなされます。
+ 呼び出しに `NextToken` が含まれている場合、その呼び出しは Query API に対する以前の呼び出しの後続呼び出しとみなされ、結果セットが返されます。
+ 4 時間後、同じ を持つすべてのリクエスト`ClientToken`は新しいリクエストとして扱われます。
タイプ: 文字列
長さの制限: 最小長 32。最大長は 128 です。
必須: いいえ
** [MaxRows](#API_query_Query_RequestSyntax) **
`Query` 出力で返される行の総数。`MaxRows` 値が指定された `Query` の最初の実行では、次の 2 つのケースでクエリの結果セットが返されます。
+ 結果のサイズが `1MB` 未満である。
+ 結果セットの行数が `maxRows` の値未満である。
上記に該当しない場合、`Query` の最初の呼び出しは `NextToken` のみを返します。これは、結果セットを取得するために後続の呼び出しで使用できます。ページ分割を再開するには、後続コマンドで `NextToken` 値を指定します。
行サイズが大きい場合 (例: 行に列が多数ある場合)、Timestream はレスポンスサイズが 1 MB の上限を超えないように、返す行数を減らすことがあります。`MaxRows` が指定されていない場合、Timestream は 1 MB の上限を満たす必要な行数を送信します。
タイプ: 整数
有効範囲: 最小値 は 1 です。最大値は 1000 です。
必須: いいえ
** [NextToken](#API_query_Query_RequestSyntax) **
結果セットを返すために使用されるページ分割トークン。`Query` API が `NextToken` を使用して呼び出されると、その呼び出しは `Query` に対する以前の呼び出しの後続呼び出しとみなされ、結果セットが返されます。ただし、`Query` 呼び出しに `ClientToken` のみが含まれる場合、`Query` の呼び出しは新しいクエリ実行とみなされます。
クエリで NextToken を使用する場合は、次の点に注意してください。
+ ページ分割トークンは、最大 5 回の `Query` 呼び出しと、最大 1 時間のどちらか早い方に使用できます。
+ 同じ `NextToken` を使用すると、同じレコードセットが返されます。結果セットをページ分割し続けるには、最新の `nextToken` を使用する必要があります。
+ `Query` 呼び出しが `TokenA` と `TokenB` の 2 つの `NextToken` 値を返すとします。`TokenB` が後続の `Query` 呼び出しで使用される場合、`TokenA` は無効になり、再利用できません。
+ ページ分割の開始後にクエリから以前の結果セットをリクエストするには、Query API を再度呼び出す必要があります。
+ `null` が返されるまでは最新の `NextToken` を使用してページ分割し、これが返された時点で新しい `NextToken` を使用する必要があります。
+ クエリ発行元と結果読み取り先の IAM プリンシパルが同じでない場合や、クエリ発行元と結果読み取り先のクエリリクエストに同じクエリ文字列がない場合、クエリは `Invalid pagination token` エラーで失敗します。
タイプ: 文字列
長さの制約: 最小長は 1 です。最大長は 2,048 です。
必須: いいえ
** [QueryInsights](#API_query_Query_RequestSyntax) **
`QueryInsights` を有効にするための設定をカプセル化します。
`QueryInsights` を有効にすると、実行したクエリのクエリ結果に加えて、インサイトとメトリクスが返されます。`QueryInsights` を使用して、クエリのパフォーマンスをチューニングできます。
型: [QueryInsights](API_query_QueryInsights.md) オブジェクト
必須: いいえ
** [QueryString](#API_query_Query_RequestSyntax) **
Timestream によって実行されるクエリ。
タイプ: 文字列
長さの制約: 最小長は 1 です。最大長は 262,144 です。
必須: はい
## レスポンスの構文
```
{
"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"
}
]
}
]
}
]
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [ColumnInfo](#API_query_Query_ResponseSyntax) **
返された結果セットの列データ型。
型: [ColumnInfo](API_query_ColumnInfo.md) オブジェクトの配列
** [NextToken](#API_query_Query_ResponseSyntax) **
`Query` 呼び出しで再度使用して次の結果セットを取得できるページ分割トークン。
タイプ: 文字列
長さの制約: 最小長は 1 です。最大長は 2,048 です。
** [QueryId](#API_query_Query_ResponseSyntax) **
指定されたクエリの一意の ID。
タイプ: 文字列
長さの制約: 最小長は 1 です。最大長 64
パターン: `[a-zA-Z0-9]+`
** [QueryInsightsResponse](#API_query_Query_ResponseSyntax) **
実行したクエリに関連するインサイトとメトリクスを含む `QueryInsights` をカプセル化します。
型: [QueryInsightsResponse](API_query_QueryInsightsResponse.md) オブジェクト
** [QueryStatus](#API_query_Query_ResponseSyntax) **
進行状況やスキャンされたバイト数など、クエリのステータスに関する情報。
型: [QueryStatus](API_query_QueryStatus.md) オブジェクト
** [Rows](#API_query_Query_ResponseSyntax) **
クエリによって返される結果セット行。
型: [Row](API_query_Row.md) オブジェクトの配列
## エラー
すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。
** AccessDeniedException **
アカウント設定にアクセスするために必要なアクセス許可がありません。
HTTP ステータスコード: 400
** ConflictException **
キャンセルされたクエリの結果をポーリングできません。
HTTP ステータスコード: 400
** InternalServerException **
リクエストの処理中に内部サーバーエラーが発生しました。
HTTP ステータスコード: 400
** InvalidEndpointException **
リクエストされたエンドポイントが無効です。
HTTP ステータスコード: 400
** QueryExecutionException **
Timestream がクエリを正常に実行できませんでした。
HTTP ステータスコード: 400
** ThrottlingException **
リクエストが多すぎるため、リクエストがスロットリングされました。
HTTP ステータスコード: 400
** ValidationException **
リクエストが無効であるか、形式が正しくありません。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/Query)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/Query)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/Query)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/Query)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/Query)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/Query)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/Query)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/Query)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/Query)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/Query)
# TagResource
タグのセットを Timestream リソースに関連付けます。次に、これらのユーザー定義タグをアクティブ化し、コスト配分の追跡のため、Billing and Cost Management コンソールに表示できます。
## リクエストの構文
```
{
"ResourceARN": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [ResourceARN](#API_query_TagResource_RequestSyntax) **
タグを追加する Timestream リソースを識別します。この値は Amazon リソースネーム (ARN) です。
タイプ: 文字列
長さの制約: 最小長は 1 です。最大長は 2,048 です。
必須: はい
** [Tags](#API_query_TagResource_RequestSyntax) **
Timestream リソースに割り当てられるタグ。
型: [Tag](API_query_Tag.md) オブジェクトの配列
配列メンバー: 最小数は 0 項目です。最大数は 200 項目です。
必須: はい
## レスポンス要素
アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。
## エラー
すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。
** InvalidEndpointException **
リクエストされたエンドポイントが無効です。
HTTP ステータスコード: 400
** ResourceNotFoundException **
リクエストされたリソースが見つかりませんでした。
** ScheduledQueryArn **
スケジュールされたクエリの ARN。
HTTP ステータスコード: 400
** ServiceQuotaExceededException **
サービスクォータを超過しました。
HTTP ステータスコード: 400
** ThrottlingException **
リクエストが多すぎるため、リクエストがスロットリングされました。
HTTP ステータスコード: 400
** ValidationException **
リクエストが無効であるか、形式が正しくありません。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/TagResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/TagResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/TagResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/TagResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/TagResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/TagResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/TagResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/TagResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/TagResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/TagResource)
# UntagResource
Timestream クエリリソースからタグの関連付けを削除します。
## リクエストの構文
```
{
"ResourceARN": "string",
"TagKeys": [ "string" ]
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [ResourceARN](#API_query_UntagResource_RequestSyntax) **
タグを削除する Timestream リソース。この値は Amazon リソースネーム (ARN) です。
タイプ: 文字列
長さの制約: 最小長は 1 です。最大長は 2,048 です。
必須: はい
** [TagKeys](#API_query_UntagResource_RequestSyntax) **
タグキーのリスト。このリストのメンバーであるキーを持つリソースの既存のタグは、Timestream リソースから削除されます。
型: 文字列の配列
配列メンバー: 最小数は 0 項目です。最大数は 200 項目です。
長さの制限：最小長 1、最大長は 128 です。
必須: はい
## レスポンス要素
アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。
## エラー
すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。
** InvalidEndpointException **
リクエストされたエンドポイントが無効です。
HTTP ステータスコード: 400
** ResourceNotFoundException **
リクエストされたリソースが見つかりませんでした。
** ScheduledQueryArn **
スケジュールされたクエリの ARN。
HTTP ステータスコード: 400
** ThrottlingException **
リクエストが多すぎるため、リクエストがスロットリングされました。
HTTP ステータスコード: 400
** ValidationException **
リクエストが無効であるか、形式が正しくありません。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/UntagResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/UntagResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/UntagResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/UntagResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/UntagResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/UntagResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/UntagResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/UntagResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/UntagResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/UntagResource)
# UpdateAccountSettings
クエリ料金に TCU を使用するようにアカウントを移行し、設定した最大クエリコンピューティングユニット数を変更します。`MaxQueryTCU` の値を希望の設定まで減らした場合、新しい値が有効になるまでに最大 24 時間かかります。
**注記**
クエリ料金に TCU を使用するようにアカウントを移行した後は、クエリ料金にスキャン済みバイト数を使用するように移行できません。
## リクエストの構文
```
{
"MaxQueryTCU": number,
"QueryCompute": {
"ComputeMode": "string",
"ProvisionedCapacity": {
"NotificationConfiguration": {
"RoleArn": "string",
"SnsConfiguration": {
"TopicArn": "string"
}
},
"TargetQueryTCU": number
}
},
"QueryPricingModel": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [MaxQueryTCU](#API_query_UpdateAccountSettings_RequestSyntax) **
サービスがクエリを処理するために任意の時点で使用するコンピューティングユニットの最大数。クエリを実行するには、最小数を 4 TCU に設定する必要があります。TCU の最大数は、4 の倍数 (4、8、16、32 など) に設定できます。`MaxQueryTCU` に対してサポートされる最大値は 1000 です。このソフト制限の引き上げをリクエストするには、 AWS サポートにお問い合わせください。maxQueryTCU のデフォルトクォータの詳細については、「デフォルトのクォータ」を参照してください。この設定は、Timestream コンピューティングユニット (TCU) のオンデマンド使用にのみ適用されます。
`MaxQueryTCU` に対してサポートされる最大値は 1000 です。このソフト制限の引き上げをリクエストするには、 AWS サポートにお問い合わせください。`maxQueryTCU` のデフォルトクォータの詳細については、「[デフォルトのクォータ](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html#limits.default)」を参照してください。
タイプ: 整数
必須: いいえ
** [QueryCompute](#API_query_UpdateAccountSettings_RequestSyntax) **
アカウントのクエリコンピューティング設定を変更します。これには、アカウントのクエリ料金モデルやプロビジョンド Timestream コンピューティングユニット (TCU) 数が含まれます。QueryCompute は、アジアパシフィック (ムンバイ) リージョンでのみ使用できます。
この API はべき等です。つまり、同じリクエストを複数回行っても、1 回行う場合と効果は同じです。
型: [QueryComputeRequest](API_query_QueryComputeRequest.md) オブジェクト
必須: いいえ
** [QueryPricingModel](#API_query_UpdateAccountSettings_RequestSyntax) **
アカウントにおけるクエリの料金モデル。
`QueryPricingModel` パラメータは複数の Timestream オペレーションで使用されますが、`UpdateAccountSettings` API オペレーションは `COMPUTE_UNITS` 以外の値を認識しません。
型: 文字列
有効な値：`BYTES_SCANNED | COMPUTE_UNITS`
必須：いいえ
## レスポンスの構文
```
{
"MaxQueryTCU": number,
"QueryCompute": {
"ComputeMode": "string",
"ProvisionedCapacity": {
"ActiveQueryTCU": number,
"LastUpdate": {
"Status": "string",
"StatusMessage": "string",
"TargetQueryTCU": number
},
"NotificationConfiguration": {
"RoleArn": "string",
"SnsConfiguration": {
"TopicArn": "string"
}
}
}
},
"QueryPricingModel": "string"
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [MaxQueryTCU](#API_query_UpdateAccountSettings_ResponseSyntax) **
サービスがクエリを処理するために任意の時点で使用するコンピューティングユニットの設定済みの最大数。
タイプ: 整数
** [QueryCompute](#API_query_UpdateAccountSettings_ResponseSyntax) **
アカウントのデータのクエリに関する更新されたアカウント設定を確認します。QueryCompute は、アジアパシフィック (ムンバイ) リージョンでのみ使用できます。
型: [QueryComputeResponse](API_query_QueryComputeResponse.md) オブジェクト
** [QueryPricingModel](#API_query_UpdateAccountSettings_ResponseSyntax) **
アカウントの料金モデル。
型: 文字列
有効な値：`BYTES_SCANNED | COMPUTE_UNITS`
## エラー
すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。
** AccessDeniedException **
アカウント設定にアクセスするために必要なアクセス許可がありません。
HTTP ステータスコード: 400
** InternalServerException **
リクエストの処理中に内部サーバーエラーが発生しました。
HTTP ステータスコード: 400
** InvalidEndpointException **
リクエストされたエンドポイントが無効です。
HTTP ステータスコード: 400
** ThrottlingException **
リクエストが多すぎるため、リクエストがスロットリングされました。
HTTP ステータスコード: 400
** ValidationException **
リクエストが無効であるか、形式が正しくありません。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/UpdateAccountSettings)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/UpdateAccountSettings)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/UpdateAccountSettings)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/UpdateAccountSettings)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/UpdateAccountSettings)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/UpdateAccountSettings)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/UpdateAccountSettings)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/UpdateAccountSettings)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/UpdateAccountSettings)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/UpdateAccountSettings)
# UpdateScheduledQuery
スケジュールされたクエリを更新します。
## リクエストの構文
```
{
"ScheduledQueryArn": "string",
"State": "string"
}
```
## リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
** [ScheduledQueryArn](#API_query_UpdateScheduledQuery_RequestSyntax) **
スケジュールされたクエリの ARN。
タイプ: 文字列
長さの制約: 最小長は 1 です。最大長は 2,048 です。
必須: はい
** [State](#API_query_UpdateScheduledQuery_RequestSyntax) **
スケジュールされたクエリの状態。
型: 文字列
有効な値: `ENABLED | DISABLED`
必須: はい
## レスポンス要素
アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。
## エラー
すべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。
** AccessDeniedException **
アカウント設定にアクセスするために必要なアクセス許可がありません。
HTTP ステータスコード: 400
** InternalServerException **
リクエストの処理中に内部サーバーエラーが発生しました。
HTTP ステータスコード: 400
** InvalidEndpointException **
リクエストされたエンドポイントが無効です。
HTTP ステータスコード: 400
** ResourceNotFoundException **
リクエストされたリソースが見つかりませんでした。
** ScheduledQueryArn **
スケジュールされたクエリの ARN。
HTTP ステータスコード: 400
** ThrottlingException **
リクエストが多すぎるため、リクエストがスロットリングされました。
HTTP ステータスコード: 400
** ValidationException **
リクエストが無効であるか、形式が正しくありません。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/timestream-query-2018-11-01/UpdateScheduledQuery)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/timestream-query-2018-11-01/UpdateScheduledQuery)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-query-2018-11-01/UpdateScheduledQuery)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/timestream-query-2018-11-01/UpdateScheduledQuery)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-query-2018-11-01/UpdateScheduledQuery)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/timestream-query-2018-11-01/UpdateScheduledQuery)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/timestream-query-2018-11-01/UpdateScheduledQuery)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/timestream-query-2018-11-01/UpdateScheduledQuery)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/timestream-query-2018-11-01/UpdateScheduledQuery)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-query-2018-11-01/UpdateScheduledQuery)