@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonKinesisAnalyticsV2 extends Object implements AmazonKinesisAnalyticsV2
AmazonKinesisAnalyticsV2
. Convenient method forms pass through to the
corresponding overload that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
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.
|
CreateApplicationResult |
createApplication(CreateApplicationRequest request)
Creates a Managed Service for Apache Flink 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 SQL-based 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 Managed Service for Apache Flink application.
|
DescribeApplicationResult |
describeApplication(DescribeApplicationRequest request)
Returns information about a specific Managed Service for Apache Flink application.
|
DescribeApplicationSnapshotResult |
describeApplicationSnapshot(DescribeApplicationSnapshotRequest request)
Returns information about a snapshot of application state data.
|
DescribeApplicationVersionResult |
describeApplicationVersion(DescribeApplicationVersionRequest request)
Provides a detailed description of a specified version of the application.
|
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 Managed Service for Apache Flink applications in your account.
|
ListApplicationSnapshotsResult |
listApplicationSnapshots(ListApplicationSnapshotsRequest request)
Lists information about the current application snapshots.
|
ListApplicationVersionsResult |
listApplicationVersions(ListApplicationVersionsRequest request)
Lists all the versions for the specified application, including versions that were rolled back.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Retrieves the list of key-value tags assigned to the application.
|
RollbackApplicationResult |
rollbackApplication(RollbackApplicationRequest request)
Reverts the application to the previous running version.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartApplicationResult |
startApplication(StartApplicationRequest request)
Starts the specified Managed Service for Apache Flink application.
|
StopApplicationResult |
stopApplication(StopApplicationRequest request)
Stops the application from processing data.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Adds one or more key-value tags to a Managed Service for Apache Flink application.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes one or more tags from a Managed Service for Apache Flink application.
|
UpdateApplicationResult |
updateApplication(UpdateApplicationRequest request)
Updates an existing Managed Service for Apache Flink application.
|
UpdateApplicationMaintenanceConfigurationResult |
updateApplicationMaintenanceConfiguration(UpdateApplicationMaintenanceConfigurationRequest request)
Updates the maintenance configuration of the Managed Service for Apache Flink application.
|
public AddApplicationCloudWatchLoggingOptionResult addApplicationCloudWatchLoggingOption(AddApplicationCloudWatchLoggingOptionRequest request)
AmazonKinesisAnalyticsV2
Adds an Amazon CloudWatch log stream to monitor application configuration errors.
addApplicationCloudWatchLoggingOption
in interface AmazonKinesisAnalyticsV2
public AddApplicationInputResult addApplicationInput(AddApplicationInputRequest request)
AmazonKinesisAnalyticsV2
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.
addApplicationInput
in interface AmazonKinesisAnalyticsV2
public AddApplicationInputProcessingConfigurationResult addApplicationInputProcessingConfiguration(AddApplicationInputProcessingConfigurationRequest request)
AmazonKinesisAnalyticsV2
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 Amazon Lambda.
addApplicationInputProcessingConfiguration
in interface AmazonKinesisAnalyticsV2
public AddApplicationOutputResult addApplicationOutput(AddApplicationOutputRequest request)
AmazonKinesisAnalyticsV2
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 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.
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.
addApplicationOutput
in interface AmazonKinesisAnalyticsV2
public AddApplicationReferenceDataSourceResult addApplicationReferenceDataSource(AddApplicationReferenceDataSourceRequest request)
AmazonKinesisAnalyticsV2
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.
addApplicationReferenceDataSource
in interface AmazonKinesisAnalyticsV2
public AddApplicationVpcConfigurationResult addApplicationVpcConfiguration(AddApplicationVpcConfigurationRequest request)
AmazonKinesisAnalyticsV2
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 Managed Service for Apache Flink applications:
VPC configurations are not supported for SQL applications.
When a VPC is added to a Managed Service for Apache Flink 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.
addApplicationVpcConfiguration
in interface AmazonKinesisAnalyticsV2
public CreateApplicationResult createApplication(CreateApplicationRequest request)
AmazonKinesisAnalyticsV2
Creates a Managed Service for Apache Flink application. For information about creating a Managed Service for Apache Flink application, see Creating an Application.
createApplication
in interface AmazonKinesisAnalyticsV2
public CreateApplicationPresignedUrlResult createApplicationPresignedUrl(CreateApplicationPresignedUrlRequest request)
AmazonKinesisAnalyticsV2
Creates and returns a URL that you can use to connect to an application's extension.
The IAM role or user used to call this API defines the permissions to access the extension. After 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.
You control the amount of time that the URL will be valid using the
SessionExpirationDurationInSeconds
parameter. If you do not provide this parameter, the returned URL
is valid for twelve hours.
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.
createApplicationPresignedUrl
in interface AmazonKinesisAnalyticsV2
public CreateApplicationSnapshotResult createApplicationSnapshot(CreateApplicationSnapshotRequest request)
AmazonKinesisAnalyticsV2
Creates a snapshot of the application's state data.
createApplicationSnapshot
in interface AmazonKinesisAnalyticsV2
public DeleteApplicationResult deleteApplication(DeleteApplicationRequest request)
AmazonKinesisAnalyticsV2
Deletes the specified application. Managed Service for Apache Flink halts application execution and deletes the application.
deleteApplication
in interface AmazonKinesisAnalyticsV2
public DeleteApplicationCloudWatchLoggingOptionResult deleteApplicationCloudWatchLoggingOption(DeleteApplicationCloudWatchLoggingOptionRequest request)
AmazonKinesisAnalyticsV2
Deletes an Amazon CloudWatch log stream from an SQL-based Kinesis Data Analytics application.
deleteApplicationCloudWatchLoggingOption
in interface AmazonKinesisAnalyticsV2
public DeleteApplicationInputProcessingConfigurationResult deleteApplicationInputProcessingConfiguration(DeleteApplicationInputProcessingConfigurationRequest request)
AmazonKinesisAnalyticsV2
Deletes an InputProcessingConfiguration from an input.
deleteApplicationInputProcessingConfiguration
in interface AmazonKinesisAnalyticsV2
public DeleteApplicationOutputResult deleteApplicationOutput(DeleteApplicationOutputRequest request)
AmazonKinesisAnalyticsV2
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.
deleteApplicationOutput
in interface AmazonKinesisAnalyticsV2
public DeleteApplicationReferenceDataSourceResult deleteApplicationReferenceDataSource(DeleteApplicationReferenceDataSourceRequest request)
AmazonKinesisAnalyticsV2
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.
deleteApplicationReferenceDataSource
in interface AmazonKinesisAnalyticsV2
public DeleteApplicationSnapshotResult deleteApplicationSnapshot(DeleteApplicationSnapshotRequest request)
AmazonKinesisAnalyticsV2
Deletes a snapshot of application state.
deleteApplicationSnapshot
in interface AmazonKinesisAnalyticsV2
public DeleteApplicationVpcConfigurationResult deleteApplicationVpcConfiguration(DeleteApplicationVpcConfigurationRequest request)
AmazonKinesisAnalyticsV2
Removes a VPC configuration from a Managed Service for Apache Flink application.
deleteApplicationVpcConfiguration
in interface AmazonKinesisAnalyticsV2
public DescribeApplicationResult describeApplication(DescribeApplicationRequest request)
AmazonKinesisAnalyticsV2
Returns information about a specific Managed Service for Apache Flink application.
If you want to retrieve a list of all applications in your account, use the ListApplications operation.
describeApplication
in interface AmazonKinesisAnalyticsV2
public DescribeApplicationSnapshotResult describeApplicationSnapshot(DescribeApplicationSnapshotRequest request)
AmazonKinesisAnalyticsV2
Returns information about a snapshot of application state data.
describeApplicationSnapshot
in interface AmazonKinesisAnalyticsV2
public DescribeApplicationVersionResult describeApplicationVersion(DescribeApplicationVersionRequest request)
AmazonKinesisAnalyticsV2
Provides a detailed description of a specified version of the application. To see a list of all the versions of an application, invoke the ListApplicationVersions operation.
This operation is supported only for Managed Service for Apache Flink.
describeApplicationVersion
in interface AmazonKinesisAnalyticsV2
public DiscoverInputSchemaResult discoverInputSchema(DiscoverInputSchemaRequest request)
AmazonKinesisAnalyticsV2
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.
discoverInputSchema
in interface AmazonKinesisAnalyticsV2
public ListApplicationSnapshotsResult listApplicationSnapshots(ListApplicationSnapshotsRequest request)
AmazonKinesisAnalyticsV2
Lists information about the current application snapshots.
listApplicationSnapshots
in interface AmazonKinesisAnalyticsV2
public ListApplicationVersionsResult listApplicationVersions(ListApplicationVersionsRequest request)
AmazonKinesisAnalyticsV2
Lists all the versions for the specified application, including versions that were rolled back. The response also includes a summary of the configuration associated with each version.
To get the complete description of a specific application version, invoke the DescribeApplicationVersion operation.
This operation is supported only for Managed Service for Apache Flink.
listApplicationVersions
in interface AmazonKinesisAnalyticsV2
public ListApplicationsResult listApplications(ListApplicationsRequest request)
AmazonKinesisAnalyticsV2
Returns a list of Managed Service for Apache Flink 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.
listApplications
in interface AmazonKinesisAnalyticsV2
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AmazonKinesisAnalyticsV2
Retrieves the list of key-value tags assigned to the application. For more information, see Using Tagging.
listTagsForResource
in interface AmazonKinesisAnalyticsV2
public RollbackApplicationResult rollbackApplication(RollbackApplicationRequest request)
AmazonKinesisAnalyticsV2
Reverts the application to the previous running version. You can roll back an application if you suspect it is stuck in a transient status.
You can roll back an application only if it is in the UPDATING
or AUTOSCALING
status.
When you rollback an application, it loads state data from the last successful snapshot. If the application has no snapshots, Managed Service for Apache Flink rejects the rollback request.
This action is not supported for Managed Service for Apache Flink for SQL applications.
rollbackApplication
in interface AmazonKinesisAnalyticsV2
public StartApplicationResult startApplication(StartApplicationRequest request)
AmazonKinesisAnalyticsV2
Starts the specified Managed Service for Apache Flink application. After creating an application, you must exclusively call this operation to start your application.
startApplication
in interface AmazonKinesisAnalyticsV2
public StopApplicationResult stopApplication(StopApplicationRequest request)
AmazonKinesisAnalyticsV2
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.
Managed Service for Apache Flink takes a snapshot when the application is stopped, unless Force
is
set to true
.
stopApplication
in interface AmazonKinesisAnalyticsV2
public TagResourceResult tagResource(TagResourceRequest request)
AmazonKinesisAnalyticsV2
Adds one or more key-value tags to a Managed Service for Apache Flink 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.
tagResource
in interface AmazonKinesisAnalyticsV2
public UntagResourceResult untagResource(UntagResourceRequest request)
AmazonKinesisAnalyticsV2
Removes one or more tags from a Managed Service for Apache Flink application. For more information, see Using Tagging.
untagResource
in interface AmazonKinesisAnalyticsV2
public UpdateApplicationResult updateApplication(UpdateApplicationRequest request)
AmazonKinesisAnalyticsV2
Updates an existing Managed Service for Apache Flink application. Using this operation, you can update application code, input configuration, and output configuration.
Managed Service for Apache Flink updates the ApplicationVersionId
each time you update your
application.
updateApplication
in interface AmazonKinesisAnalyticsV2
public UpdateApplicationMaintenanceConfigurationResult updateApplicationMaintenanceConfiguration(UpdateApplicationMaintenanceConfigurationRequest request)
AmazonKinesisAnalyticsV2
Updates the maintenance configuration of the Managed Service for Apache Flink application.
You can invoke this operation on an application that is in one of the two following states: READY
or
RUNNING
. If you invoke it when the application is in a state other than these two states, it throws
a ResourceInUseException
. The service makes use of the updated configuration the next time it
schedules maintenance for the application. If you invoke this operation after the service schedules maintenance,
the service will apply the configuration update the next time it schedules maintenance for the application. This
means that you might not see the maintenance configuration update applied to the maintenance process that follows
a successful invocation of this operation, but to the following maintenance process instead.
To see the current maintenance configuration of your application, invoke the DescribeApplication operation.
For information about application maintenance, see Managed Service for Apache Flink for Apache Flink Maintenance.
This operation is supported only for Managed Service for Apache Flink.
updateApplicationMaintenanceConfiguration
in interface AmazonKinesisAnalyticsV2
public void shutdown()
AmazonKinesisAnalyticsV2
shutdown
in interface AmazonKinesisAnalyticsV2
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonKinesisAnalyticsV2
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.
getCachedResponseMetadata
in interface AmazonKinesisAnalyticsV2
request
- The originally executed request.