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

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

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

UpdateApplication

注記

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

既存の Amazon Kinesis Analytics アプリケーションを更新します。この API を使用して、アプリケーションコード、入力設定、および出力設定を更新できます。

Amazon Kinesis Analytics は、アプリケーションが更新されるたびに、CurrentApplicationVersionId を更新します。

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

リクエストの構文

{ "ApplicationName": "string", "ApplicationUpdate": { "ApplicationCodeUpdate": "string", "CloudWatchLoggingOptionUpdates": [ { "CloudWatchLoggingOptionId": "string", "LogStreamARNUpdate": "string", "RoleARNUpdate": "string" } ], "InputUpdates": [ { "InputId": "string", "InputParallelismUpdate": { "CountUpdate": number }, "InputProcessingConfigurationUpdate": { "InputLambdaProcessorUpdate": { "ResourceARNUpdate": "string", "RoleARNUpdate": "string" } }, "InputSchemaUpdate": { "RecordColumnUpdates": [ { "Mapping": "string", "Name": "string", "SqlType": "string" } ], "RecordEncodingUpdate": "string", "RecordFormatUpdate": { "MappingParameters": { "CSVMappingParameters": { "RecordColumnDelimiter": "string", "RecordRowDelimiter": "string" }, "JSONMappingParameters": { "RecordRowPath": "string" } }, "RecordFormatType": "string" } }, "KinesisFirehoseInputUpdate": { "ResourceARNUpdate": "string", "RoleARNUpdate": "string" }, "KinesisStreamsInputUpdate": { "ResourceARNUpdate": "string", "RoleARNUpdate": "string" }, "NamePrefixUpdate": "string" } ], "OutputUpdates": [ { "DestinationSchemaUpdate": { "RecordFormatType": "string" }, "KinesisFirehoseOutputUpdate": { "ResourceARNUpdate": "string", "RoleARNUpdate": "string" }, "KinesisStreamsOutputUpdate": { "ResourceARNUpdate": "string", "RoleARNUpdate": "string" }, "LambdaOutputUpdate": { "ResourceARNUpdate": "string", "RoleARNUpdate": "string" }, "NameUpdate": "string", "OutputId": "string" } ], "ReferenceDataSourceUpdates": [ { "ReferenceId": "string", "ReferenceSchemaUpdate": { "RecordColumns": [ { "Mapping": "string", "Name": "string", "SqlType": "string" } ], "RecordEncoding": "string", "RecordFormat": { "MappingParameters": { "CSVMappingParameters": { "RecordColumnDelimiter": "string", "RecordRowDelimiter": "string" }, "JSONMappingParameters": { "RecordRowPath": "string" } }, "RecordFormatType": "string" } }, "S3ReferenceDataSourceUpdate": { "BucketARNUpdate": "string", "FileKeyUpdate": "string", "ReferenceRoleARNUpdate": "string" }, "TableNameUpdate": "string" } ] }, "CurrentApplicationVersionId": number }

リクエストパラメータ

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

ApplicationName

更新する Amazon Kinesis Analytics アプリケーションの名前。

型: 文字列

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

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

必須: はい

ApplicationUpdate

アプリケーションの更新を記述します。

型: ApplicationUpdate オブジェクト

必須: はい

CurrentApplicationVersionId

現在のアプリケーションバージョン ID。DescribeApplication オペレーションを使用してこの値を取得できます。

型: 長整数

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

必須: はい

レスポンス要素

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

エラー

CodeValidationException

ユーザー指定のアプリケーションコード (クエリ) が無効です。これは単純な構文エラーである可能性があります。

HTTP ステータスコード:400

ConcurrentModificationException

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

HTTP ステータスコード:400

InvalidArgumentException

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

HTTP ステータスコード:400

ResourceInUseException

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

HTTP ステータスコード:400

ResourceNotFoundException

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

HTTP ステータスコード:400

UnsupportedOperationException

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

HTTP ステータスコード:400

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

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