KinesisAnalytics class

This is the Amazon Kinesis Analytics v1 API Reference. The Amazon Kinesis Analytics Developer Guide provides additional information.

Constructors

KinesisAnalytics.new({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

addApplicationCloudWatchLoggingOption({required String applicationName, required CloudWatchLoggingOption cloudWatchLoggingOption, required int currentApplicationVersionId}) → Future<void>
Working with Amazon CloudWatch Logs
addApplicationInput({required String applicationName, required int currentApplicationVersionId, required Input input}) → Future<void>
Configuring Application Input
addApplicationInputProcessingConfiguration({required String applicationName, required int currentApplicationVersionId, required String inputId, required InputProcessingConfiguration inputProcessingConfiguration}) → Future<void>
InputProcessingConfiguration
addApplicationOutput({required String applicationName, required int currentApplicationVersionId, required Output output}) → Future<void>
If you want Amazon Kinesis Analytics to deliver data from an in-application stream within your application to an external destination (such as an Amazon Kinesis stream, an Amazon Kinesis Firehose delivery stream, or an AWS Lambda function), you add the relevant configuration to your application using this operation. You can configure one or more outputs for your application. Each output configuration maps an in-application stream and an external destination.
addApplicationReferenceDataSource({required String applicationName, required int currentApplicationVersionId, required ReferenceDataSource referenceDataSource}) → Future<void>
Amazon Kinesis Analytics reads reference data (that is, an Amazon S3 object) and creates an in-application table within your application. In the request, you provide the source (S3 bucket name and object key name), name of the in-application table to create, and the necessary mapping information that describes how data in Amazon S3 object maps to columns in the resulting in-application table.
close() → void
Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
createApplication({required String applicationName, String? applicationCode, String? applicationDescription, List<CloudWatchLoggingOption>? cloudWatchLoggingOptions, List<Input>? inputs, List<Output>? outputs, List<Tag>? tags}) → Future<CreateApplicationResponse>
How it Works
deleteApplication({required String applicationName, required DateTime createTimestamp}) → Future<void>
This operation requires permissions to perform the kinesisanalytics:DeleteApplication action.
deleteApplicationCloudWatchLoggingOption({required String applicationName, required String cloudWatchLoggingOptionId, required int currentApplicationVersionId}) → Future<void>
Working with Amazon CloudWatch Logs
deleteApplicationInputProcessingConfiguration({required String applicationName, required int currentApplicationVersionId, required String inputId}) → Future<void>
InputProcessingConfiguration
deleteApplicationOutput({required String applicationName, required int currentApplicationVersionId, required String outputId}) → Future<void>
This operation requires permissions to perform the kinesisanalytics:DeleteApplicationOutput action.
deleteApplicationReferenceDataSource({required String applicationName, required int currentApplicationVersionId, required String referenceId}) → Future<void>
If the application is running, Amazon Kinesis Analytics immediately removes the in-application table that you created using the AddApplicationReferenceDataSource operation.
describeApplication({required String applicationName}) → Future<DescribeApplicationResponse>
If you want to retrieve a list of all applications in your account, use the ListApplications operation.
discoverInputSchema({InputProcessingConfiguration? inputProcessingConfiguration, InputStartingPositionConfiguration? inputStartingPositionConfiguration, String? resourceARN, String? roleARN, S3Configuration? s3Configuration}) → Future<DiscoverInputSchemaResponse>
You can use the inferred schema when configuring a streaming source for your application. For conceptual information, see Configuring Application Input. Note that when you create an application using the Amazon Kinesis Analytics console, the console uses this operation to infer a schema and show it in the console user interface.
listApplications({String? exclusiveStartApplicationName, int? limit}) → Future<ListApplicationsResponse>
HasMoreApplications
listTagsForResource({required String resourceARN}) → Future<ListTagsForResourceResponse>
Retrieves the list of key-value tags assigned to the application. For more information, see Using Tagging.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
startApplication({required String applicationName, required List<InputConfiguration> inputConfigurations}) → Future<void>
After the application starts, it begins consuming the input data, processes it, and writes the output to the configured destination.
stopApplication({required String applicationName}) → Future<void>
DescribeApplication
tagResource({required String resourceARN, required List<Tag> tags}) → Future<void>
Adds one or more key-value tags to a Kinesis Analytics application. 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.
toString() → String
A string representation of this object.
inherited
untagResource({required String resourceARN, required List<String> tagKeys}) → Future<void>
Removes one or more tags from a Kinesis Analytics application. For more information, see Using Tagging.
updateApplication({required String applicationName, required ApplicationUpdate applicationUpdate, required int currentApplicationVersionId}) → Future<void>
Note that Amazon Kinesis Analytics updates the CurrentApplicationVersionId each time you update your application.

Operators

operator ==(Object other) → bool
The equality operator.
inherited