@Generated(value="software.amazon.awssdk:codegen") public interface KinesisAnalyticsClient extends SdkClient
builder() method.
null| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default AddApplicationCloudWatchLoggingOptionResponse |
addApplicationCloudWatchLoggingOption(AddApplicationCloudWatchLoggingOptionRequest addApplicationCloudWatchLoggingOptionRequest)
Adds a CloudWatch log stream to monitor application configuration errors.
|
default AddApplicationCloudWatchLoggingOptionResponse |
addApplicationCloudWatchLoggingOption(Consumer<AddApplicationCloudWatchLoggingOptionRequest.Builder> addApplicationCloudWatchLoggingOptionRequest)
Adds a CloudWatch log stream to monitor application configuration errors.
|
default AddApplicationInputResponse |
addApplicationInput(AddApplicationInputRequest addApplicationInputRequest)
Adds a streaming source to your Amazon Kinesis application.
|
default AddApplicationInputResponse |
addApplicationInput(Consumer<AddApplicationInputRequest.Builder> addApplicationInputRequest)
Adds a streaming source to your Amazon Kinesis application.
|
default AddApplicationInputProcessingConfigurationResponse |
addApplicationInputProcessingConfiguration(AddApplicationInputProcessingConfigurationRequest addApplicationInputProcessingConfigurationRequest)
Adds an InputProcessingConfiguration to an application.
|
default AddApplicationInputProcessingConfigurationResponse |
addApplicationInputProcessingConfiguration(Consumer<AddApplicationInputProcessingConfigurationRequest.Builder> addApplicationInputProcessingConfigurationRequest)
Adds an InputProcessingConfiguration to an application.
|
default AddApplicationOutputResponse |
addApplicationOutput(AddApplicationOutputRequest addApplicationOutputRequest)
Adds an external destination to your Amazon Kinesis Analytics application.
|
default AddApplicationOutputResponse |
addApplicationOutput(Consumer<AddApplicationOutputRequest.Builder> addApplicationOutputRequest)
Adds an external destination to your Amazon Kinesis Analytics application.
|
default AddApplicationReferenceDataSourceResponse |
addApplicationReferenceDataSource(AddApplicationReferenceDataSourceRequest addApplicationReferenceDataSourceRequest)
Adds a reference data source to an existing application.
|
default AddApplicationReferenceDataSourceResponse |
addApplicationReferenceDataSource(Consumer<AddApplicationReferenceDataSourceRequest.Builder> addApplicationReferenceDataSourceRequest)
Adds a reference data source to an existing application.
|
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)
Creates an Amazon Kinesis Analytics application.
|
default CreateApplicationResponse |
createApplication(CreateApplicationRequest createApplicationRequest)
Creates an Amazon Kinesis Analytics application.
|
default DeleteApplicationResponse |
deleteApplication(Consumer<DeleteApplicationRequest.Builder> deleteApplicationRequest)
Deletes the specified application.
|
default DeleteApplicationResponse |
deleteApplication(DeleteApplicationRequest deleteApplicationRequest)
Deletes the specified application.
|
default DeleteApplicationCloudWatchLoggingOptionResponse |
deleteApplicationCloudWatchLoggingOption(Consumer<DeleteApplicationCloudWatchLoggingOptionRequest.Builder> deleteApplicationCloudWatchLoggingOptionRequest)
Deletes a CloudWatch log stream from an application.
|
default DeleteApplicationCloudWatchLoggingOptionResponse |
deleteApplicationCloudWatchLoggingOption(DeleteApplicationCloudWatchLoggingOptionRequest deleteApplicationCloudWatchLoggingOptionRequest)
Deletes a CloudWatch log stream from an application.
|
default DeleteApplicationInputProcessingConfigurationResponse |
deleteApplicationInputProcessingConfiguration(Consumer<DeleteApplicationInputProcessingConfigurationRequest.Builder> deleteApplicationInputProcessingConfigurationRequest)
Deletes an InputProcessingConfiguration from an input.
|
default DeleteApplicationInputProcessingConfigurationResponse |
deleteApplicationInputProcessingConfiguration(DeleteApplicationInputProcessingConfigurationRequest deleteApplicationInputProcessingConfigurationRequest)
Deletes an InputProcessingConfiguration from an input.
|
default DeleteApplicationOutputResponse |
deleteApplicationOutput(Consumer<DeleteApplicationOutputRequest.Builder> deleteApplicationOutputRequest)
Deletes output destination configuration from your application configuration.
|
default DeleteApplicationOutputResponse |
deleteApplicationOutput(DeleteApplicationOutputRequest deleteApplicationOutputRequest)
Deletes output destination configuration from your application configuration.
|
default DeleteApplicationReferenceDataSourceResponse |
deleteApplicationReferenceDataSource(Consumer<DeleteApplicationReferenceDataSourceRequest.Builder> deleteApplicationReferenceDataSourceRequest)
Deletes a reference data source configuration from the specified application configuration.
|
default DeleteApplicationReferenceDataSourceResponse |
deleteApplicationReferenceDataSource(DeleteApplicationReferenceDataSourceRequest deleteApplicationReferenceDataSourceRequest)
Deletes a reference data source configuration from the specified application configuration.
|
default DescribeApplicationResponse |
describeApplication(Consumer<DescribeApplicationRequest.Builder> describeApplicationRequest)
Returns information about a specific Amazon Kinesis Analytics application.
|
default DescribeApplicationResponse |
describeApplication(DescribeApplicationRequest describeApplicationRequest)
Returns information about a specific Amazon Kinesis Analytics application.
|
default DiscoverInputSchemaResponse |
discoverInputSchema(Consumer<DiscoverInputSchemaRequest.Builder> discoverInputSchemaRequest)
Infers a schema by evaluating sample records on the specified streaming source (Amazon Kinesis stream or Amazon
Kinesis Firehose delivery stream) or S3 object.
|
default 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) or S3 object.
|
default ListApplicationsResponse |
listApplications()
Returns a list of Amazon Kinesis Analytics applications in your account.
|
default ListApplicationsResponse |
listApplications(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest)
Returns a list of Amazon Kinesis Analytics applications in your account.
|
default ListApplicationsResponse |
listApplications(ListApplicationsRequest listApplicationsRequest)
Returns a list of Amazon Kinesis Analytics applications in your account.
|
static ServiceMetadata |
serviceMetadata() |
default StartApplicationResponse |
startApplication(Consumer<StartApplicationRequest.Builder> startApplicationRequest)
Starts the specified Amazon Kinesis Analytics application.
|
default StartApplicationResponse |
startApplication(StartApplicationRequest startApplicationRequest)
Starts the specified Amazon Kinesis Analytics application.
|
default StopApplicationResponse |
stopApplication(Consumer<StopApplicationRequest.Builder> stopApplicationRequest)
Stops the application from processing input data.
|
default StopApplicationResponse |
stopApplication(StopApplicationRequest stopApplicationRequest)
Stops the application from processing input data.
|
default UpdateApplicationResponse |
updateApplication(Consumer<UpdateApplicationRequest.Builder> updateApplicationRequest)
Updates an existing Amazon Kinesis Analytics application.
|
default UpdateApplicationResponse |
updateApplication(UpdateApplicationRequest updateApplicationRequest)
Updates an existing Amazon Kinesis Analytics application.
|
serviceNameclosestatic final String SERVICE_NAME
static KinesisAnalyticsClient create()
KinesisAnalyticsClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static KinesisAnalyticsClientBuilder builder()
KinesisAnalyticsClient.default AddApplicationCloudWatchLoggingOptionResponse addApplicationCloudWatchLoggingOption(AddApplicationCloudWatchLoggingOptionRequest addApplicationCloudWatchLoggingOptionRequest) throws ResourceNotFoundException, ResourceInUseException, InvalidArgumentException, ConcurrentModificationException, UnsupportedOperationException, AwsServiceException, SdkClientException, KinesisAnalyticsException
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.
addApplicationCloudWatchLoggingOptionRequest - 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.UnsupportedOperationExceptionSdkException - 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 type.AwsServiceExceptiondefault AddApplicationCloudWatchLoggingOptionResponse addApplicationCloudWatchLoggingOption(Consumer<AddApplicationCloudWatchLoggingOptionRequest.Builder> addApplicationCloudWatchLoggingOptionRequest) throws ResourceNotFoundException, ResourceInUseException, InvalidArgumentException, ConcurrentModificationException, UnsupportedOperationException, AwsServiceException, SdkClientException, KinesisAnalyticsException
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()
addApplicationCloudWatchLoggingOptionRequest - A Consumer that will call methods on AddApplicationCloudWatchLoggingOptionRequest.Builder
to create a request.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.UnsupportedOperationExceptionSdkException - 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 type.AwsServiceExceptiondefault AddApplicationInputResponse addApplicationInput(AddApplicationInputRequest addApplicationInputRequest) throws ResourceNotFoundException, ResourceInUseException, InvalidArgumentException, ConcurrentModificationException, CodeValidationException, UnsupportedOperationException, AwsServiceException, SdkClientException, KinesisAnalyticsException
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.
addApplicationInputRequest - 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.CodeValidationException - User-provided application code (query) is invalid. This can be a simple syntax error.UnsupportedOperationExceptionSdkException - 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 type.AwsServiceExceptiondefault AddApplicationInputResponse addApplicationInput(Consumer<AddApplicationInputRequest.Builder> addApplicationInputRequest) throws ResourceNotFoundException, ResourceInUseException, InvalidArgumentException, ConcurrentModificationException, CodeValidationException, UnsupportedOperationException, AwsServiceException, SdkClientException, KinesisAnalyticsException
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()
addApplicationInputRequest - A Consumer that will call methods on AddApplicationInputRequest.Builder to create a
request.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.CodeValidationException - User-provided application code (query) is invalid. This can be a simple syntax error.UnsupportedOperationExceptionSdkException - 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 type.AwsServiceExceptiondefault AddApplicationInputProcessingConfigurationResponse addApplicationInputProcessingConfiguration(AddApplicationInputProcessingConfigurationRequest addApplicationInputProcessingConfigurationRequest) throws ResourceNotFoundException, ResourceInUseException, InvalidArgumentException, ConcurrentModificationException, UnsupportedOperationException, AwsServiceException, SdkClientException, KinesisAnalyticsException
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.
addApplicationInputProcessingConfigurationRequest - 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.UnsupportedOperationExceptionSdkException - 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 type.AwsServiceExceptiondefault AddApplicationInputProcessingConfigurationResponse addApplicationInputProcessingConfiguration(Consumer<AddApplicationInputProcessingConfigurationRequest.Builder> addApplicationInputProcessingConfigurationRequest) throws ResourceNotFoundException, ResourceInUseException, InvalidArgumentException, ConcurrentModificationException, UnsupportedOperationException, AwsServiceException, SdkClientException, KinesisAnalyticsException
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()
addApplicationInputProcessingConfigurationRequest - A Consumer that will call methods on
AddApplicationInputProcessingConfigurationRequest.Builder to create a request.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.UnsupportedOperationExceptionSdkException - 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 type.AwsServiceExceptiondefault AddApplicationOutputResponse addApplicationOutput(AddApplicationOutputRequest addApplicationOutputRequest) throws ResourceNotFoundException, ResourceInUseException, InvalidArgumentException, ConcurrentModificationException, UnsupportedOperationException, AwsServiceException, SdkClientException, KinesisAnalyticsException
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.
addApplicationOutputRequest - 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.UnsupportedOperationExceptionSdkException - 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 type.AwsServiceExceptiondefault AddApplicationOutputResponse addApplicationOutput(Consumer<AddApplicationOutputRequest.Builder> addApplicationOutputRequest) throws ResourceNotFoundException, ResourceInUseException, InvalidArgumentException, ConcurrentModificationException, UnsupportedOperationException, AwsServiceException, SdkClientException, KinesisAnalyticsException
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()
addApplicationOutputRequest - A Consumer that will call methods on AddApplicationOutputRequest.Builder to create a
request.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.UnsupportedOperationExceptionSdkException - 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 type.AwsServiceExceptiondefault AddApplicationReferenceDataSourceResponse addApplicationReferenceDataSource(AddApplicationReferenceDataSourceRequest addApplicationReferenceDataSourceRequest) throws ResourceNotFoundException, ResourceInUseException, InvalidArgumentException, ConcurrentModificationException, UnsupportedOperationException, AwsServiceException, SdkClientException, KinesisAnalyticsException
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.
addApplicationReferenceDataSourceRequest - 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.UnsupportedOperationExceptionSdkException - 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 type.AwsServiceExceptiondefault AddApplicationReferenceDataSourceResponse addApplicationReferenceDataSource(Consumer<AddApplicationReferenceDataSourceRequest.Builder> addApplicationReferenceDataSourceRequest) throws ResourceNotFoundException, ResourceInUseException, InvalidArgumentException, ConcurrentModificationException, UnsupportedOperationException, AwsServiceException, SdkClientException, KinesisAnalyticsException
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()
addApplicationReferenceDataSourceRequest - A Consumer that will call methods on AddApplicationReferenceDataSourceRequest.Builder to
create a request.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.UnsupportedOperationExceptionSdkException - 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 type.AwsServiceExceptiondefault CreateApplicationResponse createApplication(CreateApplicationRequest createApplicationRequest) throws CodeValidationException, ResourceInUseException, LimitExceededException, InvalidArgumentException, AwsServiceException, SdkClientException, KinesisAnalyticsException
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.
createApplicationRequest - TBDCodeValidationException - 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.SdkException - 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 type.AwsServiceExceptiondefault CreateApplicationResponse createApplication(Consumer<CreateApplicationRequest.Builder> createApplicationRequest) throws CodeValidationException, ResourceInUseException, LimitExceededException, InvalidArgumentException, AwsServiceException, SdkClientException, KinesisAnalyticsException
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()
createApplicationRequest - A Consumer that will call methods on CreateApplicationRequest.Builder to create a request.
TBDCodeValidationException - 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.SdkException - 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 type.AwsServiceExceptiondefault DeleteApplicationResponse deleteApplication(DeleteApplicationRequest deleteApplicationRequest) throws ConcurrentModificationException, ResourceNotFoundException, ResourceInUseException, UnsupportedOperationException, AwsServiceException, SdkClientException, KinesisAnalyticsException
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.
deleteApplicationRequest - 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.UnsupportedOperationExceptionSdkException - 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 type.AwsServiceExceptiondefault DeleteApplicationResponse deleteApplication(Consumer<DeleteApplicationRequest.Builder> deleteApplicationRequest) throws ConcurrentModificationException, ResourceNotFoundException, ResourceInUseException, UnsupportedOperationException, AwsServiceException, SdkClientException, KinesisAnalyticsException
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()
deleteApplicationRequest - A Consumer that will call methods on DeleteApplicationRequest.Builder to create a request.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.UnsupportedOperationExceptionSdkException - 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 type.AwsServiceExceptiondefault DeleteApplicationCloudWatchLoggingOptionResponse deleteApplicationCloudWatchLoggingOption(DeleteApplicationCloudWatchLoggingOptionRequest deleteApplicationCloudWatchLoggingOptionRequest) throws ResourceNotFoundException, ResourceInUseException, InvalidArgumentException, ConcurrentModificationException, UnsupportedOperationException, AwsServiceException, SdkClientException, KinesisAnalyticsException
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.
deleteApplicationCloudWatchLoggingOptionRequest - 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.UnsupportedOperationExceptionSdkException - 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 type.AwsServiceExceptiondefault DeleteApplicationCloudWatchLoggingOptionResponse deleteApplicationCloudWatchLoggingOption(Consumer<DeleteApplicationCloudWatchLoggingOptionRequest.Builder> deleteApplicationCloudWatchLoggingOptionRequest) throws ResourceNotFoundException, ResourceInUseException, InvalidArgumentException, ConcurrentModificationException, UnsupportedOperationException, AwsServiceException, SdkClientException, KinesisAnalyticsException
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()
deleteApplicationCloudWatchLoggingOptionRequest - A Consumer that will call methods on
DeleteApplicationCloudWatchLoggingOptionRequest.Builder to create a request.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.UnsupportedOperationExceptionSdkException - 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 type.AwsServiceExceptiondefault DeleteApplicationInputProcessingConfigurationResponse deleteApplicationInputProcessingConfiguration(DeleteApplicationInputProcessingConfigurationRequest deleteApplicationInputProcessingConfigurationRequest) throws ResourceNotFoundException, ResourceInUseException, InvalidArgumentException, ConcurrentModificationException, UnsupportedOperationException, AwsServiceException, SdkClientException, KinesisAnalyticsException
Deletes an InputProcessingConfiguration from an input.
deleteApplicationInputProcessingConfigurationRequest - 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.UnsupportedOperationExceptionSdkException - 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 type.AwsServiceExceptiondefault DeleteApplicationInputProcessingConfigurationResponse deleteApplicationInputProcessingConfiguration(Consumer<DeleteApplicationInputProcessingConfigurationRequest.Builder> deleteApplicationInputProcessingConfigurationRequest) throws ResourceNotFoundException, ResourceInUseException, InvalidArgumentException, ConcurrentModificationException, UnsupportedOperationException, AwsServiceException, SdkClientException, KinesisAnalyticsException
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()
deleteApplicationInputProcessingConfigurationRequest - A Consumer that will call methods on
DeleteApplicationInputProcessingConfigurationRequest.Builder to create a request.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.UnsupportedOperationExceptionSdkException - 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 type.AwsServiceExceptiondefault DeleteApplicationOutputResponse deleteApplicationOutput(DeleteApplicationOutputRequest deleteApplicationOutputRequest) throws ResourceNotFoundException, ResourceInUseException, InvalidArgumentException, ConcurrentModificationException, UnsupportedOperationException, AwsServiceException, SdkClientException, KinesisAnalyticsException
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.
deleteApplicationOutputRequest - 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.UnsupportedOperationExceptionSdkException - 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 type.AwsServiceExceptiondefault DeleteApplicationOutputResponse deleteApplicationOutput(Consumer<DeleteApplicationOutputRequest.Builder> deleteApplicationOutputRequest) throws ResourceNotFoundException, ResourceInUseException, InvalidArgumentException, ConcurrentModificationException, UnsupportedOperationException, AwsServiceException, SdkClientException, KinesisAnalyticsException
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()
deleteApplicationOutputRequest - A Consumer that will call methods on DeleteApplicationOutputRequest.Builder to create a
request.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.UnsupportedOperationExceptionSdkException - 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 type.AwsServiceExceptiondefault DeleteApplicationReferenceDataSourceResponse deleteApplicationReferenceDataSource(DeleteApplicationReferenceDataSourceRequest deleteApplicationReferenceDataSourceRequest) throws ResourceNotFoundException, ResourceInUseException, InvalidArgumentException, ConcurrentModificationException, UnsupportedOperationException, AwsServiceException, SdkClientException, KinesisAnalyticsException
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.
deleteApplicationReferenceDataSourceRequest - 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.UnsupportedOperationExceptionSdkException - 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 type.AwsServiceExceptiondefault DeleteApplicationReferenceDataSourceResponse deleteApplicationReferenceDataSource(Consumer<DeleteApplicationReferenceDataSourceRequest.Builder> deleteApplicationReferenceDataSourceRequest) throws ResourceNotFoundException, ResourceInUseException, InvalidArgumentException, ConcurrentModificationException, UnsupportedOperationException, AwsServiceException, SdkClientException, KinesisAnalyticsException
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()
deleteApplicationReferenceDataSourceRequest - A Consumer that will call methods on DeleteApplicationReferenceDataSourceRequest.Builder
to create a request.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.UnsupportedOperationExceptionSdkException - 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 type.AwsServiceExceptiondefault DescribeApplicationResponse describeApplication(DescribeApplicationRequest describeApplicationRequest) throws ResourceNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, KinesisAnalyticsException
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.
describeApplicationRequest - ResourceNotFoundException - Specified application can't be found.UnsupportedOperationExceptionSdkException - 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 type.AwsServiceExceptiondefault DescribeApplicationResponse describeApplication(Consumer<DescribeApplicationRequest.Builder> describeApplicationRequest) throws ResourceNotFoundException, UnsupportedOperationException, AwsServiceException, SdkClientException, KinesisAnalyticsException
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()
describeApplicationRequest - A Consumer that will call methods on DescribeApplicationRequest.Builder to create a
request.ResourceNotFoundException - Specified application can't be found.UnsupportedOperationExceptionSdkException - 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 type.AwsServiceExceptiondefault DiscoverInputSchemaResponse discoverInputSchema(DiscoverInputSchemaRequest discoverInputSchemaRequest) throws InvalidArgumentException, UnableToDetectSchemaException, ResourceProvisionedThroughputExceededException, ServiceUnavailableException, AwsServiceException, SdkClientException, KinesisAnalyticsException
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.
discoverInputSchemaRequest - 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.ServiceUnavailableException - The service is unavailable. Back off and retry the operation.SdkException - 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 type.AwsServiceExceptiondefault DiscoverInputSchemaResponse discoverInputSchema(Consumer<DiscoverInputSchemaRequest.Builder> discoverInputSchemaRequest) throws InvalidArgumentException, UnableToDetectSchemaException, ResourceProvisionedThroughputExceededException, ServiceUnavailableException, AwsServiceException, SdkClientException, KinesisAnalyticsException
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()
discoverInputSchemaRequest - A Consumer that will call methods on DiscoverInputSchemaRequest.Builder to create a
request.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.ServiceUnavailableException - The service is unavailable. Back off and retry the operation.SdkException - 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 type.AwsServiceExceptiondefault ListApplicationsResponse listApplications() throws AwsServiceException, SdkClientException, KinesisAnalyticsException
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.
SdkException - 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 type.AwsServiceExceptionlistApplications(ListApplicationsRequest),
AWS API Documentationdefault ListApplicationsResponse listApplications(ListApplicationsRequest listApplicationsRequest) throws AwsServiceException, SdkClientException, KinesisAnalyticsException
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.
listApplicationsRequest - SdkException - 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 type.AwsServiceExceptiondefault ListApplicationsResponse listApplications(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest) throws AwsServiceException, SdkClientException, KinesisAnalyticsException
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()
listApplicationsRequest - A Consumer that will call methods on ListApplicationsRequest.Builder to create a request.SdkException - 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 type.AwsServiceExceptiondefault StartApplicationResponse startApplication(StartApplicationRequest startApplicationRequest) throws ResourceNotFoundException, ResourceInUseException, InvalidArgumentException, InvalidApplicationConfigurationException, UnsupportedOperationException, AwsServiceException, SdkClientException, KinesisAnalyticsException
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.
startApplicationRequest - 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.UnsupportedOperationExceptionSdkException - 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 type.AwsServiceExceptiondefault StartApplicationResponse startApplication(Consumer<StartApplicationRequest.Builder> startApplicationRequest) throws ResourceNotFoundException, ResourceInUseException, InvalidArgumentException, InvalidApplicationConfigurationException, UnsupportedOperationException, AwsServiceException, SdkClientException, KinesisAnalyticsException
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()
startApplicationRequest - A Consumer that will call methods on StartApplicationRequest.Builder to create a request.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.UnsupportedOperationExceptionSdkException - 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 type.AwsServiceExceptiondefault StopApplicationResponse stopApplication(StopApplicationRequest stopApplicationRequest) throws ResourceNotFoundException, ResourceInUseException, UnsupportedOperationException, AwsServiceException, SdkClientException, KinesisAnalyticsException
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.
stopApplicationRequest - ResourceNotFoundException - Specified application can't be found.ResourceInUseException - Application is not available for this operation.UnsupportedOperationExceptionSdkException - 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 type.AwsServiceExceptiondefault StopApplicationResponse stopApplication(Consumer<StopApplicationRequest.Builder> stopApplicationRequest) throws ResourceNotFoundException, ResourceInUseException, UnsupportedOperationException, AwsServiceException, SdkClientException, KinesisAnalyticsException
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()
stopApplicationRequest - A Consumer that will call methods on StopApplicationRequest.Builder to create a request.ResourceNotFoundException - Specified application can't be found.ResourceInUseException - Application is not available for this operation.UnsupportedOperationExceptionSdkException - 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 type.AwsServiceExceptiondefault UpdateApplicationResponse updateApplication(UpdateApplicationRequest updateApplicationRequest) throws CodeValidationException, ResourceNotFoundException, ResourceInUseException, InvalidArgumentException, ConcurrentModificationException, UnsupportedOperationException, AwsServiceException, SdkClientException, KinesisAnalyticsException
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.
updateApplicationRequest - 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.UnsupportedOperationExceptionSdkException - 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 type.AwsServiceExceptiondefault UpdateApplicationResponse updateApplication(Consumer<UpdateApplicationRequest.Builder> updateApplicationRequest) throws CodeValidationException, ResourceNotFoundException, ResourceInUseException, InvalidArgumentException, ConcurrentModificationException, UnsupportedOperationException, AwsServiceException, SdkClientException, KinesisAnalyticsException
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()
updateApplicationRequest - A Consumer that will call methods on UpdateApplicationRequest.Builder to create a request.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.UnsupportedOperationExceptionSdkException - 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 type.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.