logo
Expand description

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.

If you’re using the service, you’re probably looking for KinesisAnalyticsV2Client and KinesisAnalyticsV2.

Structs

Describes code configuration for an application.

Describes code configuration for an application.

Describes code configuration updates for an application. This is supported for a Flink-based Kinesis Data Analytics application or a SQL-based Kinesis Data Analytics application.

Specifies the creation parameters for a Kinesis Data Analytics application.

Describes details about the application code and starting parameters for a Kinesis Data Analytics application.

Describes updates to an application's configuration.

Describes the application, including the application Amazon Resource Name (ARN), status, latest version, and input and output configurations.

The details of the maintenance configuration for the application.

Describes the updated maintenance configuration for the application.

Specifies the method and snapshot to use when restarting an application using previously saved application state.

Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.

Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.

Describes updates to whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.

Provides application summary information, including the application Amazon Resource Name (ARN), name, and status.

The summary of the application version.

For a SQL-based Kinesis Data Analytics application, provides additional mapping information when the record format uses delimiters, such as CSV. For example, the following sample records use CSV format, where the records use the '\n' as the row delimiter and a comma (",") as the column delimiter:

"name1", "address1"

"name2", "address2"

The configuration parameters for the default AWS Glue database. You use this database for SQL queries that you write in a Kinesis Data Analytics Studio notebook.

The configuration parameters for the default AWS Glue database. You use this database for Apache Flink SQL queries and table API transforms that you write in a Kinesis Data Analytics Studio notebook.

Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance. For more information, see Checkpoints for Fault Tolerance in the Apache Flink Documentation.

Describes checkpointing parameters for a Flink-based Kinesis Data Analytics application.

Describes updates to the checkpointing parameters for a Flink-based Kinesis Data Analytics application.

Provides a description of Amazon CloudWatch logging options, including the log stream Amazon Resource Name (ARN).

Describes the Amazon CloudWatch logging option.

Describes the Amazon CloudWatch logging option updates.

Specifies either the application code, or the location of the application code, for a Flink-based Kinesis Data Analytics application.

Describes details about the code of a Kinesis Data Analytics application.

Describes an update to the code of an application. Not supported for Apache Zeppelin.

Specifies dependency JARs, as well as JAR files that contain user-defined functions (UDF).

Specifies a dependency JAR or a JAR of user-defined functions.

The information required to deploy a Kinesis Data Analytics Studio notebook as an application with durable state..

The configuration information required to deploy an Amazon Data Analytics Studio notebook as an application with durable state.

Updates to the configuration information required to deploy an Amazon Data Analytics Studio notebook as an application with durable state..

Describes the data format when records are written to the destination in a SQL-based Kinesis Data Analytics application.

Describes execution properties for a Flink-based Kinesis Data Analytics application.

Describes the execution properties for an Apache Flink runtime.

Describes updates to the execution property groups for a Flink-based Kinesis Data Analytics application or a Studio notebook.

Describes configuration parameters for a Flink-based Kinesis Data Analytics application or a Studio notebook.

Describes configuration parameters for a Flink-based Kinesis Data Analytics application.

Describes updates to the configuration parameters for a Flink-based Kinesis Data Analytics application.

Describes the starting parameters for a Flink-based Kinesis Data Analytics application.

The configuration of the Glue Data Catalog that you use for Apache Flink SQL queries and table API transforms that you write in an application.

The configuration of the Glue Data Catalog that you use for Apache Flink SQL queries and table API transforms that you write in an application.

Updates to the configuration of the Glue Data Catalog that you use for SQL queries that you write in a Kinesis Data Analytics Studio notebook.

When you configure the application input for a SQL-based Kinesis Data Analytics application, you specify the streaming source, the in-application stream name that is created, and the mapping between the two.

Describes the application input configuration for a SQL-based Kinesis Data Analytics application.

An object that contains the Amazon Resource Name (ARN) of the AWS Lambda function that is used to preprocess records in the stream in a SQL-based Kinesis Data Analytics application.

For a SQL-based Kinesis Data Analytics application, an object that contains the Amazon Resource Name (ARN) of the AWS Lambda function that is used to preprocess records in the stream.

For a SQL-based Kinesis Data Analytics application, represents an update to the InputLambdaProcessor that is used to preprocess the records in the stream.

For a SQL-based Kinesis Data Analytics application, describes the number of in-application streams to create for a given streaming source.

For a SQL-based Kinesis Data Analytics application, provides updates to the parallelism count.

For a SQL-based Kinesis Data Analytics application, describes a processor that is used to preprocess the records in the stream before being processed by your application code. Currently, the only input processor available is AWS Lambda.

For a SQL-based Kinesis Data Analytics application, provides the configuration information about an input processor. Currently, the only input processor available is AWS Lambda.

For a SQL-based Kinesis Data Analytics application, describes updates to an InputProcessingConfiguration.

Describes updates for an SQL-based Kinesis Data Analytics application's input schema.

Describes the point at which the application reads from the streaming source.

For a SQL-based Kinesis Data Analytics application, describes updates to a specific input configuration (identified by the InputId of an application).

For a SQL-based Kinesis Data Analytics application, provides additional mapping information when JSON is the record format on the streaming source.

A client for the Kinesis Analytics V2 API.

For a SQL-based Kinesis Data Analytics application, identifies a Kinesis Data Firehose delivery stream as the streaming source. You provide the delivery stream's Amazon Resource Name (ARN).

Describes the Amazon Kinesis Data Firehose delivery stream that is configured as the streaming source in the application input configuration.

For a SQL-based Kinesis Data Analytics application, when updating application input configuration, provides information about a Kinesis Data Firehose delivery stream as the streaming source.

For a SQL-based Kinesis Data Analytics application, when configuring application output, identifies a Kinesis Data Firehose delivery stream as the destination. You provide the stream Amazon Resource Name (ARN) of the delivery stream.

For a SQL-based Kinesis Data Analytics application's output, describes the Kinesis Data Firehose delivery stream that is configured as its destination.

For a SQL-based Kinesis Data Analytics application, when updating an output configuration using the UpdateApplication operation, provides information about a Kinesis Data Firehose delivery stream that is configured as the destination.

Identifies a Kinesis data stream as the streaming source. You provide the stream's Amazon Resource Name (ARN).

For a SQL-based Kinesis Data Analytics application, describes the Kinesis data stream that is configured as the streaming source in the application input configuration.

When you update the input configuration for a SQL-based Kinesis Data Analytics application, provides information about a Kinesis stream as the streaming source.

When you configure a SQL-based Kinesis Data Analytics application's output, identifies a Kinesis data stream as the destination. You provide the stream Amazon Resource Name (ARN).

For an SQL-based Kinesis Data Analytics application's output, describes the Kinesis data stream that is configured as its destination.

When you update a SQL-based Kinesis Data Analytics application's output configuration using the UpdateApplication operation, provides information about a Kinesis data stream that is configured as the destination.

When you configure a SQL-based Kinesis Data Analytics application's output, identifies an AWS Lambda function as the destination. You provide the function Amazon Resource Name (ARN) of the Lambda function.

For a SQL-based Kinesis Data Analytics application's output, describes the AWS Lambda function that is configured as its destination.

When you update an SQL-based Kinesis Data Analytics application's output configuration using the UpdateApplication operation, provides information about an AWS Lambda function that is configured as the destination.

When you configure a SQL-based Kinesis Data Analytics application's input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.

The information required to specify a Maven reference. You can use Maven references to specify dependency JAR files.

Describes configuration parameters for Amazon CloudWatch logging for an application. For more information about CloudWatch logging, see Monitoring.

Describes configuration parameters for CloudWatch logging for an application.

Describes updates to configuration parameters for Amazon CloudWatch logging for an application.

Describes a SQL-based Kinesis Data Analytics application's output configuration, in which you identify an in-application stream and a destination where you want the in-application stream data to be written. The destination can be a Kinesis data stream or a Kinesis Data Firehose delivery stream.

For a SQL-based Kinesis Data Analytics application, describes the application output configuration, which includes the in-application stream name and the destination where the stream data is written. The destination can be a Kinesis data stream or a Kinesis Data Firehose delivery stream.

For a SQL-based Kinesis Data Analytics application, describes updates to the output configuration identified by the OutputId.

Describes parameters for how a Flink-based Kinesis Data Analytics application executes multiple tasks simultaneously. For more information about parallelism, see Parallel Execution in the Apache Flink Documentation.

Describes parameters for how a Flink-based Kinesis Data Analytics application executes multiple tasks simultaneously.

Describes updates to parameters for how an application executes multiple tasks simultaneously.

Property key-value pairs passed into an application.

For a SQL-based Kinesis Data Analytics application, describes the mapping of each data element in the streaming source to the corresponding column in the in-application stream.

Also used to describe the format of the reference data source.

For a SQL-based Kinesis Data Analytics application, describes the record format and relevant mapping information that should be applied to schematize the records on the stream.

For a SQL-based Kinesis Data Analytics application, describes the reference data source by providing the source information (Amazon S3 bucket name and object key name), the resulting in-application table name that is created, and the necessary schema to map the data elements in the Amazon S3 object to the in-application table.

For a SQL-based Kinesis Data Analytics application, describes the reference data source configured for an application.

When you update a reference data source configuration for a SQL-based Kinesis Data Analytics application, this object provides all the updated values (such as the source bucket name and object key name), the in-application table name that is created, and updated mapping information that maps the data in the Amazon S3 object to the in-application reference table that is created.

Describes the starting parameters for an Kinesis Data Analytics application.

Describes the starting properties for a Kinesis Data Analytics application.

Describes the updates to the starting parameters for a Kinesis Data Analytics application.

Describes the location of an application's code stored in an S3 bucket.

For a SQL-based Kinesis Data Analytics application, provides a description of an Amazon S3 data source, including the Amazon Resource Name (ARN) of the S3 bucket and the name of the Amazon S3 object that contains the data.

The S3 bucket that holds the application information.

The description of the S3 base location that holds the application.

The information required to update the S3 base location that holds the application.

For a Kinesis Data Analytics application provides a description of an Amazon S3 object, including the Amazon Resource Name (ARN) of the S3 bucket, the name of the Amazon S3 object that contains the data, and the version number of the Amazon S3 object that contains the data.

Describes an update for the Amazon S3 code content location for an application.

For a SQL-based Kinesis Data Analytics application, identifies the Amazon S3 bucket and object that contains the reference data.

A Kinesis Data Analytics application loads reference data only once. If the data changes, you call the UpdateApplication operation to trigger reloading of data into your application.

For a SQL-based Kinesis Data Analytics application, provides the bucket name and object key name that stores the reference data.

For a SQL-based Kinesis Data Analytics application, describes the Amazon S3 bucket name and object key name for an in-application reference table.

Provides details about a snapshot of application state.

For a SQL-based Kinesis Data Analytics application, describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.

Describes the inputs, outputs, and reference data sources for a SQL-based Kinesis Data Analytics application.

Describes the inputs, outputs, and reference data sources for a SQL-based Kinesis Data Analytics application.

Describes updates to the input streams, destination streams, and reference data sources for a SQL-based Kinesis Data Analytics application.

Describes the starting parameters for a SQL-based Kinesis Data Analytics application.

A key-value pair (the value is optional) that you can define and assign to AWS resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. 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.

Describes the parameters of a VPC used by the application.

Describes the parameters of a VPC used by the application.

Describes updates to the VPC configuration used by the application.

The configuration of a Kinesis Data Analytics Studio notebook.

The configuration of a Kinesis Data Analytics Studio notebook.

Updates to the configuration of Kinesis Data Analytics Studio notebook.

Describes configuration parameters for Amazon CloudWatch logging for a Kinesis Data Analytics Studio notebook. For more information about CloudWatch logging, see Monitoring.

The monitoring configuration for Apache Zeppelin within a Kinesis Data Analytics Studio notebook.

Updates to the monitoring configuration for Apache Zeppelin within a Kinesis Data Analytics Studio notebook.

Enums

Errors returned by AddApplicationCloudWatchLoggingOption

Errors returned by AddApplicationInput

Errors returned by AddApplicationInputProcessingConfiguration

Errors returned by AddApplicationOutput

Errors returned by AddApplicationReferenceDataSource

Errors returned by AddApplicationVpcConfiguration

Errors returned by CreateApplication

Errors returned by CreateApplicationPresignedUrl

Errors returned by CreateApplicationSnapshot

Errors returned by DeleteApplicationCloudWatchLoggingOption

Errors returned by DeleteApplication

Errors returned by DeleteApplicationInputProcessingConfiguration

Errors returned by DeleteApplicationOutput

Errors returned by DeleteApplicationReferenceDataSource

Errors returned by DeleteApplicationSnapshot

Errors returned by DeleteApplicationVpcConfiguration

Errors returned by DescribeApplication

Errors returned by DescribeApplicationSnapshot

Errors returned by DescribeApplicationVersion

Errors returned by DiscoverInputSchema

Errors returned by ListApplicationSnapshots

Errors returned by ListApplicationVersions

Errors returned by ListApplications

Errors returned by ListTagsForResource

Errors returned by RollbackApplication

Errors returned by StartApplication

Errors returned by StopApplication

Errors returned by TagResource

Errors returned by UntagResource

Errors returned by UpdateApplication

Errors returned by UpdateApplicationMaintenanceConfiguration

Traits

Trait representing the capabilities of the Kinesis Analytics V2 API. Kinesis Analytics V2 clients implement this trait.