lib/aws-sdk-kinesisanalytics/client.rb in aws-sdk-kinesisanalytics-1.1.0 vs lib/aws-sdk-kinesisanalytics/client.rb in aws-sdk-kinesisanalytics-1.2.0
- old
+ new
@@ -308,13 +308,13 @@
# operation to get the current application version. If the version
# specified is not the current version, the
# `ConcurrentModificationException` is returned.
#
# @option params [required, String] :input_id
- # The ID of the input configuration to which to add the input
- # configuration. You can get a list of the input IDs for an application
- # using the DescribeApplication operation.
+ # 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.
#
# @option params [required, Types::InputProcessingConfiguration] :input_processing_configuration
# The InputProcessingConfiguration to add to the application.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
@@ -345,15 +345,16 @@
# 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
- # destination (such as an Amazon Kinesis stream or a Firehose delivery
- # stream), you add the relevant configuration to your application using
- # this operation. You can configure one or more outputs for your
- # application. Each output configuration maps an in-application stream
- # and an external destination.
+ # destination (such as an Amazon Kinesis stream, an Amazon Kinesis
+ # Firehose delivery stream, or an Amazon Lambda function), you add the
+ # relevant configuration to your application using this operation. You
+ # can configure one or more outputs for your application. Each output
+ # configuration maps an in-application stream and an external
+ # destination.
#
# You can use one of the output configurations to deliver data from your
# in-application error stream to an external destination so that you can
# analyze the errors. For conceptual information, see [Understanding
# Application Output (Destination)][1].
@@ -377,21 +378,21 @@
# @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 add the output
+ # 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.
#
# @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 or an Amazon
- # Kinesis Firehose delivery stream), and record the formation to use
- # when writing to the destination.
+ # stream, a destination (that is, an Amazon Kinesis stream, an Amazon
+ # Kinesis Firehose delivery stream, or an Amazon Lambda function), and
+ # record the formation to use when writing to the destination.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
@@ -406,10 +407,14 @@
# },
# kinesis_firehose_output: {
# resource_arn: "ResourceARN", # required
# role_arn: "RoleARN", # required
# },
+ # lambda_output: {
+ # resource_arn: "ResourceARN", # required
+ # role_arn: "RoleARN", # required
+ # },
# destination_schema: { # required
# record_format_type: "JSON", # accepts JSON, CSV
# },
# },
# })
@@ -510,12 +515,12 @@
req.send_request(options)
end
# 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 five streaming destinations where you
- # want Amazon Kinesis Analytics to write the output data from your
+ # 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].
#
# In the input configuration, you map the streaming source to an
# in-application stream, which you can think of as a constantly updating
# table. In the mapping, you must provide a schema for the
@@ -526,11 +531,11 @@
# data, transform it, and generate output. Your application code can
# create one or more SQL artifacts like SQL streams or pumps.
#
# In the output configuration, you can configure the application to
# write data from in-application streams created in your applications to
- # up to five streaming destinations.
+ # up to three destinations.
#
# To read data from your source stream or write data to destination
# streams, Amazon Kinesis Analytics needs your permissions. You grant
# these permissions by creating IAM roles. This operation requires
# permissions to perform the `kinesisanalytics:CreateApplication`
@@ -559,36 +564,38 @@
# to an in-application stream that is created. Your application code can
# then query the in-application stream like a table (you can think of it
# as a constantly updating table).
#
# For the streaming source, you provide its Amazon Resource Name (ARN)
- # and format of data on the stream (for example, JSON, CSV, etc). You
+ # and format of data on the stream (for example, JSON, CSV, etc.). You
# also must provide an IAM role that Amazon Kinesis Analytics can assume
# to read this stream on your behalf.
#
# To create the in-application stream, you need to specify a schema to
# transform your data into a schematized version used in SQL. In the
# schema, you provide the necessary mapping of the data elements in the
# streaming source to record columns in the in-app stream.
#
# @option params [Array<Types::Output>] :outputs
# You can configure application output to write data from any of the
- # in-application streams to up to five destinations.
+ # in-application streams to up to three destinations.
#
# These destinations can be Amazon Kinesis streams, Amazon Kinesis
- # Firehose delivery streams, or both.
+ # Firehose delivery streams, Amazon Lambda destinations, or any
+ # combination of the three.
#
# In the configuration, you specify the in-application stream name, the
- # destination stream Amazon Resource Name (ARN), and the format to use
- # when writing data. You must also provide an IAM role that Amazon
- # Kinesis Analytics can assume to write to the destination stream on
- # your behalf.
+ # destination stream or Lambda function Amazon Resource Name (ARN), and
+ # the format to use when writing data. You must also provide an IAM role
+ # that Amazon Kinesis Analytics can assume to write to the destination
+ # stream or Lambda function on your behalf.
#
- # In the output configuration, you also provide the output stream Amazon
- # Resource Name (ARN) and the format of data in the stream (for example,
- # JSON, CSV). You also must provide an IAM role that Amazon Kinesis
- # Analytics can assume to write to this stream on your behalf.
+ # In the output configuration, you also provide the output stream or
+ # Lambda function ARN. For stream destinations, you provide the format
+ # of data in the stream (for example, JSON, CSV). You also must provide
+ # an IAM role that Amazon Kinesis Analytics can assume to write to the
+ # stream or Lambda function on your behalf.
#
# @option params [Array<Types::CloudWatchLoggingOption>] :cloud_watch_logging_options
# Use this parameter to configure a CloudWatch log stream to monitor
# application configuration errors. For more information, see [Working
# with Amazon CloudWatch Logs][1].
@@ -601,11 +608,11 @@
# 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
# the number of advertisement clicks by vendor, and insert resulting
# rows in another in-application stream using pumps. For more
- # inforamtion about the typical pattern, see [Application Code][1].
+ # information about the typical pattern, see [Application Code][1].
#
# You can provide such series of SQL statements, where output of one
# statement can be used as the input for the next statement. You store
# intermediate results by creating in-application streams and pumps.
#
@@ -681,10 +688,14 @@
# },
# kinesis_firehose_output: {
# resource_arn: "ResourceARN", # required
# role_arn: "RoleARN", # required
# },
+ # lambda_output: {
+ # resource_arn: "ResourceARN", # required
+ # role_arn: "RoleARN", # required
+ # },
# destination_schema: { # required
# record_format_type: "JSON", # accepts JSON, CSV
# },
# },
# ],
@@ -758,12 +769,12 @@
# @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 use the DescribeApplication operation to get the
- # `CloudWatchLoggingOptionId`.
+ # delete. You can get the `CloudWatchLoggingOptionId` by using the
+ # DescribeApplication operation.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
@@ -790,12 +801,12 @@
# @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
- # configuration. You can get a list of the input IDs for an application
- # using the DescribeApplication operation.
+ # processing configuration. You can get a list of the input IDs for an
+ # application by using the DescribeApplication operation.
#
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
# @example Request syntax with placeholder values
#
@@ -961,10 +972,12 @@
# resp.application_detail.output_descriptions[0].name #=> String
# resp.application_detail.output_descriptions[0].kinesis_streams_output_description.resource_arn #=> String
# resp.application_detail.output_descriptions[0].kinesis_streams_output_description.role_arn #=> String
# resp.application_detail.output_descriptions[0].kinesis_firehose_output_description.resource_arn #=> String
# resp.application_detail.output_descriptions[0].kinesis_firehose_output_description.role_arn #=> String
+ # resp.application_detail.output_descriptions[0].lambda_output_description.resource_arn #=> String
+ # resp.application_detail.output_descriptions[0].lambda_output_description.role_arn #=> String
# resp.application_detail.output_descriptions[0].destination_schema.record_format_type #=> String, one of "JSON", "CSV"
# resp.application_detail.reference_data_source_descriptions #=> Array
# resp.application_detail.reference_data_source_descriptions[0].reference_id #=> String
# resp.application_detail.reference_data_source_descriptions[0].table_name #=> String
# resp.application_detail.reference_data_source_descriptions[0].s3_reference_data_source_description.bucket_arn #=> String
@@ -995,13 +1008,13 @@
req.send_request(options)
end
# Infers a schema by evaluating sample records on the specified
# streaming source (Amazon Kinesis stream or Amazon Kinesis Firehose
- # delivery stream). In the response, the operation returns the inferred
- # schema and also the sample records that the operation used to infer
- # the schema.
+ # 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.
#
# You can use the inferred schema when configuring a streaming source
# for your application. For conceptual information, see [Configuring
# Application Input][1]. Note that when you create an application using
# the Amazon Kinesis Analytics console, the console uses this operation
@@ -1024,10 +1037,11 @@
# @option params [Types::InputStartingPositionConfiguration] :input_starting_position_configuration
# Point at which you want Amazon Kinesis Analytics to start reading
# records from the specified streaming source discovery purposes.
#
# @option params [Types::S3Configuration] :s3_configuration
+ # Specify this parameter to discover a schema from data in an S3 object.
#
# @option params [Types::InputProcessingConfiguration] :input_processing_configuration
# The InputProcessingConfiguration to use to preprocess the records
# before discovering the schema of the records.
#
@@ -1305,10 +1319,14 @@
# },
# kinesis_firehose_output_update: {
# resource_arn_update: "ResourceARN",
# role_arn_update: "RoleARN",
# },
+ # lambda_output_update: {
+ # resource_arn_update: "ResourceARN",
+ # role_arn_update: "RoleARN",
+ # },
# destination_schema_update: {
# record_format_type: "JSON", # accepts JSON, CSV
# },
# },
# ],
@@ -1375,10 +1393,10 @@
operation: config.api.operation(operation_name),
client: self,
params: params,
config: config)
context[:gem_name] = 'aws-sdk-kinesisanalytics'
- context[:gem_version] = '1.1.0'
+ context[:gem_version] = '1.2.0'
Seahorse::Client::Request.new(handlers, context)
end
# @api private
# @deprecated