client.rb in aws-sdk-kinesisanalyticsv2-1.53.0

- old
+ new

@@ -403,12 +403,12 @@
     #
     # @option params [required, String] :application_name
     #   The Kinesis Data Analytics application name.
     #
     # @option params [Integer] :current_application_version_id
-    #   The version ID of the Kinesis Data Analytics application. You must
-    #   provide the `CurrentApplicationVersionId` or the
+    #   The version ID of the SQL-based Kinesis Data Analytics application.
+    #   You must provide the `CurrentApplicationVersionId` or the
     #   `ConditionalToken`.You can retrieve the application version ID using
     #   DescribeApplication. For better concurrency support, use the
     #   `ConditionalToken` parameter instead of `CurrentApplicationVersionId`.
     #
     # @option params [required, Types::CloudWatchLoggingOption] :cloud_watch_logging_option
@@ -821,19 +821,19 @@
     end
 
     # Adds a Virtual Private Cloud (VPC) configuration to the application.
     # Applications can use VPCs to store and access resources securely.
     #
-    # Note the following about VPC configurations for Kinesis Data Analytics
-    # applications:
+    # Note the following about VPC configurations for Managed Service for
+    # Apache Flink applications:
     #
     # * VPC configurations are not supported for SQL applications.
     #
-    # * When a VPC is added to a Kinesis Data Analytics application, the
-    #   application can no longer be accessed from the Internet directly. To
-    #   enable Internet access to the application, add an Internet gateway
-    #   to your VPC.
+    # * When a VPC is added to a Managed Service for Apache Flink
+    #   application, the application can no longer be accessed from the
+    #   Internet directly. To enable Internet access to the application, add
+    #   an Internet gateway to your VPC.
     #
     # @option params [required, String] :application_name
     #   The name of an existing application.
     #
     # @option params [Integer] :current_application_version_id
@@ -892,13 +892,13 @@
     def add_application_vpc_configuration(params = {}, options = {})
       req = build_request(:add_application_vpc_configuration, params)
       req.send_request(options)
     end
 
-    # Creates a Kinesis Data Analytics application. For information about
-    # creating a Kinesis Data Analytics application, see [Creating an
-    # Application][1].
+    # Creates a Managed Service for Apache Flink application. For
+    # information about creating a Managed Service for Apache Flink
+    # application, see [Creating an Application][1].
     #
     #
     #
     # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/java/getting-started.html
     #
@@ -933,13 +933,13 @@
     #
     #
     #   [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/java/how-tagging.html
     #
     # @option params [String] :application_mode
-    #   Use the `STREAMING` mode to create a Kinesis Data Analytics For Flink
-    #   application. To create a Kinesis Data Analytics Studio notebook, use
-    #   the `INTERACTIVE` mode.
+    #   Use the `STREAMING` mode to create a Managed Service for Apache Flink
+    #   application. To create a Managed Service for Apache Flink Studio
+    #   notebook, use the `INTERACTIVE` mode.
     #
     # @return [Types::CreateApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::CreateApplicationResponse#application_detail #application_detail} => Types::ApplicationDetail
     #
@@ -1343,12 +1343,12 @@
     def create_application_snapshot(params = {}, options = {})
       req = build_request(:create_application_snapshot, params)
       req.send_request(options)
     end
 
-    # Deletes the specified application. Kinesis Data Analytics halts
-    # application execution and deletes the application.
+    # Deletes the specified application. Managed Service for Apache Flink
+    # halts application execution and deletes the application.
     #
     # @option params [required, String] :application_name
     #   The name of the application to delete.
     #
     # @option params [required, Time,DateTime,Date,Integer,String] :create_timestamp
@@ -1370,12 +1370,12 @@
     def delete_application(params = {}, options = {})
       req = build_request(:delete_application, params)
       req.send_request(options)
     end
 
-    # Deletes an Amazon CloudWatch log stream from an Kinesis Data Analytics
-    # application.
+    # Deletes an Amazon CloudWatch log stream from an SQL-based Kinesis Data
+    # Analytics application.
     #
     # @option params [required, String] :application_name
     #   The application name.
     #
     # @option params [Integer] :current_application_version_id
@@ -1602,11 +1602,12 @@
     def delete_application_snapshot(params = {}, options = {})
       req = build_request(:delete_application_snapshot, params)
       req.send_request(options)
     end
 
-    # Removes a VPC configuration from a Kinesis Data Analytics application.
+    # Removes a VPC configuration from a Managed Service for Apache Flink
+    # application.
     #
     # @option params [required, String] :application_name
     #   The name of an existing application.
     #
     # @option params [Integer] :current_application_version_id
@@ -1653,21 +1654,21 @@
     def delete_application_vpc_configuration(params = {}, options = {})
       req = build_request(:delete_application_vpc_configuration, params)
       req.send_request(options)
     end
 
-    # Returns information about a specific Kinesis Data Analytics
+    # Returns information about a specific Managed Service for Apache Flink
     # application.
     #
     # If you want to retrieve a list of all applications in your account,
     # use the ListApplications operation.
     #
     # @option params [required, String] :application_name
     #   The name of the application.
     #
     # @option params [Boolean] :include_additional_details
-    #   Displays verbose information about a Kinesis Data Analytics
+    #   Displays verbose information about a Managed Service for Apache Flink
     #   application, including the application's job plan.
     #
     # @return [Types::DescribeApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::DescribeApplicationResponse#application_detail #application_detail} => Types::ApplicationDetail
@@ -1829,10 +1830,11 @@
     #
     #   resp.snapshot_details.snapshot_name #=> String
     #   resp.snapshot_details.snapshot_status #=> String, one of "CREATING", "READY", "DELETING", "FAILED"
     #   resp.snapshot_details.application_version_id #=> Integer
     #   resp.snapshot_details.snapshot_creation_timestamp #=> Time
+    #   resp.snapshot_details.runtime_environment #=> String, one of "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"
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/DescribeApplicationSnapshot AWS API Documentation
     #
     # @overload describe_application_snapshot(params = {})
     # @param [Hash] params ({})
@@ -1843,12 +1845,11 @@
 
     # Provides a detailed description of a specified version of the
     # application. To see a list of all the versions of an application,
     # invoke the ListApplicationVersions operation.
     #
-    # <note markdown="1"> This operation is supported only for Amazon Kinesis Data Analytics for
-    # Apache Flink.
+    # <note markdown="1"> This operation is supported only for Managed Service for Apache Flink.
     #
     #  </note>
     #
     # @option params [required, String] :application_name
     #   The name of the application for which you want to get the version
@@ -2012,11 +2013,11 @@
     # @option params [required, String] :service_execution_role
     #   The ARN of the role that is used to access the streaming source.
     #
     # @option params [Types::InputStartingPositionConfiguration] :input_starting_position_configuration
     #   The point at which you want Kinesis Data Analytics to start reading
-    #   records from the specified streaming source discovery purposes.
+    #   records from the specified streaming source for discovery purposes.
     #
     # @option params [Types::S3Configuration] :s3_configuration
     #   Specify this parameter to discover a schema from data in an Amazon S3
     #   object.
     #
@@ -2110,10 +2111,11 @@
     #   resp.snapshot_summaries #=> Array
     #   resp.snapshot_summaries[0].snapshot_name #=> String
     #   resp.snapshot_summaries[0].snapshot_status #=> String, one of "CREATING", "READY", "DELETING", "FAILED"
     #   resp.snapshot_summaries[0].application_version_id #=> Integer
     #   resp.snapshot_summaries[0].snapshot_creation_timestamp #=> Time
+    #   resp.snapshot_summaries[0].runtime_environment #=> String, one of "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"
     #   resp.next_token #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/ListApplicationSnapshots AWS API Documentation
     #
     # @overload list_application_snapshots(params = {})
@@ -2128,12 +2130,11 @@
     # of the configuration associated with each version.
     #
     # To get the complete description of a specific application version,
     # invoke the DescribeApplicationVersion operation.
     #
-    # <note markdown="1"> This operation is supported only for Amazon Kinesis Data Analytics for
-    # Apache Flink.
+    # <note markdown="1"> This operation is supported only for Managed Service for Apache Flink.
     #
     #  </note>
     #
     # @option params [required, String] :application_name
     #   The name of the application for which you want to list all versions.
@@ -2179,13 +2180,13 @@
     def list_application_versions(params = {}, options = {})
       req = build_request(:list_application_versions, params)
       req.send_request(options)
     end
 
-    # Returns a list of Kinesis Data Analytics applications in your account.
-    # For each application, the response includes the application name,
-    # Amazon Resource Name (ARN), and status.
+    # Returns a list of Managed Service for Apache Flink applications in
+    # your account. For each application, the response includes the
+    # application name, Amazon Resource Name (ARN), and status.
     #
     # If you want detailed information about a specific application, use
     # DescribeApplication.
     #
     # @option params [Integer] :limit
@@ -2273,15 +2274,15 @@
     #
     # You can roll back an application only if it is in the `UPDATING` or
     # `AUTOSCALING` status.
     #
     # When you rollback an application, it loads state data from the last
-    # successful snapshot. If the application has no snapshots, Kinesis Data
-    # Analytics rejects the rollback request.
+    # successful snapshot. If the application has no snapshots, Managed
+    # Service for Apache Flink rejects the rollback request.
     #
-    # This action is not supported for Kinesis Data Analytics for SQL
-    # applications.
+    # This action is not supported for Managed Service for Apache Flink for
+    # SQL applications.
     #
     # @option params [required, String] :application_name
     #   The name of the application.
     #
     # @option params [required, Integer] :current_application_version_id
@@ -2423,20 +2424,20 @@
     def rollback_application(params = {}, options = {})
       req = build_request(:rollback_application, params)
       req.send_request(options)
     end
 
-    # Starts the specified Kinesis Data Analytics application. After
-    # creating an application, you must exclusively call this operation to
-    # start your application.
+    # Starts the specified Managed Service for Apache Flink application.
+    # After creating an application, you must exclusively call this
+    # operation to start your application.
     #
     # @option params [required, String] :application_name
     #   The name of the application.
     #
     # @option params [Types::RunConfiguration] :run_configuration
-    #   Identifies the run configuration (start parameters) of a Kinesis Data
-    #   Analytics application.
+    #   Identifies the run configuration (start parameters) of a Managed
+    #   Service for Apache Flink application.
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
     # @example Request syntax with placeholder values
     #
@@ -2475,29 +2476,29 @@
     # `Force` parameter to `true`.
     #
     # You can use the DescribeApplication operation to find the application
     # status.
     #
-    # Kinesis Data Analytics takes a snapshot when the application is
-    # stopped, unless `Force` is set to `true`.
+    # Managed Service for Apache Flink takes a snapshot when the application
+    # is stopped, unless `Force` is set to `true`.
     #
     # @option params [required, String] :application_name
     #   The name of the running application to stop.
     #
     # @option params [Boolean] :force
     #   Set to `true` to force the application to stop. If you set `Force` to
-    #   `true`, Kinesis Data Analytics stops the application without taking a
-    #   snapshot.
+    #   `true`, Managed Service for Apache Flink stops the application without
+    #   taking a snapshot.
     #
     #   <note markdown="1"> Force-stopping your application may lead to data loss or duplication.
     #   To prevent data loss or duplicate processing of data during
     #   application restarts, we recommend you to take frequent snapshots of
     #   your application.
     #
     #    </note>
     #
-    #   You can only force stop a Flink-based Kinesis Data Analytics
+    #   You can only force stop a Managed Service for Apache Flink
     #   application. You can't force stop a SQL-based Kinesis Data Analytics
     #   application.
     #
     #   The application must be in the `STARTING`, `UPDATING`, `STOPPING`,
     #   `AUTOSCALING`, or `RUNNING` status.
@@ -2518,11 +2519,11 @@
     def stop_application(params = {}, options = {})
       req = build_request(:stop_application, params)
       req.send_request(options)
     end
 
-    # Adds one or more key-value tags to a Kinesis Data Analytics
+    # Adds one or more key-value tags to a Managed Service for Apache Flink
     # application. Note that the maximum number of application tags includes
     # system tags. The maximum number of user-defined application tags is
     # 50. For more information, see [Using Tagging][1].
     #
     #
@@ -2556,20 +2557,20 @@
     def tag_resource(params = {}, options = {})
       req = build_request(:tag_resource, params)
       req.send_request(options)
     end
 
-    # Removes one or more tags from a Kinesis Data Analytics application.
-    # For more information, see [Using Tagging][1].
+    # Removes one or more tags from a Managed Service for Apache Flink
+    # application. For more information, see [Using Tagging][1].
     #
     #
     #
     # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/java/how-tagging.html
     #
     # @option params [required, String] :resource_arn
-    #   The ARN of the Kinesis Data Analytics application from which to remove
-    #   the tags.
+    #   The ARN of the Managed Service for Apache Flink application from which
+    #   to remove the tags.
     #
     # @option params [required, Array<String>] :tag_keys
     #   A list of keys of tags to remove from the specified application.
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
@@ -2588,23 +2589,17 @@
     def untag_resource(params = {}, options = {})
       req = build_request(:untag_resource, params)
       req.send_request(options)
     end
 
-    # Updates an existing Kinesis Data Analytics application. Using this
-    # operation, you can update application code, input configuration, and
-    # output configuration.
+    # Updates an existing Managed Service for Apache Flink application.
+    # Using this operation, you can update application code, input
+    # configuration, and output configuration.
     #
-    # Kinesis Data Analytics updates the `ApplicationVersionId` each time
-    # you update your application.
+    # Managed Service for Apache Flink updates the `ApplicationVersionId`
+    # each time you update your application.
     #
-    # <note markdown="1"> You cannot update the `RuntimeEnvironment` of an existing application.
-    # If you need to update an application's `RuntimeEnvironment`, you must
-    # delete the application and create it again.
-    #
-    #  </note>
-    #
     # @option params [required, String] :application_name
     #   The name of the application to update.
     #
     # @option params [Integer] :current_application_version_id
     #   The current application version ID. You must provide the
@@ -2634,10 +2629,20 @@
     #   `ConditionalToken`. You get the application's current
     #   `ConditionalToken` using DescribeApplication. For better concurrency
     #   support, use the `ConditionalToken` parameter instead of
     #   `CurrentApplicationVersionId`.
     #
+    # @option params [String] :runtime_environment_update
+    #   Updates the Managed Service for Apache Flink runtime environment used
+    #   to run your code. To avoid issues you must:
+    #
+    #   * Ensure your new jar and dependencies are compatible with the new
+    #     runtime selected.
+    #
+    #   * Ensure your new code's state is compatible with the snapshot from
+    #     which your application will start
+    #
     # @return [Types::UpdateApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::UpdateApplicationResponse#application_detail #application_detail} => Types::ApplicationDetail
     #
     # @example Request syntax with placeholder values
@@ -2838,10 +2843,11 @@
     #         cloud_watch_logging_option_id: "Id", # required
     #         log_stream_arn_update: "LogStreamARN",
     #       },
     #     ],
     #     conditional_token: "ConditionalToken",
+    #     runtime_environment_update: "SQL-1_0", # accepts 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
     #   })
     #
     # @example Response structure
     #
     #   resp.application_detail.application_arn #=> String
@@ -2966,12 +2972,12 @@
     def update_application(params = {}, options = {})
       req = build_request(:update_application, params)
       req.send_request(options)
     end
 
-    # Updates the maintenance configuration of the Kinesis Data Analytics
-    # application.
+    # Updates the maintenance configuration of the Managed Service for
+    # Apache Flink application.
     #
     # You can invoke this operation on an application that is in one of the
     # two following states: `READY` or `RUNNING`. If you invoke it when the
     # application is in a state other than these two states, it throws a
     # `ResourceInUseException`. The service makes use of the updated
@@ -2984,15 +2990,14 @@
     # operation, but to the following maintenance process instead.
     #
     # To see the current maintenance configuration of your application,
     # invoke the DescribeApplication operation.
     #
-    # For information about application maintenance, see [Kinesis Data
-    # Analytics for Apache Flink Maintenance][1].
+    # For information about application maintenance, see [Managed Service
+    # for Apache Flink for Apache Flink Maintenance][1].
     #
-    # <note markdown="1"> This operation is supported only for Amazon Kinesis Data Analytics for
-    # Apache Flink.
+    # <note markdown="1"> This operation is supported only for Managed Service for Apache Flink.
     #
     #  </note>
     #
     #
     #
@@ -3045,10 +3050,10 @@
         operation: config.api.operation(operation_name),
         client: self,
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-kinesisanalyticsv2'
-      context[:gem_version] = '1.52.0'
+      context[:gem_version] = '1.53.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 
     # @api private
     # @deprecated