/* * 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.kinesisanalytics; import javax.annotation.Generated; import com.amazonaws.*; import com.amazonaws.regions.*; import com.amazonaws.services.kinesisanalytics.model.*; /** * Interface for accessing Kinesis Analytics. *
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.kinesisanalytics.AbstractAmazonKinesisAnalytics} instead. *
*
*
* Overview *
** This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. * Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation. *
** This is the Amazon Kinesis Analytics v1 API Reference. The Amazon Kinesis Analytics Developer Guide provides * additional information. *
*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AmazonKinesisAnalytics { /** * 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"; /** * Overrides the default endpoint for this client ("https://kinesisanalytics.us-east-1.amazonaws.com"). Callers can * use this method to control which AWS region they want to work with. ** Callers can pass in just the endpoint (ex: "kinesisanalytics.us-east-1.amazonaws.com") or a full URL, including * the protocol (ex: "https://kinesisanalytics.us-east-1.amazonaws.com"). If the protocol is not specified here, the * default protocol from this client's {@link ClientConfiguration} will be used, which by default is HTTPS. *
* For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available * endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- * choose-endpoint *
* This method is not threadsafe. An endpoint should be configured when the client is created and before any * service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in * transit or retrying. * * @param endpoint * The endpoint (ex: "kinesisanalytics.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: * "https://kinesisanalytics.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will * communicate with. * @deprecated use {@link AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)} for * example: * {@code builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));} */ @Deprecated void setEndpoint(String endpoint); /** * An alternative to {@link AmazonKinesisAnalytics#setEndpoint(String)}, sets the regional endpoint for this * client's service calls. Callers can use this method to control which AWS region they want to work with. *
* By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the * {@link ClientConfiguration} supplied at construction. *
* This method is not threadsafe. A region should be configured when the client is created and before any service
* requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit
* or retrying.
*
* @param region
* The region this client will communicate with. See {@link Region#getRegion(com.amazonaws.regions.Regions)}
* for accessing a given region. Must not be null and must be a region where the service is available.
*
* @see Region#getRegion(com.amazonaws.regions.Regions)
* @see Region#createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
* @see Region#isServiceSupported(String)
* @deprecated use {@link AwsClientBuilder#setRegion(String)}
*/
@Deprecated
void setRegion(Region region);
/**
*
* This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL
* applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see
* Amazon Kinesis Data Analytics API V2 Documentation.
*
* Adds a CloudWatch log stream to monitor application configuration errors. For more information about using * CloudWatch log streams with Amazon Kinesis Analytics applications, see Working with Amazon * CloudWatch Logs. *
* * @param addApplicationCloudWatchLoggingOptionRequest * @return Result of the AddApplicationCloudWatchLoggingOption operation returned by the service. * @throws ResourceNotFoundException * Specified application can't be found. * @throws ResourceInUseException * Application is not available for this operation. * @throws InvalidArgumentException * Specified input parameter value is invalid. * @throws 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. * @throws UnsupportedOperationException * The request was rejected because a specified parameter is not supported or a specified resource is not * valid for this operation. * @sample AmazonKinesisAnalytics.AddApplicationCloudWatchLoggingOption * @see AWS API Documentation */ AddApplicationCloudWatchLoggingOptionResult addApplicationCloudWatchLoggingOption( AddApplicationCloudWatchLoggingOptionRequest addApplicationCloudWatchLoggingOptionRequest); /** ** This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL * applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see * Amazon Kinesis Data Analytics API V2 Documentation. *
** Adds a streaming source to your Amazon Kinesis application. For conceptual information, see Configuring Application * Input. *
** You can add a streaming source either when you create an application or you can use this operation to add a * streaming source after you create an application. For more information, see CreateApplication. *
** Any configuration update, including adding a streaming source using this operation, results in a new version of * the application. You can use the DescribeApplication operation to find the current application version. *
*
* This operation requires permissions to perform the kinesisanalytics:AddApplicationInput
action.
*
* This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL * applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see * Amazon Kinesis Data Analytics API V2 Documentation. *
** Adds an * InputProcessingConfiguration to an application. An input processor preprocesses records on the input stream * before the application's SQL code executes. Currently, the only input processor available is AWS Lambda. *
* * @param addApplicationInputProcessingConfigurationRequest * @return Result of the AddApplicationInputProcessingConfiguration operation returned by the service. * @throws ResourceNotFoundException * Specified application can't be found. * @throws ResourceInUseException * Application is not available for this operation. * @throws InvalidArgumentException * Specified input parameter value is invalid. * @throws 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. * @throws UnsupportedOperationException * The request was rejected because a specified parameter is not supported or a specified resource is not * valid for this operation. * @sample AmazonKinesisAnalytics.AddApplicationInputProcessingConfiguration * @see AWS API Documentation */ AddApplicationInputProcessingConfigurationResult addApplicationInputProcessingConfiguration( AddApplicationInputProcessingConfigurationRequest addApplicationInputProcessingConfigurationRequest); /** ** This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL * applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see * Amazon Kinesis Data Analytics API V2 Documentation. *
** Adds an external destination to your Amazon Kinesis Analytics application. *
** If you want Amazon Kinesis Analytics to deliver data from an in-application stream within your application to an * external destination (such as an Amazon Kinesis stream, an Amazon Kinesis Firehose delivery stream, or an AWS * Lambda function), you add the relevant configuration to your application using this operation. You can configure * one or more outputs for your application. Each output configuration maps an in-application stream and an external * destination. *
** You can use one of the output configurations to deliver data from your in-application error stream to an external * destination so that you can analyze the errors. For more information, see Understanding Application * Output (Destination). *
** Any configuration update, including adding a streaming source using this operation, results in a new version of * the application. You can use the DescribeApplication operation to find the current application version. *
** For the limits on the number of application inputs and outputs you can configure, see Limits. *
*
* This operation requires permissions to perform the kinesisanalytics:AddApplicationOutput
action.
*
* This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL * applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see * Amazon Kinesis Data Analytics API V2 Documentation. *
** Adds a reference data source to an existing application. *
** Amazon Kinesis Analytics reads reference data (that is, an Amazon S3 object) and creates an in-application table * within your application. In the request, you provide the source (S3 bucket name and object key name), name of the * in-application table to create, and the necessary mapping information that describes how data in Amazon S3 object * maps to columns in the resulting in-application table. *
** For conceptual information, see Configuring Application * Input. For the limits on data sources you can add to your application, see Limits. *
*
* This operation requires permissions to perform the kinesisanalytics:AddApplicationOutput
action.
*
* This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL * applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see * Amazon Kinesis Data Analytics API V2 Documentation. *
** Creates an Amazon Kinesis Analytics application. You can configure each application with one streaming source as * input, application code to process the input, and up to three destinations where you want Amazon Kinesis * Analytics to write the output data from your application. For an overview, see How it Works. *
** In the input configuration, you map the streaming source to an in-application stream, which you can think of as a * constantly updating table. In the mapping, you must provide a schema for the in-application stream and map each * data column in the in-application stream to a data element in the streaming source. *
** Your application code is one or more SQL statements that read input data, transform it, and generate output. Your * application code can create one or more SQL artifacts like SQL streams or pumps. *
** In the output configuration, you can configure the application to write data from in-application streams created * in your applications to up to three destinations. *
*
* To read data from your source stream or write data to destination streams, Amazon Kinesis Analytics needs your
* permissions. You grant these permissions by creating IAM roles. This operation requires permissions to perform
* the kinesisanalytics:CreateApplication
action.
*
* For introductory exercises to create an Amazon Kinesis Analytics application, see Getting Started. *
* * @param createApplicationRequest * TBD * @return Result of the CreateApplication operation returned by the service. * @throws CodeValidationException * User-provided application code (query) is invalid. This can be a simple syntax error. * @throws ResourceInUseException * Application is not available for this operation. * @throws LimitExceededException * Exceeded the number of applications allowed. * @throws InvalidArgumentException * Specified input parameter value is invalid. * @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 modification to an application. For example, two individuals * attempting to edit the same application at the same time. * @sample AmazonKinesisAnalytics.CreateApplication * @see AWS API Documentation */ CreateApplicationResult createApplication(CreateApplicationRequest createApplicationRequest); /** ** This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL * applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see * Amazon Kinesis Data Analytics API V2 Documentation. *
** Deletes the specified application. Amazon Kinesis Analytics halts application execution and deletes the * application, including any application artifacts (such as in-application streams, reference table, and * application code). *
*
* This operation requires permissions to perform the kinesisanalytics:DeleteApplication
action.
*
* This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL * applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see * Amazon Kinesis Data Analytics API V2 Documentation. *
** Deletes a CloudWatch log stream from an application. For more information about using CloudWatch log streams with * Amazon Kinesis Analytics applications, see Working with Amazon * CloudWatch Logs. *
* * @param deleteApplicationCloudWatchLoggingOptionRequest * @return Result of the DeleteApplicationCloudWatchLoggingOption operation returned by the service. * @throws ResourceNotFoundException * Specified application can't be found. * @throws ResourceInUseException * Application is not available for this operation. * @throws InvalidArgumentException * Specified input parameter value is invalid. * @throws 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. * @throws UnsupportedOperationException * The request was rejected because a specified parameter is not supported or a specified resource is not * valid for this operation. * @sample AmazonKinesisAnalytics.DeleteApplicationCloudWatchLoggingOption * @see AWS API Documentation */ DeleteApplicationCloudWatchLoggingOptionResult deleteApplicationCloudWatchLoggingOption( DeleteApplicationCloudWatchLoggingOptionRequest deleteApplicationCloudWatchLoggingOptionRequest); /** ** This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL * applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see * Amazon Kinesis Data Analytics API V2 Documentation. *
** Deletes an InputProcessingConfiguration from an input. *
* * @param deleteApplicationInputProcessingConfigurationRequest * @return Result of the DeleteApplicationInputProcessingConfiguration operation returned by the service. * @throws ResourceNotFoundException * Specified application can't be found. * @throws ResourceInUseException * Application is not available for this operation. * @throws InvalidArgumentException * Specified input parameter value is invalid. * @throws 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. * @throws UnsupportedOperationException * The request was rejected because a specified parameter is not supported or a specified resource is not * valid for this operation. * @sample AmazonKinesisAnalytics.DeleteApplicationInputProcessingConfiguration * @see AWS API Documentation */ DeleteApplicationInputProcessingConfigurationResult deleteApplicationInputProcessingConfiguration( DeleteApplicationInputProcessingConfigurationRequest deleteApplicationInputProcessingConfigurationRequest); /** ** This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL * applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see * Amazon Kinesis Data Analytics API V2 Documentation. *
** Deletes output destination configuration from your application configuration. Amazon Kinesis Analytics will no * longer write data from the corresponding in-application stream to the external output destination. *
*
* This operation requires permissions to perform the kinesisanalytics:DeleteApplicationOutput
action.
*
* This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL * applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see * Amazon Kinesis Data Analytics API V2 Documentation. *
** Deletes a reference data source configuration from the specified application configuration. *
** If the application is running, Amazon Kinesis Analytics immediately removes the in-application table that you * created using the AddApplicationReferenceDataSource operation. *
*
* This operation requires permissions to perform the
* kinesisanalytics.DeleteApplicationReferenceDataSource
action.
*
* This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL * applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see * Amazon Kinesis Data Analytics API V2 Documentation. *
** Returns information about a specific Amazon Kinesis Analytics application. *
** If you want to retrieve a list of all applications in your account, use the ListApplications * operation. *
*
* This operation requires permissions to perform the kinesisanalytics:DescribeApplication
action. You
* can use DescribeApplication
to get the current application versionId, which you need to call other
* operations such as Update
.
*
* This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL * applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see * Amazon Kinesis Data Analytics API V2 Documentation. *
** Infers a schema by evaluating sample records on the specified streaming source (Amazon Kinesis stream or Amazon * Kinesis Firehose delivery stream) or S3 object. In the response, the operation returns the inferred schema and * also the sample records that the operation used to infer the schema. *
** You can use the inferred schema when configuring a streaming source for your application. For conceptual * information, see Configuring Application * Input. Note that when you create an application using the Amazon Kinesis Analytics console, the console uses * this operation to infer a schema and show it in the console user interface. *
*
* This operation requires permissions to perform the kinesisanalytics:DiscoverInputSchema
action.
*
* This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL * applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see * Amazon Kinesis Data Analytics API V2 Documentation. *
*
* Returns a list of Amazon Kinesis Analytics applications in your account. For each application, the response
* includes the application name, Amazon Resource Name (ARN), and status. If the response returns the
* HasMoreApplications
value as true, you can send another request by adding the
* ExclusiveStartApplicationName
in the request body, and set the value of this to the last application
* name from the previous response.
*
* If you want detailed information about a specific application, use DescribeApplication. *
*
* This operation requires permissions to perform the kinesisanalytics:ListApplications
action.
*
* 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 * Specified input parameter value is invalid. * @throws 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. * @sample AmazonKinesisAnalytics.ListTagsForResource * @see AWS API Documentation */ ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest); /** ** This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL * applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see * Amazon Kinesis Data Analytics API V2 Documentation. *
** Starts the specified Amazon Kinesis Analytics application. After creating an application, you must exclusively * call this operation to start your application. *
** After the application starts, it begins consuming the input data, processes it, and writes the output to the * configured destination. *
*
* The application status must be READY
for you to start an application. You can get the application
* status in the console or using the DescribeApplication operation.
*
* After you start the application, you can stop the application from processing the input by calling the StopApplication * operation. *
*
* This operation requires permissions to perform the kinesisanalytics:StartApplication
action.
*
* This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL * applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see * Amazon Kinesis Data Analytics API V2 Documentation. *
** Stops the application from processing input data. You can stop an application only if it is in the running state. * You can use the DescribeApplication * operation to find the application state. After the application is stopped, Amazon Kinesis Analytics stops * reading data from the input, the application stops processing data, and there is no output written to the * destination. *
*
* This operation requires permissions to perform the kinesisanalytics:StopApplication
action.
*
* Adds one or more key-value tags to a Kinesis Analytics application. Note that the maximum number of application * tags includes system tags. The maximum number of user-defined application tags is 50. For more information, see * Using Tagging. *
* * @param tagResourceRequest * @return Result of the TagResource operation returned by the service. * @throws ResourceNotFoundException * Specified application can't be found. * @throws ResourceInUseException * 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 * Specified input parameter value is invalid. * @throws 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. * @sample AmazonKinesisAnalytics.TagResource * @see AWS * API Documentation */ TagResourceResult tagResource(TagResourceRequest tagResourceRequest); /** ** Removes one or more tags from a Kinesis 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 * 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 * Specified input parameter value is invalid. * @throws 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. * @sample AmazonKinesisAnalytics.UntagResource * @see AWS * API Documentation */ UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest); /** ** This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL * applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see * Amazon Kinesis Data Analytics API V2 Documentation. *
** Updates an existing Amazon Kinesis Analytics application. Using this API, you can update application code, input * configuration, and output configuration. *
*
* Note that Amazon Kinesis Analytics updates the CurrentApplicationVersionId
each time you update your
* application.
*
* This operation requires permission for the kinesisanalytics:UpdateApplication
action.
*
* 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); }