/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.kinesisanalyticsv2; import javax.annotation.Generated; import com.amazonaws.*; import com.amazonaws.regions.*; import com.amazonaws.services.kinesisanalyticsv2.model.*; /** * Interface for accessing Kinesis Analytics V2. *

* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.kinesisanalyticsv2.AbstractAmazonKinesisAnalyticsV2} instead. *

*

*

* Amazon Kinesis Data Analytics is a fully managed service that you can use to process and analyze streaming data using * Java, SQL, or Scala. The service enables you to quickly author and run Java, SQL, or Scala code against streaming * sources to perform time series analytics, feed real-time dashboards, and create real-time metrics. *

*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AmazonKinesisAnalyticsV2 { /** * The region metadata service name for computing region endpoints. You can use this value to retrieve metadata * (such as supported regions) of the service. * * @see RegionUtils#getRegionsForService(String) */ String ENDPOINT_PREFIX = "kinesisanalytics"; /** *

* Adds an Amazon CloudWatch log stream to monitor application configuration errors. *

* * @param addApplicationCloudWatchLoggingOptionRequest * @return Result of the AddApplicationCloudWatchLoggingOption operation returned by the service. * @throws ResourceNotFoundException * Specified application can't be found. * @throws ResourceInUseException * The application is not available for this operation. * @throws InvalidArgumentException * The specified input parameter value is not valid. * @throws ConcurrentModificationException * Exception thrown as a result of concurrent modifications to an application. This error can be the result * of attempting to modify an application without using the current application ID. * @throws InvalidRequestException * The request JSON is not valid for the operation. * @throws InvalidApplicationConfigurationException * The user-provided application configuration is not valid. * @sample AmazonKinesisAnalyticsV2.AddApplicationCloudWatchLoggingOption * @see AWS API Documentation */ AddApplicationCloudWatchLoggingOptionResult addApplicationCloudWatchLoggingOption( AddApplicationCloudWatchLoggingOptionRequest addApplicationCloudWatchLoggingOptionRequest); /** *

* Adds a streaming source to your SQL-based Kinesis Data Analytics application. *

*

* You can add a streaming source 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. *

* * @param addApplicationInputRequest * @return Result of the AddApplicationInput operation returned by the service. * @throws ResourceNotFoundException * Specified application can't be found. * @throws ResourceInUseException * The application is not available for this operation. * @throws InvalidArgumentException * The specified input parameter value is not valid. * @throws ConcurrentModificationException * Exception thrown as a result of concurrent modifications to an application. This error can be the result * of attempting to modify an application without using the current application ID. * @throws CodeValidationException * The user-provided application code (query) is not valid. This can be a simple syntax error. * @throws InvalidRequestException * The request JSON is not valid for the operation. * @sample AmazonKinesisAnalyticsV2.AddApplicationInput * @see AWS API Documentation */ AddApplicationInputResult addApplicationInput(AddApplicationInputRequest addApplicationInputRequest); /** *

* Adds an InputProcessingConfiguration to a SQL-based Kinesis Data Analytics application. An input processor * pre-processes records on the input stream before the application's SQL code executes. Currently, the only input * processor available is Amazon Lambda. *

* * @param addApplicationInputProcessingConfigurationRequest * @return Result of the AddApplicationInputProcessingConfiguration operation returned by the service. * @throws ResourceNotFoundException * Specified application can't be found. * @throws ResourceInUseException * The application is not available for this operation. * @throws InvalidArgumentException * The specified input parameter value is not valid. * @throws ConcurrentModificationException * Exception thrown as a result of concurrent modifications to an application. This error can be the result * of attempting to modify an application without using the current application ID. * @throws InvalidRequestException * The request JSON is not valid for the operation. * @sample AmazonKinesisAnalyticsV2.AddApplicationInputProcessingConfiguration * @see AWS API Documentation */ AddApplicationInputProcessingConfigurationResult addApplicationInputProcessingConfiguration( AddApplicationInputProcessingConfigurationRequest addApplicationInputProcessingConfigurationRequest); /** *

* Adds an external destination to your SQL-based Kinesis Data Analytics application. *

*

* If you want Kinesis Data Analytics to deliver data from an in-application stream within your application to an * external destination (such as an Kinesis data stream, a Kinesis Data Firehose delivery stream, or an Amazon * Lambda function), you add the relevant configuration to your application using this operation. You can configure * one or more outputs for your application. Each output configuration maps an in-application stream and an external * destination. *

*

* You can use one of the output configurations to deliver data from your in-application error stream to an external * destination so that you can analyze the errors. *

*

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

* * @param addApplicationOutputRequest * @return Result of the AddApplicationOutput operation returned by the service. * @throws ResourceNotFoundException * Specified application can't be found. * @throws ResourceInUseException * The application is not available for this operation. * @throws InvalidArgumentException * The specified input parameter value is not valid. * @throws ConcurrentModificationException * Exception thrown as a result of concurrent modifications to an application. This error can be the result * of attempting to modify an application without using the current application ID. * @throws InvalidRequestException * The request JSON is not valid for the operation. * @sample AmazonKinesisAnalyticsV2.AddApplicationOutput * @see AWS API Documentation */ AddApplicationOutputResult addApplicationOutput(AddApplicationOutputRequest addApplicationOutputRequest); /** *

* Adds a reference data source to an existing SQL-based Kinesis Data Analytics application. *

*

* Kinesis Data 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 an Amazon S3 * object maps to columns in the resulting in-application table. *

* * @param addApplicationReferenceDataSourceRequest * @return Result of the AddApplicationReferenceDataSource operation returned by the service. * @throws ResourceNotFoundException * Specified application can't be found. * @throws ResourceInUseException * The application is not available for this operation. * @throws InvalidArgumentException * The specified input parameter value is not valid. * @throws ConcurrentModificationException * Exception thrown as a result of concurrent modifications to an application. This error can be the result * of attempting to modify an application without using the current application ID. * @throws InvalidRequestException * The request JSON is not valid for the operation. * @sample AmazonKinesisAnalyticsV2.AddApplicationReferenceDataSource * @see AWS API Documentation */ AddApplicationReferenceDataSourceResult addApplicationReferenceDataSource(AddApplicationReferenceDataSourceRequest addApplicationReferenceDataSourceRequest); /** *

* Adds a Virtual Private Cloud (VPC) configuration to the application. Applications can use VPCs to store and * access resources securely. *

*

* Note the following about VPC configurations for Kinesis Data Analytics applications: *

* * * @param addApplicationVpcConfigurationRequest * @return Result of the AddApplicationVpcConfiguration operation returned by the service. * @throws ResourceNotFoundException * Specified application can't be found. * @throws ResourceInUseException * The application is not available for this operation. * @throws InvalidArgumentException * The specified input parameter value is not valid. * @throws ConcurrentModificationException * Exception thrown as a result of concurrent modifications to an application. This error can be the result * of attempting to modify an application without using the current application ID. * @throws InvalidApplicationConfigurationException * The user-provided application configuration is not valid. * @sample AmazonKinesisAnalyticsV2.AddApplicationVpcConfiguration * @see AWS API Documentation */ AddApplicationVpcConfigurationResult addApplicationVpcConfiguration(AddApplicationVpcConfigurationRequest addApplicationVpcConfigurationRequest); /** *

* Creates a Kinesis Data Analytics application. For information about creating a Kinesis Data Analytics * application, see Creating * an Application. *

* * @param createApplicationRequest * @return Result of the CreateApplication operation returned by the service. * @throws CodeValidationException * The user-provided application code (query) is not valid. This can be a simple syntax error. * @throws ResourceInUseException * The application is not available for this operation. * @throws LimitExceededException * The number of allowed resources has been exceeded. * @throws InvalidArgumentException * The specified input parameter value is not valid. * @throws InvalidRequestException * The request JSON is not valid for the operation. * @throws TooManyTagsException * Application created with too many tags, or too many tags added to an application. Note that the maximum * number of application tags includes system tags. The maximum number of user-defined application tags is * 50. * @throws ConcurrentModificationException * Exception thrown as a result of concurrent modifications to an application. This error can be the result * of attempting to modify an application without using the current application ID. * @throws UnsupportedOperationException * The request was rejected because a specified parameter is not supported or a specified resource is not * valid for this operation. * @sample AmazonKinesisAnalyticsV2.CreateApplication * @see AWS API Documentation */ CreateApplicationResult createApplication(CreateApplicationRequest createApplicationRequest); /** *

* Creates and returns a URL that you can use to connect to an application's extension. *

*

* The IAM role or user used to call this API defines the permissions to access the extension. After the presigned * URL is created, no additional permission is required to access this URL. IAM authorization policies for this API * are also enforced for every HTTP request that attempts to connect to the extension. *

*

* You control the amount of time that the URL will be valid using the * SessionExpirationDurationInSeconds parameter. If you do not provide this parameter, the returned URL * is valid for twelve hours. *

* *

* The URL that you get from a call to CreateApplicationPresignedUrl must be used within 3 minutes to be valid. If * you first try to use the URL after the 3-minute limit expires, the service returns an HTTP 403 Forbidden error. *

*
* * @param createApplicationPresignedUrlRequest * @return Result of the CreateApplicationPresignedUrl operation returned by the service. * @throws ResourceNotFoundException * Specified application can't be found. * @throws ResourceInUseException * The application is not available for this operation. * @throws InvalidArgumentException * The specified input parameter value is not valid. * @sample AmazonKinesisAnalyticsV2.CreateApplicationPresignedUrl * @see AWS API Documentation */ CreateApplicationPresignedUrlResult createApplicationPresignedUrl(CreateApplicationPresignedUrlRequest createApplicationPresignedUrlRequest); /** *

* Creates a snapshot of the application's state data. *

* * @param createApplicationSnapshotRequest * @return Result of the CreateApplicationSnapshot operation returned by the service. * @throws ResourceInUseException * The application is not available for this operation. * @throws ResourceNotFoundException * Specified application can't be found. * @throws LimitExceededException * The number of allowed resources has been exceeded. * @throws InvalidArgumentException * The specified input parameter value is not valid. * @throws UnsupportedOperationException * The request was rejected because a specified parameter is not supported or a specified resource is not * valid for this operation. * @throws InvalidRequestException * The request JSON is not valid for the operation. * @throws InvalidApplicationConfigurationException * The user-provided application configuration is not valid. * @sample AmazonKinesisAnalyticsV2.CreateApplicationSnapshot * @see AWS API Documentation */ CreateApplicationSnapshotResult createApplicationSnapshot(CreateApplicationSnapshotRequest createApplicationSnapshotRequest); /** *

* Deletes the specified application. Kinesis Data Analytics halts application execution and deletes the * application. *

* * @param deleteApplicationRequest * @return Result of the DeleteApplication operation returned by the service. * @throws ConcurrentModificationException * Exception thrown as a result of concurrent modifications to an application. This error can be the result * of attempting to modify an application without using the current application ID. * @throws ResourceNotFoundException * Specified application can't be found. * @throws ResourceInUseException * The application is not available for this operation. * @throws InvalidArgumentException * The specified input parameter value is not valid. * @throws InvalidRequestException * The request JSON is not valid for the operation. * @throws InvalidApplicationConfigurationException * The user-provided application configuration is not valid. * @sample AmazonKinesisAnalyticsV2.DeleteApplication * @see AWS API Documentation */ DeleteApplicationResult deleteApplication(DeleteApplicationRequest deleteApplicationRequest); /** *

* Deletes an Amazon CloudWatch log stream from an Kinesis Data Analytics application. *

* * @param deleteApplicationCloudWatchLoggingOptionRequest * @return Result of the DeleteApplicationCloudWatchLoggingOption operation returned by the service. * @throws ResourceNotFoundException * Specified application can't be found. * @throws ResourceInUseException * The application is not available for this operation. * @throws InvalidArgumentException * The specified input parameter value is not valid. * @throws ConcurrentModificationException * Exception thrown as a result of concurrent modifications to an application. This error can be the result * of attempting to modify an application without using the current application ID. * @throws InvalidRequestException * The request JSON is not valid for the operation. * @throws InvalidApplicationConfigurationException * The user-provided application configuration is not valid. * @sample AmazonKinesisAnalyticsV2.DeleteApplicationCloudWatchLoggingOption * @see AWS API Documentation */ DeleteApplicationCloudWatchLoggingOptionResult deleteApplicationCloudWatchLoggingOption( DeleteApplicationCloudWatchLoggingOptionRequest deleteApplicationCloudWatchLoggingOptionRequest); /** *

* Deletes an InputProcessingConfiguration from an input. *

* * @param deleteApplicationInputProcessingConfigurationRequest * @return Result of the DeleteApplicationInputProcessingConfiguration operation returned by the service. * @throws ResourceNotFoundException * Specified application can't be found. * @throws ResourceInUseException * The application is not available for this operation. * @throws InvalidArgumentException * The specified input parameter value is not valid. * @throws ConcurrentModificationException * Exception thrown as a result of concurrent modifications to an application. This error can be the result * of attempting to modify an application without using the current application ID. * @throws InvalidRequestException * The request JSON is not valid for the operation. * @sample AmazonKinesisAnalyticsV2.DeleteApplicationInputProcessingConfiguration * @see AWS API Documentation */ DeleteApplicationInputProcessingConfigurationResult deleteApplicationInputProcessingConfiguration( DeleteApplicationInputProcessingConfigurationRequest deleteApplicationInputProcessingConfigurationRequest); /** *

* Deletes the output destination configuration from your SQL-based Kinesis Data Analytics application's * configuration. Kinesis Data Analytics will no longer write data from the corresponding in-application stream to * the external output destination. *

* * @param deleteApplicationOutputRequest * @return Result of the DeleteApplicationOutput operation returned by the service. * @throws ResourceNotFoundException * Specified application can't be found. * @throws ResourceInUseException * The application is not available for this operation. * @throws InvalidArgumentException * The specified input parameter value is not valid. * @throws ConcurrentModificationException * Exception thrown as a result of concurrent modifications to an application. This error can be the result * of attempting to modify an application without using the current application ID. * @throws InvalidRequestException * The request JSON is not valid for the operation. * @sample AmazonKinesisAnalyticsV2.DeleteApplicationOutput * @see AWS API Documentation */ DeleteApplicationOutputResult deleteApplicationOutput(DeleteApplicationOutputRequest deleteApplicationOutputRequest); /** *

* Deletes a reference data source configuration from the specified SQL-based Kinesis Data Analytics application's * configuration. *

*

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

* * @param deleteApplicationReferenceDataSourceRequest * @return Result of the DeleteApplicationReferenceDataSource operation returned by the service. * @throws ResourceNotFoundException * Specified application can't be found. * @throws ResourceInUseException * The application is not available for this operation. * @throws InvalidArgumentException * The specified input parameter value is not valid. * @throws ConcurrentModificationException * Exception thrown as a result of concurrent modifications to an application. This error can be the result * of attempting to modify an application without using the current application ID. * @throws InvalidRequestException * The request JSON is not valid for the operation. * @sample AmazonKinesisAnalyticsV2.DeleteApplicationReferenceDataSource * @see AWS API Documentation */ DeleteApplicationReferenceDataSourceResult deleteApplicationReferenceDataSource( DeleteApplicationReferenceDataSourceRequest deleteApplicationReferenceDataSourceRequest); /** *

* Deletes a snapshot of application state. *

* * @param deleteApplicationSnapshotRequest * @return Result of the DeleteApplicationSnapshot operation returned by the service. * @throws ResourceInUseException * The application is not available for this operation. * @throws InvalidArgumentException * The specified input parameter value is not valid. * @throws UnsupportedOperationException * The request was rejected because a specified parameter is not supported or a specified resource is not * valid for this operation. * @throws InvalidRequestException * The request JSON is not valid for the operation. * @throws ResourceNotFoundException * Specified application can't be found. * @throws ConcurrentModificationException * Exception thrown as a result of concurrent modifications to an application. This error can be the result * of attempting to modify an application without using the current application ID. * @sample AmazonKinesisAnalyticsV2.DeleteApplicationSnapshot * @see AWS API Documentation */ DeleteApplicationSnapshotResult deleteApplicationSnapshot(DeleteApplicationSnapshotRequest deleteApplicationSnapshotRequest); /** *

* Removes a VPC configuration from a Kinesis Data Analytics application. *

* * @param deleteApplicationVpcConfigurationRequest * @return Result of the DeleteApplicationVpcConfiguration operation returned by the service. * @throws ResourceNotFoundException * Specified application can't be found. * @throws ResourceInUseException * The application is not available for this operation. * @throws InvalidArgumentException * The specified input parameter value is not valid. * @throws ConcurrentModificationException * Exception thrown as a result of concurrent modifications to an application. This error can be the result * of attempting to modify an application without using the current application ID. * @throws InvalidApplicationConfigurationException * The user-provided application configuration is not valid. * @sample AmazonKinesisAnalyticsV2.DeleteApplicationVpcConfiguration * @see AWS API Documentation */ DeleteApplicationVpcConfigurationResult deleteApplicationVpcConfiguration(DeleteApplicationVpcConfigurationRequest deleteApplicationVpcConfigurationRequest); /** *

* Returns information about a specific Kinesis Data Analytics application. *

*

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

* * @param describeApplicationRequest * @return Result of the DescribeApplication operation returned by the service. * @throws ResourceNotFoundException * Specified application can't be found. * @throws InvalidArgumentException * The specified input parameter value is not valid. * @throws InvalidRequestException * The request JSON is not valid for the operation. * @sample AmazonKinesisAnalyticsV2.DescribeApplication * @see AWS API Documentation */ DescribeApplicationResult describeApplication(DescribeApplicationRequest describeApplicationRequest); /** *

* Returns information about a snapshot of application state data. *

* * @param describeApplicationSnapshotRequest * @return Result of the DescribeApplicationSnapshot operation returned by the service. * @throws ResourceNotFoundException * Specified application can't be found. * @throws InvalidArgumentException * The specified input parameter value is not valid. * @throws UnsupportedOperationException * The request was rejected because a specified parameter is not supported or a specified resource is not * valid for this operation. * @sample AmazonKinesisAnalyticsV2.DescribeApplicationSnapshot * @see AWS API Documentation */ DescribeApplicationSnapshotResult describeApplicationSnapshot(DescribeApplicationSnapshotRequest describeApplicationSnapshotRequest); /** *

* Provides a detailed description of a specified version of the application. To see a list of all the versions of * an application, invoke the ListApplicationVersions operation. *

* *

* This operation is supported only for Amazon Kinesis Data Analytics for Apache Flink. *

*
* * @param describeApplicationVersionRequest * @return Result of the DescribeApplicationVersion operation returned by the service. * @throws InvalidArgumentException * The specified input parameter value is not valid. * @throws ResourceNotFoundException * Specified application can't be found. * @throws UnsupportedOperationException * The request was rejected because a specified parameter is not supported or a specified resource is not * valid for this operation. * @sample AmazonKinesisAnalyticsV2.DescribeApplicationVersion * @see AWS API Documentation */ DescribeApplicationVersionResult describeApplicationVersion(DescribeApplicationVersionRequest describeApplicationVersionRequest); /** *

* Infers a schema for a SQL-based Kinesis Data Analytics application by evaluating sample records on the specified * streaming source (Kinesis data stream or Kinesis Data Firehose delivery stream) or Amazon 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. When you create an * application using the Kinesis Data Analytics console, the console uses this operation to infer a schema and show * it in the console user interface. *

* * @param discoverInputSchemaRequest * @return Result of the DiscoverInputSchema operation returned by the service. * @throws InvalidArgumentException * The specified input parameter value is not valid. * @throws UnableToDetectSchemaException * The data format is not valid. Kinesis Data Analytics cannot detect the schema for the given streaming * source. * @throws ResourceProvisionedThroughputExceededException * Discovery failed to get a record from the streaming source because of the Kinesis Streams * ProvisionedThroughputExceededException. For more information, see GetRecords in the * Amazon Kinesis Streams API Reference. * @throws ServiceUnavailableException * The service cannot complete the request. * @throws InvalidRequestException * The request JSON is not valid for the operation. * @throws UnsupportedOperationException * The request was rejected because a specified parameter is not supported or a specified resource is not * valid for this operation. * @sample AmazonKinesisAnalyticsV2.DiscoverInputSchema * @see AWS API Documentation */ DiscoverInputSchemaResult discoverInputSchema(DiscoverInputSchemaRequest discoverInputSchemaRequest); /** *

* Lists information about the current application snapshots. *

* * @param listApplicationSnapshotsRequest * @return Result of the ListApplicationSnapshots operation returned by the service. * @throws InvalidArgumentException * The specified input parameter value is not valid. * @throws UnsupportedOperationException * The request was rejected because a specified parameter is not supported or a specified resource is not * valid for this operation. * @sample AmazonKinesisAnalyticsV2.ListApplicationSnapshots * @see AWS API Documentation */ ListApplicationSnapshotsResult listApplicationSnapshots(ListApplicationSnapshotsRequest listApplicationSnapshotsRequest); /** *

* Lists all the versions for the specified application, including versions that were rolled back. The response also * includes a summary of the configuration associated with each version. *

*

* To get the complete description of a specific application version, invoke the DescribeApplicationVersion * operation. *

* *

* This operation is supported only for Amazon Kinesis Data Analytics for Apache Flink. *

*
* * @param listApplicationVersionsRequest * @return Result of the ListApplicationVersions operation returned by the service. * @throws InvalidArgumentException * The specified input parameter value is not valid. * @throws ResourceNotFoundException * Specified application can't be found. * @throws UnsupportedOperationException * The request was rejected because a specified parameter is not supported or a specified resource is not * valid for this operation. * @sample AmazonKinesisAnalyticsV2.ListApplicationVersions * @see AWS API Documentation */ ListApplicationVersionsResult listApplicationVersions(ListApplicationVersionsRequest listApplicationVersionsRequest); /** *

* Returns a list of Kinesis Data Analytics applications in your account. For each application, the response * includes the application name, Amazon Resource Name (ARN), and status. *

*

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

* * @param listApplicationsRequest * @return Result of the ListApplications operation returned by the service. * @throws InvalidRequestException * The request JSON is not valid for the operation. * @sample AmazonKinesisAnalyticsV2.ListApplications * @see AWS API Documentation */ ListApplicationsResult listApplications(ListApplicationsRequest listApplicationsRequest); /** *

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

* * @param listTagsForResourceRequest * @return Result of the ListTagsForResource operation returned by the service. * @throws ResourceNotFoundException * Specified application can't be found. * @throws InvalidArgumentException * The specified input parameter value is not valid. * @throws ConcurrentModificationException * Exception thrown as a result of concurrent modifications to an application. This error can be the result * of attempting to modify an application without using the current application ID. * @sample AmazonKinesisAnalyticsV2.ListTagsForResource * @see AWS API Documentation */ ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest); /** *

* Reverts the application to the previous running version. You can roll back an application if you suspect it is * stuck in a transient status. *

*

* You can roll back an application only if it is in the UPDATING or AUTOSCALING status. *

*

* When you rollback an application, it loads state data from the last successful snapshot. If the application has * no snapshots, Kinesis Data Analytics rejects the rollback request. *

*

* This action is not supported for Kinesis Data Analytics for SQL applications. *

* * @param rollbackApplicationRequest * @return Result of the RollbackApplication operation returned by the service. * @throws ResourceNotFoundException * Specified application can't be found. * @throws InvalidArgumentException * The specified input parameter value is not valid. * @throws ResourceInUseException * The application is not available for this operation. * @throws InvalidRequestException * The request JSON is not valid for the operation. * @throws ConcurrentModificationException * Exception thrown as a result of concurrent modifications to an application. This error can be the result * of attempting to modify an application without using the current application ID. * @throws UnsupportedOperationException * The request was rejected because a specified parameter is not supported or a specified resource is not * valid for this operation. * @sample AmazonKinesisAnalyticsV2.RollbackApplication * @see AWS API Documentation */ RollbackApplicationResult rollbackApplication(RollbackApplicationRequest rollbackApplicationRequest); /** *

* Starts the specified Kinesis Data Analytics application. After creating an application, you must exclusively call * this operation to start your application. *

* * @param startApplicationRequest * @return Result of the StartApplication operation returned by the service. * @throws ResourceNotFoundException * Specified application can't be found. * @throws ResourceInUseException * The application is not available for this operation. * @throws InvalidArgumentException * The specified input parameter value is not valid. * @throws InvalidApplicationConfigurationException * The user-provided application configuration is not valid. * @throws InvalidRequestException * The request JSON is not valid for the operation. * @sample AmazonKinesisAnalyticsV2.StartApplication * @see AWS API Documentation */ StartApplicationResult startApplication(StartApplicationRequest startApplicationRequest); /** *

* Stops the application from processing data. You can stop an application only if it is in the running status, * unless you set the Force parameter to true. *

*

* You can use the DescribeApplication operation to find the application status. *

*

* Kinesis Data Analytics takes a snapshot when the application is stopped, unless Force is set to * true. *

* * @param stopApplicationRequest * @return Result of the StopApplication operation returned by the service. * @throws ResourceNotFoundException * Specified application can't be found. * @throws ResourceInUseException * The application is not available for this operation. * @throws InvalidArgumentException * The specified input parameter value is not valid. * @throws InvalidRequestException * The request JSON is not valid for the operation. * @throws InvalidApplicationConfigurationException * The user-provided application configuration is not valid. * @throws ConcurrentModificationException * Exception thrown as a result of concurrent modifications to an application. This error can be the result * of attempting to modify an application without using the current application ID. * @sample AmazonKinesisAnalyticsV2.StopApplication * @see AWS API Documentation */ StopApplicationResult stopApplication(StopApplicationRequest stopApplicationRequest); /** *

* Adds one or more key-value tags to a Kinesis Data 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. *

* * @param tagResourceRequest * @return Result of the TagResource operation returned by the service. * @throws ResourceNotFoundException * Specified application can't be found. * @throws ResourceInUseException * The application is not available for this operation. * @throws TooManyTagsException * Application created with too many tags, or too many tags added to an application. Note that the maximum * number of application tags includes system tags. The maximum number of user-defined application tags is * 50. * @throws InvalidArgumentException * The specified input parameter value is not valid. * @throws ConcurrentModificationException * Exception thrown as a result of concurrent modifications to an application. This error can be the result * of attempting to modify an application without using the current application ID. * @sample AmazonKinesisAnalyticsV2.TagResource * @see AWS * API Documentation */ TagResourceResult tagResource(TagResourceRequest tagResourceRequest); /** *

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

* * @param untagResourceRequest * @return Result of the UntagResource operation returned by the service. * @throws ResourceNotFoundException * Specified application can't be found. * @throws ResourceInUseException * The application is not available for this operation. * @throws TooManyTagsException * Application created with too many tags, or too many tags added to an application. Note that the maximum * number of application tags includes system tags. The maximum number of user-defined application tags is * 50. * @throws InvalidArgumentException * The specified input parameter value is not valid. * @throws ConcurrentModificationException * Exception thrown as a result of concurrent modifications to an application. This error can be the result * of attempting to modify an application without using the current application ID. * @sample AmazonKinesisAnalyticsV2.UntagResource * @see AWS API Documentation */ UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest); /** *

* Updates an existing Kinesis Data Analytics application. Using this operation, you can update application code, * input configuration, and output configuration. *

*

* Kinesis Data Analytics updates the ApplicationVersionId each time you update your application. *

* *

* You cannot update the RuntimeEnvironment of an existing application. If you need to update an * application's RuntimeEnvironment, you must delete the application and create it again. *

*
* * @param updateApplicationRequest * @return Result of the UpdateApplication operation returned by the service. * @throws CodeValidationException * The user-provided application code (query) is not valid. This can be a simple syntax error. * @throws ResourceNotFoundException * Specified application can't be found. * @throws ResourceInUseException * The application is not available for this operation. * @throws InvalidArgumentException * The specified input parameter value is not valid. * @throws ConcurrentModificationException * Exception thrown as a result of concurrent modifications to an application. This error can be the result * of attempting to modify an application without using the current application ID. * @throws InvalidRequestException * The request JSON is not valid for the operation. * @throws InvalidApplicationConfigurationException * The user-provided application configuration is not valid. * @throws LimitExceededException * The number of allowed resources has been exceeded. * @sample AmazonKinesisAnalyticsV2.UpdateApplication * @see AWS API Documentation */ UpdateApplicationResult updateApplication(UpdateApplicationRequest updateApplicationRequest); /** *

* Updates the maintenance configuration of the Kinesis Data Analytics application. *

*

* You can invoke this operation on an application that is in one of the two following states: READY or * RUNNING. If you invoke it when the application is in a state other than these two states, it throws * a ResourceInUseException. The service makes use of the updated configuration the next time it * schedules maintenance for the application. If you invoke this operation after the service schedules maintenance, * the service will apply the configuration update the next time it schedules maintenance for the application. This * means that you might not see the maintenance configuration update applied to the maintenance process that follows * a successful invocation of this operation, but to the following maintenance process instead. *

*

* To see the current maintenance configuration of your application, invoke the DescribeApplication * operation. *

*

* For information about application maintenance, see Kinesis Data Analytics for * Apache Flink Maintenance. *

* *

* This operation is supported only for Amazon Kinesis Data Analytics for Apache Flink. *

*
* * @param updateApplicationMaintenanceConfigurationRequest * @return Result of the UpdateApplicationMaintenanceConfiguration operation returned by the service. * @throws ResourceNotFoundException * Specified application can't be found. * @throws ResourceInUseException * The application is not available for this operation. * @throws InvalidArgumentException * The specified input parameter value is not valid. * @throws ConcurrentModificationException * Exception thrown as a result of concurrent modifications to an application. This error can be the result * of attempting to modify an application without using the current application ID. * @throws UnsupportedOperationException * The request was rejected because a specified parameter is not supported or a specified resource is not * valid for this operation. * @sample AmazonKinesisAnalyticsV2.UpdateApplicationMaintenanceConfiguration * @see AWS API Documentation */ UpdateApplicationMaintenanceConfigurationResult updateApplicationMaintenanceConfiguration( UpdateApplicationMaintenanceConfigurationRequest updateApplicationMaintenanceConfigurationRequest); /** * Shuts down this client object, releasing any resources that might be held open. This is an optional method, and * callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client * has been shutdown, it should not be used to make any more requests. */ void shutdown(); /** * Returns additional metadata for a previously executed successful request, typically used for debugging issues * where a service isn't acting as expected. This data isn't considered part of the result data returned by an * operation, so it's available through this separate, diagnostic interface. *

* Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic * information for an executed request, you should use this method to retrieve it as soon as possible after * executing a request. * * @param request * The originally executed request. * * @return The response metadata for the specified request, or null if none is available. */ ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request); }