[−][src]Crate rusoto_kinesisanalytics
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
| AddApplicationCloudWatchLoggingOptionRequest | |
| AddApplicationCloudWatchLoggingOptionResponse | |
| AddApplicationInputProcessingConfigurationRequest | |
| AddApplicationInputProcessingConfigurationResponse | |
| AddApplicationInputRequest | |
| AddApplicationInputResponse | |
| AddApplicationOutputRequest | |
| AddApplicationOutputResponse | |
| AddApplicationReferenceDataSourceRequest | |
| AddApplicationReferenceDataSourceResponse | |
| ApplicationDetail | 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. |
| ApplicationSummary | 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. |
| ApplicationUpdate | Describes updates to apply to an existing Amazon Kinesis Analytics application. |
| CSVMappingParameters | 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: |
| CloudWatchLoggingOption | Provides a description of CloudWatch logging options, including the log stream Amazon Resource Name (ARN) and the role ARN. |
| CloudWatchLoggingOptionDescription | Description of the CloudWatch logging option. |
| CloudWatchLoggingOptionUpdate | Describes CloudWatch logging option updates. |
| CreateApplicationRequest | TBD |
| CreateApplicationResponse | TBD |
| DeleteApplicationCloudWatchLoggingOptionRequest | |
| DeleteApplicationCloudWatchLoggingOptionResponse | |
| DeleteApplicationInputProcessingConfigurationRequest | |
| DeleteApplicationInputProcessingConfigurationResponse | |
| DeleteApplicationOutputRequest | |
| DeleteApplicationOutputResponse | |
| DeleteApplicationReferenceDataSourceRequest | |
| DeleteApplicationReferenceDataSourceResponse | |
| DeleteApplicationRequest | |
| DeleteApplicationResponse | |
| DescribeApplicationRequest | |
| DescribeApplicationResponse | |
| DestinationSchema | Describes the data format when records are written to the destination. For more information, see Configuring Application Output. |
| DiscoverInputSchemaRequest | |
| DiscoverInputSchemaResponse | |
| 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. |
| InputConfiguration | 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. |
| InputDescription | Describes the application input configuration. For more information, see Configuring Application Input. |
| InputLambdaProcessor | 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. |
| InputLambdaProcessorDescription | 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. |
| InputLambdaProcessorUpdate | Represents an update to the InputLambdaProcessor that is used to preprocess the records in the stream. |
| InputParallelism | Describes the number of in-application streams to create for a given streaming source. For information about parallelism, see Configuring Application Input. |
| InputParallelismUpdate | Provides updates to the parallelism count. |
| InputProcessingConfiguration | 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. |
| InputProcessingConfigurationDescription | Provides configuration information about an input processor. Currently, the only input processor available is AWS Lambda. |
| InputProcessingConfigurationUpdate | Describes updates to an InputProcessingConfiguration. |
| InputSchemaUpdate | Describes updates for the application's input schema. |
| InputStartingPositionConfiguration | Describes the point at which the application reads from the streaming source. |
| InputUpdate | Describes updates to a specific input configuration (identified by the |
| JSONMappingParameters | Provides additional mapping information when JSON is the record format on the streaming source. |
| KinesisAnalyticsClient | A client for the Kinesis Analytics API. |
| KinesisFirehoseInput | 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. |
| KinesisFirehoseInputDescription | Describes the Amazon Kinesis Firehose delivery stream that is configured as the streaming source in the application input configuration. |
| KinesisFirehoseInputUpdate | When updating application input configuration, provides information about an Amazon Kinesis Firehose delivery stream as the streaming source. |
| KinesisFirehoseOutput | 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. |
| KinesisFirehoseOutputDescription | For an application output, describes the Amazon Kinesis Firehose delivery stream configured as its destination. |
| KinesisFirehoseOutputUpdate | When updating an output configuration using the UpdateApplication operation, provides information about an Amazon Kinesis Firehose delivery stream configured as the destination. |
| KinesisStreamsInput | 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. |
| KinesisStreamsInputDescription | Describes the Amazon Kinesis stream that is configured as the streaming source in the application input configuration. |
| KinesisStreamsInputUpdate | When updating application input configuration, provides information about an Amazon Kinesis stream as the streaming source. |
| KinesisStreamsOutput | 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. |
| KinesisStreamsOutputDescription | For an application output, describes the Amazon Kinesis stream configured as its destination. |
| KinesisStreamsOutputUpdate | When updating an output configuration using the UpdateApplication operation, provides information about an Amazon Kinesis stream configured as the destination. |
| LambdaOutput | 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. |
| LambdaOutputDescription | For an application output, describes the AWS Lambda function configured as its destination. |
| LambdaOutputUpdate | When updating an output configuration using the UpdateApplication operation, provides information about an AWS Lambda function configured as the destination. |
| ListApplicationsRequest | |
| ListApplicationsResponse | |
| ListTagsForResourceRequest | |
| ListTagsForResourceResponse | |
| MappingParameters | 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. |
| OutputDescription | 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. |
| OutputUpdate | Describes updates to the output configuration identified by the |
| RecordColumn | 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. |
| RecordFormat | Describes the record format and relevant mapping information that should be applied to schematize the records on the stream. |
| ReferenceDataSource | 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. |
| ReferenceDataSourceDescription | Describes the reference data source configured for an application. |
| ReferenceDataSourceUpdate | 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. |
| S3ReferenceDataSource | 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. |
| S3ReferenceDataSourceDescription | Provides the bucket name and object key name that stores the reference data. |
| S3ReferenceDataSourceUpdate | 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. |
| SourceSchema | 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. |
| StartApplicationRequest | |
| StartApplicationResponse | |
| StopApplicationRequest | |
| StopApplicationResponse | |
| 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. |
| TagResourceRequest | |
| TagResourceResponse | |
| UntagResourceRequest | |
| UntagResourceResponse | |
| UpdateApplicationRequest | |
| UpdateApplicationResponse |
Enums
| AddApplicationCloudWatchLoggingOptionError | Errors returned by AddApplicationCloudWatchLoggingOption |
| AddApplicationInputError | Errors returned by AddApplicationInput |
| AddApplicationInputProcessingConfigurationError | Errors returned by AddApplicationInputProcessingConfiguration |
| AddApplicationOutputError | Errors returned by AddApplicationOutput |
| AddApplicationReferenceDataSourceError | Errors returned by AddApplicationReferenceDataSource |
| CreateApplicationError | Errors returned by CreateApplication |
| DeleteApplicationCloudWatchLoggingOptionError | Errors returned by DeleteApplicationCloudWatchLoggingOption |
| DeleteApplicationError | Errors returned by DeleteApplication |
| DeleteApplicationInputProcessingConfigurationError | Errors returned by DeleteApplicationInputProcessingConfiguration |
| DeleteApplicationOutputError | Errors returned by DeleteApplicationOutput |
| DeleteApplicationReferenceDataSourceError | Errors returned by DeleteApplicationReferenceDataSource |
| DescribeApplicationError | Errors returned by DescribeApplication |
| DiscoverInputSchemaError | Errors returned by DiscoverInputSchema |
| ListApplicationsError | Errors returned by ListApplications |
| ListTagsForResourceError | Errors returned by ListTagsForResource |
| StartApplicationError | Errors returned by StartApplication |
| StopApplicationError | Errors returned by StopApplication |
| TagResourceError | Errors returned by TagResource |
| UntagResourceError | Errors returned by UntagResource |
| UpdateApplicationError | Errors returned by UpdateApplication |
Traits
| KinesisAnalytics | Trait representing the capabilities of the Kinesis Analytics API. Kinesis Analytics clients implement this trait. |