AddApplicationOutput - Amazon Kinesis Data Analytics for SQL Applications 開発者ガイド

慎重な検討の結果、Amazon Kinesis Data Analytics for SQL アプリケーションのサポートは終了することになりました。サポート終了は次の 2 段階で行われます。

1. 2025 年 10 月 15 日以降、新しい Kinesis Data Analytics for SQL アプリケーションを作成することはできなくなります。

2. 2026 年 1 月 27 日以降、アプリケーションは削除されます。Amazon Kinesis Data Analytics for SQL アプリケーションを起動することも操作することもできなくなります。これ以降、Amazon Kinesis Data Analytics for SQL のサポートは終了します。詳細については、「Amazon Kinesis Data Analytics for SQL アプリケーションのサポート終了」を参照してください。

AddApplicationOutput

注記

このドキュメントの対象は、SQL アプリケーションのみがサポートされる Amazon Kinesis Data Analytics API のバージョン 1 です。バージョン 2 の API では、SQL および Java アプリケーションがサポートされます。バージョン 2 の詳細については、Amazon Kinesis Data Analytics API V2 のドキュメントを参照してください。

外部宛先を Amazon Kinesis Analytics アプリケーションに追加します。

Amazon Kinesis Analytics がデータをアプリケーション内のアプリケーション内ストリームから外部宛先 (Amazon Kinesis ストリーム、Amazon Kinesis Firehose 配信ストリーム、AWS Lambda 関数など) に配信するように設定する場合、このオペレーションを使用して、関連する設定をアプリケーションに追加します。アプリケーションに対して 1 つ以上の出力を設定できます。各出力構成により、アプリケーション内ストリームと外部送信先がマッピングされます。

いずれかの出力構成を使用して、データをアプリケーション内エラーストリームから外部送信先に配信できます。これにより、エラーの分析が可能になります。詳細については、「アプリケーション出力 (宛先) について」を参照してください。

このオペレーションを使用したストリーミングソースの追加などのすべての構成の更新により、アプリケーションの新しいバージョンになります。DescribeApplication オペレーションを使用して、現在のアプリケーションバージョンを見つけることができます。

設定できるアプリケーションの入力数および出力数の制限については、「制限」を参照してください。

このオペレーションには kinesisanalytics:AddApplicationOutput アクションを実行するアクセス許可が必要です。

リクエストの構文

{ "ApplicationName": "string", "CurrentApplicationVersionId": number, "Output": { "DestinationSchema": { "RecordFormatType": "string" }, "KinesisFirehoseOutput": { "ResourceARN": "string", "RoleARN": "string" }, "KinesisStreamsOutput": { "ResourceARN": "string", "RoleARN": "string" }, "LambdaOutput": { "ResourceARN": "string", "RoleARN": "string" }, "Name": "string" } }

リクエストパラメータ

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

ApplicationName

出力構成を追加するアプリケーションの名前。

型: 文字列

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

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

必須: はい

CurrentApplicationVersionId

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

型: 長整数

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

必須: はい

Output

それぞれが 1 つの出力構成を記述するオブジェクトの配列です。出力構成では、アプリケーション内ストリームの名前、送信先 (つまり、Amazon Kinesis ストリーム、Amazon Kinesis Firehose 配信ストリーム、または AWS Lambda 関数) を指定し、送信先に書き込むときに使用するフォーメーションを記録します。

型: Output オブジェクト

必須: はい

レスポンス要素

アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。

エラー

ConcurrentModificationException

アプリケーションへの同時変更の結果としてスローされる例外。例えば、2 人の個人が同じアプリケーションを同時に編集しようとしています。

HTTP ステータスコード: 400

InvalidArgumentException

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

HTTP ステータスコード: 400

ResourceInUseException

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

HTTP ステータスコード: 400

ResourceNotFoundException

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

HTTP ステータスコード: 400

UnsupportedOperationException

指定されたパラメータがサポートされていないか、指定されたリソースがこのオペレーションに対して有効でないため、リクエストは拒否されました。

HTTP ステータスコード: 400

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

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