AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Classes

NameDescription
Class AddApplicationCloudWatchLoggingOptionRequest

Container for the parameters to the AddApplicationCloudWatchLoggingOption operation. Adds a CloudWatch log stream to monitor application configuration errors. For more information about using CloudWatch log streams with Amazon Kinesis Analytics applications, see Working with Amazon CloudWatch Logs.

Class AddApplicationCloudWatchLoggingOptionResponse

This is the response object from the AddApplicationCloudWatchLoggingOption operation.

Class AddApplicationInputRequest

Container for the parameters to the AddApplicationInput operation. Adds a streaming source to your Amazon Kinesis application. For conceptual information, see Configuring Application Input.

You can add a streaming source either when you create an application or you can use this operation to add a streaming source after you create an application. For more information, see CreateApplication.

Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version.

This operation requires permissions to perform the kinesisanalytics:AddApplicationInput action.

Class AddApplicationInputResponse

Class AddApplicationOutputRequest

Container for the parameters to the AddApplicationOutput operation. Adds an external destination to your Amazon Kinesis Analytics application.

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 or a Firehose delivery stream), 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.

You can use one of the output configurations to deliver data from your in-application error stream to an external destination so that you can analyze the errors. For conceptual information, see Understanding Application Output (Destination).

Note that any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version.

For the limits on the number of application inputs and outputs you can configure, see Limits.

This operation requires permissions to perform the kinesisanalytics:AddApplicationOutput action.

Class AddApplicationOutputResponse

Class AddApplicationReferenceDataSourceRequest

Container for the parameters to the AddApplicationReferenceDataSource operation. Adds a reference data source to an existing application.

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.

For conceptual information, see Configuring Application Input. For the limits on data sources you can add to your application, see Limits.

This operation requires permissions to perform the kinesisanalytics:AddApplicationOutput action.

Class AddApplicationReferenceDataSourceResponse

Class ApplicationDetail

Provides a description of the application, including the application Amazon Resource Name (ARN), status, latest version, and input and output configuration.

Class ApplicationSummary

Provides application summary information, including the application Amazon Resource Name (ARN), name, and status.

Class ApplicationUpdate

Describes updates to apply to an existing Amazon Kinesis Analytics application.

Class CloudWatchLoggingOption

Provides a description of CloudWatch logging options, including the log stream Amazon Resource Name (ARN) and the role ARN.

Class CloudWatchLoggingOptionDescription

Description of the CloudWatch logging option.

Class CloudWatchLoggingOptionUpdate

Describes CloudWatch logging option updates.

Class CodeValidationException

KinesisAnalytics exception

Class ConcurrentModificationException

KinesisAnalytics exception

Class CreateApplicationRequest

Container for the parameters to the CreateApplication operation. Creates an Amazon Kinesis Analytics application. You can configure each application with one streaming source as input, application code to process the input, and up to five streaming destinations where you want Amazon Kinesis Analytics to write the output data from your application. For an overview, see How it Works.

In the input configuration, you map the streaming source to an in-application stream, which you can think of as a constantly updating table. In the mapping, you must provide a schema for the in-application stream and map each data column in the in-application stream to a data element in the streaming source.

Your application code is one or more SQL statements that read input data, transform it, and generate output. Your application code can create one or more SQL artifacts like SQL streams or pumps.

In the output configuration, you can configure the application to write data from in-application streams created in your applications to up to five streaming destinations.

To read data from your source stream or write data to destination streams, Amazon Kinesis Analytics needs your permissions. You grant these permissions by creating IAM roles. This operation requires permissions to perform the kinesisanalytics:CreateApplication action.

For introductory exercises to create an Amazon Kinesis Analytics application, see Getting Started.

Class CreateApplicationResponse

TBD

Class 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:

"name1", "address1"

"name2, "address2"

Class DeleteApplicationCloudWatchLoggingOptionRequest

Container for the parameters to the DeleteApplicationCloudWatchLoggingOption operation. Deletes a CloudWatch log stream from an application. For more information about using CloudWatch log streams with Amazon Kinesis Analytics applications, see Working with Amazon CloudWatch Logs.

Class DeleteApplicationCloudWatchLoggingOptionResponse

This is the response object from the DeleteApplicationCloudWatchLoggingOption operation.

Class DeleteApplicationOutputRequest

Container for the parameters to the DeleteApplicationOutput operation. Deletes output destination configuration from your application configuration. Amazon Kinesis Analytics will no longer write data from the corresponding in-application stream to the external output destination.

This operation requires permissions to perform the kinesisanalytics:DeleteApplicationOutput action.

Class DeleteApplicationOutputResponse

Class DeleteApplicationReferenceDataSourceRequest

Container for the parameters to the DeleteApplicationReferenceDataSource operation. Deletes a reference data source configuration from the specified application configuration.

If the application is running, Amazon Kinesis Analytics immediately removes the in-application table that you created using the AddApplicationReferenceDataSource operation.

This operation requires permissions to perform the kinesisanalytics.DeleteApplicationReferenceDataSource action.

Class DeleteApplicationReferenceDataSourceResponse

This is the response object from the DeleteApplicationReferenceDataSource operation.

Class DeleteApplicationRequest

Container for the parameters to the DeleteApplication operation. Deletes the specified application. Amazon Kinesis Analytics halts application execution and deletes the application, including any application artifacts (such as in-application streams, reference table, and application code).

This operation requires permissions to perform the kinesisanalytics:DeleteApplication action.

Class DeleteApplicationResponse

Class DescribeApplicationRequest

Container for the parameters to the DescribeApplication operation. Returns information about a specific Amazon Kinesis Analytics application.

If you want to retrieve a list of all applications in your account, use the ListApplications operation.

This operation requires permissions to perform the kinesisanalytics:DescribeApplication action. You can use DescribeApplication to get the current application versionId, which you need to call other operations such as Update.

Class DescribeApplicationResponse

Class DestinationSchema

Describes the data format when records are written to the destination. For more information, see Configuring Application Output.

Class DiscoverInputSchemaRequest

Container for the parameters to the DiscoverInputSchema operation. Infers a schema by evaluating sample records on the specified streaming source (Amazon Kinesis stream or Amazon Kinesis Firehose delivery stream). In the response, the operation returns the inferred schema and also the sample records that the operation used to infer the schema.

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.

This operation requires permissions to perform the kinesisanalytics:DiscoverInputSchema action.

Class DiscoverInputSchemaResponse

Class 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.

Class 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.

Class InputDescription

Describes the application input configuration. For more information, see Configuring Application Input.

Class InputParallelism

Describes the number of in-application streams to create for a given streaming source. For information about parallelism, see Configuring Application Input.

Class InputParallelismUpdate

Provides updates to the parallelism count.

Class InputSchemaUpdate

Describes updates for the application's input schema.

Class InputStartingPositionConfiguration

Describes the point at which the application reads from the streaming source.

Class InputUpdate

Describes updates to a specific input configuration (identified by the InputId of an application).

Class InvalidApplicationConfigurationException

KinesisAnalytics exception

Class InvalidArgumentException

KinesisAnalytics exception

Class JSONMappingParameters

Provides additional mapping information when JSON is the record format on the streaming source.

Class KinesisFirehoseInput

Identifies an Amazon Kinesis Firehose delivery stream as the streaming source. You provide the Firehose delivery stream's Amazon Resource Name (ARN) and an IAM role ARN that enables Amazon Kinesis Analytics to access the stream on your behalf.

Class KinesisFirehoseInputDescription

Describes the Amazon Kinesis Firehose delivery stream that is configured as the streaming source in the application input configuration.

Class KinesisFirehoseInputUpdate

When updating application input configuration, provides information about an Amazon Kinesis Firehose delivery stream as the streaming source.

Class 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.

Class KinesisFirehoseOutputDescription

For an application output, describes the Amazon Kinesis Firehose delivery stream configured as its destination.

Class KinesisFirehoseOutputUpdate

When updating an output configuration using the UpdateApplication operation, provides information about an Amazon Kinesis Firehose delivery stream configured as the destination.

Class KinesisStreamsInput

Identifies an Amazon Kinesis stream as the streaming source. You provide the stream's ARN and an IAM role ARN that enables Amazon Kinesis Analytics to access the stream on your behalf.

Class KinesisStreamsInputDescription

Describes the Amazon Kinesis stream that is configured as the streaming source in the application input configuration.

Class KinesisStreamsInputUpdate

When updating application input configuration, provides information about an Amazon Kinesis stream as the streaming source.

Class KinesisStreamsOutput

When configuring application output, identifies a 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.

Class KinesisStreamsOutputDescription

For an application output, describes the Amazon Kinesis stream configured as its destination.

Class KinesisStreamsOutputUpdate

When updating an output configuration using the UpdateApplication operation, provides information about an Amazon Kinesis stream configured as the destination.

Class LimitExceededException

KinesisAnalytics exception

Class ListApplicationsRequest

Container for the parameters to the ListApplications operation. Returns a list of Amazon Kinesis Analytics applications in your account. For each application, the response includes the application name, Amazon Resource Name (ARN), and status. If the response returns the HasMoreApplications value as true, you can send another request by adding the ExclusiveStartApplicationName in the request body, and set the value of this to the last application name from the previous response.

If you want detailed information about a specific application, use DescribeApplication.

This operation requires permissions to perform the kinesisanalytics:ListApplications action.

Class ListApplicationsResponse

Class 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.

Class 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.

Class 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.

Class OutputUpdate

Describes updates to the output configuration identified by the OutputId.

Class 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.

Class RecordFormat

Describes the record format and relevant mapping information that should be applied to schematize the records on the stream.

Class 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.

Class ReferenceDataSourceDescription

Describes the reference data source configured for an application.

Class 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.

Class ResourceInUseException

KinesisAnalytics exception

Class ResourceNotFoundException

KinesisAnalytics exception

Class ResourceProvisionedThroughputExceededException

KinesisAnalytics exception

Class 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.

Class S3ReferenceDataSourceDescription

Provides the bucket name and object key name that stores the reference data.

Class 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.

Class ServiceUnavailableException

KinesisAnalytics exception

Class 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.

Class StartApplicationRequest

Container for the parameters to the StartApplication operation. Starts the specified Amazon Kinesis Analytics application. After creating an application, you must exclusively call this operation to start your application.

After the application starts, it begins consuming the input data, processes it, and writes the output to the configured destination.

The application status must be READY for you to start an application. You can get the application status in the console or using the DescribeApplication operation.

After you start the application, you can stop the application from processing the input by calling the StopApplication operation.

This operation requires permissions to perform the kinesisanalytics:StartApplication action.

Class StartApplicationResponse

Class StopApplicationRequest

Container for the parameters to the StopApplication operation. Stops the application from processing input data. You can stop an application only if it is in the running state. You can use the DescribeApplication operation to find the application state. After the application is stopped, Amazon Kinesis Analytics stops reading data from the input, the application stops processing data, and there is no output written to the destination.

This operation requires permissions to perform the kinesisanalytics:StopApplication action.

Class StopApplicationResponse

Class UnableToDetectSchemaException

KinesisAnalytics exception

Class UpdateApplicationRequest

Container for the parameters to the UpdateApplication operation. Updates an existing Amazon Kinesis Analytics application. Using this API, you can update application code, input configuration, and output configuration.

Note that Amazon Kinesis Analytics updates the CurrentApplicationVersionId each time you update your application.

This operation requires permission for the kinesisanalytics:UpdateApplication action.

Class UpdateApplicationResponse

This is the response object from the UpdateApplication operation.