software.amazon.awssdk.services.kinesisanalytics

Interface KinesisAnalyticsAsyncClient

All Superinterfaces:

AutoCloseable

@Generated(value="software.amazon.awssdk:codegen")
public interface KinesisAnalyticsAsyncClient
extends AutoCloseable

Service client for accessing Kinesis Analytics asynchronously. This can be created using the static builder() method. null

Method Summary

Modifier and Type	Method and Description
default CompletableFuture<AddApplicationCloudWatchLoggingOptionResponse>	addApplicationCloudWatchLoggingOption(AddApplicationCloudWatchLoggingOptionRequest addApplicationCloudWatchLoggingOptionRequest) Adds a CloudWatch log stream to monitor application configuration errors.
default CompletableFuture<AddApplicationInputResponse>	addApplicationInput(AddApplicationInputRequest addApplicationInputRequest) Adds a streaming source to your Amazon Kinesis application.
default CompletableFuture<AddApplicationOutputResponse>	addApplicationOutput(AddApplicationOutputRequest addApplicationOutputRequest) Adds an external destination to your Amazon Kinesis Analytics application.
default CompletableFuture<AddApplicationReferenceDataSourceResponse>	addApplicationReferenceDataSource(AddApplicationReferenceDataSourceRequest addApplicationReferenceDataSourceRequest) Adds a reference data source to an existing application.
static KinesisAnalyticsAsyncClientBuilder	builder() Create a builder that can be used to configure and create a KinesisAnalyticsAsyncClient.
static KinesisAnalyticsAsyncClient	create() Create a KinesisAnalyticsAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CompletableFuture<CreateApplicationResponse>	createApplication(CreateApplicationRequest createApplicationRequest) Creates an Amazon Kinesis Analytics application.
default CompletableFuture<DeleteApplicationResponse>	deleteApplication(DeleteApplicationRequest deleteApplicationRequest) Deletes the specified application.
default CompletableFuture<DeleteApplicationCloudWatchLoggingOptionResponse>	deleteApplicationCloudWatchLoggingOption(DeleteApplicationCloudWatchLoggingOptionRequest deleteApplicationCloudWatchLoggingOptionRequest) Deletes a CloudWatch log stream from an application.
default CompletableFuture<DeleteApplicationOutputResponse>	deleteApplicationOutput(DeleteApplicationOutputRequest deleteApplicationOutputRequest) Deletes output destination configuration from your application configuration.
default CompletableFuture<DeleteApplicationReferenceDataSourceResponse>	deleteApplicationReferenceDataSource(DeleteApplicationReferenceDataSourceRequest deleteApplicationReferenceDataSourceRequest) Deletes a reference data source configuration from the specified application configuration.
default CompletableFuture<DescribeApplicationResponse>	describeApplication(DescribeApplicationRequest describeApplicationRequest) Returns information about a specific Amazon Kinesis Analytics application.
default CompletableFuture<DiscoverInputSchemaResponse>	discoverInputSchema(DiscoverInputSchemaRequest discoverInputSchemaRequest) Infers a schema by evaluating sample records on the specified streaming source (Amazon Kinesis stream or Amazon Kinesis Firehose delivery stream).
default CompletableFuture<ListApplicationsResponse>	listApplications(ListApplicationsRequest listApplicationsRequest) Returns a list of Amazon Kinesis Analytics applications in your account.
default CompletableFuture<StartApplicationResponse>	startApplication(StartApplicationRequest startApplicationRequest) Starts the specified Amazon Kinesis Analytics application.
default CompletableFuture<StopApplicationResponse>	stopApplication(StopApplicationRequest stopApplicationRequest) Stops the application from processing input data.
default CompletableFuture<UpdateApplicationResponse>	updateApplication(UpdateApplicationRequest updateApplicationRequest) Updates an existing Amazon Kinesis Analytics application.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

create

static KinesisAnalyticsAsyncClient create()

Create a KinesisAnalyticsAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static KinesisAnalyticsAsyncClientBuilder builder()

Create a builder that can be used to configure and create a KinesisAnalyticsAsyncClient.

addApplicationCloudWatchLoggingOption

default CompletableFuture<AddApplicationCloudWatchLoggingOptionResponse> addApplicationCloudWatchLoggingOption(AddApplicationCloudWatchLoggingOptionRequest addApplicationCloudWatchLoggingOptionRequest)

Adds a CloudWatch log stream to monitor application configuration errors. For more information about using CloudWatch log streams with Amazon Kinesis Analytics applications, see Monitoring Configuration Errors.

Parameters:

addApplicationCloudWatchLoggingOptionRequest -

Returns:

A Java Future containing the result of the AddApplicationCloudWatchLoggingOption operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ResourceNotFoundException Specified application can't be found.
• ResourceInUseException Application is not available for this operation.
• InvalidArgumentException Specified input parameter value is invalid.
• ConcurrentModificationException 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• KinesisAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

addApplicationInput

default CompletableFuture<AddApplicationInputResponse> addApplicationInput(AddApplicationInputRequest addApplicationInputRequest)

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.

Parameters:

addApplicationInputRequest -

Returns:

A Java Future containing the result of the AddApplicationInput operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ResourceNotFoundException Specified application can't be found.
• ResourceInUseException Application is not available for this operation.
• InvalidArgumentException Specified input parameter value is invalid.
• ConcurrentModificationException 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• KinesisAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

addApplicationOutput

default CompletableFuture<AddApplicationOutputResponse> addApplicationOutput(AddApplicationOutputRequest addApplicationOutputRequest)

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.

Parameters:

addApplicationOutputRequest -

Returns:

A Java Future containing the result of the AddApplicationOutput operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ResourceNotFoundException Specified application can't be found.
• ResourceInUseException Application is not available for this operation.
• InvalidArgumentException Specified input parameter value is invalid.
• ConcurrentModificationException 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• KinesisAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

addApplicationReferenceDataSource

default CompletableFuture<AddApplicationReferenceDataSourceResponse> addApplicationReferenceDataSource(AddApplicationReferenceDataSourceRequest addApplicationReferenceDataSourceRequest)

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.

Parameters:

addApplicationReferenceDataSourceRequest -

Returns:

A Java Future containing the result of the AddApplicationReferenceDataSource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ResourceNotFoundException Specified application can't be found.
• ResourceInUseException Application is not available for this operation.
• InvalidArgumentException Specified input parameter value is invalid.
• ConcurrentModificationException 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• KinesisAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

createApplication

default CompletableFuture<CreateApplicationResponse> createApplication(CreateApplicationRequest createApplicationRequest)

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.

Parameters:

createApplicationRequest - TBD

Returns:

A Java Future containing the result of the CreateApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• CodeValidationException User-provided application code (query) is invalid. This can be a simple syntax error.
• ResourceInUseException Application is not available for this operation.
• LimitExceededException Exceeded the number of applications allowed.
• InvalidArgumentException Specified input parameter value is invalid.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• KinesisAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

deleteApplication

default CompletableFuture<DeleteApplicationResponse> deleteApplication(DeleteApplicationRequest deleteApplicationRequest)

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.

Parameters:

deleteApplicationRequest -

Returns:

A Java Future containing the result of the DeleteApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ConcurrentModificationException 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.
• ResourceNotFoundException Specified application can't be found.
• ResourceInUseException Application is not available for this operation.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• KinesisAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

deleteApplicationCloudWatchLoggingOption

default CompletableFuture<DeleteApplicationCloudWatchLoggingOptionResponse> deleteApplicationCloudWatchLoggingOption(DeleteApplicationCloudWatchLoggingOptionRequest deleteApplicationCloudWatchLoggingOptionRequest)

Deletes a CloudWatch log stream from an application. For more information about using CloudWatch log streams with Amazon Kinesis Analytics applications, see Monitoring Configuration Errors.

Parameters:

deleteApplicationCloudWatchLoggingOptionRequest -

Returns:

A Java Future containing the result of the DeleteApplicationCloudWatchLoggingOption operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ResourceNotFoundException Specified application can't be found.
• ResourceInUseException Application is not available for this operation.
• InvalidArgumentException Specified input parameter value is invalid.
• ConcurrentModificationException 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• KinesisAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

deleteApplicationOutput

default CompletableFuture<DeleteApplicationOutputResponse> deleteApplicationOutput(DeleteApplicationOutputRequest deleteApplicationOutputRequest)

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.

Parameters:

deleteApplicationOutputRequest -

Returns:

A Java Future containing the result of the DeleteApplicationOutput operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ResourceNotFoundException Specified application can't be found.
• ResourceInUseException Application is not available for this operation.
• InvalidArgumentException Specified input parameter value is invalid.
• ConcurrentModificationException 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• KinesisAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

deleteApplicationReferenceDataSource

default CompletableFuture<DeleteApplicationReferenceDataSourceResponse> deleteApplicationReferenceDataSource(DeleteApplicationReferenceDataSourceRequest deleteApplicationReferenceDataSourceRequest)

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.

Parameters:

deleteApplicationReferenceDataSourceRequest -

Returns:

A Java Future containing the result of the DeleteApplicationReferenceDataSource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ResourceNotFoundException Specified application can't be found.
• ResourceInUseException Application is not available for this operation.
• InvalidArgumentException Specified input parameter value is invalid.
• ConcurrentModificationException 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• KinesisAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

describeApplication

default CompletableFuture<DescribeApplicationResponse> describeApplication(DescribeApplicationRequest describeApplicationRequest)

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.

Parameters:

describeApplicationRequest -

Returns:

A Java Future containing the result of the DescribeApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ResourceNotFoundException Specified application can't be found.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• KinesisAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

discoverInputSchema

default CompletableFuture<DiscoverInputSchemaResponse> discoverInputSchema(DiscoverInputSchemaRequest discoverInputSchemaRequest)

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.

Parameters:

discoverInputSchemaRequest -

Returns:

A Java Future containing the result of the DiscoverInputSchema operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidArgumentException Specified input parameter value is invalid.
• UnableToDetectSchemaException Data format is not valid, Amazon Kinesis Analytics is not able to detect schema for the given streaming source.
• ResourceProvisionedThroughputExceededException 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• KinesisAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listApplications

default CompletableFuture<ListApplicationsResponse> listApplications(ListApplicationsRequest listApplicationsRequest)

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.

Parameters:

listApplicationsRequest -

Returns:

A Java Future containing the result of the ListApplications operation returned by the service.

See Also:

AWS API Documentation

startApplication

default CompletableFuture<StartApplicationResponse> startApplication(StartApplicationRequest startApplicationRequest)

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.

Parameters:

startApplicationRequest -

Returns:

A Java Future containing the result of the StartApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ResourceNotFoundException Specified application can't be found.
• ResourceInUseException Application is not available for this operation.
• InvalidArgumentException Specified input parameter value is invalid.
• InvalidApplicationConfigurationException User-provided application configuration is not valid.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• KinesisAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

stopApplication

default CompletableFuture<StopApplicationResponse> stopApplication(StopApplicationRequest stopApplicationRequest)

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.

Parameters:

stopApplicationRequest -

Returns:

A Java Future containing the result of the StopApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ResourceNotFoundException Specified application can't be found.
• ResourceInUseException Application is not available for this operation.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• KinesisAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

updateApplication

default CompletableFuture<UpdateApplicationResponse> updateApplication(UpdateApplicationRequest updateApplicationRequest)

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.

Parameters:

updateApplicationRequest -

Returns:

A Java Future containing the result of the UpdateApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• CodeValidationException User-provided application code (query) is invalid. This can be a simple syntax error.
• ResourceNotFoundException Specified application can't be found.
• ResourceInUseException Application is not available for this operation.
• InvalidArgumentException Specified input parameter value is invalid.
• ConcurrentModificationException 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• KinesisAnalyticsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation