KinesisAnalyticsClient Class

Member Function Documentation

KinesisAnalyticsClient::KinesisAnalyticsClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Constructs a KinesisAnalyticsClient object.

The new client object will region, credentials, and manager for network operations.

The new object will be owned by parent, if set.

KinesisAnalyticsClient::KinesisAnalyticsClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

This function overloads KinesisAnalyticsClient().

This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).

See also QtAws::Core::AwsEndpoint::getEndpoint.

[slot] AddApplicationCloudWatchLoggingOptionResponse *KinesisAnalyticsClient::addApplicationCloudWatchLoggingOption(const AddApplicationCloudWatchLoggingOptionRequest &request)

Sends request to the KinesisAnalyticsClient service, and returns a pointer to an AddApplicationCloudWatchLoggingOptionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Adds a CloudWatch log stream to monitor application configuration errors. For more information about using CloudWatch log streams with Amazon Kinesis Analytics applications, see <a href="http://docs.aws.amazon.com/kinesisanalytics/latest/dev/cloudwatch-logs.html">Working with Amazon CloudWatch

[slot] AddApplicationInputResponse *KinesisAnalyticsClient::addApplicationInput(const AddApplicationInputRequest &request)

Sends request to the KinesisAnalyticsClient service, and returns a pointer to an AddApplicationInputResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Adds a streaming source to your Amazon Kinesis application. For conceptual information, see <a href="http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html">Configuring Application Input</a>.

</p

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

<a>CreateApplication</a>>

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

</p

This operation requires permissions to perform the <code>kinesisanalytics:AddApplicationInput</code>

[slot] AddApplicationInputProcessingConfigurationResponse *KinesisAnalyticsClient::addApplicationInputProcessingConfiguration(const AddApplicationInputProcessingConfigurationRequest &request)

Sends request to the KinesisAnalyticsClient service, and returns a pointer to an AddApplicationInputProcessingConfigurationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Adds an <a>InputProcessingConfiguration</a> to an application. An input processor preprocesses records on the input stream before the application's SQL code executes. Currently, the only input processor available is <a href="https://aws.amazon.com/documentation/lambda/">AWS

[slot] AddApplicationOutputResponse *KinesisAnalyticsClient::addApplicationOutput(const AddApplicationOutputRequest &request)

Sends request to the KinesisAnalyticsClient service, and returns a pointer to an AddApplicationOutputResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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, an Amazon Kinesis Firehose delivery stream, or an Amazon 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>

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 <a href="http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html">Understanding Application Output (Destination)</a>.

</p

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 <a>DescribeApplication</a> operation to find the current application

version>

For the limits on the number of application inputs and outputs you can configure, see <a

href="http://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html">Limits</a>>

This operation requires permissions to perform the <code>kinesisanalytics:AddApplicationOutput</code>

[slot] AddApplicationReferenceDataSourceResponse *KinesisAnalyticsClient::addApplicationReferenceDataSource(const AddApplicationReferenceDataSourceRequest &request)

Sends request to the KinesisAnalyticsClient service, and returns a pointer to an AddApplicationReferenceDataSourceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <a href="http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html">Configuring Application Input</a>. For the limits on data sources you can add to your application, see <a href="http://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html">Limits</a>.

</p

This operation requires permissions to perform the <code>kinesisanalytics:AddApplicationOutput</code> action.

[slot] CreateApplicationResponse *KinesisAnalyticsClient::createApplication(const CreateApplicationRequest &request)

Sends request to the KinesisAnalyticsClient service, and returns a pointer to an CreateApplicationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 three destinations where you want Amazon Kinesis Analytics to write the output data from your application. For an overview, see <a href="http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works.html">How it Works</a>.

</p

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 three

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 <code>kinesisanalytics:CreateApplication</code> action.

</p

For introductory exercises to create an Amazon Kinesis Analytics application, see <a href="http://docs.aws.amazon.com/kinesisanalytics/latest/dev/getting-started.html">Getting Started</a>.

[slot] DeleteApplicationResponse *KinesisAnalyticsClient::deleteApplication(const DeleteApplicationRequest &request)

Sends request to the KinesisAnalyticsClient service, and returns a pointer to an DeleteApplicationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <code>kinesisanalytics:DeleteApplication</code>

[slot] DeleteApplicationCloudWatchLoggingOptionResponse *KinesisAnalyticsClient::deleteApplicationCloudWatchLoggingOption(const DeleteApplicationCloudWatchLoggingOptionRequest &request)

Sends request to the KinesisAnalyticsClient service, and returns a pointer to an DeleteApplicationCloudWatchLoggingOptionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes a CloudWatch log stream from an application. For more information about using CloudWatch log streams with Amazon Kinesis Analytics applications, see <a href="http://docs.aws.amazon.com/kinesisanalytics/latest/dev/cloudwatch-logs.html">Working with Amazon CloudWatch

[slot] DeleteApplicationInputProcessingConfigurationResponse *KinesisAnalyticsClient::deleteApplicationInputProcessingConfiguration(const DeleteApplicationInputProcessingConfigurationRequest &request)

Sends request to the KinesisAnalyticsClient service, and returns a pointer to an DeleteApplicationInputProcessingConfigurationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes an <a>InputProcessingConfiguration</a> from an

[slot] DeleteApplicationOutputResponse *KinesisAnalyticsClient::deleteApplicationOutput(const DeleteApplicationOutputRequest &request)

Sends request to the KinesisAnalyticsClient service, and returns a pointer to an DeleteApplicationOutputResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <code>kinesisanalytics:DeleteApplicationOutput</code>

[slot] DeleteApplicationReferenceDataSourceResponse *KinesisAnalyticsClient::deleteApplicationReferenceDataSource(const DeleteApplicationReferenceDataSourceRequest &request)

Sends request to the KinesisAnalyticsClient service, and returns a pointer to an DeleteApplicationReferenceDataSourceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <a>AddApplicationReferenceDataSource</a> operation.

</p

This operation requires permissions to perform the <code>kinesisanalytics.DeleteApplicationReferenceDataSource</code>

[slot] DescribeApplicationResponse *KinesisAnalyticsClient::describeApplication(const DescribeApplicationRequest &request)

Sends request to the KinesisAnalyticsClient service, and returns a pointer to an DescribeApplicationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns information about a specific Amazon Kinesis Analytics

application>

If you want to retrieve a list of all applications in your account, use the <a>ListApplications</a>

operation>

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

[slot] DiscoverInputSchemaResponse *KinesisAnalyticsClient::discoverInputSchema(const DiscoverInputSchemaRequest &request)

Sends request to the KinesisAnalyticsClient service, and returns a pointer to an DiscoverInputSchemaResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Infers a schema by evaluating sample records on the specified streaming source (Amazon Kinesis stream or Amazon Kinesis Firehose delivery stream) or S3 object. 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 <a href="http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html">Configuring Application Input</a>. 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.

</p

This operation requires permissions to perform the <code>kinesisanalytics:DiscoverInputSchema</code> action.

[slot] ListApplicationsResponse *KinesisAnalyticsClient::listApplications(const ListApplicationsRequest &request)

Sends request to the KinesisAnalyticsClient service, and returns a pointer to an ListApplicationsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <code>HasMoreApplications</code> value as true, you can send another request by adding the <code>ExclusiveStartApplicationName</code> in the request body, and set the value of this to the last application name from the previous response.

</p

If you want detailed information about a specific application, use

<a>DescribeApplication</a>>

This operation requires permissions to perform the <code>kinesisanalytics:ListApplications</code>

[slot] StartApplicationResponse *KinesisAnalyticsClient::startApplication(const StartApplicationRequest &request)

Sends request to the KinesisAnalyticsClient service, and returns a pointer to an StartApplicationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <code>READY</code> for you to start an application. You can get the application status in the console or using the <a>DescribeApplication</a>

operation>

After you start the application, you can stop the application from processing the input by calling the <a>StopApplication</a>

operation>

This operation requires permissions to perform the <code>kinesisanalytics:StartApplication</code>

[slot] StopApplicationResponse *KinesisAnalyticsClient::stopApplication(const StopApplicationRequest &request)

Sends request to the KinesisAnalyticsClient service, and returns a pointer to an StopApplicationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Stops the application from processing input data. You can stop an application only if it is in the running state. You can use the <a>DescribeApplication</a> 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.

</p

This operation requires permissions to perform the <code>kinesisanalytics:StopApplication</code>

[slot] UpdateApplicationResponse *KinesisAnalyticsClient::updateApplication(const UpdateApplicationRequest &request)

Sends request to the KinesisAnalyticsClient service, and returns a pointer to an UpdateApplicationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates an existing Amazon Kinesis Analytics application. Using this API, you can update application code, input configuration, and output configuration.

</p

Note that Amazon Kinesis Analytics updates the <code>CurrentApplicationVersionId</code> each time you update your application.

</p

This operation requires permission for the <code>kinesisanalytics:UpdateApplication</code>