Smaws_Client_KinesisAnalytics.Types
type nonrec input_lambda_processor_update = {
role_arn_update : role_ar_n option;
The ARN of the new IAM role that is used to access the AWS Lambda function.
*)resource_arn_update : resource_ar_n option;
The Amazon Resource Name (ARN) of the new AWS Lambda function that is used to preprocess the records in the stream.
To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda
*)}
Represents an update to the InputLambdaProcessor that is used to preprocess the records in the stream.
type nonrec input_processing_configuration_update = {
input_lambda_processor_update : input_lambda_processor_update;
}
Describes updates to an InputProcessingConfiguration.
type nonrec kinesis_streams_input_update = {
role_arn_update : role_ar_n option;
ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to grant the necessary permissions to this role.
*)resource_arn_update : resource_ar_n option;
Amazon Resource Name (ARN) of the input Amazon Kinesis stream to read.
*)}
When updating application input configuration, provides information about an Amazon Kinesis stream as the streaming source.
type nonrec kinesis_firehose_input_update = {
role_arn_update : role_ar_n option;
ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to grant the necessary permissions to this role.
*)resource_arn_update : resource_ar_n option;
Amazon Resource Name (ARN) of the input Amazon Kinesis Firehose delivery stream to read.
*)}
When updating application input configuration, provides information about an Amazon Kinesis Firehose delivery stream as the streaming source.
type nonrec json_mapping_parameters = {
record_row_path : record_row_path;
Path to the top-level parent that contains the records.
*)}
Provides additional mapping information when JSON is the record format on the streaming source.
type nonrec csv_mapping_parameters = {
record_column_delimiter : record_column_delimiter;
Column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.
*)record_row_delimiter : record_row_delimiter;
Row delimiter. For example, in a CSV format, '\n' is the typical row delimiter.
*)}
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"
type nonrec mapping_parameters = {
csv_mapping_parameters : csv_mapping_parameters option;
Provides additional mapping information when the record format uses delimiters (for example, CSV).
*)json_mapping_parameters : json_mapping_parameters option;
Provides additional mapping information when JSON is the record format on the streaming source.
*)}
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.
type nonrec record_format = {
mapping_parameters : mapping_parameters option;
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.
*)record_format_type : record_format_type;
The type of record format.
*)}
Describes the record format and relevant mapping information that should be applied to schematize the records on the stream.
type nonrec record_column = {
sql_type : record_column_sql_type;
Type of column created in the in-application input stream or reference table.
*)mapping : record_column_mapping option;
Reference to the data element in the streaming input or the reference data source. This element is required if the RecordFormatType is JSON
.
name : record_column_name;
Name of the column created in the in-application input stream or reference table.
*)}
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.
type nonrec record_columns = record_column list
type nonrec input_schema_update = {
record_column_updates : record_columns option;
A list of RecordColumn
objects. Each object describes the mapping of the streaming source element to the corresponding column in the in-application stream.
record_encoding_update : record_encoding option;
Specifies the encoding of the records in the streaming source. For example, UTF-8.
*)record_format_update : record_format option;
Specifies the format of the records on the streaming source.
*)}
Describes updates for the application's input schema.
type nonrec input_parallelism_update = {
count_update : input_parallelism_count option;
Number of in-application streams to create for the specified streaming source.
*)}
Provides updates to the parallelism count.
type nonrec input_update = {
input_parallelism_update : input_parallelism_update option;
Describes the parallelism updates (the number in-application streams Amazon Kinesis Analytics creates for the specific streaming source).
*)input_schema_update : input_schema_update option;
Describes the data format on the streaming source, and how record elements on the streaming source map to columns of the in-application stream that is created.
*)kinesis_firehose_input_update : kinesis_firehose_input_update option;
If an Amazon Kinesis Firehose delivery stream is the streaming source to be updated, provides an updated stream ARN and IAM role ARN.
*)kinesis_streams_input_update : kinesis_streams_input_update option;
If an Amazon Kinesis stream is the streaming source to be updated, provides an updated stream Amazon Resource Name (ARN) and IAM role ARN.
*)input_processing_configuration_update : input_processing_configuration_update
option;
Describes updates for an input processing configuration.
*)name_prefix_update : in_app_stream_name option;
Name prefix for in-application streams that Amazon Kinesis Analytics creates for the specific streaming source.
*)input_id : id;
Input ID of the application input to be updated.
*)}
Describes updates to a specific input configuration (identified by the InputId
of an application).
type nonrec input_updates = input_update list
type nonrec kinesis_streams_output_update = {
role_arn_update : role_ar_n option;
ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to grant the necessary permissions to this role.
*)resource_arn_update : resource_ar_n option;
Amazon Resource Name (ARN) of the Amazon Kinesis stream where you want to write the output.
*)}
When updating an output configuration using the UpdateApplication operation, provides information about an Amazon Kinesis stream configured as the destination.
type nonrec kinesis_firehose_output_update = {
role_arn_update : role_ar_n option;
ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to grant the necessary permissions to this role.
*)resource_arn_update : resource_ar_n option;
Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream to write to.
*)}
When updating an output configuration using the UpdateApplication operation, provides information about an Amazon Kinesis Firehose delivery stream configured as the destination.
type nonrec lambda_output_update = {
role_arn_update : role_ar_n option;
ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination function on your behalf. You need to grant the necessary permissions to this role.
*)resource_arn_update : resource_ar_n option;
Amazon Resource Name (ARN) of the destination Lambda function.
To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda
*)}
When updating an output configuration using the UpdateApplication operation, provides information about an AWS Lambda function configured as the destination.
type nonrec destination_schema = {
record_format_type : record_format_type;
Specifies the format of the records on the output stream.
*)}
Describes the data format when records are written to the destination. For more information, see Configuring Application Output.
type nonrec output_update = {
destination_schema_update : destination_schema option;
Describes the data format when records are written to the destination. For more information, see Configuring Application Output.
*)lambda_output_update : lambda_output_update option;
Describes an AWS Lambda function as the destination for the output.
*)kinesis_firehose_output_update : kinesis_firehose_output_update option;
Describes an Amazon Kinesis Firehose delivery stream as the destination for the output.
*)kinesis_streams_output_update : kinesis_streams_output_update option;
Describes an Amazon Kinesis stream as the destination for the output.
*)name_update : in_app_stream_name option;
If you want to specify a different in-application stream for this output configuration, use this field to specify the new in-application stream name.
*)output_id : id;
Identifies the specific output configuration that you want to update.
*)}
Describes updates to the output configuration identified by the OutputId
.
type nonrec output_updates = output_update list
type nonrec s3_reference_data_source_update = {
reference_role_arn_update : role_ar_n option;
ARN of the IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object and populate the in-application.
*)file_key_update : file_key option;
Object key name.
*)bucket_arn_update : bucket_ar_n option;
Amazon Resource Name (ARN) of the S3 bucket.
*)}
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.
type nonrec source_schema = {
record_columns : record_columns;
A list of RecordColumn
objects.
record_encoding : record_encoding option;
Specifies the encoding of the records in the streaming source. For example, UTF-8.
*)record_format : record_format;
Specifies the format of the records on the streaming source.
*)}
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.
type nonrec reference_data_source_update = {
reference_schema_update : source_schema option;
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.
*)s3_reference_data_source_update : s3_reference_data_source_update option;
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.
*)table_name_update : in_app_table_name option;
In-application table name that is created by this update.
*)reference_id : id;
ID of the reference data source being updated. You can use the DescribeApplication operation to get this value.
*)}
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.
type nonrec reference_data_source_updates = reference_data_source_update list
type nonrec cloud_watch_logging_option_update = {
role_arn_update : role_ar_n option;
IAM ARN of the role to use to send application messages. Note: To write application messages to CloudWatch, the IAM role used must have the PutLogEvents
policy action enabled.
log_stream_arn_update : log_stream_ar_n option;
ARN of the CloudWatch log to receive application messages.
*)cloud_watch_logging_option_id : id;
ID of the CloudWatch logging option to update
*)}
Describes CloudWatch logging option updates.
type nonrec cloud_watch_logging_option_updates =
cloud_watch_logging_option_update list
type nonrec application_update = {
cloud_watch_logging_option_updates : cloud_watch_logging_option_updates option;
Describes application CloudWatch logging option updates.
*)reference_data_source_updates : reference_data_source_updates option;
Describes application reference data source updates.
*)output_updates : output_updates option;
Describes application output configuration updates.
*)application_code_update : application_code option;
Describes application code updates.
*)input_updates : input_updates option;
Describes application input configuration updates.
*)}
Describes updates to apply to an existing Amazon Kinesis Analytics application.
type nonrec update_application_request = {
application_update : application_update;
Describes application updates.
*)current_application_version_id : application_version_id;
The current application version ID. You can use the DescribeApplication operation to get this value.
*)application_name : application_name;
Name of the Amazon Kinesis Analytics application to update.
*)}
The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
Specified application can't be found.
Application is not available for this operation.
Specified input parameter value is invalid.
Exception thrown as a result of concurrent modification to an application. For example, two individuals attempting to edit the same application at the same time.
User-provided application code (query) is invalid. This can be a simple syntax error.
type nonrec tag_keys = tag_key list
type nonrec untag_resource_request = {
tag_keys : tag_keys;
A list of keys of tags to remove from the specified application.
*)resource_ar_n : kinesis_analytics_ar_n;
The ARN of the Kinesis Analytics application from which to remove the tags.
*)}
Application created with too many tags, or too many tags added to an application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50.
type nonrec raw_input_records = raw_input_record list
type nonrec processed_input_records = processed_input_record list
type nonrec unable_to_detect_schema_exception = {
processed_input_records : processed_input_records option;
raw_input_records : raw_input_records option;
message : error_message option;
}
Data format is not valid. Amazon Kinesis Analytics is not able to detect schema for the given streaming source.
type nonrec tag = {
value : tag_value option;
The value of the key-value tag. The value is optional.
*)key : tag_key;
The key of the key-value 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.
type nonrec tags = tag list
type nonrec tag_resource_request = {
resource_ar_n : kinesis_analytics_ar_n;
The ARN of the application to assign the tags.
*)}
type nonrec stop_application_request = {
application_name : application_name;
Name of the running application to stop.
*)}
type nonrec input_starting_position_configuration = {
input_starting_position : input_starting_position option;
The starting position on the stream.
NOW
- Start reading just after the most recent record in the stream, start at the request time stamp that the customer issued.TRIM_HORIZON
- Start reading at the last untrimmed record in the stream, which is the oldest record available in the stream. This option is not available for an Amazon Kinesis Firehose delivery stream.LAST_STOPPED_POINT
- Resume reading from where the application last stopped reading.}
Describes the point at which the application reads from the streaming source.
type nonrec input_configuration = {
input_starting_position_configuration : input_starting_position_configuration;
Point at which you want the application to start processing records from the streaming source.
*)id : id;
}
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.
type nonrec input_configurations = input_configuration list
type nonrec start_application_request = {
input_configurations : input_configurations;
Identifies the specific input, by ID, that the application starts consuming. Amazon Kinesis Analytics starts reading the streaming source associated with the input. You can also specify where in the streaming source you want Amazon Kinesis Analytics to start reading.
*)application_name : application_name;
Name of the application.
*)}
User-provided application configuration is not valid.
The service is unavailable. Back off and retry the operation.
type nonrec s3_reference_data_source_description = {
reference_role_ar_n : role_ar_n;
ARN of the IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object on your behalf to populate the in-application reference table.
*)file_key : file_key;
Amazon S3 object key name.
*)bucket_ar_n : bucket_ar_n;
Amazon Resource Name (ARN) of the S3 bucket.
*)}
Provides the bucket name and object key name that stores the reference data.
type nonrec s3_reference_data_source = {
reference_role_ar_n : role_ar_n;
ARN of the IAM role that the service can assume to read data on your behalf. This role must have permission for the s3:GetObject
action on the object and trust policy that allows Amazon Kinesis Analytics service principal to assume this role.
file_key : file_key;
Object key name containing reference data.
*)bucket_ar_n : bucket_ar_n;
Amazon Resource Name (ARN) of the S3 bucket.
*)}
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.
type nonrec s3_configuration = {
file_key : file_key;
The name of the object that contains the data.
*)bucket_ar_n : bucket_ar_n;
ARN of the S3 bucket that contains the data.
*)role_ar_n : role_ar_n;
IAM ARN of the role used to access the data.
*)}
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.
Discovery failed to get a record from the streaming source because of the Amazon Kinesis Streams ProvisionedThroughputExceededException. For more information, see GetRecords in the Amazon Kinesis Streams API Reference.
type nonrec reference_data_source_description = {
reference_schema : source_schema option;
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.
*)s3_reference_data_source_description : s3_reference_data_source_description;
Provides the S3 bucket name, the object key name that contains the reference data. It also provides the Amazon Resource Name (ARN) of the IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object and populate the in-application reference table.
*)table_name : in_app_table_name;
The in-application table name created by the specific reference data source configuration.
*)reference_id : id;
ID of the reference data source. This is the ID that Amazon Kinesis Analytics assigns when you add the reference data source to your application using the AddApplicationReferenceDataSource operation.
*)}
Describes the reference data source configured for an application.
type nonrec reference_data_source_descriptions =
reference_data_source_description list
type nonrec reference_data_source = {
reference_schema : 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.
*)s3_reference_data_source : s3_reference_data_source option;
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.
table_name : in_app_table_name;
Name of the in-application table to create.
*)}
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.
type nonrec parsed_input_record = parsed_input_record_field list
type nonrec parsed_input_records = parsed_input_record list
type nonrec kinesis_streams_output = {
role_ar_n : role_ar_n;
ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination stream on your behalf. You need to grant the necessary permissions to this role.
*)resource_ar_n : resource_ar_n;
ARN of the destination Amazon Kinesis stream to write to.
*)}
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.
type nonrec kinesis_firehose_output = {
role_ar_n : role_ar_n;
ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination stream on your behalf. You need to grant the necessary permissions to this role.
*)resource_ar_n : resource_ar_n;
ARN of the destination Amazon Kinesis Firehose delivery stream to write to.
*)}
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.
type nonrec lambda_output = {
role_ar_n : role_ar_n;
ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination function on your behalf. You need to grant the necessary permissions to this role.
*)resource_ar_n : resource_ar_n;
Amazon Resource Name (ARN) of the destination Lambda function to write to.
To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda
*)}
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.
type nonrec output = {
destination_schema : destination_schema;
Describes the data format when records are written to the destination. For more information, see Configuring Application Output.
*)lambda_output : lambda_output option;
Identifies an AWS Lambda function as the destination.
*)kinesis_firehose_output : kinesis_firehose_output option;
Identifies an Amazon Kinesis Firehose delivery stream as the destination.
*)kinesis_streams_output : kinesis_streams_output option;
Identifies an Amazon Kinesis stream as the destination.
*)name : in_app_stream_name;
Name of the in-application stream.
*)}
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.
type nonrec outputs = output list
type nonrec kinesis_streams_output_description = {
role_ar_n : role_ar_n option;
ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream.
*)resource_ar_n : resource_ar_n option;
Amazon Resource Name (ARN) of the Amazon Kinesis stream.
*)}
For an application output, describes the Amazon Kinesis stream configured as its destination.
type nonrec kinesis_firehose_output_description = {
role_ar_n : role_ar_n option;
ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream.
*)resource_ar_n : resource_ar_n option;
Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream.
*)}
For an application output, describes the Amazon Kinesis Firehose delivery stream configured as its destination.
type nonrec lambda_output_description = {
role_ar_n : role_ar_n option;
ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination function.
*)resource_ar_n : resource_ar_n option;
Amazon Resource Name (ARN) of the destination Lambda function.
*)}
For an application output, describes the AWS Lambda function configured as its destination.
type nonrec output_description = {
destination_schema : destination_schema option;
Data format used for writing data to the destination.
*)lambda_output_description : lambda_output_description option;
Describes the AWS Lambda function configured as the destination where output is written.
*)kinesis_firehose_output_description : kinesis_firehose_output_description
option;
Describes the Amazon Kinesis Firehose delivery stream configured as the destination where output is written.
*)kinesis_streams_output_description : kinesis_streams_output_description option;
Describes Amazon Kinesis stream configured as the destination where output is written.
*)name : in_app_stream_name option;
Name of the in-application stream configured as output.
*)output_id : id option;
A unique identifier for the output configuration.
*)}
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.
type nonrec output_descriptions = output_description list
type nonrec application_summary = {
application_status : application_status;
Status of the application.
*)application_ar_n : resource_ar_n;
ARN of the application.
*)application_name : application_name;
Name of the application.
*)}
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.
type nonrec application_summaries = application_summary list
type nonrec list_applications_response = {
has_more_applications : boolean_object;
Returns true if there are more applications to retrieve.
*)application_summaries : application_summaries;
List of ApplicationSummary
objects.
}
type nonrec list_applications_request = {
exclusive_start_application_name : application_name option;
Name of the application to start the list with. When using pagination to retrieve the list, you don't need to specify this parameter in the first request. However, in subsequent requests, you add the last application name from the previous response to get the next page of applications.
*)limit : list_applications_input_limit option;
Maximum number of applications to list.
*)}
Exceeded the number of applications allowed.
type nonrec kinesis_streams_input_description = {
role_ar_n : role_ar_n option;
ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream.
*)resource_ar_n : resource_ar_n option;
Amazon Resource Name (ARN) of the Amazon Kinesis stream.
*)}
Describes the Amazon Kinesis stream that is configured as the streaming source in the application input configuration.
type nonrec kinesis_streams_input = {
role_ar_n : role_ar_n;
ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to grant the necessary permissions to this role.
*)resource_ar_n : resource_ar_n;
ARN of the input Amazon Kinesis stream to read.
*)}
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.
type nonrec kinesis_firehose_input_description = {
role_ar_n : role_ar_n option;
ARN of the IAM role that Amazon Kinesis Analytics assumes to access the stream.
*)resource_ar_n : resource_ar_n option;
Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream.
*)}
Describes the Amazon Kinesis Firehose delivery stream that is configured as the streaming source in the application input configuration.
type nonrec kinesis_firehose_input = {
role_ar_n : role_ar_n;
ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to make sure that the role has the necessary permissions to access the stream.
*)resource_ar_n : resource_ar_n;
ARN of the input delivery stream.
*)}
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.
type nonrec discover_input_schema_response = {
raw_input_records : raw_input_records option;
Raw stream data that was sampled to infer the schema.
*)processed_input_records : processed_input_records option;
Stream data that was modified by the processor specified in the InputProcessingConfiguration
parameter.
parsed_input_records : parsed_input_records option;
An array of elements, where each element corresponds to a row in a stream record (a stream record can have more than one row).
*)input_schema : source_schema option;
Schema inferred from the streaming source. It identifies the format of the data in the streaming source and how each data element maps to corresponding columns in the in-application stream that you can create.
*)}
type nonrec input_lambda_processor = {
role_ar_n : role_ar_n;
The ARN of the IAM role that is used to access the AWS Lambda function.
*)resource_ar_n : resource_ar_n;
The ARN of the AWS Lambda function that operates on records in the stream.
To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda
*)}
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.
type nonrec input_processing_configuration = {
input_lambda_processor : input_lambda_processor;
The InputLambdaProcessor that is used to preprocess the records in the stream before being processed by your application code.
*)}
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.
type nonrec discover_input_schema_request = {
input_processing_configuration : input_processing_configuration option;
The InputProcessingConfiguration to use to preprocess the records before discovering the schema of the records.
*)s3_configuration : s3_configuration option;
Specify this parameter to discover a schema from data in an Amazon S3 object.
*)input_starting_position_configuration : input_starting_position_configuration
option;
Point at which you want Amazon Kinesis Analytics to start reading records from the specified streaming source discovery purposes.
*)role_ar_n : role_ar_n option;
ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf.
*)resource_ar_n : resource_ar_n option;
Amazon Resource Name (ARN) of the streaming source.
*)}
type nonrec in_app_stream_names = in_app_stream_name list
type nonrec input_lambda_processor_description = {
role_ar_n : role_ar_n option;
The ARN of the IAM role that is used to access the AWS Lambda function.
*)resource_ar_n : resource_ar_n option;
}
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.
type nonrec input_processing_configuration_description = {
input_lambda_processor_description : input_lambda_processor_description option;
}
Provides configuration information about an input processor. Currently, the only input processor available is AWS Lambda.
Describes the number of in-application streams to create for a given streaming source. For information about parallelism, see Configuring Application Input.
type nonrec input_description = {
input_starting_position_configuration : input_starting_position_configuration
option;
Point at which the application is configured to read from the input stream.
*)input_parallelism : input_parallelism option;
Describes the configured parallelism (number of in-application streams mapped to the streaming source).
*)input_schema : source_schema option;
Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created.
*)kinesis_firehose_input_description : kinesis_firehose_input_description option;
If an Amazon Kinesis Firehose delivery stream is configured as a streaming source, provides the delivery stream's ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.
*)kinesis_streams_input_description : kinesis_streams_input_description option;
If an Amazon Kinesis stream is configured as streaming source, provides Amazon Kinesis stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.
*)input_processing_configuration_description : input_processing_configuration_description
option;
The description of the preprocessor that executes on records in this input before the application's code is run.
*)in_app_stream_names : in_app_stream_names option;
Returns the in-application stream names that are mapped to the stream source.
*)name_prefix : in_app_stream_name option;
In-application name prefix.
*)input_id : id option;
Input ID associated with the application input. This is the ID that Amazon Kinesis Analytics assigns to each input configuration you add to your application.
*)}
Describes the application input configuration. For more information, see Configuring Application Input.
type nonrec input_descriptions = input_description list
type nonrec cloud_watch_logging_option_description = {
role_ar_n : role_ar_n;
IAM ARN of the role to use to send application messages. Note: To write application messages to CloudWatch, the IAM role used must have the PutLogEvents
policy action enabled.
log_stream_ar_n : log_stream_ar_n;
ARN of the CloudWatch log to receive application messages.
*)cloud_watch_logging_option_id : id option;
ID of the CloudWatch logging option description.
*)}
Description of the CloudWatch logging option.
type nonrec cloud_watch_logging_option_descriptions =
cloud_watch_logging_option_description list
type nonrec application_detail = {
application_version_id : application_version_id;
Provides the current application version.
*)application_code : application_code option;
Returns the application code that you provided to perform data analysis on any of the in-application streams in your application.
*)cloud_watch_logging_option_descriptions : cloud_watch_logging_option_descriptions
option;
Describes the CloudWatch log streams that are configured to receive application messages. For more information about using CloudWatch log streams with Amazon Kinesis Analytics applications, see Working with Amazon CloudWatch Logs.
*)reference_data_source_descriptions : reference_data_source_descriptions option;
Describes reference data sources configured for the application. For more information, see Configuring Application Input.
*)output_descriptions : output_descriptions option;
Describes the application output configuration. For more information, see Configuring Application Output.
*)input_descriptions : input_descriptions option;
Describes the application input configuration. For more information, see Configuring Application Input.
*)last_update_timestamp : timestamp option;
Time stamp when the application was last updated.
*)create_timestamp : timestamp option;
Time stamp when the application version was created.
*)application_status : application_status;
Status of the application.
*)application_ar_n : resource_ar_n;
ARN of the application.
*)application_description : application_description option;
Description of the application.
*)application_name : application_name;
Name of the application.
*)}
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.
type nonrec describe_application_response = {
application_detail : application_detail;
Provides a description of the application, such as the application Amazon Resource Name (ARN), status, latest version, and input and output configuration details.
*)}
type nonrec describe_application_request = {
application_name : application_name;
Name of the application.
*)}
type nonrec delete_application_reference_data_source_request = {
reference_id : id;
ID of the reference data source. When you add a reference data source to your application using the AddApplicationReferenceDataSource, Amazon Kinesis Analytics assigns an ID. You can use the DescribeApplication operation to get the reference ID.
*)current_application_version_id : application_version_id;
Version of the application. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException
is returned.
application_name : application_name;
Name of an existing application.
*)}
type nonrec delete_application_output_request = {
output_id : id;
The ID of the configuration to delete. Each output configuration that is added to the application, either when the application is created or later using the AddApplicationOutput operation, has a unique ID. You need to provide the ID to uniquely identify the output configuration that you want to delete from the application configuration. You can use the DescribeApplication operation to get the specific OutputId
.
current_application_version_id : application_version_id;
Amazon Kinesis Analytics application version. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException
is returned.
application_name : application_name;
Amazon Kinesis Analytics application name.
*)}
type nonrec delete_application_input_processing_configuration_request = {
input_id : id;
The ID of the input configuration from which to delete the input processing configuration. You can get a list of the input IDs for an application by using the DescribeApplication operation.
*)current_application_version_id : application_version_id;
The version ID of the Kinesis Analytics application.
*)application_name : application_name;
The Kinesis Analytics application name.
*)}
type nonrec delete_application_cloud_watch_logging_option_request = {
cloud_watch_logging_option_id : id;
The CloudWatchLoggingOptionId
of the CloudWatch logging option to delete. You can get the CloudWatchLoggingOptionId
by using the DescribeApplication operation.
current_application_version_id : application_version_id;
The version ID of the Kinesis Analytics application.
*)application_name : application_name;
The Kinesis Analytics application name.
*)}
type nonrec delete_application_request = {
create_timestamp : timestamp;
You can use the DescribeApplication
operation to get this value.
application_name : application_name;
Name of the Amazon Kinesis Analytics application to delete.
*)}
type nonrec create_application_response = {
application_summary : application_summary;
In response to your CreateApplication
request, Amazon Kinesis Analytics returns a response with a summary of the application it created, including the application Amazon Resource Name (ARN), name, and status.
}
TBD
type nonrec input = {
input_schema : source_schema;
Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created.
Also used to describe the format of the reference data source.
*)input_parallelism : input_parallelism option;
Describes the number of in-application streams to create.
Data from your source is routed to these in-application input streams.
(see Configuring Application Input.
*)kinesis_firehose_input : kinesis_firehose_input option;
If the streaming source is an Amazon Kinesis Firehose delivery stream, identifies the delivery stream's ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.
Note: Either KinesisStreamsInput
or KinesisFirehoseInput
is required.
kinesis_streams_input : kinesis_streams_input option;
If the streaming source is an Amazon Kinesis stream, identifies the stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.
Note: Either KinesisStreamsInput
or KinesisFirehoseInput
is required.
input_processing_configuration : input_processing_configuration option;
The InputProcessingConfiguration for the input. An input processor transforms records as they are received from the stream, before the application's SQL code executes. Currently, the only input processing configuration available is InputLambdaProcessor.
*)name_prefix : in_app_stream_name;
Name prefix to use when creating an in-application stream. Suppose that you specify a prefix "MyInApplicationStream." Amazon Kinesis Analytics then creates one or more (as per the InputParallelism
count you specified) in-application streams with names "MyInApplicationStream_001," "MyInApplicationStream_002," and so on.
}
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.
type nonrec inputs = input list
type nonrec cloud_watch_logging_option = {
role_ar_n : role_ar_n;
IAM ARN of the role to use to send application messages. Note: To write application messages to CloudWatch, the IAM role that is used must have the PutLogEvents
policy action enabled.
log_stream_ar_n : log_stream_ar_n;
ARN of the CloudWatch log to receive application messages.
*)}
Provides a description of CloudWatch logging options, including the log stream Amazon Resource Name (ARN) and the role ARN.
type nonrec cloud_watch_logging_options = cloud_watch_logging_option list
type nonrec create_application_request = {
application_code : application_code option;
One or more SQL statements that read input data, transform it, and generate output. For example, you can write a SQL statement that reads data from one in-application stream, generates a running average of the number of advertisement clicks by vendor, and insert resulting rows in another in-application stream using pumps. For more information about the typical pattern, see Application Code.
You can provide such series of SQL statements, where output of one statement can be used as the input for the next statement. You store intermediate results by creating in-application streams and pumps.
Note that the application code must create the streams with names specified in the Outputs
. For example, if your Outputs
defines output streams named ExampleOutputStream1
and ExampleOutputStream2
, then your application code must create these streams.
cloud_watch_logging_options : cloud_watch_logging_options option;
Use this parameter to configure a CloudWatch log stream to monitor application configuration errors. For more information, see Working with Amazon CloudWatch Logs.
*)outputs : outputs option;
You can configure application output to write data from any of the in-application streams to up to three destinations.
These destinations can be Amazon Kinesis streams, Amazon Kinesis Firehose delivery streams, AWS Lambda destinations, or any combination of the three.
In the configuration, you specify the in-application stream name, the destination stream or Lambda function Amazon Resource Name (ARN), and the format to use when writing data. You must also provide an IAM role that Amazon Kinesis Analytics can assume to write to the destination stream or Lambda function on your behalf.
In the output configuration, you also provide the output stream or Lambda function ARN. For stream destinations, you provide the format of data in the stream (for example, JSON, CSV). You also must provide an IAM role that Amazon Kinesis Analytics can assume to write to the stream or Lambda function on your behalf.
*)inputs : inputs option;
Use this parameter to configure the application input.
You can configure your application to receive input from a single streaming source. In this configuration, you map this streaming source to an in-application stream that is created. Your application code can then query the in-application stream like a table (you can think of it as a constantly updating table).
For the streaming source, you provide its Amazon Resource Name (ARN) and format of data on the stream (for example, JSON, CSV, etc.). You also must provide an IAM role that Amazon Kinesis Analytics can assume to read this stream on your behalf.
To create the in-application stream, you need to specify a schema to transform your data into a schematized version used in SQL. In the schema, you provide the necessary mapping of the data elements in the streaming source to record columns in the in-app stream.
*)application_description : application_description option;
Summary description of the application.
*)application_name : application_name;
Name of your Amazon Kinesis Analytics application (for example, sample-app
).
}
TBD
type nonrec add_application_reference_data_source_request = {
reference_data_source : reference_data_source;
The reference data source can be an object in your Amazon S3 bucket. Amazon Kinesis Analytics reads the object and copies the data into the in-application table that is created. You provide an S3 bucket, object key name, and the resulting in-application table that is created. You must also provide an IAM role with the necessary permissions that Amazon Kinesis Analytics can assume to read the object from your S3 bucket on your behalf.
*)current_application_version_id : application_version_id;
Version of the application for which you are adding the reference data source. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException
is returned.
application_name : application_name;
Name of an existing application.
*)}
type nonrec add_application_output_request = {
output : output;
An array of objects, each describing one output configuration. In the output configuration, you specify the name of an in-application stream, a destination (that is, an Amazon Kinesis stream, an Amazon Kinesis Firehose delivery stream, or an AWS Lambda function), and record the formation to use when writing to the destination.
*)current_application_version_id : application_version_id;
Version of the application to which you want to add the output configuration. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException
is returned.
application_name : application_name;
Name of the application to which you want to add the output configuration.
*)}
type nonrec add_application_input_processing_configuration_request = {
input_processing_configuration : input_processing_configuration;
input_id : id;
The ID of the input configuration to add the input processing configuration to. You can get a list of the input IDs for an application using the DescribeApplication operation.
*)current_application_version_id : application_version_id;
Version of the application to which you want to add the input processing configuration. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException
is returned.
application_name : application_name;
Name of the application to which you want to add the input processing configuration.
*)}
type nonrec add_application_input_request = {
input : input;
current_application_version_id : application_version_id;
Current version of your Amazon Kinesis Analytics application. You can use the DescribeApplication operation to find the current application version.
*)application_name : application_name;
Name of your existing Amazon Kinesis Analytics application to which you want to add the streaming source.
*)}
type nonrec add_application_cloud_watch_logging_option_request = {
cloud_watch_logging_option : cloud_watch_logging_option;
Provides the CloudWatch log stream Amazon Resource Name (ARN) and the IAM role ARN. Note: To write application messages to CloudWatch, the IAM role that is used must have the PutLogEvents
policy action enabled.
current_application_version_id : application_version_id;
The version ID of the Kinesis Analytics application.
*)application_name : application_name;
The Kinesis Analytics application name.
*)}