com.amazonaws.services.kinesisanalyticsv2

Interface AmazonKinesisAnalyticsV2

All Known Subinterfaces:

AmazonKinesisAnalyticsV2Async

All Known Implementing Classes:

AbstractAmazonKinesisAnalyticsV2, AbstractAmazonKinesisAnalyticsV2Async, AmazonKinesisAnalyticsV2AsyncClient, AmazonKinesisAnalyticsV2Client

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonKinesisAnalyticsV2

Interface for accessing Kinesis Analytics V2.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonKinesisAnalyticsV2 instead.

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
AddApplicationCloudWatchLoggingOptionResult	addApplicationCloudWatchLoggingOption(AddApplicationCloudWatchLoggingOptionRequest addApplicationCloudWatchLoggingOptionRequest) Adds an Amazon CloudWatch log stream to monitor application configuration errors.
AddApplicationInputResult	addApplicationInput(AddApplicationInputRequest addApplicationInputRequest) Adds a streaming source to your SQL-based Amazon Kinesis Data Analytics application.
AddApplicationInputProcessingConfigurationResult	addApplicationInputProcessingConfiguration(AddApplicationInputProcessingConfigurationRequest addApplicationInputProcessingConfigurationRequest) Adds an InputProcessingConfiguration to an SQL-based Kinesis Data Analytics application.
AddApplicationOutputResult	addApplicationOutput(AddApplicationOutputRequest addApplicationOutputRequest) Adds an external destination to your SQL-based Amazon Kinesis Data Analytics application.
AddApplicationReferenceDataSourceResult	addApplicationReferenceDataSource(AddApplicationReferenceDataSourceRequest addApplicationReferenceDataSourceRequest) Adds a reference data source to an existing SQL-based Amazon Kinesis Data Analytics application.
AddApplicationVpcConfigurationResult	addApplicationVpcConfiguration(AddApplicationVpcConfigurationRequest addApplicationVpcConfigurationRequest) Adds a Virtual Private Cloud (VPC) configuration to the application.
CreateApplicationResult	createApplication(CreateApplicationRequest createApplicationRequest) Creates an Amazon Kinesis Data Analytics application.
CreateApplicationSnapshotResult	createApplicationSnapshot(CreateApplicationSnapshotRequest createApplicationSnapshotRequest) Creates a snapshot of the application's state data.
DeleteApplicationResult	deleteApplication(DeleteApplicationRequest deleteApplicationRequest) Deletes the specified application.
DeleteApplicationCloudWatchLoggingOptionResult	deleteApplicationCloudWatchLoggingOption(DeleteApplicationCloudWatchLoggingOptionRequest deleteApplicationCloudWatchLoggingOptionRequest) Deletes an Amazon CloudWatch log stream from an Amazon Kinesis Data Analytics application.
DeleteApplicationInputProcessingConfigurationResult	deleteApplicationInputProcessingConfiguration(DeleteApplicationInputProcessingConfigurationRequest deleteApplicationInputProcessingConfigurationRequest) Deletes an InputProcessingConfiguration from an input.
DeleteApplicationOutputResult	deleteApplicationOutput(DeleteApplicationOutputRequest deleteApplicationOutputRequest) Deletes the output destination configuration from your SQL-based Amazon Kinesis Data Analytics application's configuration.
DeleteApplicationReferenceDataSourceResult	deleteApplicationReferenceDataSource(DeleteApplicationReferenceDataSourceRequest deleteApplicationReferenceDataSourceRequest) Deletes a reference data source configuration from the specified SQL-based Amazon Kinesis Data Analytics application's configuration.
DeleteApplicationSnapshotResult	deleteApplicationSnapshot(DeleteApplicationSnapshotRequest deleteApplicationSnapshotRequest) Deletes a snapshot of application state.
DeleteApplicationVpcConfigurationResult	deleteApplicationVpcConfiguration(DeleteApplicationVpcConfigurationRequest deleteApplicationVpcConfigurationRequest) Removes a VPC configuration from a Kinesis Data Analytics application.
DescribeApplicationResult	describeApplication(DescribeApplicationRequest describeApplicationRequest) Returns information about a specific Amazon Kinesis Data Analytics application.
DescribeApplicationSnapshotResult	describeApplicationSnapshot(DescribeApplicationSnapshotRequest describeApplicationSnapshotRequest) Returns information about a snapshot of application state data.
DiscoverInputSchemaResult	discoverInputSchema(DiscoverInputSchemaRequest discoverInputSchemaRequest) Infers a schema for an SQL-based Amazon 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.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
ListApplicationsResult	listApplications(ListApplicationsRequest listApplicationsRequest) Returns a list of Amazon Kinesis Data Analytics applications in your account.
ListApplicationSnapshotsResult	listApplicationSnapshots(ListApplicationSnapshotsRequest listApplicationSnapshotsRequest) Lists information about the current application snapshots.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Retrieves the list of key-value tags assigned to the application.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartApplicationResult	startApplication(StartApplicationRequest startApplicationRequest) Starts the specified Amazon Kinesis Data Analytics application.
StopApplicationResult	stopApplication(StopApplicationRequest stopApplicationRequest) Stops the application from processing data.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Adds one or more key-value tags to a Kinesis Analytics application.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes one or more tags from a Kinesis Analytics application.
UpdateApplicationResult	updateApplication(UpdateApplicationRequest updateApplicationRequest) Updates an existing Amazon Kinesis Data Analytics application.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

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

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

addApplicationCloudWatchLoggingOption

AddApplicationCloudWatchLoggingOptionResult addApplicationCloudWatchLoggingOption(AddApplicationCloudWatchLoggingOptionRequest addApplicationCloudWatchLoggingOptionRequest)

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

Parameters:

addApplicationCloudWatchLoggingOptionRequest -

Returns:

Result of the AddApplicationCloudWatchLoggingOption operation returned by the service.

Throws:

ResourceNotFoundException - Specified application can't be found.

ResourceInUseException - The application is not available for this operation.

InvalidArgumentException - The specified input parameter value is not valid.

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.

InvalidRequestException - The request JSON is not valid for the operation.

InvalidApplicationConfigurationException - The user-provided application configuration is not valid.

See Also:

AWS API Documentation

addApplicationInput

AddApplicationInputResult addApplicationInput(AddApplicationInputRequest addApplicationInputRequest)

Adds a streaming source to your SQL-based Amazon 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.

Parameters:

addApplicationInputRequest -

Returns:

Result of the AddApplicationInput operation returned by the service.

Throws:

ResourceNotFoundException - Specified application can't be found.

ResourceInUseException - The application is not available for this operation.

InvalidArgumentException - The specified input parameter value is not valid.

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.

CodeValidationException - The user-provided application code (query) is not valid. This can be a simple syntax error.

InvalidRequestException - The request JSON is not valid for the operation.

See Also:

AWS API Documentation

addApplicationInputProcessingConfiguration

AddApplicationInputProcessingConfigurationResult addApplicationInputProcessingConfiguration(AddApplicationInputProcessingConfigurationRequest addApplicationInputProcessingConfigurationRequest)

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

Parameters:

addApplicationInputProcessingConfigurationRequest -

Returns:

Result of the AddApplicationInputProcessingConfiguration operation returned by the service.

Throws:

ResourceNotFoundException - Specified application can't be found.

ResourceInUseException - The application is not available for this operation.

InvalidArgumentException - The specified input parameter value is not valid.

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.

InvalidRequestException - The request JSON is not valid for the operation.

See Also:

AWS API Documentation

addApplicationOutput

AddApplicationOutputResult addApplicationOutput(AddApplicationOutputRequest addApplicationOutputRequest)

Adds an external destination to your SQL-based Amazon 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 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.

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.

Parameters:

addApplicationOutputRequest -

Returns:

Result of the AddApplicationOutput operation returned by the service.

Throws:

ResourceNotFoundException - Specified application can't be found.

ResourceInUseException - The application is not available for this operation.

InvalidArgumentException - The specified input parameter value is not valid.

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.

InvalidRequestException - The request JSON is not valid for the operation.

See Also:

AWS API Documentation

addApplicationReferenceDataSource

AddApplicationReferenceDataSourceResult addApplicationReferenceDataSource(AddApplicationReferenceDataSourceRequest addApplicationReferenceDataSourceRequest)

Adds a reference data source to an existing SQL-based Amazon 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.

Parameters:

addApplicationReferenceDataSourceRequest -

Returns:

Result of the AddApplicationReferenceDataSource operation returned by the service.

Throws:

ResourceNotFoundException - Specified application can't be found.

ResourceInUseException - The application is not available for this operation.

InvalidArgumentException - The specified input parameter value is not valid.

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.

InvalidRequestException - The request JSON is not valid for the operation.

See Also:

AWS API Documentation

addApplicationVpcConfiguration

AddApplicationVpcConfigurationResult addApplicationVpcConfiguration(AddApplicationVpcConfigurationRequest addApplicationVpcConfigurationRequest)

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:

• VPC configurations are not supported for SQL applications.

• When a VPC is added to a Kinesis Data Analytics application, the application can no longer be accessed from the Internet directly. To enable Internet access to the application, add an Internet gateway to your VPC.

Parameters:

addApplicationVpcConfigurationRequest -

Returns:

Result of the AddApplicationVpcConfiguration operation returned by the service.

Throws:

ResourceNotFoundException - Specified application can't be found.

ResourceInUseException - The application is not available for this operation.

InvalidArgumentException - The specified input parameter value is not valid.

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.

See Also:

AWS API Documentation

createApplication

CreateApplicationResult createApplication(CreateApplicationRequest createApplicationRequest)

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

Parameters:

createApplicationRequest -

Returns:

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.

ResourceInUseException - The application is not available for this operation.

LimitExceededException - The number of allowed resources has been exceeded.

InvalidArgumentException - The specified input parameter value is not valid.

InvalidRequestException - The request JSON is not valid for the operation.

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.

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.

See Also:

AWS API Documentation

createApplicationSnapshot

CreateApplicationSnapshotResult createApplicationSnapshot(CreateApplicationSnapshotRequest createApplicationSnapshotRequest)

Creates a snapshot of the application's state data.

Parameters:

createApplicationSnapshotRequest -

Returns:

Result of the CreateApplicationSnapshot operation returned by the service.

Throws:

ResourceInUseException - The application is not available for this operation.

ResourceNotFoundException - Specified application can't be found.

LimitExceededException - The number of allowed resources has been exceeded.

InvalidArgumentException - The specified input parameter value is not valid.

UnsupportedOperationException - The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.

InvalidRequestException - The request JSON is not valid for the operation.

See Also:

AWS API Documentation

deleteApplication

DeleteApplicationResult deleteApplication(DeleteApplicationRequest deleteApplicationRequest)

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

Parameters:

deleteApplicationRequest -

Returns:

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.

ResourceNotFoundException - Specified application can't be found.

ResourceInUseException - The application is not available for this operation.

InvalidArgumentException - The specified input parameter value is not valid.

InvalidRequestException - The request JSON is not valid for the operation.

InvalidApplicationConfigurationException - The user-provided application configuration is not valid.

See Also:

AWS API Documentation

deleteApplicationCloudWatchLoggingOption

DeleteApplicationCloudWatchLoggingOptionResult deleteApplicationCloudWatchLoggingOption(DeleteApplicationCloudWatchLoggingOptionRequest deleteApplicationCloudWatchLoggingOptionRequest)

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

Parameters:

deleteApplicationCloudWatchLoggingOptionRequest -

Returns:

Result of the DeleteApplicationCloudWatchLoggingOption operation returned by the service.

Throws:

ResourceNotFoundException - Specified application can't be found.

ResourceInUseException - The application is not available for this operation.

InvalidArgumentException - The specified input parameter value is not valid.

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.

InvalidRequestException - The request JSON is not valid for the operation.

InvalidApplicationConfigurationException - The user-provided application configuration is not valid.

See Also:

AWS API Documentation

deleteApplicationInputProcessingConfiguration

DeleteApplicationInputProcessingConfigurationResult deleteApplicationInputProcessingConfiguration(DeleteApplicationInputProcessingConfigurationRequest deleteApplicationInputProcessingConfigurationRequest)

Deletes an InputProcessingConfiguration from an input.

Parameters:

deleteApplicationInputProcessingConfigurationRequest -

Returns:

Result of the DeleteApplicationInputProcessingConfiguration operation returned by the service.

Throws:

ResourceNotFoundException - Specified application can't be found.

ResourceInUseException - The application is not available for this operation.

InvalidArgumentException - The specified input parameter value is not valid.

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.

InvalidRequestException - The request JSON is not valid for the operation.

See Also:

AWS API Documentation

deleteApplicationOutput

DeleteApplicationOutputResult deleteApplicationOutput(DeleteApplicationOutputRequest deleteApplicationOutputRequest)

Deletes the output destination configuration from your SQL-based Amazon 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.

Parameters:

deleteApplicationOutputRequest -

Returns:

Result of the DeleteApplicationOutput operation returned by the service.

Throws:

ResourceNotFoundException - Specified application can't be found.

ResourceInUseException - The application is not available for this operation.

InvalidArgumentException - The specified input parameter value is not valid.

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.

InvalidRequestException - The request JSON is not valid for the operation.

See Also:

AWS API Documentation

deleteApplicationReferenceDataSource

DeleteApplicationReferenceDataSourceResult deleteApplicationReferenceDataSource(DeleteApplicationReferenceDataSourceRequest deleteApplicationReferenceDataSourceRequest)

Deletes a reference data source configuration from the specified SQL-based Amazon 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.

Parameters:

deleteApplicationReferenceDataSourceRequest -

Returns:

Result of the DeleteApplicationReferenceDataSource operation returned by the service.

Throws:

ResourceNotFoundException - Specified application can't be found.

ResourceInUseException - The application is not available for this operation.

InvalidArgumentException - The specified input parameter value is not valid.

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.

InvalidRequestException - The request JSON is not valid for the operation.

See Also:

AWS API Documentation

deleteApplicationSnapshot

DeleteApplicationSnapshotResult deleteApplicationSnapshot(DeleteApplicationSnapshotRequest deleteApplicationSnapshotRequest)

Deletes a snapshot of application state.

Parameters:

deleteApplicationSnapshotRequest -

Returns:

Result of the DeleteApplicationSnapshot operation returned by the service.

Throws:

ResourceInUseException - The application is not available for this operation.

InvalidArgumentException - The specified input parameter value is not valid.

UnsupportedOperationException - The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.

InvalidRequestException - The request JSON is not valid for the operation.

ResourceNotFoundException - Specified application can't be found.

See Also:

AWS API Documentation

deleteApplicationVpcConfiguration

DeleteApplicationVpcConfigurationResult deleteApplicationVpcConfiguration(DeleteApplicationVpcConfigurationRequest deleteApplicationVpcConfigurationRequest)

Removes a VPC configuration from a Kinesis Data Analytics application.

Parameters:

deleteApplicationVpcConfigurationRequest -

Returns:

Result of the DeleteApplicationVpcConfiguration operation returned by the service.

Throws:

ResourceNotFoundException - Specified application can't be found.

ResourceInUseException - The application is not available for this operation.

InvalidArgumentException - The specified input parameter value is not valid.

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.

See Also:

AWS API Documentation

describeApplication

DescribeApplicationResult describeApplication(DescribeApplicationRequest describeApplicationRequest)

Returns information about a specific Amazon Kinesis Data Analytics application.

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

Parameters:

describeApplicationRequest -

Returns:

Result of the DescribeApplication operation returned by the service.

Throws:

ResourceNotFoundException - Specified application can't be found.

InvalidArgumentException - The specified input parameter value is not valid.

InvalidRequestException - The request JSON is not valid for the operation.

See Also:

AWS API Documentation

describeApplicationSnapshot

DescribeApplicationSnapshotResult describeApplicationSnapshot(DescribeApplicationSnapshotRequest describeApplicationSnapshotRequest)

Returns information about a snapshot of application state data.

Parameters:

describeApplicationSnapshotRequest -

Returns:

Result of the DescribeApplicationSnapshot operation returned by the service.

Throws:

ResourceNotFoundException - Specified application can't be found.

InvalidArgumentException - The specified input parameter value is not valid.

UnsupportedOperationException - The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.

See Also:

AWS API Documentation

discoverInputSchema

DiscoverInputSchemaResult discoverInputSchema(DiscoverInputSchemaRequest discoverInputSchemaRequest)

Infers a schema for an SQL-based Amazon 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.

Parameters:

discoverInputSchemaRequest -

Returns:

Result of the DiscoverInputSchema operation returned by the service.

Throws:

InvalidArgumentException - The specified input parameter value is not valid.

UnableToDetectSchemaException - The data format is not valid. Amazon Kinesis Data Analytics cannot detect the 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 cannot complete the request.

InvalidRequestException - The request JSON is not valid for the operation.

See Also:

AWS API Documentation

listApplicationSnapshots

ListApplicationSnapshotsResult listApplicationSnapshots(ListApplicationSnapshotsRequest listApplicationSnapshotsRequest)

Lists information about the current application snapshots.

Parameters:

listApplicationSnapshotsRequest -

Returns:

Result of the ListApplicationSnapshots operation returned by the service.

Throws:

InvalidArgumentException - The specified input parameter value is not valid.

UnsupportedOperationException - The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.

See Also:

AWS API Documentation

listApplications

ListApplicationsResult listApplications(ListApplicationsRequest listApplicationsRequest)

Returns a list of Amazon 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.

Parameters:

listApplicationsRequest -

Returns:

Result of the ListApplications operation returned by the service.

Throws:

InvalidRequestException - The request JSON is not valid for the operation.

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

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

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

ResourceNotFoundException - Specified application can't be found.

InvalidArgumentException - The specified input parameter value is not valid.

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.

See Also:

AWS API Documentation

startApplication

StartApplicationResult startApplication(StartApplicationRequest startApplicationRequest)

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

Parameters:

startApplicationRequest -

Returns:

Result of the StartApplication operation returned by the service.

Throws:

ResourceNotFoundException - Specified application can't be found.

ResourceInUseException - The application is not available for this operation.

InvalidArgumentException - The specified input parameter value is not valid.

InvalidApplicationConfigurationException - The user-provided application configuration is not valid.

InvalidRequestException - The request JSON is not valid for the operation.

See Also:

AWS API Documentation

stopApplication

StopApplicationResult stopApplication(StopApplicationRequest stopApplicationRequest)

Stops the application from processing 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.

Parameters:

stopApplicationRequest -

Returns:

Result of the StopApplication operation returned by the service.

Throws:

ResourceNotFoundException - Specified application can't be found.

ResourceInUseException - The application is not available for this operation.

InvalidArgumentException - The specified input parameter value is not valid.

InvalidRequestException - The request JSON is not valid for the operation.

InvalidApplicationConfigurationException - The user-provided application configuration is not valid.

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Adds one or more key-value tags to a Kinesis Analytics application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50. For more information, see Using Tagging.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

ResourceNotFoundException - Specified application can't be found.

ResourceInUseException - The application is not available for this operation.

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.

InvalidArgumentException - The specified input parameter value is not valid.

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.

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

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

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

ResourceNotFoundException - Specified application can't be found.

ResourceInUseException - The application is not available for this operation.

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.

InvalidArgumentException - The specified input parameter value is not valid.

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.

See Also:

AWS API Documentation

updateApplication

UpdateApplicationResult updateApplication(UpdateApplicationRequest updateApplicationRequest)

Updates an existing Amazon 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.

Parameters:

updateApplicationRequest -

Returns:

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.

ResourceNotFoundException - Specified application can't be found.

ResourceInUseException - The application is not available for this operation.

InvalidArgumentException - The specified input parameter value is not valid.

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.

InvalidRequestException - The request JSON is not valid for the operation.

InvalidApplicationConfigurationException - The user-provided application configuration is not valid.

See Also:

AWS API Documentation

shutdown

void shutdown()

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.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

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.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.