Class: Aws::KinesisAnalytics::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::KinesisAnalytics::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/client.rb
Overview
An API client for KinesisAnalytics. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::KinesisAnalytics::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#add_application_cloud_watch_logging_option(params = {}) ⇒ Struct
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. -
#add_application_input(params = {}) ⇒ Struct
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. -
#add_application_input_processing_configuration(params = {}) ⇒ Struct
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. -
#add_application_output(params = {}) ⇒ Struct
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. -
#add_application_reference_data_source(params = {}) ⇒ Struct
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. -
#create_application(params = {}) ⇒ Types::CreateApplicationResponse
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. -
#delete_application(params = {}) ⇒ Struct
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. -
#delete_application_cloud_watch_logging_option(params = {}) ⇒ Struct
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. -
#delete_application_input_processing_configuration(params = {}) ⇒ Struct
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. -
#delete_application_output(params = {}) ⇒ Struct
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. -
#delete_application_reference_data_source(params = {}) ⇒ Struct
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. -
#describe_application(params = {}) ⇒ Types::DescribeApplicationResponse
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. -
#discover_input_schema(params = {}) ⇒ Types::DiscoverInputSchemaResponse
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. -
#list_applications(params = {}) ⇒ Types::ListApplicationsResponse
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. -
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Retrieves the list of key-value tags assigned to the application.
-
#start_application(params = {}) ⇒ Struct
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. -
#stop_application(params = {}) ⇒ Struct
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. -
#tag_resource(params = {}) ⇒ Struct
Adds one or more key-value tags to a Kinesis Analytics application.
-
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from a Kinesis Analytics application.
-
#update_application(params = {}) ⇒ Struct
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
429 430 431 |
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/client.rb', line 429 def initialize(*args) super end |
Instance Method Details
#add_application_cloud_watch_logging_option(params = {}) ⇒ Struct
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.
481 482 483 484 |
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/client.rb', line 481 def add_application_cloud_watch_logging_option(params = {}, = {}) req = build_request(:add_application_cloud_watch_logging_option, params) req.send_request() end |
#add_application_input(params = {}) ⇒ Struct
Adds a streaming source to your Amazon Kinesis application. For conceptual information, see Configuring Application Input.
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.
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.
This operation requires permissions to perform the
kinesisanalytics:AddApplicationInput
action.
591 592 593 594 |
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/client.rb', line 591 def add_application_input(params = {}, = {}) req = build_request(:add_application_input, params) req.send_request() end |
#add_application_input_processing_configuration(params = {}) ⇒ Struct
Adds an InputProcessingConfiguration 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.
665 666 667 668 |
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/client.rb', line 665 def add_application_input_processing_configuration(params = {}, = {}) req = build_request(:add_application_input_processing_configuration, params) req.send_request() end |
#add_application_output(params = {}) ⇒ Struct
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, an Amazon Kinesis Firehose delivery stream, or an AWS 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 more information, see Understanding Application Output (Destination).
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.
For the limits on the number of application inputs and outputs you can configure, see Limits.
This operation requires permissions to perform the
kinesisanalytics:AddApplicationOutput
action.
765 766 767 768 |
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/client.rb', line 765 def add_application_output(params = {}, = {}) req = build_request(:add_application_output, params) req.send_request() end |
#add_application_reference_data_source(params = {}) ⇒ Struct
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 name), name of the in-application table to create, and the necessary mapping information that describes how data in Amazon S3 object maps to columns in the resulting in-application table.
For conceptual information, see Configuring Application Input. For the limits on data sources you can add to your application, see Limits.
This operation requires permissions to perform the
kinesisanalytics:AddApplicationOutput
action.
864 865 866 867 |
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/client.rb', line 864 def add_application_reference_data_source(params = {}, = {}) req = build_request(:add_application_reference_data_source, params) req.send_request() end |
#create_application(params = {}) ⇒ Types::CreateApplicationResponse
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.
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 in-application stream and map each data column in the in-application stream to a data element in the streaming source.
Your application code is one or more SQL statements that read input 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 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
action.
For introductory exercises to create an Amazon Kinesis Analytics application, see Getting Started.
1097 1098 1099 1100 |
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/client.rb', line 1097 def create_application(params = {}, = {}) req = build_request(:create_application, params) req.send_request() end |
#delete_application(params = {}) ⇒ Struct
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).
This operation requires permissions to perform the
kinesisanalytics:DeleteApplication
action.
1137 1138 1139 1140 |
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/client.rb', line 1137 def delete_application(params = {}, = {}) req = build_request(:delete_application, params) req.send_request() end |
#delete_application_cloud_watch_logging_option(params = {}) ⇒ Struct
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.
1187 1188 1189 1190 |
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/client.rb', line 1187 def delete_application_cloud_watch_logging_option(params = {}, = {}) req = build_request(:delete_application_cloud_watch_logging_option, params) req.send_request() end |
#delete_application_input_processing_configuration(params = {}) ⇒ Struct
Deletes an InputProcessingConfiguration from an input.
1235 1236 1237 1238 |
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/client.rb', line 1235 def delete_application_input_processing_configuration(params = {}, = {}) req = build_request(:delete_application_input_processing_configuration, params) req.send_request() end |
#delete_application_output(params = {}) ⇒ Struct
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.
This operation requires permissions to perform the
kinesisanalytics:DeleteApplicationOutput
action.
1297 1298 1299 1300 |
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/client.rb', line 1297 def delete_application_output(params = {}, = {}) req = build_request(:delete_application_output, params) req.send_request() end |
#delete_application_reference_data_source(params = {}) ⇒ Struct
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.
This operation requires permissions to perform the
kinesisanalytics.DeleteApplicationReferenceDataSource
action.
1362 1363 1364 1365 |
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/client.rb', line 1362 def delete_application_reference_data_source(params = {}, = {}) req = build_request(:delete_application_reference_data_source, params) req.send_request() end |
#describe_application(params = {}) ⇒ Types::DescribeApplicationResponse
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.
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
.
1469 1470 1471 1472 |
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/client.rb', line 1469 def describe_application(params = {}, = {}) req = build_request(:describe_application, params) req.send_request() end |
#discover_input_schema(params = {}) ⇒ Types::DiscoverInputSchemaResponse
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.
You can use the inferred schema when configuring a streaming source for your application. For conceptual information, see Configuring Application Input. Note that when you create an application using the Amazon Kinesis Analytics console, the console uses this operation to infer a schema and show it in the console user interface.
This operation requires permissions to perform the
kinesisanalytics:DiscoverInputSchema
action.
1575 1576 1577 1578 |
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/client.rb', line 1575 def discover_input_schema(params = {}, = {}) req = build_request(:discover_input_schema, params) req.send_request() end |
#list_applications(params = {}) ⇒ Types::ListApplicationsResponse
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.
This operation requires permissions to perform the
kinesisanalytics:ListApplications
action.
1640 1641 1642 1643 |
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/client.rb', line 1640 def list_applications(params = {}, = {}) req = build_request(:list_applications, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Retrieves the list of key-value tags assigned to the application. For more information, see Using Tagging.
1675 1676 1677 1678 |
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/client.rb', line 1675 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#start_application(params = {}) ⇒ Struct
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.
After you start the application, you can stop the application from processing the input by calling the StopApplication operation.
This operation requires permissions to perform the
kinesisanalytics:StartApplication
action.
1739 1740 1741 1742 |
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/client.rb', line 1739 def start_application(params = {}, = {}) req = build_request(:start_application, params) req.send_request() end |
#stop_application(params = {}) ⇒ Struct
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.
This operation requires permissions to perform the
kinesisanalytics:StopApplication
action.
1781 1782 1783 1784 |
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/client.rb', line 1781 def stop_application(params = {}, = {}) req = build_request(:stop_application, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
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. For more information, see Using Tagging.
1819 1820 1821 1822 |
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/client.rb', line 1819 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from a Kinesis Analytics application. For more information, see Using Tagging.
1851 1852 1853 1854 |
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/client.rb', line 1851 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_application(params = {}) ⇒ Struct
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
CurrentApplicationVersionId
each time you update your application.
This operation requires permission for the
kinesisanalytics:UpdateApplication
action.
2010 2011 2012 2013 |
# File 'gems/aws-sdk-kinesisanalytics/lib/aws-sdk-kinesisanalytics/client.rb', line 2010 def update_application(params = {}, = {}) req = build_request(:update_application, params) req.send_request() end |