com.amazonaws.services.kinesisanalytics.AmazonKinesisAnalyticsClient Maven / Gradle / Ivy
Show all versions of aws-java-sdk-kinesis Show documentation
/*
* Copyright 2012-2017 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 org.w3c.dom.*;
import java.net.*;
import java.util.*;
import java.util.Map.Entry;
import org.apache.commons.logging.*;
import com.amazonaws.*;
import com.amazonaws.auth.*;
import com.amazonaws.auth.presign.PresignerParams;
import com.amazonaws.handlers.*;
import com.amazonaws.http.*;
import com.amazonaws.internal.*;
import com.amazonaws.internal.auth.*;
import com.amazonaws.metrics.*;
import com.amazonaws.regions.*;
import com.amazonaws.transform.*;
import com.amazonaws.util.*;
import com.amazonaws.protocol.json.*;
import com.amazonaws.util.AWSRequestMetrics.Field;
import com.amazonaws.annotation.ThreadSafe;
import com.amazonaws.client.AwsSyncClientParams;
import com.amazonaws.AmazonServiceException;
import com.amazonaws.services.kinesisanalytics.model.*;
import com.amazonaws.services.kinesisanalytics.model.transform.*;
/**
* Client for accessing Kinesis Analytics. All service calls made using this client are blocking, and will not return
* until the service call completes.
*
*
*/
@ThreadSafe
public class AmazonKinesisAnalyticsClient extends AmazonWebServiceClient implements AmazonKinesisAnalytics {
/** Provider for AWS credentials. */
private final AWSCredentialsProvider awsCredentialsProvider;
private static final Log log = LogFactory.getLog(AmazonKinesisAnalytics.class);
/** Default signing name for the service. */
private static final String DEFAULT_SIGNING_NAME = "kinesisanalytics";
/** Client configuration factory providing ClientConfigurations tailored to this client */
protected static final ClientConfigurationFactory configFactory = new ClientConfigurationFactory();
private final com.amazonaws.protocol.json.SdkJsonProtocolFactory protocolFactory = new com.amazonaws.protocol.json.SdkJsonProtocolFactory(
new JsonClientMetadata()
.withProtocolVersion("1.1")
.withSupportsCbor(false)
.withSupportsIon(false)
.addErrorMetadata(
new JsonErrorShapeMetadata().withErrorCode("ConcurrentModificationException").withModeledClass(
com.amazonaws.services.kinesisanalytics.model.ConcurrentModificationException.class))
.addErrorMetadata(
new JsonErrorShapeMetadata().withErrorCode("InvalidApplicationConfigurationException").withModeledClass(
com.amazonaws.services.kinesisanalytics.model.InvalidApplicationConfigurationException.class))
.addErrorMetadata(
new JsonErrorShapeMetadata().withErrorCode("UnableToDetectSchemaException").withModeledClass(
com.amazonaws.services.kinesisanalytics.model.UnableToDetectSchemaException.class))
.addErrorMetadata(
new JsonErrorShapeMetadata().withErrorCode("CodeValidationException").withModeledClass(
com.amazonaws.services.kinesisanalytics.model.CodeValidationException.class))
.addErrorMetadata(
new JsonErrorShapeMetadata().withErrorCode("InvalidArgumentException").withModeledClass(
com.amazonaws.services.kinesisanalytics.model.InvalidArgumentException.class))
.addErrorMetadata(
new JsonErrorShapeMetadata().withErrorCode("ResourceInUseException").withModeledClass(
com.amazonaws.services.kinesisanalytics.model.ResourceInUseException.class))
.addErrorMetadata(
new JsonErrorShapeMetadata().withErrorCode("ResourceNotFoundException").withModeledClass(
com.amazonaws.services.kinesisanalytics.model.ResourceNotFoundException.class))
.addErrorMetadata(
new JsonErrorShapeMetadata().withErrorCode("ResourceProvisionedThroughputExceededException").withModeledClass(
com.amazonaws.services.kinesisanalytics.model.ResourceProvisionedThroughputExceededException.class))
.addErrorMetadata(
new JsonErrorShapeMetadata().withErrorCode("LimitExceededException").withModeledClass(
com.amazonaws.services.kinesisanalytics.model.LimitExceededException.class))
.withBaseServiceExceptionClass(com.amazonaws.services.kinesisanalytics.model.AmazonKinesisAnalyticsException.class));
/**
* Constructs a new client to invoke service methods on Kinesis Analytics. A credentials provider chain will be used
* that searches for credentials in this order:
*
* - Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
* - Java System Properties - aws.accessKeyId and aws.secretKey
* - Instance profile credentials delivered through the Amazon EC2 metadata service
*
*
*
* All service calls made using this new client object are blocking, and will not return until the service call
* completes.
*
* @see DefaultAWSCredentialsProviderChain
*/
public AmazonKinesisAnalyticsClient() {
this(DefaultAWSCredentialsProviderChain.getInstance(), configFactory.getConfig());
}
/**
* Constructs a new client to invoke service methods on Kinesis Analytics. A credentials provider chain will be used
* that searches for credentials in this order:
*
* - Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
* - Java System Properties - aws.accessKeyId and aws.secretKey
* - Instance profile credentials delivered through the Amazon EC2 metadata service
*
*
*
* All service calls made using this new client object are blocking, and will not return until the service call
* completes.
*
* @param clientConfiguration
* The client configuration options controlling how this client connects to Kinesis Analytics (ex: proxy
* settings, retry counts, etc.).
*
* @see DefaultAWSCredentialsProviderChain
*/
public AmazonKinesisAnalyticsClient(ClientConfiguration clientConfiguration) {
this(DefaultAWSCredentialsProviderChain.getInstance(), clientConfiguration);
}
/**
* Constructs a new client to invoke service methods on Kinesis Analytics using the specified AWS account
* credentials.
*
*
* All service calls made using this new client object are blocking, and will not return until the service call
* completes.
*
* @param awsCredentials
* The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
*/
public AmazonKinesisAnalyticsClient(AWSCredentials awsCredentials) {
this(awsCredentials, configFactory.getConfig());
}
/**
* Constructs a new client to invoke service methods on Kinesis Analytics using the specified AWS account
* credentials and client configuration options.
*
*
* All service calls made using this new client object are blocking, and will not return until the service call
* completes.
*
* @param awsCredentials
* The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
* @param clientConfiguration
* The client configuration options controlling how this client connects to Kinesis Analytics (ex: proxy
* settings, retry counts, etc.).
*/
public AmazonKinesisAnalyticsClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) {
super(clientConfiguration);
this.awsCredentialsProvider = new StaticCredentialsProvider(awsCredentials);
init();
}
/**
* Constructs a new client to invoke service methods on Kinesis Analytics using the specified AWS account
* credentials provider.
*
*
* All service calls made using this new client object are blocking, and will not return until the service call
* completes.
*
* @param awsCredentialsProvider
* The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
*/
public AmazonKinesisAnalyticsClient(AWSCredentialsProvider awsCredentialsProvider) {
this(awsCredentialsProvider, configFactory.getConfig());
}
/**
* Constructs a new client to invoke service methods on Kinesis Analytics using the specified AWS account
* credentials provider and client configuration options.
*
*
* All service calls made using this new client object are blocking, and will not return until the service call
* completes.
*
* @param awsCredentialsProvider
* The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
* @param clientConfiguration
* The client configuration options controlling how this client connects to Kinesis Analytics (ex: proxy
* settings, retry counts, etc.).
*/
public AmazonKinesisAnalyticsClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) {
this(awsCredentialsProvider, clientConfiguration, null);
}
/**
* Constructs a new client to invoke service methods on Kinesis Analytics using the specified AWS account
* credentials provider, client configuration options, and request metric collector.
*
*
* All service calls made using this new client object are blocking, and will not return until the service call
* completes.
*
* @param awsCredentialsProvider
* The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
* @param clientConfiguration
* The client configuration options controlling how this client connects to Kinesis Analytics (ex: proxy
* settings, retry counts, etc.).
* @param requestMetricCollector
* optional request metric collector
*/
public AmazonKinesisAnalyticsClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector) {
super(clientConfiguration, requestMetricCollector);
this.awsCredentialsProvider = awsCredentialsProvider;
init();
}
/**
* Constructs a new client to invoke service methods on Kinesis Analytics using the specified parameters.
*
*
* All service calls made using this new client object are blocking, and will not return until the service call
* completes.
*
* @param clientParams
* Object providing client parameters.
*/
AmazonKinesisAnalyticsClient(AwsSyncClientParams clientParams) {
super(clientParams);
this.awsCredentialsProvider = clientParams.getCredentialsProvider();
init();
}
private void init() {
setServiceNameIntern(DEFAULT_SIGNING_NAME);
setEndpointPrefix(ENDPOINT_PREFIX);
// calling this.setEndPoint(...) will also modify the signer accordingly
setEndpoint("https://kinesisanalytics.us-east-1.amazonaws.com");
HandlerChainFactory chainFactory = new HandlerChainFactory();
requestHandler2s.addAll(chainFactory.newRequestHandlerChain("/com/amazonaws/services/kinesisanalytics/request.handlers"));
requestHandler2s.addAll(chainFactory.newRequestHandler2Chain("/com/amazonaws/services/kinesisanalytics/request.handler2s"));
requestHandler2s.addAll(chainFactory.getGlobalHandlers());
}
/**
*
* 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.
*
*
* @param addApplicationInputRequest
* @return Result of the AddApplicationInput 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.
* @sample AmazonKinesisAnalytics.AddApplicationInput
* @see AWS API Documentation
*/
@Override
public AddApplicationInputResult addApplicationInput(AddApplicationInputRequest addApplicationInputRequest) {
ExecutionContext executionContext = createExecutionContext(addApplicationInputRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new AddApplicationInputRequestMarshaller(protocolFactory).marshall(super.beforeMarshalling(addApplicationInputRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(
new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new AddApplicationInputResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* 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 or a Firehose delivery stream), 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 conceptual information, see Understanding Application
* Output (Destination).
*
*
* Note that 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.
*
*
* @param addApplicationOutputRequest
* @return Result of the AddApplicationOutput 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.
* @sample AmazonKinesisAnalytics.AddApplicationOutput
* @see AWS API Documentation
*/
@Override
public AddApplicationOutputResult addApplicationOutput(AddApplicationOutputRequest addApplicationOutputRequest) {
ExecutionContext executionContext = createExecutionContext(addApplicationOutputRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new AddApplicationOutputRequestMarshaller(protocolFactory).marshall(super.beforeMarshalling(addApplicationOutputRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(
new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new AddApplicationOutputResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* 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.
*
*
* @param addApplicationReferenceDataSourceRequest
* @return Result of the AddApplicationReferenceDataSource 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.
* @sample AmazonKinesisAnalytics.AddApplicationReferenceDataSource
* @see AWS API Documentation
*/
@Override
public AddApplicationReferenceDataSourceResult addApplicationReferenceDataSource(
AddApplicationReferenceDataSourceRequest addApplicationReferenceDataSourceRequest) {
ExecutionContext executionContext = createExecutionContext(addApplicationReferenceDataSourceRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new AddApplicationReferenceDataSourceRequestMarshaller(protocolFactory).marshall(super
.beforeMarshalling(addApplicationReferenceDataSourceRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(
new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false),
new AddApplicationReferenceDataSourceResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* 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 five streaming 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, with the option of renaming,
* casting and dropping columns as desired.
*
*
* 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 five streaming 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.
* @sample AmazonKinesisAnalytics.CreateApplication
* @see AWS API Documentation
*/
@Override
public CreateApplicationResult createApplication(CreateApplicationRequest createApplicationRequest) {
ExecutionContext executionContext = createExecutionContext(createApplicationRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new CreateApplicationRequestMarshaller(protocolFactory).marshall(super.beforeMarshalling(createApplicationRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(
new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new CreateApplicationResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* 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.
*
*
* @param deleteApplicationRequest
* @return Result of the DeleteApplication operation returned by the service.
* @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 ResourceNotFoundException
* Specified application can't be found.
* @throws ResourceInUseException
* Application is not available for this operation.
* @sample AmazonKinesisAnalytics.DeleteApplication
* @see AWS API Documentation
*/
@Override
public DeleteApplicationResult deleteApplication(DeleteApplicationRequest deleteApplicationRequest) {
ExecutionContext executionContext = createExecutionContext(deleteApplicationRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new DeleteApplicationRequestMarshaller(protocolFactory).marshall(super.beforeMarshalling(deleteApplicationRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(
new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new DeleteApplicationResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* 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.
*
*
* @param deleteApplicationOutputRequest
* @return Result of the DeleteApplicationOutput operation returned by the service.
* @throws ResourceNotFoundException
* Specified application can't be found.
* @throws ResourceInUseException
* Application is not available for this operation.
* @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.DeleteApplicationOutput
* @see AWS API Documentation
*/
@Override
public DeleteApplicationOutputResult deleteApplicationOutput(DeleteApplicationOutputRequest deleteApplicationOutputRequest) {
ExecutionContext executionContext = createExecutionContext(deleteApplicationOutputRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new DeleteApplicationOutputRequestMarshaller(protocolFactory).marshall(super.beforeMarshalling(deleteApplicationOutputRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(
new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false),
new DeleteApplicationOutputResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* 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.
*
*
* @param deleteApplicationReferenceDataSourceRequest
* @return Result of the DeleteApplicationReferenceDataSource 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.
* @sample AmazonKinesisAnalytics.DeleteApplicationReferenceDataSource
* @see AWS API Documentation
*/
@Override
public DeleteApplicationReferenceDataSourceResult deleteApplicationReferenceDataSource(
DeleteApplicationReferenceDataSourceRequest deleteApplicationReferenceDataSourceRequest) {
ExecutionContext executionContext = createExecutionContext(deleteApplicationReferenceDataSourceRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new DeleteApplicationReferenceDataSourceRequestMarshaller(protocolFactory).marshall(super
.beforeMarshalling(deleteApplicationReferenceDataSourceRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(
new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false),
new DeleteApplicationReferenceDataSourceResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* 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
.
*
*
* @param describeApplicationRequest
* @return Result of the DescribeApplication operation returned by the service.
* @throws ResourceNotFoundException
* Specified application can't be found.
* @sample AmazonKinesisAnalytics.DescribeApplication
* @see AWS API Documentation
*/
@Override
public DescribeApplicationResult describeApplication(DescribeApplicationRequest describeApplicationRequest) {
ExecutionContext executionContext = createExecutionContext(describeApplicationRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new DescribeApplicationRequestMarshaller(protocolFactory).marshall(super.beforeMarshalling(describeApplicationRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(
new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new DescribeApplicationResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* Infers a schema by evaluating sample records on the specified streaming source (Amazon Kinesis stream or Amazon
* Kinesis Firehose delivery stream). 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.
*
*
* @param discoverInputSchemaRequest
* @return Result of the DiscoverInputSchema operation returned by the service.
* @throws InvalidArgumentException
* Specified input parameter value is invalid.
* @throws UnableToDetectSchemaException
* Data format is not valid, Kinesis Analytics is not able to detect schema for the given streaming source.
* @throws ResourceProvisionedThroughputExceededException
* Discovery failed to get a record from the streaming source because of the Kinesis Streams
* ProvisionedThroughputExceededException.
* @sample AmazonKinesisAnalytics.DiscoverInputSchema
* @see AWS API Documentation
*/
@Override
public DiscoverInputSchemaResult discoverInputSchema(DiscoverInputSchemaRequest discoverInputSchemaRequest) {
ExecutionContext executionContext = createExecutionContext(discoverInputSchemaRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new DiscoverInputSchemaRequestMarshaller(protocolFactory).marshall(super.beforeMarshalling(discoverInputSchemaRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(
new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new DiscoverInputSchemaResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* 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.
*
*
* @param listApplicationsRequest
* @return Result of the ListApplications operation returned by the service.
* @sample AmazonKinesisAnalytics.ListApplications
* @see AWS API Documentation
*/
@Override
public ListApplicationsResult listApplications(ListApplicationsRequest listApplicationsRequest) {
ExecutionContext executionContext = createExecutionContext(listApplicationsRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new ListApplicationsRequestMarshaller(protocolFactory).marshall(super.beforeMarshalling(listApplicationsRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(
new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new ListApplicationsResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* 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.
*
*
* @param startApplicationRequest
* @return Result of the StartApplication 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 InvalidApplicationConfigurationException
* User-provided application configuration is not valid.
* @sample AmazonKinesisAnalytics.StartApplication
* @see AWS API Documentation
*/
@Override
public StartApplicationResult startApplication(StartApplicationRequest startApplicationRequest) {
ExecutionContext executionContext = createExecutionContext(startApplicationRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new StartApplicationRequestMarshaller(protocolFactory).marshall(super.beforeMarshalling(startApplicationRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(
new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new StartApplicationResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* 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.
*
*
* @param stopApplicationRequest
* @return Result of the StopApplication operation returned by the service.
* @throws ResourceNotFoundException
* Specified application can't be found.
* @throws ResourceInUseException
* Application is not available for this operation.
* @sample AmazonKinesisAnalytics.StopApplication
* @see AWS API Documentation
*/
@Override
public StopApplicationResult stopApplication(StopApplicationRequest stopApplicationRequest) {
ExecutionContext executionContext = createExecutionContext(stopApplicationRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new StopApplicationRequestMarshaller(protocolFactory).marshall(super.beforeMarshalling(stopApplicationRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(
new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new StopApplicationResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* Updates an existing Kinesis Analytics application. Using this API, you can update application code, input
* configuration, and output configuration.
*
*
* Note that Kinesis Analytics updates the CurrentApplicationVersionId
each time you update your
* application.
*
*
* This opeation requires permission for the kinesisanalytics:UpdateApplication
action.
*
*
* @param updateApplicationRequest
* @return Result of the UpdateApplication operation returned by the service.
* @throws CodeValidationException
* User-provided application code (query) is invalid. This can be a simple syntax error.
* @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.
* @sample AmazonKinesisAnalytics.UpdateApplication
* @see AWS API Documentation
*/
@Override
public UpdateApplicationResult updateApplication(UpdateApplicationRequest updateApplicationRequest) {
ExecutionContext executionContext = createExecutionContext(updateApplicationRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new UpdateApplicationRequestMarshaller(protocolFactory).marshall(super.beforeMarshalling(updateApplicationRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(
new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new UpdateApplicationResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
* 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.
*
* @param request
* The originally executed request
*
* @return The response metadata for the specified request, or null if none is available.
*/
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request) {
return client.getResponseMetadataForRequest(request);
}
/**
* Normal invoke with authentication. Credentials are required and may be overriden at the request level.
**/
private Response invoke(Request request, HttpResponseHandler> responseHandler,
ExecutionContext executionContext) {
executionContext.setCredentialsProvider(CredentialUtils.getCredentialsProvider(request.getOriginalRequest(), awsCredentialsProvider));
return doInvoke(request, responseHandler, executionContext);
}
/**
* Invoke with no authentication. Credentials are not required and any credentials set on the client or request will
* be ignored for this operation.
**/
private Response anonymousInvoke(Request request,
HttpResponseHandler> responseHandler, ExecutionContext executionContext) {
return doInvoke(request, responseHandler, executionContext);
}
/**
* Invoke the request using the http client. Assumes credentials (or lack thereof) have been configured in the
* ExecutionContext beforehand.
**/
private Response doInvoke(Request request, HttpResponseHandler> responseHandler,
ExecutionContext executionContext) {
request.setEndpoint(endpoint);
request.setTimeOffset(timeOffset);
HttpResponseHandler errorResponseHandler = protocolFactory.createErrorResponseHandler(new JsonErrorResponseMetadata());
return client.execute(request, responseHandler, errorResponseHandler, executionContext);
}
}