PrepareQuery - Amazon Timestream
リクエストの構文リクエストパラメータレスポンスの構文レスポンス要素エラー以下の資料も参照してください。

Amazon Timestream for LiveAnalytics に類似した機能をご希望の場合は Amazon Timestream for InfluxDB をご検討ください。リアルタイム分析に適した、シンプルなデータインジェストと 1 桁ミリ秒のクエリ応答時間を特徴としています。詳細については、こちらを参照してください。

PrepareQuery

Timestream が後で実行するために保存するパラメータを含むクエリを送信できる同期オペレーション。Timestream は、ValidateOnly が true に設定されている場合にのみ、このオペレーションの使用をサポートします。

リクエストの構文

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

リクエストパラメータ

すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。

リクエストは以下のデータを JSON 形式で受け入れます。

QueryString

準備済みステートメントとして使用する Timestream クエリ文字列。パラメータ名は、クエリ文字列 @ 文字とその後に識別子を続けることで指定できます。

タイプ: 文字列

長さの制約: 最小長は 1 です。最大長は 262,144 です。

必須: はい

ValidateOnly

この値を 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

送信されたクエリ文字列の SELECT 句列のリスト。

タイプ: SelectColumn オブジェクトの配列

Parameters

送信されたクエリ文字列で使用されるパラメータのリスト。

タイプ: ParameterMapping オブジェクトの配列

QueryString

準備するクエリ文字列。

タイプ: 文字列

長さの制約: 最小長は 1 です。最大長は 262,144 です。

エラー

すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。

AccessDeniedException

アカウント設定にアクセスするために必要なアクセス許可がありません。

HTTP ステータスコード: 400

InternalServerException

リクエストの処理中に内部サーバーエラーが発生しました。

HTTP ステータスコード: 400

InvalidEndpointException

リクエストされたエンドポイントが無効です。

HTTP ステータスコード: 400

ThrottlingException

リクエストが多すぎるため、リクエストがスロットリングされました。

HTTP ステータスコード: 400

ValidationException

リクエストが無効であるか、形式が正しくありません。

HTTP ステータスコード: 400

以下の資料も参照してください。

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。