UpdateApplication - Amazon Managed Service for Apache Flink (以前の Amazon Kinesis Data Analytics for Apache Flink)

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

UpdateApplication

既存の Managed Service for Apache Flink アプリケーションを更新します。このオペレーションを使用して、アプリケーションコード、入力設定、出力設定を更新できます。

Managed Service for Apache Flink は、アプリケーションを更新するたびに ApplicationVersionId を更新します。

リクエストの構文

{ "ApplicationConfigurationUpdate": { "ApplicationCodeConfigurationUpdate": { "CodeContentTypeUpdate": "string", "CodeContentUpdate": { "S3ContentLocationUpdate": { "BucketARNUpdate": "string", "FileKeyUpdate": "string", "ObjectVersionUpdate": "string" }, "TextContentUpdate": "string", "ZipFileContentUpdate": blob } }, "ApplicationSnapshotConfigurationUpdate": { "SnapshotsEnabledUpdate": boolean }, "EnvironmentPropertyUpdates": { "PropertyGroups": [ { "PropertyGroupId": "string", "PropertyMap": { "string" : "string" } } ] }, "FlinkApplicationConfigurationUpdate": { "CheckpointConfigurationUpdate": { "CheckpointingEnabledUpdate": boolean, "CheckpointIntervalUpdate": number, "ConfigurationTypeUpdate": "string", "MinPauseBetweenCheckpointsUpdate": number }, "MonitoringConfigurationUpdate": { "ConfigurationTypeUpdate": "string", "LogLevelUpdate": "string", "MetricsLevelUpdate": "string" }, "ParallelismConfigurationUpdate": { "AutoScalingEnabledUpdate": boolean, "ConfigurationTypeUpdate": "string", "ParallelismPerKPUUpdate": number, "ParallelismUpdate": number } }, "SqlApplicationConfigurationUpdate": { "InputUpdates": [ { "InputId": "string", "InputParallelismUpdate": { "CountUpdate": number }, "InputProcessingConfigurationUpdate": { "InputLambdaProcessorUpdate": { "ResourceARNUpdate": "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" }, "KinesisStreamsInputUpdate": { "ResourceARNUpdate": "string" }, "NamePrefixUpdate": "string" } ], "OutputUpdates": [ { "DestinationSchemaUpdate": { "RecordFormatType": "string" }, "KinesisFirehoseOutputUpdate": { "ResourceARNUpdate": "string" }, "KinesisStreamsOutputUpdate": { "ResourceARNUpdate": "string" }, "LambdaOutputUpdate": { "ResourceARNUpdate": "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" }, "TableNameUpdate": "string" } ] }, "VpcConfigurationUpdates": [ { "SecurityGroupIdUpdates": [ "string" ], "SubnetIdUpdates": [ "string" ], "VpcConfigurationId": "string" } ], "ZeppelinApplicationConfigurationUpdate": { "CatalogConfigurationUpdate": { "GlueDataCatalogConfigurationUpdate": { "DatabaseARNUpdate": "string" } }, "CustomArtifactsConfigurationUpdate": [ { "ArtifactType": "string", "MavenReference": { "ArtifactId": "string", "GroupId": "string", "Version": "string" }, "S3ContentLocation": { "BucketARN": "string", "FileKey": "string", "ObjectVersion": "string" } } ], "DeployAsApplicationConfigurationUpdate": { "S3ContentLocationUpdate": { "BasePathUpdate": "string", "BucketARNUpdate": "string" } }, "MonitoringConfigurationUpdate": { "LogLevelUpdate": "string" } } }, "ApplicationName": "string", "CloudWatchLoggingOptionUpdates": [ { "CloudWatchLoggingOptionId": "string", "LogStreamARNUpdate": "string" } ], "ConditionalToken": "string", "CurrentApplicationVersionId": number, "RunConfigurationUpdate": { "ApplicationRestoreConfiguration": { "ApplicationRestoreType": "string", "SnapshotName": "string" }, "FlinkRunConfiguration": { "AllowNonRestoredState": boolean } }, "RuntimeEnvironmentUpdate": "string", "ServiceExecutionRoleUpdate": "string" }

リクエストパラメータ

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

ApplicationConfigurationUpdate

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

タイプ:ApplicationConfigurationUpdate オブジェクト

必須: いいえ

ApplicationName

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

型: 文字列

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

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

必須:はい

CloudWatchLoggingOptionUpdates

アプリケーションの Amazon CloudWatch ロギングオプションの更新について説明します。 CloudWatch このアクションでは既存のログオプションのみを更新できます。 CloudWatch 新しいロギングオプションを追加するには、を使用してくださいAddApplicationCloudWatchLoggingOption

型: CloudWatchLoggingOptionUpdate オブジェクトの配列

必須: いいえ

ConditionalToken

アプリケーション更新の強力な同時実行性を実装するために使用する値。CurrentApplicationVersionId または ConditionalToken を指定する必要があります。DescribeApplication を使用するとアプリケーションの現在の ConditionalToken がわかります。同時実行性のサポートを強化するには、CurrentApplicationVersionId の代わりに ConditionalToken パラメータを使用します。

型: 文字列

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

Pattern: [a-zA-Z0-9-_+/=]+

必須: いいえ

CurrentApplicationVersionId

現在のアプリケーションバージョン ID。CurrentApplicationVersionId または ConditionalToken を指定する必要があります。アプリケーションのバージョン ID は DescribeApplication を使用して取得できます。同時実行性のサポートを強化するには、CurrentApplicationVersionId の代わりに ConditionalToken パラメータを使用します。

型: 長整数

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

必須: いいえ

RunConfigurationUpdate

アプリケーションの開始パラメータの更新を記述します。

タイプ:RunConfigurationUpdate オブジェクト

必須: いいえ

RuntimeEnvironmentUpdate

コードの実行に使用される Apache Flink 用マネージドサービスのランタイム環境を更新します。問題を回避するには、次のことを行う必要があります。

  • 新しい jar と依存関係が、選択した新しいランタイムと互換性があることを確認してください。

  • 新しいコードの状態が、アプリケーションを起動するスナップショットと互換性があることを確認してください。

型: 文字列

有効な値:SQL-1_0 | FLINK-1_6 | FLINK-1_8 | ZEPPELIN-FLINK-1_0 | FLINK-1_11 | FLINK-1_13 | ZEPPELIN-FLINK-2_0 | FLINK-1_15 | ZEPPELIN-FLINK-3_0 | FLINK-1_18

必須:いいえ

ServiceExecutionRoleUpdate

サービス実行ロールの更新を記述します。

型: 文字列

長さの制限:最小長は 1 です。最大長は 2,048 です。

パターン: arn:.*

必須: いいえ

レスポンスの構文

{ "ApplicationDetail": { "ApplicationARN": "string", "ApplicationConfigurationDescription": { "ApplicationCodeConfigurationDescription": { "CodeContentDescription": { "CodeMD5": "string", "CodeSize": number, "S3ApplicationCodeLocationDescription": { "BucketARN": "string", "FileKey": "string", "ObjectVersion": "string" }, "TextContent": "string" }, "CodeContentType": "string" }, "ApplicationSnapshotConfigurationDescription": { "SnapshotsEnabled": boolean }, "EnvironmentPropertyDescriptions": { "PropertyGroupDescriptions": [ { "PropertyGroupId": "string", "PropertyMap": { "string" : "string" } } ] }, "FlinkApplicationConfigurationDescription": { "CheckpointConfigurationDescription": { "CheckpointingEnabled": boolean, "CheckpointInterval": number, "ConfigurationType": "string", "MinPauseBetweenCheckpoints": number }, "JobPlanDescription": "string", "MonitoringConfigurationDescription": { "ConfigurationType": "string", "LogLevel": "string", "MetricsLevel": "string" }, "ParallelismConfigurationDescription": { "AutoScalingEnabled": boolean, "ConfigurationType": "string", "CurrentParallelism": number, "Parallelism": number, "ParallelismPerKPU": number } }, "RunConfigurationDescription": { "ApplicationRestoreConfigurationDescription": { "ApplicationRestoreType": "string", "SnapshotName": "string" }, "FlinkRunConfigurationDescription": { "AllowNonRestoredState": boolean } }, "SqlApplicationConfigurationDescription": { "InputDescriptions": [ { "InAppStreamNames": [ "string" ], "InputId": "string", "InputParallelism": { "Count": number }, "InputProcessingConfigurationDescription": { "InputLambdaProcessorDescription": { "ResourceARN": "string", "RoleARN": "string" } }, "InputSchema": { "RecordColumns": [ { "Mapping": "string", "Name": "string", "SqlType": "string" } ], "RecordEncoding": "string", "RecordFormat": { "MappingParameters": { "CSVMappingParameters": { "RecordColumnDelimiter": "string", "RecordRowDelimiter": "string" }, "JSONMappingParameters": { "RecordRowPath": "string" } }, "RecordFormatType": "string" } }, "InputStartingPositionConfiguration": { "InputStartingPosition": "string" }, "KinesisFirehoseInputDescription": { "ResourceARN": "string", "RoleARN": "string" }, "KinesisStreamsInputDescription": { "ResourceARN": "string", "RoleARN": "string" }, "NamePrefix": "string" } ], "OutputDescriptions": [ { "DestinationSchema": { "RecordFormatType": "string" }, "KinesisFirehoseOutputDescription": { "ResourceARN": "string", "RoleARN": "string" }, "KinesisStreamsOutputDescription": { "ResourceARN": "string", "RoleARN": "string" }, "LambdaOutputDescription": { "ResourceARN": "string", "RoleARN": "string" }, "Name": "string", "OutputId": "string" } ], "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" } ] }, "VpcConfigurationDescriptions": [ { "SecurityGroupIds": [ "string" ], "SubnetIds": [ "string" ], "VpcConfigurationId": "string", "VpcId": "string" } ], "ZeppelinApplicationConfigurationDescription": { "CatalogConfigurationDescription": { "GlueDataCatalogConfigurationDescription": { "DatabaseARN": "string" } }, "CustomArtifactsConfigurationDescription": [ { "ArtifactType": "string", "MavenReferenceDescription": { "ArtifactId": "string", "GroupId": "string", "Version": "string" }, "S3ContentLocationDescription": { "BucketARN": "string", "FileKey": "string", "ObjectVersion": "string" } } ], "DeployAsApplicationConfigurationDescription": { "S3ContentLocationDescription": { "BasePath": "string", "BucketARN": "string" } }, "MonitoringConfigurationDescription": { "LogLevel": "string" } } }, "ApplicationDescription": "string", "ApplicationMaintenanceConfigurationDescription": { "ApplicationMaintenanceWindowEndTime": "string", "ApplicationMaintenanceWindowStartTime": "string" }, "ApplicationMode": "string", "ApplicationName": "string", "ApplicationStatus": "string", "ApplicationVersionId": number, "ApplicationVersionRolledBackFrom": number, "ApplicationVersionRolledBackTo": number, "ApplicationVersionUpdatedFrom": number, "CloudWatchLoggingOptionDescriptions": [ { "CloudWatchLoggingOptionId": "string", "LogStreamARN": "string", "RoleARN": "string" } ], "ConditionalToken": "string", "CreateTimestamp": number, "LastUpdateTimestamp": number, "RuntimeEnvironment": "string", "ServiceExecutionRole": "string" } }

レスポンス要素

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

ApplicationDetail

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

型: ApplicationDetail オブジェクト

エラー

CodeValidationException

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

HTTP ステータスコード:400

ConcurrentModificationException

アプリケーションへの同時変更の結果としてスローされる例外。このエラーは、現在のアプリケーション ID を使用せずにアプリケーションを変更しようとしたことが原因である可能性があります。

HTTP ステータスコード:400

InvalidApplicationConfigurationException

ユーザー指定のアプリケーション設定が無効です。

HTTP ステータスコード:400

InvalidArgumentException

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

HTTP ステータスコード:400

InvalidRequestException

要求された JSON はオペレーションに対して無効です。

HTTP ステータスコード:400

LimitExceededException

許可されているリソースの数を超過しました。

HTTP ステータスコード:400

ResourceInUseException

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

HTTP ステータスコード:400

ResourceNotFoundException

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

HTTP ステータスコード:400

その他の参照資料

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