新しいプロジェクトでは、Kinesis Data Analytics for Applications 経由で新しい Managed Service for Apache Flink Studio SQL を使用することをお勧めします。Managed Service for Apache Flink Studio は、使いやすさと高度な分析機能を兼ね備えているため、高度なストリーム処理アプリケーションを数分で構築できます。
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
AddApplicationReferenceDataSource
注記
このドキュメントの対象は、SQL アプリケーションのみがサポートされる Amazon Kinesis Data Analytics API のバージョン 1 です。バージョン 2 の API では、SQL および Java アプリケーションがサポートされます。バージョン 2 の詳細については、Amazon Kinesis Data Analytics API V2 のドキュメントを参照してください。
既存のアプリケーションにリファレンスデータソースを追加します。
Amazon Kinesis Analytics は、リファレンスデータ (つまり、Amazon S3 オブジェクト) を読み取り、アプリケーション内にアプリケーション内テーブルを作成します。リクエストでは、ソース (S3 バケット名とオブジェクトのキー名)、作成するアプリケーション内テーブルの名前、および Amazon S3 オブジェクトのデータが結果のアプリケーション内テーブルの列にマッピングされる方法を説明する必要なマッピング情報を入力します。
概念については、「アプリケーション入力の設定」を参照してください。アプリケーションに追加できるデータソースの制限については、「制限」を参照してください。
このオペレーションには kinesisanalytics:AddApplicationOutput
アクションを実行するアクセス許可が必要です。
リクエストの構文
{
"ApplicationName": "string
",
"CurrentApplicationVersionId": number
,
"ReferenceDataSource": {
"ReferenceSchema": {
"RecordColumns": [
{
"Mapping": "string
",
"Name": "string
",
"SqlType": "string
"
}
],
"RecordEncoding": "string
",
"RecordFormat": {
"MappingParameters": {
"CSVMappingParameters": {
"RecordColumnDelimiter": "string
",
"RecordRowDelimiter": "string
"
},
"JSONMappingParameters": {
"RecordRowPath": "string
"
}
},
"RecordFormatType": "string
"
}
},
"S3ReferenceDataSource": {
"BucketARN": "string
",
"FileKey": "string
",
"ReferenceRoleARN": "string
"
},
"TableName": "string
"
}
}
リクエストパラメータ
リクエストは以下の JSON 形式のデータを受け入れます。
- ApplicationName
-
既存のアプリケーションの名前。
型: 文字列
長さの制限: 最小長は 1 です。最大長は 128 です。
パターン:
[a-zA-Z0-9_.-]+
必須:はい
- CurrentApplicationVersionId
-
参照データソースを追加するアプリケーションのバージョン。DescribeApplication オペレーションを使用して、現在のアプリケーションバージョンを取得できます。指定したバージョンが現在のバージョンでない場合は、
ConcurrentModificationException
が返されます。型: 長整数
有効範囲: 最小値は 1 です。最大値は 999999999 です。
必須: はい
- ReferenceDataSource
-
リファレンスデータソースは、Amazon S3 バケット内のオブジェクトにすることができます。Amazon Kinesis Analytics は、オブジェクトを読み取り、作成されているアプリケーション内テーブルにデータをコピーします。S3 バケット、オブジェクトのキー名、および作成されているアプリケーション内テーブルを指定します。また、ユーザーに代わって Amazon Kinesis Analytics が S3 バケットからのオブジェクトの読み取りを引き受けることができる必要なアクセス許可を持つ IAM ロールも指定する必要があります。
型: ReferenceDataSource オブジェクト
必須: はい
レスポンス要素
アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。
エラー
- ConcurrentModificationException
-
アプリケーションへの同時変更の結果としてスローされる例外。例えば、2 人の個人が同じアプリケーションを同時に編集しようとしています。
HTTP ステータスコード:400
- InvalidArgumentException
-
指定された入力パラメータ値が無効です。
HTTP ステータスコード:400
- ResourceInUseException
-
このオペレーションではアプリケーションを使用できません。
HTTP ステータスコード:400
- ResourceNotFoundException
-
指定されたアプリケーションが見つかりません。
HTTP ステータスコード:400
- UnsupportedOperationException
-
指定されたパラメータがサポートされていないか、指定されたリソースがこのオペレーションに対して有効でないため、リクエストは拒否されました。
HTTP ステータスコード:400
その他の参照資料
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。