AWS.KinesisAnalyticsV2 (aws-elixir v0.8.0) View Source

Amazon Kinesis Data Analytics is a fully managed service that you can use to process and analyze streaming data using Java, SQL, or Scala.

The service enables you to quickly author and run Java, SQL, or Scala code against streaming sources to perform time series analytics, feed real-time dashboards, and create real-time metrics.

Link to this section Summary

Functions

Adds an Amazon CloudWatch log stream to monitor application configuration errors.

Adds a streaming source to your SQL-based Kinesis Data Analytics application.

Adds an InputProcessingConfiguration to a SQL-based Kinesis Data Analytics application.

Adds an external destination to your SQL-based Kinesis Data Analytics application.

Adds a reference data source to an existing SQL-based Kinesis Data Analytics application.

Adds a Virtual Private Cloud (VPC) configuration to the application.

Creates a Kinesis Data Analytics application.

Creates and returns a URL that you can use to connect to an application's extension.

Creates a snapshot of the application's state data.

Deletes the specified application.

Deletes an Amazon CloudWatch log stream from an Kinesis Data Analytics application.

Deletes an InputProcessingConfiguration from an input.

Deletes the output destination configuration from your SQL-based Kinesis Data Analytics application's configuration.

Deletes a reference data source configuration from the specified SQL-based Kinesis Data Analytics application's configuration.

Deletes a snapshot of application state.

Removes a VPC configuration from a Kinesis Data Analytics application.

Returns information about a specific Kinesis Data Analytics application.

Returns information about a snapshot of application state data.

Provides a detailed description of a specified version of the application.

Infers a schema for a SQL-based Kinesis Data Analytics application by evaluating sample records on the specified streaming source (Kinesis data stream or Kinesis Data Firehose delivery stream) or Amazon S3 object.

Lists information about the current application snapshots.

Lists all the versions for the specified application, including versions that were rolled back.

Returns a list of Kinesis Data Analytics applications in your account.

Retrieves the list of key-value tags assigned to the application.

Reverts the application to the previous running version.

Starts the specified Kinesis Data Analytics application.

Stops the application from processing data.

Adds one or more key-value tags to a Kinesis Data Analytics application.

Removes one or more tags from a Kinesis Data Analytics application.

Updates an existing Kinesis Data Analytics application.

Updates the maintenance configuration of the Kinesis Data Analytics application.

Link to this section Functions

Link to this function

add_application_cloud_watch_logging_option(client, input, options \\ [])

View Source

Adds an Amazon CloudWatch log stream to monitor application configuration errors.

Link to this function

add_application_input(client, input, options \\ [])

View Source

Adds a streaming source to your SQL-based Kinesis Data Analytics application.

You can add a streaming source 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.

Link to this function

add_application_input_processing_configuration(client, input, options \\ [])

View Source

Adds an InputProcessingConfiguration to a SQL-based Kinesis Data Analytics application.

An input processor pre-processes records on the input stream before the application's SQL code executes. Currently, the only input processor available is AWS Lambda.

Link to this function

add_application_output(client, input, options \\ [])

View Source

Adds an external destination to your SQL-based Kinesis Data Analytics application.

If you want Kinesis Data Analytics to deliver data from an in-application stream within your application to an external destination (such as an Kinesis data stream, a Kinesis Data 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.

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.

Link to this function

add_application_reference_data_source(client, input, options \\ [])

View Source

Adds a reference data source to an existing SQL-based Kinesis Data Analytics application.

Kinesis Data 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 an Amazon S3 object maps to columns in the resulting in-application table.

Link to this function

add_application_vpc_configuration(client, input, options \\ [])

View Source

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:

  • 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.

Link to this function

create_application(client, input, options \\ [])

View Source

Creates a Kinesis Data Analytics application.

For information about creating a Kinesis Data Analytics application, see Creating an Application.

Link to this function

create_application_presigned_url(client, input, options \\ [])

View Source

Creates and returns a URL that you can use to connect to an application's extension.

Currently, the only available extension is the Apache Flink dashboard.

The IAM role or user used to call this API defines the permissions to access the extension. After the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request that attempts to connect to the extension.

You control the amount of time that the URL will be valid using the SessionExpirationDurationInSeconds parameter. If you do not provide this parameter, the returned URL is valid for twelve hours.

The URL that you get from a call to CreateApplicationPresignedUrl must be used within 3 minutes to be valid. If you first try to use the URL after the 3-minute limit expires, the service returns an HTTP 403 Forbidden error.

Link to this function

create_application_snapshot(client, input, options \\ [])

View Source

Creates a snapshot of the application's state data.

Link to this function

delete_application(client, input, options \\ [])

View Source

Deletes the specified application.

Kinesis Data Analytics halts application execution and deletes the application.

Link to this function

delete_application_cloud_watch_logging_option(client, input, options \\ [])

View Source

Deletes an Amazon CloudWatch log stream from an Kinesis Data Analytics application.

Link to this function

delete_application_input_processing_configuration(client, input, options \\ [])

View Source

Deletes an InputProcessingConfiguration from an input.

Link to this function

delete_application_output(client, input, options \\ [])

View Source

Deletes the output destination configuration from your SQL-based Kinesis Data Analytics application's configuration.

Kinesis Data Analytics will no longer write data from the corresponding in-application stream to the external output destination.

Link to this function

delete_application_reference_data_source(client, input, options \\ [])

View Source

Deletes a reference data source configuration from the specified SQL-based Kinesis Data Analytics application's configuration.

If the application is running, Kinesis Data Analytics immediately removes the in-application table that you created using the AddApplicationReferenceDataSource operation.

Link to this function

delete_application_snapshot(client, input, options \\ [])

View Source

Deletes a snapshot of application state.

Link to this function

delete_application_vpc_configuration(client, input, options \\ [])

View Source

Removes a VPC configuration from a Kinesis Data Analytics application.

Link to this function

describe_application(client, input, options \\ [])

View Source

Returns information about a specific Kinesis Data Analytics application.

If you want to retrieve a list of all applications in your account, use the ListApplications operation.

Link to this function

describe_application_snapshot(client, input, options \\ [])

View Source

Returns information about a snapshot of application state data.

Link to this function

describe_application_version(client, input, options \\ [])

View Source

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.

This operation is supported only for Amazon Kinesis Data Analytics for Apache Flink.

Link to this function

discover_input_schema(client, input, options \\ [])

View Source

Infers a schema for a SQL-based Kinesis Data Analytics application by evaluating sample records on the specified streaming source (Kinesis data stream or Kinesis Data Firehose delivery stream) or Amazon 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. When you create an application using the Kinesis Data Analytics console, the console uses this operation to infer a schema and show it in the console user interface.

Link to this function

list_application_snapshots(client, input, options \\ [])

View Source

Lists information about the current application snapshots.

Link to this function

list_application_versions(client, input, options \\ [])

View Source

Lists all the versions for the specified application, including versions that were rolled back.

The response also includes a summary of the configuration associated with each version.

To get the complete description of a specific application version, invoke the DescribeApplicationVersion operation.

This operation is supported only for Amazon Kinesis Data Analytics for Apache Flink.

Link to this function

list_applications(client, input, options \\ [])

View Source

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.

If you want detailed information about a specific application, use DescribeApplication.

Link to this function

list_tags_for_resource(client, input, options \\ [])

View Source

Retrieves the list of key-value tags assigned to the application.

For more information, see Using Tagging.

Link to this function

rollback_application(client, input, options \\ [])

View Source

Reverts the application to the previous running version.

You can roll back an application if you suspect it is stuck in a transient status.

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.

This action is not supported for Kinesis Data Analytics for SQL applications.

Link to this function

start_application(client, input, options \\ [])

View Source

Starts the specified Kinesis Data Analytics application.

After creating an application, you must exclusively call this operation to start your application.

Link to this function

stop_application(client, input, options \\ [])

View Source

Stops the application from processing data.

You can stop an application only if it is in the running status, unless you set the 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.

Link to this function

tag_resource(client, input, options \\ [])

View Source

Adds one or more key-value tags to a Kinesis Data 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.

Link to this function

untag_resource(client, input, options \\ [])

View Source

Removes one or more tags from a Kinesis Data Analytics application.

For more information, see Using Tagging.

Link to this function

update_application(client, input, options \\ [])

View Source

Updates an existing Kinesis Data Analytics 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.

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.

Link to this function

update_application_maintenance_configuration(client, input, options \\ [])

View Source

Updates the maintenance configuration of the Kinesis Data Analytics 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 configuration the next time it schedules maintenance for the application. If you invoke this operation after the service schedules maintenance, the service will apply the configuration update the next time it schedules maintenance for the application. This means that you might not see the maintenance configuration update applied to the maintenance process that follows a successful invocation of this 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.

This operation is supported only for Amazon Kinesis Data Analytics for Apache Flink.