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

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

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

リクエストパラメータ

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

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

ClientToken

を使用すると、 CreateScheduledQuery 冪等性を ClientToken 呼び出すことができます。つまり、同じリクエストを繰り返し行うと、同じ結果になります。複数の同じ CreateScheduledQuery リクエストを行うと、1 つのリクエストを行うのと同じ効果があります。

  • CreateScheduledQuery が なしで呼び出された場合ClientToken、クエリはClientTokenユーザーに代わって SDKを生成します。

  • 8 時間後、同じ ClientToken を持つリクエストは新しいリクエストとして処理されます。

型: 文字列

長さの制限: 最小長 32。最大長は 128 です。

必須：いいえ

ErrorReportConfiguration

エラーレポートの構成。エラーレポートは、クエリ結果を書き込むときに問題が発生した場合に生成されます。

型: ErrorReportConfiguration オブジェクト

必須：はい

KmsKeyId

スケジュールされたクエリリソースの保管時の暗号化に使用される Amazon KMSキー。Amazon KMSキーが指定されていない場合、スケジュールされたクエリリソースは Timestream が所有する Amazon KMSキーで暗号化されます。KMS キーを指定するには、キー ID、キー ARN、エイリアス名、またはエイリアス を使用しますARN。エイリアス名を使用する場合は、名前にプレフィックスとして alias/ を付けます。

ErrorReportConfiguration を暗号化タイプSSE_KMSとして使用する場合、保管中のエラーレポートの暗号化にも同じ KmsKeyId が使用されます。

型: 文字列

長さの制限：最小長は 1 です。最大長は 2,048 です。

必須：いいえ

Name

スケジュールされたクエリの名前。

型: 文字列

長さの制限：最小長は 1 です。最大長は 64 文字です。

Pattern: [a-zA-Z0-9|!\-_*'\(\)]([a-zA-Z0-9]|[!\-_*'\(\)\/.])+

必須：はい

NotificationConfiguration

スケジュールされたクエリの通知構成。Timestream は、クエリの実行が終了したとき、状態が更新されたとき、または削除されたときに通知を送信します。

型: NotificationConfiguration オブジェクト

必須：はい

QueryString

実行するクエリ文字列。パラメータ名は、クエリ文字列 @ 文字とその後に識別子を続けることで指定できます。名前付きパラメータ @scheduled_runtime は予約されており、クエリの実行がスケジュールされている時刻を取得するためにクエリ内で使用できます。

ScheduleConfiguration パラメータに従って計算されたタイムスタンプは、クエリ実行ごとに@scheduled_runtimeパラメータの値になります。例えば、2021-12-01 00:00:00 にスケジュールされたクエリのインスタンスを実行するとします。この場合、クエリを呼び出すと、@scheduled_runtime パラメータはタイムスタンプ 2021-12-01 00:00:00 に初期化されます。

型: 文字列

長さの制限：最小長は 1 です。最大長は 262,144 です。

必須：はい

ScheduleConfiguration

クエリのスケジュール設定。

型: ScheduleConfiguration オブジェクト

必須：はい

ScheduledQueryExecutionRoleArn

スケジュールされたクエリの実行時に Timestream ARNが引き受けるIAMロールの 。

型: 文字列

長さの制限：最小長は 1 です。最大長は 2,048 です。

必須：はい

Tags

スケジュールされたクエリにラベルを付けるためのキーと値のペアのリスト。

型: Tag オブジェクトの配列

配列メンバー: 最小数は 0 項目です。最大数は 200 項目です。

必須：いいえ

TargetConfiguration

クエリの結果の書き込みに使用される設定。

型: TargetConfiguration オブジェクト

必須: いいえ

レスポンスの構文

{
   "Arn": "string"
}

レスポンス要素

アクションが成功すると、サービスは 200 HTTP レスポンスを送り返します。

次のデータは、 サービスによって JSON 形式で返されます。

Arn

ARN 作成されたスケジュールされたクエリ。

型: 文字列

長さの制限：最小長は 1 です。最大長は 2,048 です。

エラー

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

AccessDeniedException

このアクションを実行する権限がありません。

HTTP ステータスコード: 400

ConflictException

キャンセルされたクエリの結果をポーリングできません。

HTTP ステータスコード: 400

InternalServerException

内部サーバーエラーのため、サービスはこのリクエストを完全に処理できませんでした。

HTTP ステータスコード: 400

InvalidEndpointException

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

HTTP ステータスコード: 400

ServiceQuotaExceededException

サービスクォータを超えました。

HTTP ステータスコード: 400

ThrottlingException

リクエストのスロットリングにより、リクエストが拒否されました。

HTTP ステータスコード: 400

ValidationException

無効または不正な形式のリクエスト。

HTTP ステータスコード: 400

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

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