Managed Service for Apache Flink API コードの例

このトピックには、Apache Flink 用 Managed Service アクションのリクエストブロックの例が含まれています。

AWS Command Line Interface (AWS CLI) を持つアクションの入力としてJSONを使用するには、リクエストをJSONファイルに保存します。次に、 --cli-input-json パラメータを使用してファイル名をアクションに渡します。

次の例は、アクションを備えた JSON ファイルを使用する方法を示しています。


$ aws kinesisanalyticsv2 start-application --cli-input-json file://start.json

AWS CLI での JSON の使用に関する詳細については、「AWS Command Line Interface User Guide」の「CLI スケルトンの生成と CLI 入力 JSON パラメータの生成」を参照してください。

AddApplicationCloudWatchLoggingOption

次の「AddApplicationCloudWatchLoggingOption」アクションのリクエストコード例では、Amazon CloudWatch ロギングオプションを Apache Flink アプリケーション用 Managed Service に追加します。


{
    "ApplicationName": "MyApplication",
    "CloudWatchLoggingOption": {
        "LogStreamARN": "arn:aws:logs:us-east-1:123456789123:log-group:my-log-group:log-stream:My-LogStream"
    },
    "CurrentApplicationVersionId": 2
}

AddApplicationInput

次の「AddApplicationInput」アクションのリクエストコード例では、Apache Flink アプリケーション用 Managed Service にアプリケーション入力を追加します。


{
   "ApplicationName": "MyApplication",
   "CurrentApplicationVersionId": 2,
   "Input": { 
      "InputParallelism": { 
         "Count": 2
      },
      "InputSchema": { 
         "RecordColumns": [ 
            { 
               "Mapping": "$.TICKER",
               "Name": "TICKER_SYMBOL",
               "SqlType": "VARCHAR(50)"
            },
            {
                "SqlType": "REAL",
                "Name": "PRICE",
                "Mapping": "$.PRICE"
            }
         ],
         "RecordEncoding": "UTF-8",
         "RecordFormat": { 
            "MappingParameters": { 
               "JSONMappingParameters": { 
                  "RecordRowPath": "$"
               }
            },
            "RecordFormatType": "JSON"
         }
      },
      "KinesisStreamsInput": { 
         "ResourceARN": "arn:aws:kinesis:us-east-1:012345678901:stream/ExampleInputStream"
      }
   }
}

AddApplicationInputProcessingConfiguration

次の「AddApplicationInputProcessingConfiguration」アクションのリクエストコード例では、Apache Flink アプリケーション用 Managed Service にアプリケーション入力処理設定を追加します。


{
   "ApplicationName": "MyApplication",
   "CurrentApplicationVersionId": 2,
   "InputId": "2.1",
   "InputProcessingConfiguration": { 
      "InputLambdaProcessor": { 
         "ResourceARN": "arn:aws:lambda:us-east-1:012345678901:function:MyLambdaFunction"
      }
   }
}

AddApplicationOutput

次の「AddApplicationOutput」アクションのリクエストコード例では、Kinesis データストリームをアプリケーション出力として Apache Flink アプリケーション用 Managed Service に追加します。


{
   "ApplicationName": "MyApplication",
   "CurrentApplicationVersionId": 2,
   "Output": { 
      "DestinationSchema": { 
         "RecordFormatType": "JSON"
      },
      "KinesisStreamsOutput": { 
         "ResourceARN": "arn:aws:kinesis:us-east-1:012345678901:stream/ExampleOutputStream"
      },
      "Name": "DESTINATION_SQL_STREAM"
   }
}

AddApplicationReferenceDataSource

次の「AddApplicationReferenceDataSource」アクションのリクエストコード例では、CSV アプリケーション参照データソースを Apache Flink アプリケーション用 Managed Service に追加します。


{
   "ApplicationName": "MyApplication",
   "CurrentApplicationVersionId": 5,
   "ReferenceDataSource": { 
      "ReferenceSchema": { 
         "RecordColumns": [ 
            { 
               "Mapping": "$.TICKER",
               "Name": "TICKER",
               "SqlType": "VARCHAR(4)"
            },
            { 
               "Mapping": "$.COMPANYNAME",
               "Name": "COMPANY_NAME",
               "SqlType": "VARCHAR(40)"
            },
         ],
         "RecordEncoding": "UTF-8",
         "RecordFormat": { 
            "MappingParameters": { 
               "CSVMappingParameters": { 
                  "RecordColumnDelimiter": " ",
                  "RecordRowDelimiter": "\r\n"
               }
            },
            "RecordFormatType": "CSV"
         }
      },
      "S3ReferenceDataSource": { 
         "BucketARN": "arn:aws:s3:::amzn-s3-demo-bucket",
         "FileKey": "TickerReference.csv"
      },
      "TableName": "string"
   }
}

AddApplicationVpcConfiguration

次の「AddApplicationVpcConfiguration」アクションのリクエストコード例では、既存のアプリケーションに VPC 設定を追加します。


{
   "ApplicationName": "MyApplication",
   "CurrentApplicationVersionId": 9,
   "VpcConfiguration": { 
      "SecurityGroupIds": [ "sg-0123456789abcdef0" ],
      "SubnetIds": [ "subnet-0123456789abcdef0" ]
   }
}

CreateApplication

次の「CreateApplication」アクションのリクエストコード例では、Apache Flink アプリケーション用 Managed Service を作成します。


{
  "ApplicationName":"MyApplication",
  "ApplicationDescription":"My-Application-Description",
  "RuntimeEnvironment":"FLINK-1_15",
  "ServiceExecutionRole":"arn:aws:iam::123456789123:role/myrole",
  "CloudWatchLoggingOptions":[
    {
      "LogStreamARN":"arn:aws:logs:us-east-1:123456789123:log-group:my-log-group:log-stream:My-LogStream"
    }
  ],
  "ApplicationConfiguration": {
    "EnvironmentProperties":
      {"PropertyGroups": 
        [
          {"PropertyGroupId": "ConsumerConfigProperties",
            "PropertyMap": 
              {"aws.region": "us-east-1",
              "flink.stream.initpos": "LATEST"}
          },
          {"PropertyGroupId": "ProducerConfigProperties",
            "PropertyMap": 
              {"aws.region": "us-east-1"}
          },
        ]
      },
    "ApplicationCodeConfiguration":{
      "CodeContent":{
        "S3ContentLocation":{
          "BucketARN":"arn:aws:s3:::amzn-s3-demo-bucket",
          "FileKey":"myflink.jar",
          "ObjectVersion":"AbCdEfGhIjKlMnOpQrStUvWxYz12345"
        }
      },
      "CodeContentType":"ZIPFILE"
    },
      "FlinkApplicationConfiguration":{
      "ParallelismConfiguration":{
        "ConfigurationType":"CUSTOM",
        "Parallelism":2,
        "ParallelismPerKPU":1,
        "AutoScalingEnabled":true
      }
    }
  }
}

CreateApplicationSnapshot

次の「CreateApplicationSnapshot」アクションのリクエストコード例では、アプリケーション状態のスナップショットを作成します。


{
   "ApplicationName": "MyApplication",
   "SnapshotName": "MySnapshot"
}

DeleteApplication

次の「DeleteApplication」アクションのリクエストコード例では、Apache Flink アプリケーション用 Managed Service を削除します。


{"ApplicationName": "MyApplication",
"CreateTimestamp": 12345678912}

DeleteApplicationCloudWatchLoggingOption

次の「DeleteApplicationCloudWatchLoggingOption」アクションのリクエストコード例では、Apache Flink アプリケーション用 Managed Service から Amazon CloudWatch ロギングオプションを削除します。


{
    "ApplicationName": "MyApplication",
    "CloudWatchLoggingOptionId": "3.1"
    "CurrentApplicationVersionId": 3
}

DeleteApplicationInputProcessingConfiguration

次の「DeleteApplicationInputProcessingConfiguration」アクションのリクエストコード例では、Apache Flink アプリケーション用 Managed Service から入力処理設定を削除します。


{
   "ApplicationName": "MyApplication",
   "CurrentApplicationVersionId": 4,
   "InputId": "2.1"
}

DeleteApplicationOutput

次の「DeleteApplicationOutput」アクションのリクエストコード例では、Apache Flink アプリケーション用 Managed Service からアプリケーション出力を削除します。


{
   "ApplicationName": "MyApplication",
   "CurrentApplicationVersionId": 4,
   "OutputId": "4.1"
}

DeleteApplicationReferenceDataSource

次の「DeleteApplicationReferenceDataSource」アクションのリクエストコード例では、Apache Flink アプリケーション用 Managed Service からアプリケーション参照データソースを削除します。


{
   "ApplicationName": "MyApplication",
   "CurrentApplicationVersionId": 5,
   "ReferenceId": "5.1"
}

DeleteApplicationSnapshot

次の「DeleteApplicationSnapshot」アクションのリクエストコード例では、アプリケーションの状態のスナップショットを削除します。


{
   "ApplicationName": "MyApplication",
   "SnapshotCreationTimestamp": 12345678912,
   "SnapshotName": "MySnapshot"
}

DeleteApplicationVpcConfiguration

「以下のDeleteApplicationVpcConfiguration」アクションのリクエストコード例では、アプリケーションから既存の VPC 設定を削除します。


{
   "ApplicationName": "MyApplication",
   "CurrentApplicationVersionId": 9,
   "VpcConfigurationId": "1.1"
}

DescribeApplication

次の「DescribeApplication」アクションのリクエストコード例では、Apache Flink アプリケーション用 Managed Service に関する詳細を返します。


{"ApplicationName": "MyApplication"}

DescribeApplicationSnapshot

次の「DescribeApplicationSnapshot」アクションのリクエストコード例では、アプリケーションの状態のスナップショットに関する詳細を返します。


{
   "ApplicationName": "MyApplication",
   "SnapshotName": "MySnapshot"
}

DiscoverInputSchema

次の「DiscoverInputSchema」アクションのリクエストコード例では、ストリーミングソースからスキーマを生成します。


{
   "InputProcessingConfiguration": { 
      "InputLambdaProcessor": { 
         "ResourceARN": "arn:aws:lambda:us-east-1:012345678901:function:MyLambdaFunction"
      }
   },
   "InputStartingPositionConfiguration": { 
      "InputStartingPosition": "NOW"
   },
   "ResourceARN": "arn:aws:kinesis:us-east-1:012345678901:stream/ExampleInputStream",
   "S3Configuration": { 
      "BucketARN": "string",
      "FileKey": "string"
   },
   "ServiceExecutionRole": "string"
}

次の「DiscoverInputSchema」アクションのリクエストコード例では、参照ソースからスキーマを生成します。


{
   "S3Configuration": { 
      "BucketARN": "arn:aws:s3:::amzn-s3-demo-bucket",
      "FileKey": "TickerReference.csv"
   },
   "ServiceExecutionRole": "arn:aws:iam::123456789123:role/myrole"
}

ListApplications

以下の「ListApplications」アクションのリクエストコード例では、アカウント内の Apache Flink アプリケーション用 Managed Service のリストを返します。


{
   "ExclusiveStartApplicationName": "MyApplication",
   "Limit": 50
}

ListApplicationSnapshots

以下の「ListApplicationSnapshots」アクションのリクエストコード例では、アプリケーションの状態のスナップショットのリストを返します。


{"ApplicationName": "MyApplication",
   "Limit": 50,
   "NextToken": "aBcDeFgHiJkLmNoPqRsTuVwXyZ0123"
}

StartApplication

次の「StartApplication」アクションのリクエストコード例では、Apache Flink 用 Managed Service を起動し、最新のスナップショット (存在する場合) からアプリケーションの状態をロードします。


{
    "ApplicationName": "MyApplication",
    "RunConfiguration": {
        "ApplicationRestoreConfiguration": { 
         "ApplicationRestoreType": "RESTORE_FROM_LATEST_SNAPSHOT"
         }
    }
}

StopApplication

次の「API_StopApplication」アクションのリクエストコード例では、Apache Flink アプリケーション用 Managed Service を停止します。


{"ApplicationName": "MyApplication"}

UpdateApplication

次の「UpdateApplication」アクションのリクエストコード例では、Apache Flink アプリケーション用 Managed Service を更新して、アプリケーションコードの場所を変更します。


{"ApplicationName": "MyApplication",
"CurrentApplicationVersionId": 1,
"ApplicationConfigurationUpdate": { 
      "ApplicationCodeConfigurationUpdate": { 
         "CodeContentTypeUpdate": "ZIPFILE",
         "CodeContentUpdate": { 
            "S3ContentLocationUpdate": { 
               "BucketARNUpdate": "arn:aws:s3:::amzn-s3-demo-bucket",
               "FileKeyUpdate": "my_new_code.zip",
               "ObjectVersionUpdate": "2"
         }
      }
   }
}

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

ドキュメント履歴

API リファレンス