@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonKinesisAnalytics
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonKinesisAnalytics
instead.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
Modifier and Type | Method and Description |
---|---|
AddApplicationCloudWatchLoggingOptionResult |
addApplicationCloudWatchLoggingOption(AddApplicationCloudWatchLoggingOptionRequest addApplicationCloudWatchLoggingOptionRequest)
Adds a CloudWatch log stream to monitor application configuration errors.
|
AddApplicationInputResult |
addApplicationInput(AddApplicationInputRequest addApplicationInputRequest)
Adds a streaming source to your Amazon Kinesis application.
|
AddApplicationInputProcessingConfigurationResult |
addApplicationInputProcessingConfiguration(AddApplicationInputProcessingConfigurationRequest addApplicationInputProcessingConfigurationRequest)
Adds an InputProcessingConfiguration to an application.
|
AddApplicationOutputResult |
addApplicationOutput(AddApplicationOutputRequest addApplicationOutputRequest)
Adds an external destination to your Amazon Kinesis Analytics application.
|
AddApplicationReferenceDataSourceResult |
addApplicationReferenceDataSource(AddApplicationReferenceDataSourceRequest addApplicationReferenceDataSourceRequest)
Adds a reference data source to an existing application.
|
CreateApplicationResult |
createApplication(CreateApplicationRequest createApplicationRequest)
Creates an Amazon Kinesis Analytics application.
|
DeleteApplicationResult |
deleteApplication(DeleteApplicationRequest deleteApplicationRequest)
Deletes the specified application.
|
DeleteApplicationCloudWatchLoggingOptionResult |
deleteApplicationCloudWatchLoggingOption(DeleteApplicationCloudWatchLoggingOptionRequest deleteApplicationCloudWatchLoggingOptionRequest)
Deletes a CloudWatch log stream from an application.
|
DeleteApplicationInputProcessingConfigurationResult |
deleteApplicationInputProcessingConfiguration(DeleteApplicationInputProcessingConfigurationRequest deleteApplicationInputProcessingConfigurationRequest)
Deletes an InputProcessingConfiguration from an input.
|
DeleteApplicationOutputResult |
deleteApplicationOutput(DeleteApplicationOutputRequest deleteApplicationOutputRequest)
Deletes output destination configuration from your application configuration.
|
DeleteApplicationReferenceDataSourceResult |
deleteApplicationReferenceDataSource(DeleteApplicationReferenceDataSourceRequest deleteApplicationReferenceDataSourceRequest)
Deletes a reference data source configuration from the specified application configuration.
|
DescribeApplicationResult |
describeApplication(DescribeApplicationRequest describeApplicationRequest)
Returns information about a specific Amazon Kinesis Analytics application.
|
DiscoverInputSchemaResult |
discoverInputSchema(DiscoverInputSchemaRequest discoverInputSchemaRequest)
Infers a schema by evaluating sample records on the specified streaming source (Amazon Kinesis stream or Amazon
Kinesis Firehose delivery stream) or 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 Analytics applications in your account.
|
void |
setEndpoint(String endpoint)
Deprecated.
use
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion)); |
void |
setRegion(Region region)
Deprecated.
use
AwsClientBuilder#setRegion(String) |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartApplicationResult |
startApplication(StartApplicationRequest startApplicationRequest)
Starts the specified Amazon Kinesis Analytics application.
|
StopApplicationResult |
stopApplication(StopApplicationRequest stopApplicationRequest)
Stops the application from processing input data.
|
UpdateApplicationResult |
updateApplication(UpdateApplicationRequest updateApplicationRequest)
Updates an existing Amazon Kinesis Analytics application.
|
static final String ENDPOINT_PREFIX
@Deprecated void setEndpoint(String endpoint)
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)
for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
Callers can pass in just the endpoint (ex: "kinesisanalytics.us-east-1.amazonaws.com") or a full URL, including
the protocol (ex: "https://kinesisanalytics.us-east-1.amazonaws.com"). If the protocol is not specified here, the
default protocol from this client's ClientConfiguration
will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
endpoint
- The endpoint (ex: "kinesisanalytics.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
"https://kinesisanalytics.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will
communicate with.@Deprecated void setRegion(Region region)
AwsClientBuilder#setRegion(String)
setEndpoint(String)
, sets the regional endpoint for this
client's service calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
region
- The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,
Region.isServiceSupported(String)
AddApplicationCloudWatchLoggingOptionResult addApplicationCloudWatchLoggingOption(AddApplicationCloudWatchLoggingOptionRequest addApplicationCloudWatchLoggingOptionRequest)
Adds a CloudWatch log stream to monitor application configuration errors. For more information about using CloudWatch log streams with Amazon Kinesis Analytics applications, see Working with Amazon CloudWatch Logs.
addApplicationCloudWatchLoggingOptionRequest
- ResourceNotFoundException
- Specified application can't be found.ResourceInUseException
- Application is not available for this operation.InvalidArgumentException
- Specified input parameter value is invalid.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.AddApplicationInputResult addApplicationInput(AddApplicationInputRequest addApplicationInputRequest)
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.
addApplicationInputRequest
- ResourceNotFoundException
- Specified application can't be found.ResourceInUseException
- Application is not available for this operation.InvalidArgumentException
- Specified input parameter value is invalid.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.CodeValidationException
- User-provided application code (query) is invalid. This can be a simple syntax error.AddApplicationInputProcessingConfigurationResult addApplicationInputProcessingConfiguration(AddApplicationInputProcessingConfigurationRequest addApplicationInputProcessingConfigurationRequest)
Adds an InputProcessingConfiguration to an application. An input processor preprocesses records on the input stream before the application's SQL code executes. Currently, the only input processor available is AWS Lambda.
addApplicationInputProcessingConfigurationRequest
- ResourceNotFoundException
- Specified application can't be found.ResourceInUseException
- Application is not available for this operation.InvalidArgumentException
- Specified input parameter value is invalid.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.AddApplicationOutputResult addApplicationOutput(AddApplicationOutputRequest addApplicationOutputRequest)
Adds an external destination to your Amazon Kinesis Analytics application.
If you want Amazon Kinesis Analytics to deliver data from an in-application stream within your application to an external destination (such as an Amazon Kinesis stream, an Amazon Kinesis Firehose delivery stream, or an Amazon Lambda function), you add the relevant configuration to your application using this operation. You can configure one or more outputs for your application. Each output configuration maps an in-application stream and an external destination.
You can use one of the output configurations to deliver data from your in-application error stream to an external destination so that you can analyze the errors. 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.
addApplicationOutputRequest
- ResourceNotFoundException
- Specified application can't be found.ResourceInUseException
- Application is not available for this operation.InvalidArgumentException
- Specified input parameter value is invalid.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.AddApplicationReferenceDataSourceResult addApplicationReferenceDataSource(AddApplicationReferenceDataSourceRequest addApplicationReferenceDataSourceRequest)
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.
addApplicationReferenceDataSourceRequest
- ResourceNotFoundException
- Specified application can't be found.ResourceInUseException
- Application is not available for this operation.InvalidArgumentException
- Specified input parameter value is invalid.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.CreateApplicationResult createApplication(CreateApplicationRequest createApplicationRequest)
Creates an Amazon Kinesis Analytics application. You can configure each application with one streaming source as input, application code to process the input, and up to three destinations where you want Amazon Kinesis Analytics to write the output data from your application. For an overview, see How it Works.
In the input configuration, you map the streaming source to an in-application stream, which you can think of as a constantly updating table. In the mapping, you must provide a schema for the in-application stream and map each data column in the in-application stream to a data element in the streaming source.
Your application code is one or more SQL statements that read input data, transform it, and generate output. Your application code can create one or more SQL artifacts like SQL streams or pumps.
In the output configuration, you can configure the application to write data from in-application streams created in your applications to up to three destinations.
To read data from your source stream or write data to destination streams, Amazon Kinesis Analytics needs your
permissions. You grant these permissions by creating IAM roles. This operation requires permissions to perform
the kinesisanalytics:CreateApplication
action.
For introductory exercises to create an Amazon Kinesis Analytics application, see Getting Started.
createApplicationRequest
- TBDCodeValidationException
- User-provided application code (query) is invalid. This can be a simple syntax error.ResourceInUseException
- Application is not available for this operation.LimitExceededException
- Exceeded the number of applications allowed.InvalidArgumentException
- Specified input parameter value is invalid.DeleteApplicationResult deleteApplication(DeleteApplicationRequest deleteApplicationRequest)
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.
deleteApplicationRequest
- 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.ResourceNotFoundException
- Specified application can't be found.ResourceInUseException
- Application is not available for this operation.DeleteApplicationCloudWatchLoggingOptionResult deleteApplicationCloudWatchLoggingOption(DeleteApplicationCloudWatchLoggingOptionRequest deleteApplicationCloudWatchLoggingOptionRequest)
Deletes a CloudWatch log stream from an application. For more information about using CloudWatch log streams with Amazon Kinesis Analytics applications, see Working with Amazon CloudWatch Logs.
deleteApplicationCloudWatchLoggingOptionRequest
- ResourceNotFoundException
- Specified application can't be found.ResourceInUseException
- Application is not available for this operation.InvalidArgumentException
- Specified input parameter value is invalid.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.DeleteApplicationInputProcessingConfigurationResult deleteApplicationInputProcessingConfiguration(DeleteApplicationInputProcessingConfigurationRequest deleteApplicationInputProcessingConfigurationRequest)
Deletes an InputProcessingConfiguration from an input.
deleteApplicationInputProcessingConfigurationRequest
- ResourceNotFoundException
- Specified application can't be found.ResourceInUseException
- Application is not available for this operation.InvalidArgumentException
- Specified input parameter value is invalid.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.DeleteApplicationOutputResult deleteApplicationOutput(DeleteApplicationOutputRequest deleteApplicationOutputRequest)
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.
deleteApplicationOutputRequest
- ResourceNotFoundException
- Specified application can't be found.ResourceInUseException
- Application is not available for this operation.InvalidArgumentException
- Specified input parameter value is invalid.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.DeleteApplicationReferenceDataSourceResult deleteApplicationReferenceDataSource(DeleteApplicationReferenceDataSourceRequest deleteApplicationReferenceDataSourceRequest)
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.
deleteApplicationReferenceDataSourceRequest
- ResourceNotFoundException
- Specified application can't be found.ResourceInUseException
- Application is not available for this operation.InvalidArgumentException
- Specified input parameter value is invalid.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.DescribeApplicationResult describeApplication(DescribeApplicationRequest describeApplicationRequest)
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
.
describeApplicationRequest
- ResourceNotFoundException
- Specified application can't be found.DiscoverInputSchemaResult discoverInputSchema(DiscoverInputSchemaRequest discoverInputSchemaRequest)
Infers a schema by evaluating sample records on the specified streaming source (Amazon Kinesis stream or Amazon Kinesis Firehose delivery stream) or S3 object. In the response, the operation returns the inferred schema and also the sample records that the operation used to infer the schema.
You can use the inferred schema when configuring a streaming source for your application. For conceptual information, see Configuring Application Input. Note that when you create an application using the Amazon Kinesis Analytics console, the console uses this operation to infer a schema and show it in the console user interface.
This operation requires permissions to perform the kinesisanalytics:DiscoverInputSchema
action.
discoverInputSchemaRequest
- InvalidArgumentException
- Specified input parameter value is invalid.UnableToDetectSchemaException
- Data format is not valid, Amazon Kinesis Analytics is not able to detect 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 is unavailable, back off and retry the operation.ListApplicationsResult listApplications(ListApplicationsRequest listApplicationsRequest)
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.
listApplicationsRequest
- StartApplicationResult startApplication(StartApplicationRequest startApplicationRequest)
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.
startApplicationRequest
- ResourceNotFoundException
- Specified application can't be found.ResourceInUseException
- Application is not available for this operation.InvalidArgumentException
- Specified input parameter value is invalid.InvalidApplicationConfigurationException
- User-provided application configuration is not valid.StopApplicationResult stopApplication(StopApplicationRequest stopApplicationRequest)
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.
stopApplicationRequest
- ResourceNotFoundException
- Specified application can't be found.ResourceInUseException
- Application is not available for this operation.UpdateApplicationResult updateApplication(UpdateApplicationRequest updateApplicationRequest)
Updates an existing Amazon Kinesis Analytics application. Using this API, you can update application code, input configuration, and output configuration.
Note that Amazon Kinesis Analytics updates the CurrentApplicationVersionId
each time you update your
application.
This operation requires permission for the kinesisanalytics:UpdateApplication
action.
updateApplicationRequest
- CodeValidationException
- User-provided application code (query) is invalid. This can be a simple syntax error.ResourceNotFoundException
- Specified application can't be found.ResourceInUseException
- Application is not available for this operation.InvalidArgumentException
- Specified input parameter value is invalid.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.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
request
- The originally executed request.Copyright © 2018. All rights reserved.