Package software.amazon.awssdk.services.kinesisanalytics

Interface KinesisAnalyticsClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface KinesisAnalyticsClient
extends AwsClient

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

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.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
default AddApplicationCloudWatchLoggingOptionResponse	addApplicationCloudWatchLoggingOption(Consumer<AddApplicationCloudWatchLoggingOptionRequest.Builder> addApplicationCloudWatchLoggingOptionRequest)
default AddApplicationCloudWatchLoggingOptionResponse	addApplicationCloudWatchLoggingOption(AddApplicationCloudWatchLoggingOptionRequest addApplicationCloudWatchLoggingOptionRequest)
default AddApplicationInputResponse	addApplicationInput(Consumer<AddApplicationInputRequest.Builder> addApplicationInputRequest)
default AddApplicationInputResponse	addApplicationInput(AddApplicationInputRequest addApplicationInputRequest)
default AddApplicationInputProcessingConfigurationResponse	addApplicationInputProcessingConfiguration(Consumer<AddApplicationInputProcessingConfigurationRequest.Builder> addApplicationInputProcessingConfigurationRequest)
default AddApplicationInputProcessingConfigurationResponse	addApplicationInputProcessingConfiguration(AddApplicationInputProcessingConfigurationRequest addApplicationInputProcessingConfigurationRequest)
default AddApplicationOutputResponse	addApplicationOutput(Consumer<AddApplicationOutputRequest.Builder> addApplicationOutputRequest)
default AddApplicationOutputResponse	addApplicationOutput(AddApplicationOutputRequest addApplicationOutputRequest)
default AddApplicationReferenceDataSourceResponse	addApplicationReferenceDataSource(Consumer<AddApplicationReferenceDataSourceRequest.Builder> addApplicationReferenceDataSourceRequest)
default AddApplicationReferenceDataSourceResponse	addApplicationReferenceDataSource(AddApplicationReferenceDataSourceRequest addApplicationReferenceDataSourceRequest)
static KinesisAnalyticsClientBuilder	builder()	Create a builder that can be used to configure and create a KinesisAnalyticsClient.
static KinesisAnalyticsClient	create()	Create a KinesisAnalyticsClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateApplicationResponse	createApplication(Consumer<CreateApplicationRequest.Builder> createApplicationRequest)
default CreateApplicationResponse	createApplication(CreateApplicationRequest createApplicationRequest)
default DeleteApplicationResponse	deleteApplication(Consumer<DeleteApplicationRequest.Builder> deleteApplicationRequest)
default DeleteApplicationResponse	deleteApplication(DeleteApplicationRequest deleteApplicationRequest)
default DeleteApplicationCloudWatchLoggingOptionResponse	deleteApplicationCloudWatchLoggingOption(Consumer<DeleteApplicationCloudWatchLoggingOptionRequest.Builder> deleteApplicationCloudWatchLoggingOptionRequest)
default DeleteApplicationCloudWatchLoggingOptionResponse	deleteApplicationCloudWatchLoggingOption(DeleteApplicationCloudWatchLoggingOptionRequest deleteApplicationCloudWatchLoggingOptionRequest)
default DeleteApplicationInputProcessingConfigurationResponse	deleteApplicationInputProcessingConfiguration(Consumer<DeleteApplicationInputProcessingConfigurationRequest.Builder> deleteApplicationInputProcessingConfigurationRequest)
default DeleteApplicationInputProcessingConfigurationResponse	deleteApplicationInputProcessingConfiguration(DeleteApplicationInputProcessingConfigurationRequest deleteApplicationInputProcessingConfigurationRequest)
default DeleteApplicationOutputResponse	deleteApplicationOutput(Consumer<DeleteApplicationOutputRequest.Builder> deleteApplicationOutputRequest)
default DeleteApplicationOutputResponse	deleteApplicationOutput(DeleteApplicationOutputRequest deleteApplicationOutputRequest)
default DeleteApplicationReferenceDataSourceResponse	deleteApplicationReferenceDataSource(Consumer<DeleteApplicationReferenceDataSourceRequest.Builder> deleteApplicationReferenceDataSourceRequest)
default DeleteApplicationReferenceDataSourceResponse	deleteApplicationReferenceDataSource(DeleteApplicationReferenceDataSourceRequest deleteApplicationReferenceDataSourceRequest)
default DescribeApplicationResponse	describeApplication(Consumer<DescribeApplicationRequest.Builder> describeApplicationRequest)
default DescribeApplicationResponse	describeApplication(DescribeApplicationRequest describeApplicationRequest)
default DiscoverInputSchemaResponse	discoverInputSchema(Consumer<DiscoverInputSchemaRequest.Builder> discoverInputSchemaRequest)
default DiscoverInputSchemaResponse	discoverInputSchema(DiscoverInputSchemaRequest discoverInputSchemaRequest)
default ListApplicationsResponse	listApplications()
default ListApplicationsResponse	listApplications(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest)
default ListApplicationsResponse	listApplications(ListApplicationsRequest listApplicationsRequest)
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Retrieves the list of key-value tags assigned to the application.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Retrieves the list of key-value tags assigned to the application.
default KinesisAnalyticsServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default StartApplicationResponse	startApplication(Consumer<StartApplicationRequest.Builder> startApplicationRequest)
default StartApplicationResponse	startApplication(StartApplicationRequest startApplicationRequest)
default StopApplicationResponse	stopApplication(Consumer<StopApplicationRequest.Builder> stopApplicationRequest)
default StopApplicationResponse	stopApplication(StopApplicationRequest stopApplicationRequest)
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Adds one or more key-value tags to a Kinesis Analytics application.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Adds one or more key-value tags to a Kinesis Analytics application.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Removes one or more tags from a Kinesis Analytics application.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Removes one or more tags from a Kinesis Analytics application.
default UpdateApplicationResponse	updateApplication(Consumer<UpdateApplicationRequest.Builder> updateApplicationRequest)
default UpdateApplicationResponse	updateApplication(UpdateApplicationRequest updateApplicationRequest)

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

addApplicationCloudWatchLoggingOption

default AddApplicationCloudWatchLoggingOptionResponse addApplicationCloudWatchLoggingOption(AddApplicationCloudWatchLoggingOptionRequest addApplicationCloudWatchLoggingOptionRequest)
                                                                                     throws ResourceNotFoundException,
ResourceInUseException,
InvalidArgumentException,
ConcurrentModificationException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
KinesisAnalyticsException

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.

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.

Parameters:

addApplicationCloudWatchLoggingOptionRequest -

Returns:

Result of the AddApplicationCloudWatchLoggingOption operation returned by the service.

See Also:

• AWS API Documentation

addApplicationCloudWatchLoggingOption

default AddApplicationCloudWatchLoggingOptionResponse addApplicationCloudWatchLoggingOption(Consumer<AddApplicationCloudWatchLoggingOptionRequest.Builder> addApplicationCloudWatchLoggingOptionRequest)
                                                                                     throws ResourceNotFoundException,
ResourceInUseException,
InvalidArgumentException,
ConcurrentModificationException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
KinesisAnalyticsException

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.

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.

This is a convenience which creates an instance of the AddApplicationCloudWatchLoggingOptionRequest.Builder avoiding the need to create one manually via AddApplicationCloudWatchLoggingOptionRequest.builder()

Parameters:

addApplicationCloudWatchLoggingOptionRequest - A Consumer that will call methods on AddApplicationCloudWatchLoggingOptionRequest.Builder to create a request.

Returns:

Result of the AddApplicationCloudWatchLoggingOption operation returned by the service.

See Also:

• AWS API Documentation

addApplicationInput

default AddApplicationInputResponse addApplicationInput(AddApplicationInputRequest addApplicationInputRequest)
                                                 throws ResourceNotFoundException,
ResourceInUseException,
InvalidArgumentException,
ConcurrentModificationException,
CodeValidationException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
KinesisAnalyticsException

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.

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:

Result of the AddApplicationInput operation returned by the service.

See Also:

• AWS API Documentation

addApplicationInput

default AddApplicationInputResponse addApplicationInput(Consumer<AddApplicationInputRequest.Builder> addApplicationInputRequest)
                                                 throws ResourceNotFoundException,
ResourceInUseException,
InvalidArgumentException,
ConcurrentModificationException,
CodeValidationException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
KinesisAnalyticsException

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.

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.

This is a convenience which creates an instance of the AddApplicationInputRequest.Builder avoiding the need to create one manually via AddApplicationInputRequest.builder()

Parameters:

addApplicationInputRequest - A Consumer that will call methods on AddApplicationInputRequest.Builder to create a request.

Returns:

Result of the AddApplicationInput operation returned by the service.

See Also:

• AWS API Documentation

addApplicationInputProcessingConfiguration

default AddApplicationInputProcessingConfigurationResponse addApplicationInputProcessingConfiguration(AddApplicationInputProcessingConfigurationRequest addApplicationInputProcessingConfigurationRequest)
                                                                                               throws ResourceNotFoundException,
ResourceInUseException,
InvalidArgumentException,
ConcurrentModificationException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
KinesisAnalyticsException

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.

Adds an InputProcessingConfiguration 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 AWS Lambda.

Parameters:

addApplicationInputProcessingConfigurationRequest -

Returns:

Result of the AddApplicationInputProcessingConfiguration operation returned by the service.

See Also:

• AWS API Documentation

addApplicationInputProcessingConfiguration

default AddApplicationInputProcessingConfigurationResponse addApplicationInputProcessingConfiguration(Consumer<AddApplicationInputProcessingConfigurationRequest.Builder> addApplicationInputProcessingConfigurationRequest)
                                                                                               throws ResourceNotFoundException,
ResourceInUseException,
InvalidArgumentException,
ConcurrentModificationException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
KinesisAnalyticsException

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.

Adds an InputProcessingConfiguration 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 AWS Lambda.

This is a convenience which creates an instance of the AddApplicationInputProcessingConfigurationRequest.Builder avoiding the need to create one manually via AddApplicationInputProcessingConfigurationRequest.builder()

Parameters:

addApplicationInputProcessingConfigurationRequest - A Consumer that will call methods on AddApplicationInputProcessingConfigurationRequest.Builder to create a request.

Returns:

Result of the AddApplicationInputProcessingConfiguration operation returned by the service.

See Also:

• AWS API Documentation

addApplicationOutput

default AddApplicationOutputResponse addApplicationOutput(AddApplicationOutputRequest addApplicationOutputRequest)
                                                   throws ResourceNotFoundException,
ResourceInUseException,
InvalidArgumentException,
ConcurrentModificationException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
KinesisAnalyticsException

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.

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

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 more information, see Understanding Application Output (Destination).

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:

Result of the AddApplicationOutput operation returned by the service.

See Also:

• AWS API Documentation

addApplicationOutput

default AddApplicationOutputResponse addApplicationOutput(Consumer<AddApplicationOutputRequest.Builder> addApplicationOutputRequest)
                                                   throws ResourceNotFoundException,
ResourceInUseException,
InvalidArgumentException,
ConcurrentModificationException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
KinesisAnalyticsException

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.

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

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 more information, see Understanding Application Output (Destination).

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.

This is a convenience which creates an instance of the AddApplicationOutputRequest.Builder avoiding the need to create one manually via AddApplicationOutputRequest.builder()

Parameters:

addApplicationOutputRequest - A Consumer that will call methods on AddApplicationOutputRequest.Builder to create a request.

Returns:

Result of the AddApplicationOutput operation returned by the service.

See Also:

• AWS API Documentation

addApplicationReferenceDataSource

default AddApplicationReferenceDataSourceResponse addApplicationReferenceDataSource(AddApplicationReferenceDataSourceRequest addApplicationReferenceDataSourceRequest)
                                                                             throws ResourceNotFoundException,
ResourceInUseException,
InvalidArgumentException,
ConcurrentModificationException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
KinesisAnalyticsException

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.

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:

Result of the AddApplicationReferenceDataSource operation returned by the service.

See Also:

• AWS API Documentation

addApplicationReferenceDataSource

default AddApplicationReferenceDataSourceResponse addApplicationReferenceDataSource(Consumer<AddApplicationReferenceDataSourceRequest.Builder> addApplicationReferenceDataSourceRequest)
                                                                             throws ResourceNotFoundException,
ResourceInUseException,
InvalidArgumentException,
ConcurrentModificationException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
KinesisAnalyticsException

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.

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.

This is a convenience which creates an instance of the AddApplicationReferenceDataSourceRequest.Builder avoiding the need to create one manually via AddApplicationReferenceDataSourceRequest.builder()

Parameters:

addApplicationReferenceDataSourceRequest - A Consumer that will call methods on AddApplicationReferenceDataSourceRequest.Builder to create a request.

Returns:

Result of the AddApplicationReferenceDataSource operation returned by the service.

See Also:

• AWS API Documentation

createApplication

default CreateApplicationResponse createApplication(CreateApplicationRequest createApplicationRequest)
                                             throws CodeValidationException,
ResourceInUseException,
LimitExceededException,
InvalidArgumentException,
TooManyTagsException,
ConcurrentModificationException,
AwsServiceException,
SdkClientException,
KinesisAnalyticsException

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.

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

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

Parameters:

createApplicationRequest - TBD

Returns:

Result of the CreateApplication operation returned by the service.

See Also:

• AWS API Documentation

createApplication

default CreateApplicationResponse createApplication(Consumer<CreateApplicationRequest.Builder> createApplicationRequest)
                                             throws CodeValidationException,
ResourceInUseException,
LimitExceededException,
InvalidArgumentException,
TooManyTagsException,
ConcurrentModificationException,
AwsServiceException,
SdkClientException,
KinesisAnalyticsException

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.

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

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

This is a convenience which creates an instance of the CreateApplicationRequest.Builder avoiding the need to create one manually via CreateApplicationRequest.builder()

Parameters:

createApplicationRequest - A Consumer that will call methods on CreateApplicationRequest.Builder to create a request. TBD

Returns:

Result of the CreateApplication operation returned by the service.

See Also:

• AWS API Documentation

deleteApplication

default DeleteApplicationResponse deleteApplication(DeleteApplicationRequest deleteApplicationRequest)
                                             throws ConcurrentModificationException,
ResourceNotFoundException,
ResourceInUseException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
KinesisAnalyticsException

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.

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:

Result of the DeleteApplication operation returned by the service.

See Also:

• AWS API Documentation

deleteApplication

default DeleteApplicationResponse deleteApplication(Consumer<DeleteApplicationRequest.Builder> deleteApplicationRequest)
                                             throws ConcurrentModificationException,
ResourceNotFoundException,
ResourceInUseException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
KinesisAnalyticsException

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.

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.

This is a convenience which creates an instance of the DeleteApplicationRequest.Builder avoiding the need to create one manually via DeleteApplicationRequest.builder()

Parameters:

deleteApplicationRequest - A Consumer that will call methods on DeleteApplicationRequest.Builder to create a request.

Returns:

Result of the DeleteApplication operation returned by the service.

See Also:

• AWS API Documentation

deleteApplicationCloudWatchLoggingOption

default DeleteApplicationCloudWatchLoggingOptionResponse deleteApplicationCloudWatchLoggingOption(DeleteApplicationCloudWatchLoggingOptionRequest deleteApplicationCloudWatchLoggingOptionRequest)
                                                                                           throws ResourceNotFoundException,
ResourceInUseException,
InvalidArgumentException,
ConcurrentModificationException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
KinesisAnalyticsException

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.

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.

Parameters:

deleteApplicationCloudWatchLoggingOptionRequest -

Returns:

Result of the DeleteApplicationCloudWatchLoggingOption operation returned by the service.

See Also:

• AWS API Documentation

deleteApplicationCloudWatchLoggingOption

default DeleteApplicationCloudWatchLoggingOptionResponse deleteApplicationCloudWatchLoggingOption(Consumer<DeleteApplicationCloudWatchLoggingOptionRequest.Builder> deleteApplicationCloudWatchLoggingOptionRequest)
                                                                                           throws ResourceNotFoundException,
ResourceInUseException,
InvalidArgumentException,
ConcurrentModificationException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
KinesisAnalyticsException

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.

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.

This is a convenience which creates an instance of the DeleteApplicationCloudWatchLoggingOptionRequest.Builder avoiding the need to create one manually via DeleteApplicationCloudWatchLoggingOptionRequest.builder()

Parameters:

deleteApplicationCloudWatchLoggingOptionRequest - A Consumer that will call methods on DeleteApplicationCloudWatchLoggingOptionRequest.Builder to create a request.

Returns:

Result of the DeleteApplicationCloudWatchLoggingOption operation returned by the service.

See Also:

• AWS API Documentation

deleteApplicationInputProcessingConfiguration

default DeleteApplicationInputProcessingConfigurationResponse deleteApplicationInputProcessingConfiguration(DeleteApplicationInputProcessingConfigurationRequest deleteApplicationInputProcessingConfigurationRequest)
                                                                                                     throws ResourceNotFoundException,
ResourceInUseException,
InvalidArgumentException,
ConcurrentModificationException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
KinesisAnalyticsException

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.

Deletes an InputProcessingConfiguration from an input.

Parameters:

deleteApplicationInputProcessingConfigurationRequest -

Returns:

Result of the DeleteApplicationInputProcessingConfiguration operation returned by the service.

See Also:

• AWS API Documentation

deleteApplicationInputProcessingConfiguration

default DeleteApplicationInputProcessingConfigurationResponse deleteApplicationInputProcessingConfiguration(Consumer<DeleteApplicationInputProcessingConfigurationRequest.Builder> deleteApplicationInputProcessingConfigurationRequest)
                                                                                                     throws ResourceNotFoundException,
ResourceInUseException,
InvalidArgumentException,
ConcurrentModificationException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
KinesisAnalyticsException

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.

Deletes an InputProcessingConfiguration from an input.

This is a convenience which creates an instance of the DeleteApplicationInputProcessingConfigurationRequest.Builder avoiding the need to create one manually via DeleteApplicationInputProcessingConfigurationRequest.builder()

Parameters:

deleteApplicationInputProcessingConfigurationRequest - A Consumer that will call methods on DeleteApplicationInputProcessingConfigurationRequest.Builder to create a request.

Returns:

Result of the DeleteApplicationInputProcessingConfiguration operation returned by the service.

See Also:

• AWS API Documentation

deleteApplicationOutput

default DeleteApplicationOutputResponse deleteApplicationOutput(DeleteApplicationOutputRequest deleteApplicationOutputRequest)
                                                         throws ResourceNotFoundException,
ResourceInUseException,
InvalidArgumentException,
ConcurrentModificationException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
KinesisAnalyticsException

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.

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:

Result of the DeleteApplicationOutput operation returned by the service.

See Also:

• AWS API Documentation

deleteApplicationOutput

default DeleteApplicationOutputResponse deleteApplicationOutput(Consumer<DeleteApplicationOutputRequest.Builder> deleteApplicationOutputRequest)
                                                         throws ResourceNotFoundException,
ResourceInUseException,
InvalidArgumentException,
ConcurrentModificationException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
KinesisAnalyticsException

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.

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.

This is a convenience which creates an instance of the DeleteApplicationOutputRequest.Builder avoiding the need to create one manually via DeleteApplicationOutputRequest.builder()

Parameters:

deleteApplicationOutputRequest - A Consumer that will call methods on DeleteApplicationOutputRequest.Builder to create a request.

Returns:

Result of the DeleteApplicationOutput operation returned by the service.

See Also:

• AWS API Documentation

deleteApplicationReferenceDataSource

default DeleteApplicationReferenceDataSourceResponse deleteApplicationReferenceDataSource(DeleteApplicationReferenceDataSourceRequest deleteApplicationReferenceDataSourceRequest)
                                                                                   throws ResourceNotFoundException,
ResourceInUseException,
InvalidArgumentException,
ConcurrentModificationException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
KinesisAnalyticsException

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.

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:

Result of the DeleteApplicationReferenceDataSource operation returned by the service.

See Also:

• AWS API Documentation

deleteApplicationReferenceDataSource

default DeleteApplicationReferenceDataSourceResponse deleteApplicationReferenceDataSource(Consumer<DeleteApplicationReferenceDataSourceRequest.Builder> deleteApplicationReferenceDataSourceRequest)
                                                                                   throws ResourceNotFoundException,
ResourceInUseException,
InvalidArgumentException,
ConcurrentModificationException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
KinesisAnalyticsException

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.

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.

This is a convenience which creates an instance of the DeleteApplicationReferenceDataSourceRequest.Builder avoiding the need to create one manually via DeleteApplicationReferenceDataSourceRequest.builder()

Parameters:

deleteApplicationReferenceDataSourceRequest - A Consumer that will call methods on DeleteApplicationReferenceDataSourceRequest.Builder to create a request.

Returns:

Result of the DeleteApplicationReferenceDataSource operation returned by the service.

See Also:

• AWS API Documentation

describeApplication

default DescribeApplicationResponse describeApplication(DescribeApplicationRequest describeApplicationRequest)
                                                 throws ResourceNotFoundException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
KinesisAnalyticsException

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.

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:

Result of the DescribeApplication operation returned by the service.

See Also:

• AWS API Documentation

describeApplication

default DescribeApplicationResponse describeApplication(Consumer<DescribeApplicationRequest.Builder> describeApplicationRequest)
                                                 throws ResourceNotFoundException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
KinesisAnalyticsException

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.

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.

This is a convenience which creates an instance of the DescribeApplicationRequest.Builder avoiding the need to create one manually via DescribeApplicationRequest.builder()

Parameters:

describeApplicationRequest - A Consumer that will call methods on DescribeApplicationRequest.Builder to create a request.

Returns:

Result of the DescribeApplication operation returned by the service.

See Also:

• AWS API Documentation

discoverInputSchema

default DiscoverInputSchemaResponse discoverInputSchema(DiscoverInputSchemaRequest discoverInputSchemaRequest)
                                                 throws InvalidArgumentException,
UnableToDetectSchemaException,
ResourceProvisionedThroughputExceededException,
ServiceUnavailableException,
AwsServiceException,
SdkClientException,
KinesisAnalyticsException

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.

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

Result of the DiscoverInputSchema operation returned by the service.

See Also:

• AWS API Documentation

discoverInputSchema

default DiscoverInputSchemaResponse discoverInputSchema(Consumer<DiscoverInputSchemaRequest.Builder> discoverInputSchemaRequest)
                                                 throws InvalidArgumentException,
UnableToDetectSchemaException,
ResourceProvisionedThroughputExceededException,
ServiceUnavailableException,
AwsServiceException,
SdkClientException,
KinesisAnalyticsException

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.

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

This is a convenience which creates an instance of the DiscoverInputSchemaRequest.Builder avoiding the need to create one manually via DiscoverInputSchemaRequest.builder()

Parameters:

discoverInputSchemaRequest - A Consumer that will call methods on DiscoverInputSchemaRequest.Builder to create a request.

Returns:

Result of the DiscoverInputSchema operation returned by the service.

See Also:

• AWS API Documentation

listApplications

default ListApplicationsResponse listApplications(ListApplicationsRequest listApplicationsRequest)
                                           throws AwsServiceException,
SdkClientException,
KinesisAnalyticsException

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.

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:

Result of the ListApplications operation returned by the service.

See Also:

• AWS API Documentation

listApplications

default ListApplicationsResponse listApplications(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest)
                                           throws AwsServiceException,
SdkClientException,
KinesisAnalyticsException

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.

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.

This is a convenience which creates an instance of the ListApplicationsRequest.Builder avoiding the need to create one manually via ListApplicationsRequest.builder()

Parameters:

listApplicationsRequest - A Consumer that will call methods on ListApplicationsRequest.Builder to create a request.

Returns:

Result of the ListApplications operation returned by the service.

See Also:

• AWS API Documentation

listApplications

default ListApplicationsResponse listApplications()
                                           throws AwsServiceException,
SdkClientException,
KinesisAnalyticsException

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.

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.

Returns:

Result of the ListApplications operation returned by the service.

See Also:

• listApplications(ListApplicationsRequest)
• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws ResourceNotFoundException,
InvalidArgumentException,
ConcurrentModificationException,
AwsServiceException,
SdkClientException,
KinesisAnalyticsException

Retrieves the list of key-value tags assigned to the application. For more information, see Using Tagging.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws ResourceNotFoundException,
InvalidArgumentException,
ConcurrentModificationException,
AwsServiceException,
SdkClientException,
KinesisAnalyticsException

Retrieves the list of key-value tags assigned to the application. For more information, see Using Tagging.

This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

startApplication

default StartApplicationResponse startApplication(StartApplicationRequest startApplicationRequest)
                                           throws ResourceNotFoundException,
ResourceInUseException,
InvalidArgumentException,
InvalidApplicationConfigurationException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
KinesisAnalyticsException

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.

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:

Result of the StartApplication operation returned by the service.

See Also:

• AWS API Documentation

startApplication

default StartApplicationResponse startApplication(Consumer<StartApplicationRequest.Builder> startApplicationRequest)
                                           throws ResourceNotFoundException,
ResourceInUseException,
InvalidArgumentException,
InvalidApplicationConfigurationException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
KinesisAnalyticsException

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.

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.

This is a convenience which creates an instance of the StartApplicationRequest.Builder avoiding the need to create one manually via StartApplicationRequest.builder()

Parameters:

startApplicationRequest - A Consumer that will call methods on StartApplicationRequest.Builder to create a request.

Returns:

Result of the StartApplication operation returned by the service.

See Also:

• AWS API Documentation

stopApplication

default StopApplicationResponse stopApplication(StopApplicationRequest stopApplicationRequest)
                                         throws ResourceNotFoundException,
ResourceInUseException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
KinesisAnalyticsException

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.

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:

Result of the StopApplication operation returned by the service.

See Also:

• AWS API Documentation

stopApplication

default StopApplicationResponse stopApplication(Consumer<StopApplicationRequest.Builder> stopApplicationRequest)
                                         throws ResourceNotFoundException,
ResourceInUseException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
KinesisAnalyticsException

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.

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.

This is a convenience which creates an instance of the StopApplicationRequest.Builder avoiding the need to create one manually via StopApplicationRequest.builder()

Parameters:

stopApplicationRequest - A Consumer that will call methods on StopApplicationRequest.Builder to create a request.

Returns:

Result of the StopApplication operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws ResourceNotFoundException,
ResourceInUseException,
TooManyTagsException,
InvalidArgumentException,
ConcurrentModificationException,
AwsServiceException,
SdkClientException,
KinesisAnalyticsException

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.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws ResourceNotFoundException,
ResourceInUseException,
TooManyTagsException,
InvalidArgumentException,
ConcurrentModificationException,
AwsServiceException,
SdkClientException,
KinesisAnalyticsException

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.

This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws ResourceNotFoundException,
ResourceInUseException,
TooManyTagsException,
InvalidArgumentException,
ConcurrentModificationException,
AwsServiceException,
SdkClientException,
KinesisAnalyticsException

Removes one or more tags from a Kinesis Analytics application. For more information, see Using Tagging.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws ResourceNotFoundException,
ResourceInUseException,
TooManyTagsException,
InvalidArgumentException,
ConcurrentModificationException,
AwsServiceException,
SdkClientException,
KinesisAnalyticsException

Removes one or more tags from a Kinesis Analytics application. For more information, see Using Tagging.

This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

updateApplication

default UpdateApplicationResponse updateApplication(UpdateApplicationRequest updateApplicationRequest)
                                             throws CodeValidationException,
ResourceNotFoundException,
ResourceInUseException,
InvalidArgumentException,
ConcurrentModificationException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
KinesisAnalyticsException

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.

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:

Result of the UpdateApplication operation returned by the service.

See Also:

• AWS API Documentation

updateApplication

default UpdateApplicationResponse updateApplication(Consumer<UpdateApplicationRequest.Builder> updateApplicationRequest)
                                             throws CodeValidationException,
ResourceNotFoundException,
ResourceInUseException,
InvalidArgumentException,
ConcurrentModificationException,
UnsupportedOperationException,
AwsServiceException,
SdkClientException,
KinesisAnalyticsException

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.

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.

This is a convenience which creates an instance of the UpdateApplicationRequest.Builder avoiding the need to create one manually via UpdateApplicationRequest.builder()

Parameters:

updateApplicationRequest - A Consumer that will call methods on UpdateApplicationRequest.Builder to create a request.

Returns:

Result of the UpdateApplication operation returned by the service.

See Also:

• AWS API Documentation

create

static KinesisAnalyticsClient create()

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

builder

static KinesisAnalyticsClientBuilder builder()

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

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default KinesisAnalyticsServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration