AddApplicationReferenceDataSource - Amazon Managed Service for Apache Flink (以前の Amazon Kinesis Data Analytics for Apache Flink)

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

AddApplicationReferenceDataSource

リファレンスデータソースを既存の SQL ベースの Kinesis Data Analytics アプリケーションに追加します。

Kinesis Data Analytics は、リファレンスデータ (つまり、Amazon S3 オブジェクト) を読み取り、アプリケーション内にアプリケーション内テーブルを作成します。リクエストでは、ソース (S3 バケット名とオブジェクトのキー名)、作成するアプリケーション内テーブルの名前、および Amazon S3 オブジェクトのデータが結果のアプリケーション内テーブルの列にマッピングされる方法を説明する必要なマッピング情報を入力します。

リクエストの構文

{ "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" }, "TableName": "string" } }

リクエストパラメータ

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

ApplicationName

既存のアプリケーションの名前です。

型: 文字列

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

パターン: [a-zA-Z0-9_.-]+

必須:はい

CurrentApplicationVersionId

参照データソースを追加するアプリケーションのバージョン。DescribeApplication オペレーションを使用して、現在のアプリケーションバージョンを見つけることができます。指定したバージョンが現在のバージョンでない場合は、ConcurrentModificationException が返されます。

型: 長整数

有効範囲: 最小値は 1 です。最大値は 999999999 です。

必須: はい

ReferenceDataSource

リファレンスデータソースは、Amazon S3 バケット内のオブジェクトにすることができます。Kinesis Data Analytics はオブジェクトを読み取り、作成されたアプリケーション内テーブルにデータをコピーします。S3 バケット、オブジェクトのキー名、および作成されているアプリケーション内テーブルを指定します。

型: ReferenceDataSource オブジェクト

必須: はい

レスポンスの構文

{ "ApplicationARN": "string", "ApplicationVersionId": number, "ReferenceDataSourceDescriptions": [ { "ReferenceId": "string", "ReferenceSchema": { "RecordColumns": [ { "Mapping": "string", "Name": "string", "SqlType": "string" } ], "RecordEncoding": "string", "RecordFormat": { "MappingParameters": { "CSVMappingParameters": { "RecordColumnDelimiter": "string", "RecordRowDelimiter": "string" }, "JSONMappingParameters": { "RecordRowPath": "string" } }, "RecordFormatType": "string" } }, "S3ReferenceDataSourceDescription": { "BucketARN": "string", "FileKey": "string", "ReferenceRoleARN": "string" }, "TableName": "string" } ] }

レスポンス要素

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

サービスから以下のデータが JSON 形式で返されます。

ApplicationARN

アプリケーションの Amazon リソースネーム (ARN)。

型: 文字列

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

Pattern: arn:.*

ApplicationVersionId

更新されたアプリケーションバージョン ID。Kinesis Data Analytics では、アプリケーションが更新されるとこの ID が増加します。

型: 長整数

有効範囲: 最小値は 1 です。最大値は 999999999 です。

ReferenceDataSourceDescriptions

アプリケーション用に設定されたリファレンスデータソースを記述します。

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

エラー

ConcurrentModificationException

アプリケーションへの同時変更の結果としてスローされる例外。このエラーは、現在のアプリケーション ID を使用せずにアプリケーションを変更しようとしたことが原因である可能性があります。

HTTP ステータスコード:400

InvalidArgumentException

指定された入力パラメータ値が無効です。

HTTP ステータスコード:400

InvalidRequestException

要求された JSON はオペレーションに対して無効です。

HTTP ステータスコード:400

ResourceInUseException

このオペレーションではアプリケーションを使用できません。

HTTP ステータスコード:400

ResourceNotFoundException

指定されたアプリケーションが見つかりません。

HTTP ステータスコード:400

その他の参照資料

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