AddApplicationReferenceDataSource - 阿帕奇 Flink 的 Amazon 託管服務(以前為阿帕奇 Flink 的 Amazon Kinesis Data Analytics)

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

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

類型:Long

有效範圍:最小值為 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。長度上限為 2048。

模式:arn:.*

ApplicationVersionId

更新的應用程式版本 ID。Kinesis Data Analytics 會在應用程式更新時遞增此 ID。

類型:Long

有效範圍:最小值為 1。最大值為 999999999。

ReferenceDataSourceDescriptions

描述為應用程式設定的參考資料來源。

類型:ReferenceDataSourceDescription 物件陣列

錯誤

ConcurrentModificationException

因應用程式並行修改而擲回的例外狀況。此錯誤可能是因為嘗試在不使用目前應用程式 ID 的情況下修改應用程式所致。

HTTP 狀態碼:400

InvalidArgumentException

指定的輸入參數值無效。

HTTP 狀態碼:400

InvalidRequestException

請求 JSON 對該操作無效。

HTTP 狀態碼:400

ResourceInUseException

該應用程序不適用於此操作。

HTTP 狀態碼:400

ResourceNotFoundException

找不到指定的應用程式。

HTTP 狀態碼:400

另請參閱

如需在其中一個特定語言 AWS SDK 中使用此 API 的詳細資訊,請參閱下列內容: