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§
- AddApplication
Cloud Watch Logging Option Request - AddApplication
Cloud Watch Logging Option Response - AddApplication
Input Processing Configuration Request - AddApplication
Input Processing Configuration Response - AddApplication
Input Request - AddApplication
Input Response - AddApplication
Output Request - AddApplication
Output Response - AddApplication
Reference Data Source Request - AddApplication
Reference Data Source Response - AddApplication
VpcConfiguration Request - AddApplication
VpcConfiguration Response - Application
Code Configuration Describes code configuration for an application.
- Application
Code Configuration Description Describes code configuration for an application.
- Application
Code Configuration Update 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.
- Application
Configuration Specifies the creation parameters for a Kinesis Data Analytics application.
- Application
Configuration Description Describes details about the application code and starting parameters for a Kinesis Data Analytics application.
- Application
Configuration Update Describes updates to an application's configuration.
- Application
Detail Describes the application, including the application Amazon Resource Name (ARN), status, latest version, and input and output configurations.
- Application
Maintenance Configuration Description The details of the maintenance configuration for the application.
- Application
Maintenance Configuration Update Describes the updated maintenance configuration for the application.
- Application
Restore Configuration Specifies the method and snapshot to use when restarting an application using previously saved application state.
- Application
Snapshot Configuration Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.
- Application
Snapshot Configuration Description Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.
- Application
Snapshot Configuration Update Describes updates to whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.
- Application
Summary Provides application summary information, including the application Amazon Resource Name (ARN), name, and status.
- Application
Version Summary The summary of the application version.
- CSVMapping
Parameters 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"- Catalog
Configuration 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.
- Catalog
Configuration Description 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.
- Catalog
Configuration Update Updates to
- Checkpoint
Configuration 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.
- Checkpoint
Configuration Description Describes checkpointing parameters for a Flink-based Kinesis Data Analytics application.
- Checkpoint
Configuration Update Describes updates to the checkpointing parameters for a Flink-based Kinesis Data Analytics application.
- Cloud
Watch Logging Option Provides a description of Amazon CloudWatch logging options, including the log stream Amazon Resource Name (ARN).
- Cloud
Watch Logging Option Description Describes the Amazon CloudWatch logging option.
- Cloud
Watch Logging Option Update Describes the Amazon CloudWatch logging option updates.
- Code
Content Specifies either the application code, or the location of the application code, for a Flink-based Kinesis Data Analytics application.
- Code
Content Description Describes details about the code of a Kinesis Data Analytics application.
- Code
Content Update Describes an update to the code of an application. Not supported for Apache Zeppelin.
- Create
Application Presigned UrlRequest - Create
Application Presigned UrlResponse - Create
Application Request - Create
Application Response - Create
Application Snapshot Request - Create
Application Snapshot Response - Custom
Artifact Configuration Specifies dependency JARs, as well as JAR files that contain user-defined functions (UDF).
- Custom
Artifact Configuration Description Specifies a dependency JAR or a JAR of user-defined functions.
- Delete
Application Cloud Watch Logging Option Request - Delete
Application Cloud Watch Logging Option Response - Delete
Application Input Processing Configuration Request - Delete
Application Input Processing Configuration Response - Delete
Application Output Request - Delete
Application Output Response - Delete
Application Reference Data Source Request - Delete
Application Reference Data Source Response - Delete
Application Request - Delete
Application Response - Delete
Application Snapshot Request - Delete
Application Snapshot Response - Delete
Application VpcConfiguration Request - Delete
Application VpcConfiguration Response - Deploy
AsApplication Configuration The information required to deploy a Kinesis Data Analytics Studio notebook as an application with durable state..
- Deploy
AsApplication Configuration Description The configuration information required to deploy an Amazon Data Analytics Studio notebook as an application with durable state.
- Deploy
AsApplication Configuration Update Updates to the configuration information required to deploy an Amazon Data Analytics Studio notebook as an application with durable state..
- Describe
Application Request - Describe
Application Response - Describe
Application Snapshot Request - Describe
Application Snapshot Response - Describe
Application Version Request - Describe
Application Version Response - Destination
Schema Describes the data format when records are written to the destination in a SQL-based Kinesis Data Analytics application.
- Discover
Input Schema Request - Discover
Input Schema Response - Environment
Properties Describes execution properties for a Flink-based Kinesis Data Analytics application.
- Environment
Property Descriptions Describes the execution properties for an Apache Flink runtime.
- Environment
Property Updates Describes updates to the execution property groups for a Flink-based Kinesis Data Analytics application or a Studio notebook.
- Flink
Application Configuration Describes configuration parameters for a Flink-based Kinesis Data Analytics application or a Studio notebook.
- Flink
Application Configuration Description Describes configuration parameters for a Flink-based Kinesis Data Analytics application.
- Flink
Application Configuration Update Describes updates to the configuration parameters for a Flink-based Kinesis Data Analytics application.
- Flink
RunConfiguration Describes the starting parameters for a Flink-based Kinesis Data Analytics application.
- Glue
Data Catalog Configuration 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.
- Glue
Data Catalog Configuration Description 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.
- Glue
Data Catalog Configuration Update 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.
- Input
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.
- Input
Description Describes the application input configuration for a SQL-based Kinesis Data Analytics application.
- Input
Lambda Processor 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.
- Input
Lambda Processor Description 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.
- Input
Lambda Processor Update For a SQL-based Kinesis Data Analytics application, represents an update to the InputLambdaProcessor that is used to preprocess the records in the stream.
- Input
Parallelism For a SQL-based Kinesis Data Analytics application, describes the number of in-application streams to create for a given streaming source.
- Input
Parallelism Update For a SQL-based Kinesis Data Analytics application, provides updates to the parallelism count.
- Input
Processing Configuration 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.
- Input
Processing Configuration Description 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.
- Input
Processing Configuration Update For a SQL-based Kinesis Data Analytics application, describes updates to an InputProcessingConfiguration.
- Input
Schema Update Describes updates for an SQL-based Kinesis Data Analytics application's input schema.
- Input
Starting Position Configuration Describes the point at which the application reads from the streaming source.
- Input
Update For a SQL-based Kinesis Data Analytics application, describes updates to a specific input configuration (identified by the
InputIdof an application).- JSON
Mapping Parameters For a SQL-based Kinesis Data Analytics application, provides additional mapping information when JSON is the record format on the streaming source.
- Kinesis
Analytics V2Client - A client for the Kinesis Analytics V2 API.
- Kinesis
Firehose Input 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).
- Kinesis
Firehose Input Description Describes the Amazon Kinesis Data Firehose delivery stream that is configured as the streaming source in the application input configuration.
- Kinesis
Firehose Input Update 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.
- Kinesis
Firehose Output 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.
- Kinesis
Firehose Output Description For a SQL-based Kinesis Data Analytics application's output, describes the Kinesis Data Firehose delivery stream that is configured as its destination.
- Kinesis
Firehose Output Update 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.
- Kinesis
Streams Input Identifies a Kinesis data stream as the streaming source. You provide the stream's Amazon Resource Name (ARN).
- Kinesis
Streams Input Description 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.
- Kinesis
Streams Input Update When you update the input configuration for a SQL-based Kinesis Data Analytics application, provides information about a Kinesis stream as the streaming source.
- Kinesis
Streams Output 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).
- Kinesis
Streams Output Description For an SQL-based Kinesis Data Analytics application's output, describes the Kinesis data stream that is configured as its destination.
- Kinesis
Streams Output Update 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.
- Lambda
Output 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.
- Lambda
Output Description For a SQL-based Kinesis Data Analytics application's output, describes the AWS Lambda function that is configured as its destination.
- Lambda
Output Update 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.
- List
Application Snapshots Request - List
Application Snapshots Response - List
Application Versions Request - List
Application Versions Response - List
Applications Request - List
Applications Response - List
Tags ForResource Request - List
Tags ForResource Response - Mapping
Parameters 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.
- Maven
Reference The information required to specify a Maven reference. You can use Maven references to specify dependency JAR files.
- Monitoring
Configuration Describes configuration parameters for Amazon CloudWatch logging for an application. For more information about CloudWatch logging, see Monitoring.
- Monitoring
Configuration Description Describes configuration parameters for CloudWatch logging for an application.
- Monitoring
Configuration Update Describes updates to configuration parameters for Amazon CloudWatch logging for an application.
- Output
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.
- Output
Description 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.
- Output
Update For a SQL-based Kinesis Data Analytics application, describes updates to the output configuration identified by the
OutputId.- Parallelism
Configuration 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.
- Parallelism
Configuration Description Describes parameters for how a Flink-based Kinesis Data Analytics application executes multiple tasks simultaneously.
- Parallelism
Configuration Update Describes updates to parameters for how an application executes multiple tasks simultaneously.
- Property
Group Property key-value pairs passed into an application.
- Record
Column 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.
- Record
Format 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.
- Reference
Data Source 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.
- Reference
Data Source Description For a SQL-based Kinesis Data Analytics application, describes the reference data source configured for an application.
- Reference
Data Source Update 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.
- Rollback
Application Request - Rollback
Application Response - RunConfiguration
Describes the starting parameters for an Kinesis Data Analytics application.
- RunConfiguration
Description Describes the starting properties for a Kinesis Data Analytics application.
- RunConfiguration
Update Describes the updates to the starting parameters for a Kinesis Data Analytics application.
- S3Application
Code Location Description Describes the location of an application's code stored in an S3 bucket.
- S3Configuration
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.
- S3Content
Base Location The S3 bucket that holds the application information.
- S3Content
Base Location Description The description of the S3 base location that holds the application.
- S3Content
Base Location Update The information required to update the S3 base location that holds the application.
- S3Content
Location 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.
- S3Content
Location Update Describes an update for the Amazon S3 code content location for an application.
- S3Reference
Data Source 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.
- S3Reference
Data Source Description For a SQL-based Kinesis Data Analytics application, provides the bucket name and object key name that stores the reference data.
- S3Reference
Data Source Update For a SQL-based Kinesis Data Analytics application, describes the Amazon S3 bucket name and object key name for an in-application reference table.
- Snapshot
Details Provides details about a snapshot of application state.
- Source
Schema 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.
- SqlApplication
Configuration Describes the inputs, outputs, and reference data sources for a SQL-based Kinesis Data Analytics application.
- SqlApplication
Configuration Description Describes the inputs, outputs, and reference data sources for a SQL-based Kinesis Data Analytics application.
- SqlApplication
Configuration Update Describes updates to the input streams, destination streams, and reference data sources for a SQL-based Kinesis Data Analytics application.
- SqlRun
Configuration Describes the starting parameters for a SQL-based Kinesis Data Analytics application.
- Start
Application Request - Start
Application Response - Stop
Application Request - Stop
Application Response - Tag
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.
- TagResource
Request - TagResource
Response - Untag
Resource Request - Untag
Resource Response - Update
Application Maintenance Configuration Request - Update
Application Maintenance Configuration Response - Update
Application Request - Update
Application Response - VpcConfiguration
Describes the parameters of a VPC used by the application.
- VpcConfiguration
Description Describes the parameters of a VPC used by the application.
- VpcConfiguration
Update Describes updates to the VPC configuration used by the application.
- Zeppelin
Application Configuration The configuration of a Kinesis Data Analytics Studio notebook.
- Zeppelin
Application Configuration Description The configuration of a Kinesis Data Analytics Studio notebook.
- Zeppelin
Application Configuration Update Updates to the configuration of Kinesis Data Analytics Studio notebook.
- Zeppelin
Monitoring Configuration Describes configuration parameters for Amazon CloudWatch logging for a Kinesis Data Analytics Studio notebook. For more information about CloudWatch logging, see Monitoring.
- Zeppelin
Monitoring Configuration Description The monitoring configuration for Apache Zeppelin within a Kinesis Data Analytics Studio notebook.
- Zeppelin
Monitoring Configuration Update Updates to the monitoring configuration for Apache Zeppelin within a Kinesis Data Analytics Studio notebook.
Enums§
- AddApplication
Cloud Watch Logging Option Error - Errors returned by AddApplicationCloudWatchLoggingOption
- AddApplication
Input Error - Errors returned by AddApplicationInput
- AddApplication
Input Processing Configuration Error - Errors returned by AddApplicationInputProcessingConfiguration
- AddApplication
Output Error - Errors returned by AddApplicationOutput
- AddApplication
Reference Data Source Error - Errors returned by AddApplicationReferenceDataSource
- AddApplication
VpcConfiguration Error - Errors returned by AddApplicationVpcConfiguration
- Create
Application Error - Errors returned by CreateApplication
- Create
Application Presigned UrlError - Errors returned by CreateApplicationPresignedUrl
- Create
Application Snapshot Error - Errors returned by CreateApplicationSnapshot
- Delete
Application Cloud Watch Logging Option Error - Errors returned by DeleteApplicationCloudWatchLoggingOption
- Delete
Application Error - Errors returned by DeleteApplication
- Delete
Application Input Processing Configuration Error - Errors returned by DeleteApplicationInputProcessingConfiguration
- Delete
Application Output Error - Errors returned by DeleteApplicationOutput
- Delete
Application Reference Data Source Error - Errors returned by DeleteApplicationReferenceDataSource
- Delete
Application Snapshot Error - Errors returned by DeleteApplicationSnapshot
- Delete
Application VpcConfiguration Error - Errors returned by DeleteApplicationVpcConfiguration
- Describe
Application Error - Errors returned by DescribeApplication
- Describe
Application Snapshot Error - Errors returned by DescribeApplicationSnapshot
- Describe
Application Version Error - Errors returned by DescribeApplicationVersion
- Discover
Input Schema Error - Errors returned by DiscoverInputSchema
- List
Application Snapshots Error - Errors returned by ListApplicationSnapshots
- List
Application Versions Error - Errors returned by ListApplicationVersions
- List
Applications Error - Errors returned by ListApplications
- List
Tags ForResource Error - Errors returned by ListTagsForResource
- Rollback
Application Error - Errors returned by RollbackApplication
- Start
Application Error - Errors returned by StartApplication
- Stop
Application Error - Errors returned by StopApplication
- TagResource
Error - Errors returned by TagResource
- Untag
Resource Error - Errors returned by UntagResource
- Update
Application Error - Errors returned by UpdateApplication
- Update
Application Maintenance Configuration Error - Errors returned by UpdateApplicationMaintenanceConfiguration
Traits§
- Kinesis
Analytics V2 - Trait representing the capabilities of the Kinesis Analytics V2 API. Kinesis Analytics V2 clients implement this trait.