本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
AddApplicationOutput
將外部目標新增至以 SQL 為基礎的 Kinesis Data Analytics 應用程式。
若您希望 Kinesis Data Analytics 將您應用程式內串流中的資料交付到外部目標 (例如 Kinesis 資料串流、Kinesis Data Firehose 交付串流,或是 Amazon Lambda 函數),您可以使用此操作將相關組態新增到您的應用程式。您可以為您的應用程式設定一或多個輸出。每個輸出組態都會映射一個應用程式內串流和外部目標。
您可以使用其中一個輸出組態,將資料從您的應用程式內錯誤串流交付到外部目標,讓您可以分析錯誤。
任何組態更新,包括使用此操作新增串流資源,都會產生應用程式的新版本。您可以使用 DescribeApplication 操作來尋找目前的應用程式版本。
請求語法
{
"ApplicationName": "string
",
"CurrentApplicationVersionId": number
,
"Output": {
"DestinationSchema": {
"RecordFormatType": "string
"
},
"KinesisFirehoseOutput": {
"ResourceARN": "string
"
},
"KinesisStreamsOutput": {
"ResourceARN": "string
"
},
"LambdaOutput": {
"ResourceARN": "string
"
},
"Name": "string
"
}
}
請求參數
請求接受採用 JSON 格式的下列資料。
- ApplicationName
-
您要新增輸出組態之應用程式的名稱。
類型:字串
長度限制:長度下限為 1。長度上限為 128。
模式:
[a-zA-Z0-9_.-]+
必要:是
- CurrentApplicationVersionId
-
您要新增輸出組態的應用程式版本。您可以使用該DescribeApplication操作來獲取當前應用程序版本。如果指定的版本不是目前版本,則會傳回
ConcurrentModificationException
。類型:Long
有效範圍:最小值為 1。最大值為 999999999。
必要:是
- Output
-
物件陣列,每個都會描述一個輸出組態。在輸出組態中,您可以指定應用程式內串流的名稱、目的地 (也就是 Kinesis 資料串流、Kinesis Data Firehose 交付串流或 Amazon Lambda 函數),並記錄寫入目的地時要使用的格式。
類型:Output 物件
必要:是
回應語法
{
"ApplicationARN": "string",
"ApplicationVersionId": number,
"OutputDescriptions": [
{
"DestinationSchema": {
"RecordFormatType": "string"
},
"KinesisFirehoseOutputDescription": {
"ResourceARN": "string",
"RoleARN": "string"
},
"KinesisStreamsOutputDescription": {
"ResourceARN": "string",
"RoleARN": "string"
},
"LambdaOutputDescription": {
"ResourceARN": "string",
"RoleARN": "string"
},
"Name": "string",
"OutputId": "string"
}
]
}
回應元素
如果動作成功,則服務傳回 HTTP 200 回應。
服務會傳回下列 JSON 格式的資料。
- ApplicationARN
-
應用程序 Amazon 資源名稱(ARN)。
類型:字串
長度限制:長度下限為 1。長度上限為 2048。
模式:
arn:.*
- ApplicationVersionId
-
更新的應用程式版本 ID。Kinesis Data Analytics 會在應用程式更新時遞增此 ID。
類型:Long
有效範圍:最小值為 1。最大值為 999999999。
- OutputDescriptions
-
描述應用程式輸出組態。如需詳細資訊,請參閱設定應用程式輸出。
類型:OutputDescription 物件陣列
錯誤
- ConcurrentModificationException
-
因應用程式並行修改而擲回的例外狀況。此錯誤可能是因為嘗試在不使用目前應用程式 ID 的情況下修改應用程式所致。
HTTP 狀態碼:400
- InvalidArgumentException
-
指定的輸入參數值無效。
HTTP 狀態碼:400
- InvalidRequestException
-
請求 JSON 對該操作無效。
HTTP 狀態碼:400
- ResourceInUseException
-
該應用程序不適用於此操作。
HTTP 狀態碼:400
- ResourceNotFoundException
-
找不到指定的應用程式。
HTTP 狀態碼:400
另請參閱
如需在其中一個特定語言 AWS SDK 中使用此 API 的詳細資訊,請參閱下列內容: