AmazonKinesisAnalyticsV2Client (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.kinesisanalyticsv2.AmazonKinesisAnalyticsV2Client

All Implemented Interfaces:

AmazonKinesisAnalyticsV2

Direct Known Subclasses:

AmazonKinesisAnalyticsV2AsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonKinesisAnalyticsV2Client
extends AmazonWebServiceClient
implements AmazonKinesisAnalyticsV2
```
Client for accessing Kinesis Analytics V2. All service calls made using this client are blocking, and will not return until the service call completes.

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.

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  LOGGING_AWS_REQUEST_METRIC
- Fields inherited from interface com.amazonaws.services.kinesisanalyticsv2.AmazonKinesisAnalyticsV2
  ENDPOINT_PREFIX

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AddApplicationCloudWatchLoggingOptionResult`	`addApplicationCloudWatchLoggingOption(AddApplicationCloudWatchLoggingOptionRequest request)` Adds an Amazon CloudWatch log stream to monitor application configuration errors.
`AddApplicationInputResult`	`addApplicationInput(AddApplicationInputRequest request)` Adds a streaming source to your SQL-based Kinesis Data Analytics application.
`AddApplicationInputProcessingConfigurationResult`	`addApplicationInputProcessingConfiguration(AddApplicationInputProcessingConfigurationRequest request)` Adds an InputProcessingConfiguration to a SQL-based Kinesis Data Analytics application.
`AddApplicationOutputResult`	`addApplicationOutput(AddApplicationOutputRequest request)` Adds an external destination to your SQL-based Kinesis Data Analytics application.
`AddApplicationReferenceDataSourceResult`	`addApplicationReferenceDataSource(AddApplicationReferenceDataSourceRequest request)` Adds a reference data source to an existing SQL-based Kinesis Data Analytics application.
`AddApplicationVpcConfigurationResult`	`addApplicationVpcConfiguration(AddApplicationVpcConfigurationRequest request)` Adds a Virtual Private Cloud (VPC) configuration to the application.
`static AmazonKinesisAnalyticsV2ClientBuilder`	`builder()`
`CreateApplicationResult`	`createApplication(CreateApplicationRequest request)` Creates a Kinesis Data Analytics application.
`CreateApplicationPresignedUrlResult`	`createApplicationPresignedUrl(CreateApplicationPresignedUrlRequest request)` Creates and returns a URL that you can use to connect to an application's extension.
`CreateApplicationSnapshotResult`	`createApplicationSnapshot(CreateApplicationSnapshotRequest request)` Creates a snapshot of the application's state data.
`DeleteApplicationResult`	`deleteApplication(DeleteApplicationRequest request)` Deletes the specified application.
`DeleteApplicationCloudWatchLoggingOptionResult`	`deleteApplicationCloudWatchLoggingOption(DeleteApplicationCloudWatchLoggingOptionRequest request)` Deletes an Amazon CloudWatch log stream from an Kinesis Data Analytics application.
`DeleteApplicationInputProcessingConfigurationResult`	`deleteApplicationInputProcessingConfiguration(DeleteApplicationInputProcessingConfigurationRequest request)` Deletes an InputProcessingConfiguration from an input.
`DeleteApplicationOutputResult`	`deleteApplicationOutput(DeleteApplicationOutputRequest request)` Deletes the output destination configuration from your SQL-based Kinesis Data Analytics application's configuration.
`DeleteApplicationReferenceDataSourceResult`	`deleteApplicationReferenceDataSource(DeleteApplicationReferenceDataSourceRequest request)` Deletes a reference data source configuration from the specified SQL-based Kinesis Data Analytics application's configuration.
`DeleteApplicationSnapshotResult`	`deleteApplicationSnapshot(DeleteApplicationSnapshotRequest request)` Deletes a snapshot of application state.
`DeleteApplicationVpcConfigurationResult`	`deleteApplicationVpcConfiguration(DeleteApplicationVpcConfigurationRequest request)` Removes a VPC configuration from a Kinesis Data Analytics application.
`DescribeApplicationResult`	`describeApplication(DescribeApplicationRequest request)` Returns information about a specific Kinesis Data Analytics application.
`DescribeApplicationSnapshotResult`	`describeApplicationSnapshot(DescribeApplicationSnapshotRequest request)` Returns information about a snapshot of application state data.
`DiscoverInputSchemaResult`	`discoverInputSchema(DiscoverInputSchemaRequest request)` 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.
`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 request)` Returns a list of Kinesis Data Analytics applications in your account.
`ListApplicationSnapshotsResult`	`listApplicationSnapshots(ListApplicationSnapshotsRequest request)` Lists information about the current application snapshots.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` 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 request)` Starts the specified Kinesis Data Analytics application.
`StopApplicationResult`	`stopApplication(StopApplicationRequest request)` Stops the application from processing data.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Adds one or more key-value tags to a Kinesis Data Analytics application.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Removes one or more tags from a Kinesis Data Analytics application.
`UpdateApplicationResult`	`updateApplication(UpdateApplicationRequest request)` Updates an existing Kinesis Data Analytics application.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - builder
```
public static AmazonKinesisAnalyticsV2ClientBuilder builder()
```
  - addApplicationCloudWatchLoggingOption
```
public AddApplicationCloudWatchLoggingOptionResult addApplicationCloudWatchLoggingOption(AddApplicationCloudWatchLoggingOptionRequest request)
```
    Adds an Amazon CloudWatch log stream to monitor application configuration errors.
    
    Specified by:
    
    addApplicationCloudWatchLoggingOption in interface AmazonKinesisAnalyticsV2
    
    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
```
public AddApplicationInputResult addApplicationInput(AddApplicationInputRequest request)
```
    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.
    
    Specified by:
    
    addApplicationInput in interface AmazonKinesisAnalyticsV2
    
    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
```
public AddApplicationInputProcessingConfigurationResult addApplicationInputProcessingConfiguration(AddApplicationInputProcessingConfigurationRequest request)
```
    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 AWS Lambda.
    
    Specified by:
    
    addApplicationInputProcessingConfiguration in interface AmazonKinesisAnalyticsV2
    
    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
```
public AddApplicationOutputResult addApplicationOutput(AddApplicationOutputRequest request)
```
    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 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.
    
    Specified by:
    
    addApplicationOutput in interface AmazonKinesisAnalyticsV2
    
    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
```
public AddApplicationReferenceDataSourceResult addApplicationReferenceDataSource(AddApplicationReferenceDataSourceRequest request)
```
    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.
    
    Specified by:
    
    addApplicationReferenceDataSource in interface AmazonKinesisAnalyticsV2
    
    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
```
public AddApplicationVpcConfigurationResult addApplicationVpcConfiguration(AddApplicationVpcConfigurationRequest request)
```
    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.
    Specified by:
    
    addApplicationVpcConfiguration in interface AmazonKinesisAnalyticsV2
    
    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.
    
    InvalidApplicationConfigurationException - The user-provided application configuration is not valid.
    
    See Also:
    
    AWS API Documentation
  - createApplication
```
public CreateApplicationResult createApplication(CreateApplicationRequest request)
```
    Creates a Kinesis Data Analytics application. For information about creating a Kinesis Data Analytics application, see Creating an Application.
    
    Specified by:
    
    createApplication in interface AmazonKinesisAnalyticsV2
    
    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
  - createApplicationPresignedUrl
```
public CreateApplicationPresignedUrlResult createApplicationPresignedUrl(CreateApplicationPresignedUrlRequest request)
```
    Creates and returns a URL that you can use to connect to an application's extension. Currently, the only available extension is the Apache Flink dashboard.
    
    The IAM role or user used to call this API defines the permissions to access the extension. Once 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.
    
    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.
    
    Specified by:
    
    createApplicationPresignedUrl in interface AmazonKinesisAnalyticsV2
    
    Parameters:
    
    createApplicationPresignedUrlRequest -
    
    Returns:
    
    Result of the CreateApplicationPresignedUrl 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.
    
    See Also:
    
    AWS API Documentation
  - createApplicationSnapshot
```
public CreateApplicationSnapshotResult createApplicationSnapshot(CreateApplicationSnapshotRequest request)
```
    Creates a snapshot of the application's state data.
    
    Specified by:
    
    createApplicationSnapshot in interface AmazonKinesisAnalyticsV2
    
    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.
    
    InvalidApplicationConfigurationException - The user-provided application configuration is not valid.
    
    See Also:
    
    AWS API Documentation
  - deleteApplication
```
public DeleteApplicationResult deleteApplication(DeleteApplicationRequest request)
```
    Deletes the specified application. Kinesis Data Analytics halts application execution and deletes the application.
    
    Specified by:
    
    deleteApplication in interface AmazonKinesisAnalyticsV2
    
    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
```
public DeleteApplicationCloudWatchLoggingOptionResult deleteApplicationCloudWatchLoggingOption(DeleteApplicationCloudWatchLoggingOptionRequest request)
```
    Deletes an Amazon CloudWatch log stream from an Kinesis Data Analytics application.
    
    Specified by:
    
    deleteApplicationCloudWatchLoggingOption in interface AmazonKinesisAnalyticsV2
    
    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
```
public DeleteApplicationInputProcessingConfigurationResult deleteApplicationInputProcessingConfiguration(DeleteApplicationInputProcessingConfigurationRequest request)
```
    Deletes an InputProcessingConfiguration from an input.
    
    Specified by:
    
    deleteApplicationInputProcessingConfiguration in interface AmazonKinesisAnalyticsV2
    
    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
```
public DeleteApplicationOutputResult deleteApplicationOutput(DeleteApplicationOutputRequest request)
```
    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.
    
    Specified by:
    
    deleteApplicationOutput in interface AmazonKinesisAnalyticsV2
    
    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
```
public DeleteApplicationReferenceDataSourceResult deleteApplicationReferenceDataSource(DeleteApplicationReferenceDataSourceRequest request)
```
    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.
    
    Specified by:
    
    deleteApplicationReferenceDataSource in interface AmazonKinesisAnalyticsV2
    
    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
```
public DeleteApplicationSnapshotResult deleteApplicationSnapshot(DeleteApplicationSnapshotRequest request)
```
    Deletes a snapshot of application state.
    
    Specified by:
    
    deleteApplicationSnapshot in interface AmazonKinesisAnalyticsV2
    
    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
```
public DeleteApplicationVpcConfigurationResult deleteApplicationVpcConfiguration(DeleteApplicationVpcConfigurationRequest request)
```
    Removes a VPC configuration from a Kinesis Data Analytics application.
    
    Specified by:
    
    deleteApplicationVpcConfiguration in interface AmazonKinesisAnalyticsV2
    
    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.
    
    InvalidApplicationConfigurationException - The user-provided application configuration is not valid.
    
    See Also:
    
    AWS API Documentation
  - describeApplication
```
public DescribeApplicationResult describeApplication(DescribeApplicationRequest request)
```
    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.
    
    Specified by:
    
    describeApplication in interface AmazonKinesisAnalyticsV2
    
    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
```
public DescribeApplicationSnapshotResult describeApplicationSnapshot(DescribeApplicationSnapshotRequest request)
```
    Returns information about a snapshot of application state data.
    
    Specified by:
    
    describeApplicationSnapshot in interface AmazonKinesisAnalyticsV2
    
    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
```
public DiscoverInputSchemaResult discoverInputSchema(DiscoverInputSchemaRequest request)
```
    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.
    
    Specified by:
    
    discoverInputSchema in interface AmazonKinesisAnalyticsV2
    
    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. 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 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
```
public ListApplicationSnapshotsResult listApplicationSnapshots(ListApplicationSnapshotsRequest request)
```
    Lists information about the current application snapshots.
    
    Specified by:
    
    listApplicationSnapshots in interface AmazonKinesisAnalyticsV2
    
    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
```
public ListApplicationsResult listApplications(ListApplicationsRequest request)
```
    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.
    
    Specified by:
    
    listApplications in interface AmazonKinesisAnalyticsV2
    
    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
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Retrieves the list of key-value tags assigned to the application. For more information, see Using Tagging.
    
    Specified by:
    
    listTagsForResource in interface AmazonKinesisAnalyticsV2
    
    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
```
public StartApplicationResult startApplication(StartApplicationRequest request)
```
    Starts the specified Kinesis Data Analytics application. After creating an application, you must exclusively call this operation to start your application.
    
    Specified by:
    
    startApplication in interface AmazonKinesisAnalyticsV2
    
    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
```
public StopApplicationResult stopApplication(StopApplicationRequest request)
```
    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.
    
    Specified by:
    
    stopApplication in interface AmazonKinesisAnalyticsV2
    
    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.
    
    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
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    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.
    
    Specified by:
    
    tagResource in interface AmazonKinesisAnalyticsV2
    
    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
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Removes one or more tags from a Kinesis Data Analytics application. For more information, see Using Tagging.
    
    Specified by:
    
    untagResource in interface AmazonKinesisAnalyticsV2
    
    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
```
public UpdateApplicationResult updateApplication(UpdateApplicationRequest request)
```
    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.
    
    Specified by:
    
    updateApplication in interface AmazonKinesisAnalyticsV2
    
    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
  - getCachedResponseMetadata
```
public 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 the request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AmazonKinesisAnalyticsV2
    
    Parameters:
    
    request - The originally executed request
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - shutdown
```
public void shutdown()
```
    Description copied from class: AmazonWebServiceClient
    
    Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AmazonKinesisAnalyticsV2
    
    Overrides:
    
    shutdown in class AmazonWebServiceClient

Did this page help you?

Class AmazonKinesisAnalyticsV2Client

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Fields inherited from interface com.amazonaws.services.kinesisanalyticsv2.AmazonKinesisAnalyticsV2

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Method Detail

builder

addApplicationCloudWatchLoggingOption

addApplicationInput

addApplicationInputProcessingConfiguration

addApplicationOutput

addApplicationReferenceDataSource

addApplicationVpcConfiguration

createApplication

createApplicationPresignedUrl

createApplicationSnapshot

deleteApplication

deleteApplicationCloudWatchLoggingOption

deleteApplicationInputProcessingConfiguration

deleteApplicationOutput

deleteApplicationReferenceDataSource

deleteApplicationSnapshot

deleteApplicationVpcConfiguration

describeApplication

describeApplicationSnapshot

discoverInputSchema

listApplicationSnapshots

listApplications

listTagsForResource

startApplication

stopApplication

tagResource

untagResource

updateApplication

getCachedResponseMetadata

shutdown