lib/aws-sdk-kinesisanalytics/client.rb in aws-sdk-kinesisanalytics-1.12.0 vs lib/aws-sdk-kinesisanalytics/client.rb in aws-sdk-kinesisanalytics-1.13.0

- old
+ new

@@ -207,24 +207,75 @@ # # @option options [Boolean] :validate_params (true) # When `true`, request parameters are validated before # sending the request. # + # @option options [URI::HTTP,String] :http_proxy A proxy to send + # requests through. Formatted like 'http://proxy.com:123'. + # + # @option options [Float] :http_open_timeout (15) The number of + # seconds to wait when opening a HTTP session before rasing a + # `Timeout::Error`. + # + # @option options [Integer] :http_read_timeout (60) The default + # number of seconds to wait for response data. This value can + # safely be set + # per-request on the session yeidled by {#session_for}. + # + # @option options [Float] :http_idle_timeout (5) The number of + # seconds a connection is allowed to sit idble before it is + # considered stale. Stale connections are closed and removed + # from the pool before making a request. + # + # @option options [Float] :http_continue_timeout (1) The number of + # seconds to wait for a 100-continue response before sending the + # request body. This option has no effect unless the request has + # "Expect" header set to "100-continue". Defaults to `nil` which + # disables this behaviour. This value can safely be set per + # request on the session yeidled by {#session_for}. + # + # @option options [Boolean] :http_wire_trace (false) When `true`, + # HTTP debug output will be sent to the `:logger`. + # + # @option options [Boolean] :ssl_verify_peer (true) When `true`, + # SSL peer certificates are verified when establishing a + # connection. + # + # @option options [String] :ssl_ca_bundle Full path to the SSL + # certificate authority bundle file that should be used when + # verifying peer certificates. If you do not pass + # `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default + # will be used if available. + # + # @option options [String] :ssl_ca_directory Full path of the + # directory that contains the unbundled SSL certificate + # authority files for verifying peer certificates. If you do + # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the + # system default will be used if available. + # def initialize(*args) super end # @!group API Operations + # <note markdown="1"> This documentation is for version 1 of the Amazon Kinesis Data + # Analytics API, which only supports SQL applications. Version 2 of the + # API supports SQL and Java applications. For more information about + # version 2, see [Amazon Kinesis Data Analytics API V2 + # Documentation](/kinesisanalytics/latest/apiv2/Welcome.html). + # + # </note> + # # Adds a CloudWatch log stream to monitor application configuration # errors. For more information about using CloudWatch log streams with # Amazon Kinesis Analytics applications, see [Working with Amazon # CloudWatch Logs][1]. # # # - # [1]: http://docs.aws.amazon.com/kinesisanalytics/latest/dev/cloudwatch-logs.html + # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/cloudwatch-logs.html # # @option params [required, String] :application_name # The Kinesis Analytics application name. # # @option params [required, Integer] :current_application_version_id @@ -256,41 +307,60 @@ def add_application_cloud_watch_logging_option(params = {}, options = {}) req = build_request(:add_application_cloud_watch_logging_option, params) req.send_request(options) end + # <note markdown="1"> This documentation is for version 1 of the Amazon Kinesis Data + # Analytics API, which only supports SQL applications. Version 2 of the + # API supports SQL and Java applications. For more information about + # version 2, see [Amazon Kinesis Data Analytics API V2 + # Documentation](/kinesisanalytics/latest/apiv2/Welcome.html). + # + # </note> + # # Adds a streaming source to your Amazon Kinesis application. For # conceptual information, see [Configuring Application Input][1]. # # You can add a streaming source either when you create an application # or you can use this operation to add a streaming source after you - # create an application. For more information, see CreateApplication. + # create an application. For more information, see + # [CreateApplication][2]. # # Any configuration update, including adding a streaming source using # this operation, results in a new version of the application. You can - # use the DescribeApplication operation to find the current application - # version. + # use the [DescribeApplication][3] operation to find the current + # application version. # # This operation requires permissions to perform the # `kinesisanalytics:AddApplicationInput` action. # # # - # [1]: http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html + # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html + # [2]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_CreateApplication.html + # [3]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html # # @option params [required, String] :application_name # Name of your existing Amazon Kinesis Analytics application to which # you want to add the streaming source. # # @option params [required, Integer] :current_application_version_id # Current version of your Amazon Kinesis Analytics application. You can - # use the DescribeApplication operation to find the current application - # version. + # use the [DescribeApplication][1] operation to find the current + # application version. # + # + # + # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html + # # @option params [required, Types::Input] :input - # The Input to add. + # The [Input][1] to add. # + # + # + # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_Input.html + # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.add_application_input({ @@ -347,38 +417,59 @@ def add_application_input(params = {}, options = {}) req = build_request(:add_application_input, params) req.send_request(options) end - # Adds an InputProcessingConfiguration to an application. An input + # <note markdown="1"> This documentation is for version 1 of the Amazon Kinesis Data + # Analytics API, which only supports SQL applications. Version 2 of the + # API supports SQL and Java applications. For more information about + # version 2, see [Amazon Kinesis Data Analytics API V2 + # Documentation](/kinesisanalytics/latest/apiv2/Welcome.html). + # + # </note> + # + # Adds an [InputProcessingConfiguration][1] to an application. An input # processor preprocesses records on the input stream before the # application's SQL code executes. Currently, the only input processor - # available is [AWS Lambda][1]. + # available is [AWS Lambda][2]. # # # - # [1]: https://aws.amazon.com/documentation/lambda/ + # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html + # [2]: https://docs.aws.amazon.com/lambda/ # # @option params [required, String] :application_name # Name of the application to which you want to add the input processing # configuration. # # @option params [required, Integer] :current_application_version_id # Version of the application to which you want to add the input - # processing configuration. You can use the DescribeApplication + # processing configuration. You can use the [DescribeApplication][1] # operation to get the current application version. If the version # specified is not the current version, the # `ConcurrentModificationException` is returned. # + # + # + # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html + # # @option params [required, String] :input_id # The ID of the input configuration to add the input processing # configuration to. You can get a list of the input IDs for an - # application using the DescribeApplication operation. + # application using the [DescribeApplication][1] operation. # + # + # + # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html + # # @option params [required, Types::InputProcessingConfiguration] :input_processing_configuration - # The InputProcessingConfiguration to add to the application. + # The [InputProcessingConfiguration][1] to add to the application. # + # + # + # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html + # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.add_application_input_processing_configuration({ @@ -400,10 +491,18 @@ def add_application_input_processing_configuration(params = {}, options = {}) req = build_request(:add_application_input_processing_configuration, params) req.send_request(options) end + # <note markdown="1"> This documentation is for version 1 of the Amazon Kinesis Data + # Analytics API, which only supports SQL applications. Version 2 of the + # API supports SQL and Java applications. For more information about + # version 2, see [Amazon Kinesis Data Analytics API V2 + # Documentation](/kinesisanalytics/latest/apiv2/Welcome.html). + # + # </note> + # # Adds an external destination to your Amazon Kinesis Analytics # application. # # If you want Amazon Kinesis Analytics to deliver data from an # in-application stream within your application to an external @@ -419,34 +518,40 @@ # analyze the errors. For more information, see [Understanding # Application Output (Destination)][1]. # # Any configuration update, including adding a streaming source using # this operation, results in a new version of the application. You can - # use the DescribeApplication operation to find the current application - # version. + # use the [DescribeApplication][2] operation to find the current + # application version. # # For the limits on the number of application inputs and outputs you can - # configure, see [Limits][2]. + # configure, see [Limits][3]. # # This operation requires permissions to perform the # `kinesisanalytics:AddApplicationOutput` action. # # # - # [1]: http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html - # [2]: http://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html + # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html + # [2]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html + # [3]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html # # @option params [required, String] :application_name # Name of the application to which you want to add the output # configuration. # # @option params [required, Integer] :current_application_version_id # Version of the application to which you want to add the output - # configuration. You can use the DescribeApplication operation to get - # the current application version. If the version specified is not the - # current version, the `ConcurrentModificationException` is returned. + # configuration. You can use the [DescribeApplication][1] operation to + # get the current application version. If the version specified is not + # the current version, the `ConcurrentModificationException` is + # returned. # + # + # + # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html + # # @option params [required, Types::Output] :output # An array of objects, each describing one output configuration. In the # output configuration, you specify the name of an in-application # stream, a destination (that is, an Amazon Kinesis stream, an Amazon # Kinesis Firehose delivery stream, or an AWS Lambda function), and @@ -486,10 +591,18 @@ def add_application_output(params = {}, options = {}) req = build_request(:add_application_output, params) req.send_request(options) end + # <note markdown="1"> This documentation is for version 1 of the Amazon Kinesis Data + # Analytics API, which only supports SQL applications. Version 2 of the + # API supports SQL and Java applications. For more information about + # version 2, see [Amazon Kinesis Data Analytics API V2 + # Documentation](/kinesisanalytics/latest/apiv2/Welcome.html). + # + # </note> + # # Adds a reference data source to an existing application. # # Amazon Kinesis Analytics reads reference data (that is, an Amazon S3 # object) and creates an in-application table within your application. # In the request, you provide the source (S3 bucket name and object key @@ -504,22 +617,26 @@ # This operation requires permissions to perform the # `kinesisanalytics:AddApplicationOutput` action. # # # - # [1]: http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html - # [2]: http://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html + # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html + # [2]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html # # @option params [required, String] :application_name # Name of an existing application. # # @option params [required, Integer] :current_application_version_id # Version of the application for which you are adding the reference data - # source. You can use the DescribeApplication operation to get the + # source. You can use the [DescribeApplication][1] operation to get the # current application version. If the version specified is not the # current version, the `ConcurrentModificationException` is returned. # + # + # + # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html + # # @option params [required, Types::ReferenceDataSource] :reference_data_source # The reference data source can be an object in your Amazon S3 bucket. # Amazon Kinesis Analytics reads the object and copies the data into the # in-application table that is created. You provide an S3 bucket, object # key name, and the resulting in-application table that is created. You @@ -573,10 +690,18 @@ def add_application_reference_data_source(params = {}, options = {}) req = build_request(:add_application_reference_data_source, params) req.send_request(options) end + # <note markdown="1"> This documentation is for version 1 of the Amazon Kinesis Data + # Analytics API, which only supports SQL applications. Version 2 of the + # API supports SQL and Java applications. For more information about + # version 2, see [Amazon Kinesis Data Analytics API V2 + # Documentation](/kinesisanalytics/latest/apiv2/Welcome.html). + # + # </note> + # # Creates an Amazon Kinesis Analytics application. You can configure # each application with one streaming source as input, application code # to process the input, and up to three destinations where you want # Amazon Kinesis Analytics to write the output data from your # application. For an overview, see [How it Works][1]. @@ -604,12 +729,12 @@ # For introductory exercises to create an Amazon Kinesis Analytics # application, see [Getting Started][2]. # # # - # [1]: http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works.html - # [2]: http://docs.aws.amazon.com/kinesisanalytics/latest/dev/getting-started.html + # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works.html + # [2]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/getting-started.html # # @option params [required, String] :application_name # Name of your Amazon Kinesis Analytics application (for example, # `sample-app`). # @@ -660,11 +785,11 @@ # application configuration errors. For more information, see [Working # with Amazon CloudWatch Logs][1]. # # # - # [1]: http://docs.aws.amazon.com/kinesisanalytics/latest/dev/cloudwatch-logs.html + # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/cloudwatch-logs.html # # @option params [String] :application_code # One or more SQL statements that read input data, transform it, and # generate output. For example, you can write a SQL statement that reads # data from one in-application stream, generates a running average of @@ -682,12 +807,24 @@ # `ExampleOutputStream2`, then your application code must create these # streams. # # # - # [1]: http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-app-code.html + # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-app-code.html # + # @option params [Array<Types::Tag>] :tags + # A list of one or more tags to assign to the application. A tag is a + # key-value pair that identifies an 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 + # Cost Allocation Tags][1] in the *AWS Billing and Cost Management + # Guide*. + # + # + # + # [1]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html + # # @return [Types::CreateApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateApplicationResponse#application_summary #application_summary} => Types::ApplicationSummary # # @example Request syntax with placeholder values @@ -764,10 +901,16 @@ # log_stream_arn: "LogStreamARN", # required # role_arn: "RoleARN", # required # }, # ], # application_code: "ApplicationCode", + # tags: [ + # { + # key: "TagKey", # required + # value: "TagValue", + # }, + # ], # }) # # @example Response structure # # resp.application_summary.application_name #=> String @@ -781,10 +924,18 @@ def create_application(params = {}, options = {}) req = build_request(:create_application, params) req.send_request(options) end + # <note markdown="1"> This documentation is for version 1 of the Amazon Kinesis Data + # Analytics API, which only supports SQL applications. Version 2 of the + # API supports SQL and Java applications. For more information about + # version 2, see [Amazon Kinesis Data Analytics API V2 + # Documentation](/kinesisanalytics/latest/apiv2/Welcome.html). + # + # </note> + # # Deletes the specified application. Amazon Kinesis Analytics halts # application execution and deletes the application, including any # application artifacts (such as in-application streams, reference # table, and application code). # @@ -813,29 +964,41 @@ def delete_application(params = {}, options = {}) req = build_request(:delete_application, params) req.send_request(options) end + # <note markdown="1"> This documentation is for version 1 of the Amazon Kinesis Data + # Analytics API, which only supports SQL applications. Version 2 of the + # API supports SQL and Java applications. For more information about + # version 2, see [Amazon Kinesis Data Analytics API V2 + # Documentation](/kinesisanalytics/latest/apiv2/Welcome.html). + # + # </note> + # # Deletes a CloudWatch log stream from an application. For more # information about using CloudWatch log streams with Amazon Kinesis # Analytics applications, see [Working with Amazon CloudWatch Logs][1]. # # # - # [1]: http://docs.aws.amazon.com/kinesisanalytics/latest/dev/cloudwatch-logs.html + # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/cloudwatch-logs.html # # @option params [required, String] :application_name # The Kinesis Analytics application name. # # @option params [required, Integer] :current_application_version_id # The version ID of the Kinesis Analytics application. # # @option params [required, String] :cloud_watch_logging_option_id # The `CloudWatchLoggingOptionId` of the CloudWatch logging option to # delete. You can get the `CloudWatchLoggingOptionId` by using the - # DescribeApplication operation. + # [DescribeApplication][1] operation. # + # + # + # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html + # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.delete_application_cloud_watch_logging_option({ @@ -851,23 +1014,39 @@ def delete_application_cloud_watch_logging_option(params = {}, options = {}) req = build_request(:delete_application_cloud_watch_logging_option, params) req.send_request(options) end - # Deletes an InputProcessingConfiguration from an input. + # <note markdown="1"> This documentation is for version 1 of the Amazon Kinesis Data + # Analytics API, which only supports SQL applications. Version 2 of the + # API supports SQL and Java applications. For more information about + # version 2, see [Amazon Kinesis Data Analytics API V2 + # Documentation](/kinesisanalytics/latest/apiv2/Welcome.html). # + # </note> + # + # Deletes an [InputProcessingConfiguration][1] from an input. + # + # + # + # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html + # # @option params [required, String] :application_name # The Kinesis Analytics application name. # # @option params [required, Integer] :current_application_version_id # The version ID of the Kinesis Analytics application. # # @option params [required, String] :input_id # The ID of the input configuration from which to delete the input # processing configuration. You can get a list of the input IDs for an - # application by using the DescribeApplication operation. + # application by using the [DescribeApplication][1] operation. # + # + # + # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html + # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.delete_application_input_processing_configuration({ @@ -883,10 +1062,18 @@ def delete_application_input_processing_configuration(params = {}, options = {}) req = build_request(:delete_application_input_processing_configuration, params) req.send_request(options) end + # <note markdown="1"> This documentation is for version 1 of the Amazon Kinesis Data + # Analytics API, which only supports SQL applications. Version 2 of the + # API supports SQL and Java applications. For more information about + # version 2, see [Amazon Kinesis Data Analytics API V2 + # Documentation](/kinesisanalytics/latest/apiv2/Welcome.html). + # + # </note> + # # Deletes output destination configuration from your application # configuration. Amazon Kinesis Analytics will no longer write data from # the corresponding in-application stream to the external output # destination. # @@ -896,22 +1083,32 @@ # @option params [required, String] :application_name # Amazon Kinesis Analytics application name. # # @option params [required, Integer] :current_application_version_id # Amazon Kinesis Analytics application version. You can use the - # DescribeApplication operation to get the current application version. - # If the version specified is not the current version, the + # [DescribeApplication][1] operation to get the current application + # version. If the version specified is not the current version, the # `ConcurrentModificationException` is returned. # + # + # + # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html + # # @option params [required, String] :output_id # The ID of the configuration to delete. Each output configuration that # is added to the application, either when the application is created or - # later using the AddApplicationOutput operation, has a unique ID. You - # need to provide the ID to uniquely identify the output configuration - # that you want to delete from the application configuration. You can - # use the DescribeApplication operation to get the specific `OutputId`. + # later using the [AddApplicationOutput][1] operation, has a unique ID. + # You need to provide the ID to uniquely identify the output + # configuration that you want to delete from the application + # configuration. You can use the [DescribeApplication][2] operation to + # get the specific `OutputId`. # + # + # + # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_AddApplicationOutput.html + # [2]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html + # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.delete_application_output({ @@ -927,35 +1124,56 @@ def delete_application_output(params = {}, options = {}) req = build_request(:delete_application_output, params) req.send_request(options) end + # <note markdown="1"> This documentation is for version 1 of the Amazon Kinesis Data + # Analytics API, which only supports SQL applications. Version 2 of the + # API supports SQL and Java applications. For more information about + # version 2, see [Amazon Kinesis Data Analytics API V2 + # Documentation](/kinesisanalytics/latest/apiv2/Welcome.html). + # + # </note> + # # Deletes a reference data source configuration from the specified # application configuration. # # If the application is running, Amazon Kinesis Analytics immediately # removes the in-application table that you created using the - # AddApplicationReferenceDataSource operation. + # [AddApplicationReferenceDataSource][1] operation. # # This operation requires permissions to perform the # `kinesisanalytics.DeleteApplicationReferenceDataSource` action. # + # + # + # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_AddApplicationReferenceDataSource.html + # # @option params [required, String] :application_name # Name of an existing application. # # @option params [required, Integer] :current_application_version_id - # Version of the application. You can use the DescribeApplication + # Version of the application. You can use the [DescribeApplication][1] # operation to get the current application version. If the version # specified is not the current version, the # `ConcurrentModificationException` is returned. # + # + # + # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html + # # @option params [required, String] :reference_id # ID of the reference data source. When you add a reference data source - # to your application using the AddApplicationReferenceDataSource, + # to your application using the [AddApplicationReferenceDataSource][1], # Amazon Kinesis Analytics assigns an ID. You can use the - # DescribeApplication operation to get the reference ID. + # [DescribeApplication][2] operation to get the reference ID. # + # + # + # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_AddApplicationReferenceDataSource.html + # [2]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html + # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.delete_application_reference_data_source({ @@ -971,21 +1189,33 @@ def delete_application_reference_data_source(params = {}, options = {}) req = build_request(:delete_application_reference_data_source, params) req.send_request(options) end + # <note markdown="1"> This documentation is for version 1 of the Amazon Kinesis Data + # Analytics API, which only supports SQL applications. Version 2 of the + # API supports SQL and Java applications. For more information about + # version 2, see [Amazon Kinesis Data Analytics API V2 + # Documentation](/kinesisanalytics/latest/apiv2/Welcome.html). + # + # </note> + # # Returns information about a specific Amazon Kinesis Analytics # application. # # If you want to retrieve a list of all applications in your account, - # use the ListApplications operation. + # use the [ListApplications][1] operation. # # This operation requires permissions to perform the # `kinesisanalytics:DescribeApplication` action. You can use # `DescribeApplication` to get the current application versionId, which # you need to call other operations such as `Update`. # + # + # + # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_ListApplications.html + # # @option params [required, String] :application_name # Name of the application. # # @return [Types::DescribeApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -1066,10 +1296,18 @@ def describe_application(params = {}, options = {}) req = build_request(:describe_application, params) req.send_request(options) end + # <note markdown="1"> This documentation is for version 1 of the Amazon Kinesis Data + # Analytics API, which only supports SQL applications. Version 2 of the + # API supports SQL and Java applications. For more information about + # version 2, see [Amazon Kinesis Data Analytics API V2 + # Documentation](/kinesisanalytics/latest/apiv2/Welcome.html). + # + # </note> + # # Infers a schema by evaluating sample records on the specified # streaming source (Amazon Kinesis stream or Amazon Kinesis Firehose # delivery stream) or S3 object. In the response, the operation returns # the inferred schema and also the sample records that the operation # used to infer the schema. @@ -1083,11 +1321,11 @@ # This operation requires permissions to perform the # `kinesisanalytics:DiscoverInputSchema` action. # # # - # [1]: http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html + # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html # # @option params [String] :resource_arn # Amazon Resource Name (ARN) of the streaming source. # # @option params [String] :role_arn @@ -1101,13 +1339,17 @@ # @option params [Types::S3Configuration] :s3_configuration # Specify this parameter to discover a schema from data in an Amazon S3 # object. # # @option params [Types::InputProcessingConfiguration] :input_processing_configuration - # The InputProcessingConfiguration to use to preprocess the records + # The [InputProcessingConfiguration][1] to use to preprocess the records # before discovering the schema of the records. # + # + # + # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html + # # @return [Types::DiscoverInputSchemaResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DiscoverInputSchemaResponse#input_schema #input_schema} => Types::SourceSchema # * {Types::DiscoverInputSchemaResponse#parsed_input_records #parsed_input_records} => Array&lt;Array&lt;String&gt;&gt; # * {Types::DiscoverInputSchemaResponse#processed_input_records #processed_input_records} => Array&lt;String&gt; @@ -1160,24 +1402,36 @@ def discover_input_schema(params = {}, options = {}) req = build_request(:discover_input_schema, params) req.send_request(options) end + # <note markdown="1"> This documentation is for version 1 of the Amazon Kinesis Data + # Analytics API, which only supports SQL applications. Version 2 of the + # API supports SQL and Java applications. For more information about + # version 2, see [Amazon Kinesis Data Analytics API V2 + # Documentation](/kinesisanalytics/latest/apiv2/Welcome.html). + # + # </note> + # # Returns a list of Amazon Kinesis Analytics applications in your # account. For each application, the response includes the application # name, Amazon Resource Name (ARN), and status. If the response returns # the `HasMoreApplications` value as true, you can send another request # by adding the `ExclusiveStartApplicationName` in the request body, and # set the value of this to the last application name from the previous # response. # # If you want detailed information about a specific application, use - # DescribeApplication. + # [DescribeApplication][1]. # # This operation requires permissions to perform the # `kinesisanalytics:ListApplications` action. # + # + # + # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html + # # @option params [Integer] :limit # Maximum number of applications to list. # # @option params [String] :exclusive_start_application_name # Name of the application to start the list with. When using pagination @@ -1213,27 +1467,70 @@ def list_applications(params = {}, options = {}) req = build_request(:list_applications, params) req.send_request(options) end + # Retrieves the list of key-value tags assigned to the application. + # + # @option params [required, String] :resource_arn + # The ARN of the application for which to retrieve tags. + # + # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::ListTagsForResourceResponse#tags #tags} => Array&lt;Types::Tag&gt; + # + # @example Request syntax with placeholder values + # + # resp = client.list_tags_for_resource({ + # resource_arn: "KinesisAnalyticsARN", # required + # }) + # + # @example Response structure + # + # resp.tags #=> Array + # resp.tags[0].key #=> String + # resp.tags[0].value #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalytics-2015-08-14/ListTagsForResource AWS API Documentation + # + # @overload list_tags_for_resource(params = {}) + # @param [Hash] params ({}) + def list_tags_for_resource(params = {}, options = {}) + req = build_request(:list_tags_for_resource, params) + req.send_request(options) + end + + # <note markdown="1"> This documentation is for version 1 of the Amazon Kinesis Data + # Analytics API, which only supports SQL applications. Version 2 of the + # API supports SQL and Java applications. For more information about + # version 2, see [Amazon Kinesis Data Analytics API V2 + # Documentation](/kinesisanalytics/latest/apiv2/Welcome.html). + # + # </note> + # # Starts the specified Amazon Kinesis Analytics application. After # creating an application, you must exclusively call this operation to # start your application. # # After the application starts, it begins consuming the input data, # processes it, and writes the output to the configured destination. # # The application status must be `READY` for you to start an # application. You can get the application status in the console or - # using the DescribeApplication operation. + # using the [DescribeApplication][1] operation. # # After you start the application, you can stop the application from - # processing the input by calling the StopApplication operation. + # processing the input by calling the [StopApplication][2] operation. # # This operation requires permissions to perform the # `kinesisanalytics:StartApplication` action. # + # + # + # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html + # [2]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_StopApplication.html + # # @option params [required, String] :application_name # Name of the application. # # @option params [required, Array<Types::InputConfiguration>] :input_configurations # Identifies the specific input, by ID, that the application starts @@ -1264,20 +1561,32 @@ def start_application(params = {}, options = {}) req = build_request(:start_application, params) req.send_request(options) end + # <note markdown="1"> This documentation is for version 1 of the Amazon Kinesis Data + # Analytics API, which only supports SQL applications. Version 2 of the + # API supports SQL and Java applications. For more information about + # version 2, see [Amazon Kinesis Data Analytics API V2 + # Documentation](/kinesisanalytics/latest/apiv2/Welcome.html). + # + # </note> + # # Stops the application from processing input data. You can stop an # application only if it is in the running state. You can use the - # DescribeApplication operation to find the application state. After the - # application is stopped, Amazon Kinesis Analytics stops reading data - # from the input, the application stops processing data, and there is no - # output written to the destination. + # [DescribeApplication][1] operation to find the application state. + # After the application is stopped, Amazon Kinesis Analytics stops + # reading data from the input, the application stops processing data, + # and there is no output written to the destination. # # This operation requires permissions to perform the # `kinesisanalytics:StopApplication` action. # + # + # + # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html + # # @option params [required, String] :application_name # Name of the running application to stop. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @@ -1294,10 +1603,78 @@ 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 Analytics application. + # Note that the maximum number of application tags includes system tags. + # The maximum number of user-defined application tags is 50. + # + # @option params [required, String] :resource_arn + # The ARN of the application to assign the tags. + # + # @option params [required, Array<Types::Tag>] :tags + # The key-value tags to assign to the application. + # + # @return [Struct] Returns an empty {Seahorse::Client::Response response}. + # + # @example Request syntax with placeholder values + # + # resp = client.tag_resource({ + # resource_arn: "KinesisAnalyticsARN", # required + # tags: [ # required + # { + # key: "TagKey", # required + # value: "TagValue", + # }, + # ], + # }) + # + # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalytics-2015-08-14/TagResource AWS API Documentation + # + # @overload tag_resource(params = {}) + # @param [Hash] params ({}) + def tag_resource(params = {}, options = {}) + req = build_request(:tag_resource, params) + req.send_request(options) + end + + # Removes one or more tags from a Kinesis Analytics application. + # + # @option params [required, String] :resource_arn + # The ARN of the Kinesis Analytics 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}. + # + # @example Request syntax with placeholder values + # + # resp = client.untag_resource({ + # resource_arn: "KinesisAnalyticsARN", # required + # tag_keys: ["TagKey"], # required + # }) + # + # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalytics-2015-08-14/UntagResource AWS API Documentation + # + # @overload untag_resource(params = {}) + # @param [Hash] params ({}) + def untag_resource(params = {}, options = {}) + req = build_request(:untag_resource, params) + req.send_request(options) + end + + # <note markdown="1"> This documentation is for version 1 of the Amazon Kinesis Data + # Analytics API, which only supports SQL applications. Version 2 of the + # API supports SQL and Java applications. For more information about + # version 2, see [Amazon Kinesis Data Analytics API V2 + # Documentation](/kinesisanalytics/latest/apiv2/Welcome.html). + # + # </note> + # # Updates an existing Amazon Kinesis Analytics application. Using this # API, you can update application code, input configuration, and output # configuration. # # Note that Amazon Kinesis Analytics updates the @@ -1309,12 +1686,16 @@ # @option params [required, String] :application_name # Name of the Amazon Kinesis Analytics application to update. # # @option params [required, Integer] :current_application_version_id # The current application version ID. You can use the - # DescribeApplication operation to get this value. + # [DescribeApplication][1] operation to get this value. # + # + # + # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html + # # @option params [required, Types::ApplicationUpdate] :application_update # Describes application updates. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @@ -1454,10 +1835,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-kinesisanalytics' - context[:gem_version] = '1.12.0' + context[:gem_version] = '1.13.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated