リクエストの構文リクエストパラメータレスポンスの構文レスポンス要素以下の資料も参照してください。

新規プロジェクトでは、Kinesis Data Analytics for SQL よりも新しい Managed Service for Apache Flink Studio を使用することをお勧めします。Managed Service for Apache Flink Studio は、使いやすさと高度な分析機能を兼ね備えているため、高度なストリーム処理アプリケーションを数分で構築できます。

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

ListApplications

注記

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

アカウントの Amazon Kinesis Analytics アプリケーションのリストを返します。レスポンスには、アプリケーションごとにアプリケーション名、Amazon リソースネーム (ARN)、ステータスが含まれます。レスポンスで HasMoreApplications 値が true として返された場合は、リクエスト本文に ExclusiveStartApplicationName を追加し、この値を前のレスポンスからの最後のアプリケーション名に設定すると、別のリクエストを送信できます。

特定のアプリケーションの詳細情報が必要な場合は、DescribeApplication を使用します。

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

リクエストの構文


{
   "ExclusiveStartApplicationName": "string",
   "Limit": number
}

リクエストパラメータ

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

ExclusiveStartApplicationName

リストを開始するアプリケーションの名前。ページ割りを使用してリストを取得する場合、最初のリクエストでこのパラメータを指定する必要はありません。ただし、後続のリクエストでは、前のレスポンスの最後のアプリケーション名を追加して、アプリケーションの次のページを取得します。

型: 文字列

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

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

必須: いいえ

Limit

リストするアプリケーションの最大数。

型: 整数

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

必須: いいえ

レスポンスの構文


{
   "ApplicationSummaries": [ 
      { 
         "ApplicationARN": "string",
         "ApplicationName": "string",
         "ApplicationStatus": "string"
      }
   ],
   "HasMoreApplications": boolean
}