Expand description
Overview
This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.
This is the Amazon Kinesis Analytics v1 API Reference. The Amazon Kinesis Analytics Developer Guide provides additional information.
If you’re using the service, you’re probably looking for KinesisAnalyticsClient and KinesisAnalytics.
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 - Application
Detail This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.
Provides a description of the application, including the application Amazon Resource Name (ARN), status, latest version, and input and output configuration.
- Application
Summary This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.
Provides application summary information, including the application Amazon Resource Name (ARN), name, and status.
- Application
Update Describes updates to apply to an existing Amazon Kinesis Analytics application.
- CSVMapping
Parameters 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"- Cloud
Watch Logging Option Provides a description of CloudWatch logging options, including the log stream Amazon Resource Name (ARN) and the role ARN.
- Cloud
Watch Logging Option Description Description of the CloudWatch logging option.
- Cloud
Watch Logging Option Update Describes CloudWatch logging option updates.
- Create
Application Request TBD
- Create
Application Response TBD
- 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 - Describe
Application Request - Describe
Application Response - Destination
Schema Describes the data format when records are written to the destination. For more information, see Configuring Application Output.
- Discover
Input Schema Request - Discover
Input Schema Response - Input
When you configure the application input, you specify the streaming source, the in-application stream name that is created, and the mapping between the two. For more information, see Configuring Application Input.
- Input
Configuration When you start your application, you provide this configuration, which identifies the input source and the point in the input source at which you want the application to start processing records.
- Input
Description Describes the application input configuration. For more information, see Configuring Application Input.
- 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, and the ARN of the IAM role that is used to access the AWS Lambda function.
- Input
Lambda Processor Description An object that contains the Amazon Resource Name (ARN) of the AWS Lambda function that is used to preprocess records in the stream, and the ARN of the IAM role that is used to access the AWS Lambda expression.
- Input
Lambda Processor Update Represents an update to the InputLambdaProcessor that is used to preprocess the records in the stream.
- Input
Parallelism Describes the number of in-application streams to create for a given streaming source. For information about parallelism, see Configuring Application Input.
- Input
Parallelism Update Provides updates to the parallelism count.
- Input
Processing Configuration Provides a description of 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 Provides configuration information about an input processor. Currently, the only input processor available is AWS Lambda.
- Input
Processing Configuration Update Describes updates to an InputProcessingConfiguration.
- Input
Schema Update Describes updates for the application's input schema.
- Input
Starting Position Configuration Describes the point at which the application reads from the streaming source.
- Input
Update Describes updates to a specific input configuration (identified by the
InputIdof an application).- JSON
Mapping Parameters Provides additional mapping information when JSON is the record format on the streaming source.
- Kinesis
Analytics Client - A client for the Kinesis Analytics API.
- Kinesis
Firehose Input Identifies an Amazon Kinesis Firehose delivery stream as the streaming source. You provide the delivery stream's Amazon Resource Name (ARN) and an IAM role ARN that enables Amazon Kinesis Analytics to access the stream on your behalf.
- Kinesis
Firehose Input Description Describes the Amazon Kinesis Firehose delivery stream that is configured as the streaming source in the application input configuration.
- Kinesis
Firehose Input Update When updating application input configuration, provides information about an Amazon Kinesis Firehose delivery stream as the streaming source.
- Kinesis
Firehose Output When configuring application output, identifies an Amazon Kinesis Firehose delivery stream as the destination. You provide the stream Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to write to the stream on your behalf.
- Kinesis
Firehose Output Description For an application output, describes the Amazon Kinesis Firehose delivery stream configured as its destination.
- Kinesis
Firehose Output Update When updating an output configuration using the UpdateApplication operation, provides information about an Amazon Kinesis Firehose delivery stream configured as the destination.
- Kinesis
Streams Input Identifies an Amazon Kinesis stream as the streaming source. You provide the stream's Amazon Resource Name (ARN) and an IAM role ARN that enables Amazon Kinesis Analytics to access the stream on your behalf.
- Kinesis
Streams Input Description Describes the Amazon Kinesis stream that is configured as the streaming source in the application input configuration.
- Kinesis
Streams Input Update When updating application input configuration, provides information about an Amazon Kinesis stream as the streaming source.
- Kinesis
Streams Output When configuring application output, identifies an Amazon Kinesis stream as the destination. You provide the stream Amazon Resource Name (ARN) and also an IAM role ARN that Amazon Kinesis Analytics can use to write to the stream on your behalf.
- Kinesis
Streams Output Description For an application output, describes the Amazon Kinesis stream configured as its destination.
- Kinesis
Streams Output Update When updating an output configuration using the UpdateApplication operation, provides information about an Amazon Kinesis stream configured as the destination.
- Lambda
Output When configuring application output, identifies an AWS Lambda function as the destination. You provide the function Amazon Resource Name (ARN) and also an IAM role ARN that Amazon Kinesis Analytics can use to write to the function on your behalf.
- Lambda
Output Description For an application output, describes the AWS Lambda function configured as its destination.
- Lambda
Output Update When updating an output configuration using the UpdateApplication operation, provides information about an AWS Lambda function configured as the destination.
- List
Applications Request - List
Applications Response - List
Tags ForResource Request - List
Tags ForResource Response - Mapping
Parameters When configuring application 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.
- Output
Describes application 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 an Amazon Kinesis stream or an Amazon Kinesis Firehose delivery stream.
For limits on how many destinations an application can write and other limitations, see Limits.
- Output
Description 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 an Amazon Kinesis stream or an Amazon Kinesis Firehose delivery stream.
- Output
Update Describes updates to the output configuration identified by the
OutputId.- Record
Column 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 Describes the record format and relevant mapping information that should be applied to schematize the records on the stream.
- Reference
Data Source Describes the reference data source by providing the source information (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 Describes the reference data source configured for an application.
- Reference
Data Source Update When you update a reference data source configuration for an 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.
- S3Configuration
Provides a description of an Amazon S3 data source, including the Amazon Resource Name (ARN) of the S3 bucket, the ARN of the IAM role that is used to access the bucket, and the name of the Amazon S3 object that contains the data.
- S3Reference
Data Source Identifies the S3 bucket and object that contains the reference data. Also identifies the IAM role Amazon Kinesis Analytics can assume to read this object on your behalf.
An Amazon Kinesis 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 Provides the bucket name and object key name that stores the reference data.
- S3Reference
Data Source Update Describes the S3 bucket name, object key name, and IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object on your behalf and populate the in-application reference table.
- Source
Schema 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.
- 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 Request - Update
Application Response
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
- Create
Application Error - Errors returned by CreateApplication
- 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
- Describe
Application Error - Errors returned by DescribeApplication
- Discover
Input Schema Error - Errors returned by DiscoverInputSchema
- List
Applications Error - Errors returned by ListApplications
- List
Tags ForResource Error - Errors returned by ListTagsForResource
- 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
Traits§
- Kinesis
Analytics - Trait representing the capabilities of the Kinesis Analytics API. Kinesis Analytics clients implement this trait.