cloudworker-proxy
Version:
An api gateway for cloudflare workers
742 lines • 107 kB
TypeScript
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class KinesisAnalyticsV2 extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: KinesisAnalyticsV2.Types.ClientConfiguration)
config: Config & KinesisAnalyticsV2.Types.ClientConfiguration;
/**
* Adds an Amazon CloudWatch log stream to monitor application configuration errors.
*/
addApplicationCloudWatchLoggingOption(params: KinesisAnalyticsV2.Types.AddApplicationCloudWatchLoggingOptionRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.AddApplicationCloudWatchLoggingOptionResponse) => void): Request<KinesisAnalyticsV2.Types.AddApplicationCloudWatchLoggingOptionResponse, AWSError>;
/**
* Adds an Amazon CloudWatch log stream to monitor application configuration errors.
*/
addApplicationCloudWatchLoggingOption(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.AddApplicationCloudWatchLoggingOptionResponse) => void): Request<KinesisAnalyticsV2.Types.AddApplicationCloudWatchLoggingOptionResponse, AWSError>;
/**
* Adds a streaming source to your SQL-based Amazon Kinesis Data Analytics application. You can add a streaming source when you create an application, or you can use this operation to add a streaming source after you create an application. For more information, see CreateApplication. Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version.
*/
addApplicationInput(params: KinesisAnalyticsV2.Types.AddApplicationInputRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.AddApplicationInputResponse) => void): Request<KinesisAnalyticsV2.Types.AddApplicationInputResponse, AWSError>;
/**
* Adds a streaming source to your SQL-based Amazon Kinesis Data Analytics application. You can add a streaming source when you create an application, or you can use this operation to add a streaming source after you create an application. For more information, see CreateApplication. Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version.
*/
addApplicationInput(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.AddApplicationInputResponse) => void): Request<KinesisAnalyticsV2.Types.AddApplicationInputResponse, AWSError>;
/**
* Adds an InputProcessingConfiguration to an SQL-based Kinesis Data Analytics application. An input processor pre-processes records on the input stream before the application's SQL code executes. Currently, the only input processor available is AWS Lambda.
*/
addApplicationInputProcessingConfiguration(params: KinesisAnalyticsV2.Types.AddApplicationInputProcessingConfigurationRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.AddApplicationInputProcessingConfigurationResponse) => void): Request<KinesisAnalyticsV2.Types.AddApplicationInputProcessingConfigurationResponse, AWSError>;
/**
* Adds an InputProcessingConfiguration to an SQL-based Kinesis Data Analytics application. An input processor pre-processes records on the input stream before the application's SQL code executes. Currently, the only input processor available is AWS Lambda.
*/
addApplicationInputProcessingConfiguration(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.AddApplicationInputProcessingConfigurationResponse) => void): Request<KinesisAnalyticsV2.Types.AddApplicationInputProcessingConfigurationResponse, AWSError>;
/**
* Adds an external destination to your SQL-based Amazon Kinesis Data Analytics application. If you want Kinesis Data Analytics to deliver data from an in-application stream within your application to an external destination (such as an Kinesis data stream, a Kinesis Data Firehose delivery stream, or an AWS Lambda function), you add the relevant configuration to your application using this operation. You can configure one or more outputs for your application. Each output configuration maps an in-application stream and an external destination. You can use one of the output configurations to deliver data from your in-application error stream to an external destination so that you can analyze the errors. Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version.
*/
addApplicationOutput(params: KinesisAnalyticsV2.Types.AddApplicationOutputRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.AddApplicationOutputResponse) => void): Request<KinesisAnalyticsV2.Types.AddApplicationOutputResponse, AWSError>;
/**
* Adds an external destination to your SQL-based Amazon Kinesis Data Analytics application. If you want Kinesis Data Analytics to deliver data from an in-application stream within your application to an external destination (such as an Kinesis data stream, a Kinesis Data Firehose delivery stream, or an AWS Lambda function), you add the relevant configuration to your application using this operation. You can configure one or more outputs for your application. Each output configuration maps an in-application stream and an external destination. You can use one of the output configurations to deliver data from your in-application error stream to an external destination so that you can analyze the errors. Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version.
*/
addApplicationOutput(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.AddApplicationOutputResponse) => void): Request<KinesisAnalyticsV2.Types.AddApplicationOutputResponse, AWSError>;
/**
* Adds a reference data source to an existing SQL-based Amazon Kinesis Data Analytics application. Kinesis Data Analytics reads reference data (that is, an Amazon S3 object) and creates an in-application table within your application. In the request, you provide the source (S3 bucket name and object key name), name of the in-application table to create, and the necessary mapping information that describes how data in an Amazon S3 object maps to columns in the resulting in-application table.
*/
addApplicationReferenceDataSource(params: KinesisAnalyticsV2.Types.AddApplicationReferenceDataSourceRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.AddApplicationReferenceDataSourceResponse) => void): Request<KinesisAnalyticsV2.Types.AddApplicationReferenceDataSourceResponse, AWSError>;
/**
* Adds a reference data source to an existing SQL-based Amazon Kinesis Data Analytics application. Kinesis Data Analytics reads reference data (that is, an Amazon S3 object) and creates an in-application table within your application. In the request, you provide the source (S3 bucket name and object key name), name of the in-application table to create, and the necessary mapping information that describes how data in an Amazon S3 object maps to columns in the resulting in-application table.
*/
addApplicationReferenceDataSource(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.AddApplicationReferenceDataSourceResponse) => void): Request<KinesisAnalyticsV2.Types.AddApplicationReferenceDataSourceResponse, AWSError>;
/**
* 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.
*/
addApplicationVpcConfiguration(params: KinesisAnalyticsV2.Types.AddApplicationVpcConfigurationRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.AddApplicationVpcConfigurationResponse) => void): Request<KinesisAnalyticsV2.Types.AddApplicationVpcConfigurationResponse, AWSError>;
/**
* 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.
*/
addApplicationVpcConfiguration(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.AddApplicationVpcConfigurationResponse) => void): Request<KinesisAnalyticsV2.Types.AddApplicationVpcConfigurationResponse, AWSError>;
/**
* Creates an Amazon Kinesis Data Analytics application. For information about creating a Kinesis Data Analytics application, see Creating an Application.
*/
createApplication(params: KinesisAnalyticsV2.Types.CreateApplicationRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.CreateApplicationResponse) => void): Request<KinesisAnalyticsV2.Types.CreateApplicationResponse, AWSError>;
/**
* Creates an Amazon Kinesis Data Analytics application. For information about creating a Kinesis Data Analytics application, see Creating an Application.
*/
createApplication(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.CreateApplicationResponse) => void): Request<KinesisAnalyticsV2.Types.CreateApplicationResponse, AWSError>;
/**
* Creates a snapshot of the application's state data.
*/
createApplicationSnapshot(params: KinesisAnalyticsV2.Types.CreateApplicationSnapshotRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.CreateApplicationSnapshotResponse) => void): Request<KinesisAnalyticsV2.Types.CreateApplicationSnapshotResponse, AWSError>;
/**
* Creates a snapshot of the application's state data.
*/
createApplicationSnapshot(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.CreateApplicationSnapshotResponse) => void): Request<KinesisAnalyticsV2.Types.CreateApplicationSnapshotResponse, AWSError>;
/**
* Deletes the specified application. Kinesis Data Analytics halts application execution and deletes the application.
*/
deleteApplication(params: KinesisAnalyticsV2.Types.DeleteApplicationRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DeleteApplicationResponse) => void): Request<KinesisAnalyticsV2.Types.DeleteApplicationResponse, AWSError>;
/**
* Deletes the specified application. Kinesis Data Analytics halts application execution and deletes the application.
*/
deleteApplication(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DeleteApplicationResponse) => void): Request<KinesisAnalyticsV2.Types.DeleteApplicationResponse, AWSError>;
/**
* Deletes an Amazon CloudWatch log stream from an Amazon Kinesis Data Analytics application.
*/
deleteApplicationCloudWatchLoggingOption(params: KinesisAnalyticsV2.Types.DeleteApplicationCloudWatchLoggingOptionRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DeleteApplicationCloudWatchLoggingOptionResponse) => void): Request<KinesisAnalyticsV2.Types.DeleteApplicationCloudWatchLoggingOptionResponse, AWSError>;
/**
* Deletes an Amazon CloudWatch log stream from an Amazon Kinesis Data Analytics application.
*/
deleteApplicationCloudWatchLoggingOption(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DeleteApplicationCloudWatchLoggingOptionResponse) => void): Request<KinesisAnalyticsV2.Types.DeleteApplicationCloudWatchLoggingOptionResponse, AWSError>;
/**
* Deletes an InputProcessingConfiguration from an input.
*/
deleteApplicationInputProcessingConfiguration(params: KinesisAnalyticsV2.Types.DeleteApplicationInputProcessingConfigurationRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DeleteApplicationInputProcessingConfigurationResponse) => void): Request<KinesisAnalyticsV2.Types.DeleteApplicationInputProcessingConfigurationResponse, AWSError>;
/**
* Deletes an InputProcessingConfiguration from an input.
*/
deleteApplicationInputProcessingConfiguration(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DeleteApplicationInputProcessingConfigurationResponse) => void): Request<KinesisAnalyticsV2.Types.DeleteApplicationInputProcessingConfigurationResponse, AWSError>;
/**
* Deletes the output destination configuration from your SQL-based Amazon Kinesis Data Analytics application's configuration. Kinesis Data Analytics will no longer write data from the corresponding in-application stream to the external output destination.
*/
deleteApplicationOutput(params: KinesisAnalyticsV2.Types.DeleteApplicationOutputRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DeleteApplicationOutputResponse) => void): Request<KinesisAnalyticsV2.Types.DeleteApplicationOutputResponse, AWSError>;
/**
* Deletes the output destination configuration from your SQL-based Amazon Kinesis Data Analytics application's configuration. Kinesis Data Analytics will no longer write data from the corresponding in-application stream to the external output destination.
*/
deleteApplicationOutput(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DeleteApplicationOutputResponse) => void): Request<KinesisAnalyticsV2.Types.DeleteApplicationOutputResponse, AWSError>;
/**
* Deletes a reference data source configuration from the specified SQL-based Amazon Kinesis Data Analytics application's configuration. If the application is running, Kinesis Data Analytics immediately removes the in-application table that you created using the AddApplicationReferenceDataSource operation.
*/
deleteApplicationReferenceDataSource(params: KinesisAnalyticsV2.Types.DeleteApplicationReferenceDataSourceRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DeleteApplicationReferenceDataSourceResponse) => void): Request<KinesisAnalyticsV2.Types.DeleteApplicationReferenceDataSourceResponse, AWSError>;
/**
* Deletes a reference data source configuration from the specified SQL-based Amazon Kinesis Data Analytics application's configuration. If the application is running, Kinesis Data Analytics immediately removes the in-application table that you created using the AddApplicationReferenceDataSource operation.
*/
deleteApplicationReferenceDataSource(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DeleteApplicationReferenceDataSourceResponse) => void): Request<KinesisAnalyticsV2.Types.DeleteApplicationReferenceDataSourceResponse, AWSError>;
/**
* Deletes a snapshot of application state.
*/
deleteApplicationSnapshot(params: KinesisAnalyticsV2.Types.DeleteApplicationSnapshotRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DeleteApplicationSnapshotResponse) => void): Request<KinesisAnalyticsV2.Types.DeleteApplicationSnapshotResponse, AWSError>;
/**
* Deletes a snapshot of application state.
*/
deleteApplicationSnapshot(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DeleteApplicationSnapshotResponse) => void): Request<KinesisAnalyticsV2.Types.DeleteApplicationSnapshotResponse, AWSError>;
/**
* Removes a VPC configuration from a Kinesis Data Analytics application.
*/
deleteApplicationVpcConfiguration(params: KinesisAnalyticsV2.Types.DeleteApplicationVpcConfigurationRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DeleteApplicationVpcConfigurationResponse) => void): Request<KinesisAnalyticsV2.Types.DeleteApplicationVpcConfigurationResponse, AWSError>;
/**
* Removes a VPC configuration from a Kinesis Data Analytics application.
*/
deleteApplicationVpcConfiguration(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DeleteApplicationVpcConfigurationResponse) => void): Request<KinesisAnalyticsV2.Types.DeleteApplicationVpcConfigurationResponse, AWSError>;
/**
* Returns information about a specific Amazon Kinesis Data Analytics application. If you want to retrieve a list of all applications in your account, use the ListApplications operation.
*/
describeApplication(params: KinesisAnalyticsV2.Types.DescribeApplicationRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DescribeApplicationResponse) => void): Request<KinesisAnalyticsV2.Types.DescribeApplicationResponse, AWSError>;
/**
* Returns information about a specific Amazon Kinesis Data Analytics application. If you want to retrieve a list of all applications in your account, use the ListApplications operation.
*/
describeApplication(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DescribeApplicationResponse) => void): Request<KinesisAnalyticsV2.Types.DescribeApplicationResponse, AWSError>;
/**
* Returns information about a snapshot of application state data.
*/
describeApplicationSnapshot(params: KinesisAnalyticsV2.Types.DescribeApplicationSnapshotRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DescribeApplicationSnapshotResponse) => void): Request<KinesisAnalyticsV2.Types.DescribeApplicationSnapshotResponse, AWSError>;
/**
* Returns information about a snapshot of application state data.
*/
describeApplicationSnapshot(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DescribeApplicationSnapshotResponse) => void): Request<KinesisAnalyticsV2.Types.DescribeApplicationSnapshotResponse, AWSError>;
/**
* Infers a schema for an SQL-based Amazon Kinesis Data Analytics application by evaluating sample records on the specified streaming source (Kinesis data stream or Kinesis Data Firehose delivery stream) or Amazon S3 object. In the response, the operation returns the inferred schema and also the sample records that the operation used to infer the schema. You can use the inferred schema when configuring a streaming source for your application. When you create an application using the Kinesis Data Analytics console, the console uses this operation to infer a schema and show it in the console user interface.
*/
discoverInputSchema(params: KinesisAnalyticsV2.Types.DiscoverInputSchemaRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DiscoverInputSchemaResponse) => void): Request<KinesisAnalyticsV2.Types.DiscoverInputSchemaResponse, AWSError>;
/**
* Infers a schema for an SQL-based Amazon Kinesis Data Analytics application by evaluating sample records on the specified streaming source (Kinesis data stream or Kinesis Data Firehose delivery stream) or Amazon S3 object. In the response, the operation returns the inferred schema and also the sample records that the operation used to infer the schema. You can use the inferred schema when configuring a streaming source for your application. When you create an application using the Kinesis Data Analytics console, the console uses this operation to infer a schema and show it in the console user interface.
*/
discoverInputSchema(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DiscoverInputSchemaResponse) => void): Request<KinesisAnalyticsV2.Types.DiscoverInputSchemaResponse, AWSError>;
/**
* Lists information about the current application snapshots.
*/
listApplicationSnapshots(params: KinesisAnalyticsV2.Types.ListApplicationSnapshotsRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.ListApplicationSnapshotsResponse) => void): Request<KinesisAnalyticsV2.Types.ListApplicationSnapshotsResponse, AWSError>;
/**
* Lists information about the current application snapshots.
*/
listApplicationSnapshots(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.ListApplicationSnapshotsResponse) => void): Request<KinesisAnalyticsV2.Types.ListApplicationSnapshotsResponse, AWSError>;
/**
* Returns a list of Amazon Kinesis Data Analytics applications in your account. For each application, the response includes the application name, Amazon Resource Name (ARN), and status. If you want detailed information about a specific application, use DescribeApplication.
*/
listApplications(params: KinesisAnalyticsV2.Types.ListApplicationsRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.ListApplicationsResponse) => void): Request<KinesisAnalyticsV2.Types.ListApplicationsResponse, AWSError>;
/**
* Returns a list of Amazon Kinesis Data Analytics applications in your account. For each application, the response includes the application name, Amazon Resource Name (ARN), and status. If you want detailed information about a specific application, use DescribeApplication.
*/
listApplications(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.ListApplicationsResponse) => void): Request<KinesisAnalyticsV2.Types.ListApplicationsResponse, AWSError>;
/**
* Retrieves the list of key-value tags assigned to the application. For more information, see Using Tagging.
*/
listTagsForResource(params: KinesisAnalyticsV2.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.ListTagsForResourceResponse) => void): Request<KinesisAnalyticsV2.Types.ListTagsForResourceResponse, AWSError>;
/**
* Retrieves the list of key-value tags assigned to the application. For more information, see Using Tagging.
*/
listTagsForResource(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.ListTagsForResourceResponse) => void): Request<KinesisAnalyticsV2.Types.ListTagsForResourceResponse, AWSError>;
/**
* Starts the specified Amazon Kinesis Data Analytics application. After creating an application, you must exclusively call this operation to start your application.
*/
startApplication(params: KinesisAnalyticsV2.Types.StartApplicationRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.StartApplicationResponse) => void): Request<KinesisAnalyticsV2.Types.StartApplicationResponse, AWSError>;
/**
* Starts the specified Amazon Kinesis Data Analytics application. After creating an application, you must exclusively call this operation to start your application.
*/
startApplication(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.StartApplicationResponse) => void): Request<KinesisAnalyticsV2.Types.StartApplicationResponse, AWSError>;
/**
* Stops the application from processing data. You can stop an application only if it is in the running state. You can use the DescribeApplication operation to find the application state.
*/
stopApplication(params: KinesisAnalyticsV2.Types.StopApplicationRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.StopApplicationResponse) => void): Request<KinesisAnalyticsV2.Types.StopApplicationResponse, AWSError>;
/**
* Stops the application from processing data. You can stop an application only if it is in the running state. You can use the DescribeApplication operation to find the application state.
*/
stopApplication(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.StopApplicationResponse) => void): Request<KinesisAnalyticsV2.Types.StopApplicationResponse, AWSError>;
/**
* Adds one or more key-value tags to a Kinesis Analytics application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50. For more information, see Using Tagging.
*/
tagResource(params: KinesisAnalyticsV2.Types.TagResourceRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.TagResourceResponse) => void): Request<KinesisAnalyticsV2.Types.TagResourceResponse, AWSError>;
/**
* Adds one or more key-value tags to a Kinesis Analytics application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50. For more information, see Using Tagging.
*/
tagResource(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.TagResourceResponse) => void): Request<KinesisAnalyticsV2.Types.TagResourceResponse, AWSError>;
/**
* Removes one or more tags from a Kinesis Analytics application. For more information, see Using Tagging.
*/
untagResource(params: KinesisAnalyticsV2.Types.UntagResourceRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.UntagResourceResponse) => void): Request<KinesisAnalyticsV2.Types.UntagResourceResponse, AWSError>;
/**
* Removes one or more tags from a Kinesis Analytics application. For more information, see Using Tagging.
*/
untagResource(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.UntagResourceResponse) => void): Request<KinesisAnalyticsV2.Types.UntagResourceResponse, AWSError>;
/**
* Updates an existing Amazon Kinesis Data Analytics application. Using this operation, you can update application code, input configuration, and output configuration. Kinesis Data Analytics updates the ApplicationVersionId each time you update your application.
*/
updateApplication(params: KinesisAnalyticsV2.Types.UpdateApplicationRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.UpdateApplicationResponse) => void): Request<KinesisAnalyticsV2.Types.UpdateApplicationResponse, AWSError>;
/**
* Updates an existing Amazon Kinesis Data Analytics application. Using this operation, you can update application code, input configuration, and output configuration. Kinesis Data Analytics updates the ApplicationVersionId each time you update your application.
*/
updateApplication(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.UpdateApplicationResponse) => void): Request<KinesisAnalyticsV2.Types.UpdateApplicationResponse, AWSError>;
}
declare namespace KinesisAnalyticsV2 {
export interface AddApplicationCloudWatchLoggingOptionRequest {
/**
* The Kinesis Data Analytics application name.
*/
ApplicationName: ApplicationName;
/**
* The version ID of the Kinesis Data Analytics application. You can retrieve the application version ID using DescribeApplication.
*/
CurrentApplicationVersionId: ApplicationVersionId;
/**
* Provides the Amazon CloudWatch log stream Amazon Resource Name (ARN).
*/
CloudWatchLoggingOption: CloudWatchLoggingOption;
}
export interface AddApplicationCloudWatchLoggingOptionResponse {
/**
* The application's ARN.
*/
ApplicationARN?: ResourceARN;
/**
* The new version ID of the Kinesis Data Analytics application. Kinesis Data Analytics updates the ApplicationVersionId each time you change the CloudWatch logging options.
*/
ApplicationVersionId?: ApplicationVersionId;
/**
* The descriptions of the current CloudWatch logging options for the Kinesis Data Analytics application.
*/
CloudWatchLoggingOptionDescriptions?: CloudWatchLoggingOptionDescriptions;
}
export interface AddApplicationInputProcessingConfigurationRequest {
/**
* The name of the application to which you want to add the input processing configuration.
*/
ApplicationName: ApplicationName;
/**
* The version of the application to which you want to add the input processing configuration. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned.
*/
CurrentApplicationVersionId: ApplicationVersionId;
/**
* The ID of the input configuration to add the input processing configuration to. You can get a list of the input IDs for an application using the DescribeApplication operation.
*/
InputId: Id;
/**
* The InputProcessingConfiguration to add to the application.
*/
InputProcessingConfiguration: InputProcessingConfiguration;
}
export interface AddApplicationInputProcessingConfigurationResponse {
/**
* The Amazon Resource Name (ARN) of the application.
*/
ApplicationARN?: ResourceARN;
/**
* Provides the current application version.
*/
ApplicationVersionId?: ApplicationVersionId;
/**
* The input ID that is associated with the application input. This is the ID that Amazon Kinesis Data Analytics assigns to each input configuration that you add to your application.
*/
InputId?: Id;
/**
* The description of the preprocessor that executes on records in this input before the application's code is run.
*/
InputProcessingConfigurationDescription?: InputProcessingConfigurationDescription;
}
export interface AddApplicationInputRequest {
/**
* The name of your existing application to which you want to add the streaming source.
*/
ApplicationName: ApplicationName;
/**
* The current version of your application. You can use the DescribeApplication operation to find the current application version.
*/
CurrentApplicationVersionId: ApplicationVersionId;
/**
* The Input to add.
*/
Input: Input;
}
export interface AddApplicationInputResponse {
/**
* The Amazon Resource Name (ARN) of the application.
*/
ApplicationARN?: ResourceARN;
/**
* Provides the current application version.
*/
ApplicationVersionId?: ApplicationVersionId;
/**
* Describes the application input configuration.
*/
InputDescriptions?: InputDescriptions;
}
export interface AddApplicationOutputRequest {
/**
* The name of the application to which you want to add the output configuration.
*/
ApplicationName: ApplicationName;
/**
* The version of the application to which you want to add the output configuration. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned.
*/
CurrentApplicationVersionId: ApplicationVersionId;
/**
* An array of objects, each describing one output configuration. In the output configuration, you specify the name of an in-application stream, a destination (that is, a Kinesis data stream, a Kinesis Data Firehose delivery stream, or an AWS Lambda function), and record the formation to use when writing to the destination.
*/
Output: Output;
}
export interface AddApplicationOutputResponse {
/**
* The application Amazon Resource Name (ARN).
*/
ApplicationARN?: ResourceARN;
/**
* The updated application version ID. Kinesis Data Analytics increments this ID when the application is updated.
*/
ApplicationVersionId?: ApplicationVersionId;
/**
* Describes the application output configuration. For more information, see Configuring Application Output.
*/
OutputDescriptions?: OutputDescriptions;
}
export interface AddApplicationReferenceDataSourceRequest {
/**
* The name of an existing application.
*/
ApplicationName: ApplicationName;
/**
* The version of the application for which you are adding the reference data source. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned.
*/
CurrentApplicationVersionId: ApplicationVersionId;
/**
* The reference data source can be an object in your Amazon S3 bucket. Kinesis Data Analytics reads the object and copies the data into the in-application table that is created. You provide an S3 bucket, object key name, and the resulting in-application table that is created.
*/
ReferenceDataSource: ReferenceDataSource;
}
export interface AddApplicationReferenceDataSourceResponse {
/**
* The application Amazon Resource Name (ARN).
*/
ApplicationARN?: ResourceARN;
/**
* The updated application version ID. Amazon Kinesis Data Analytics increments this ID when the application is updated.
*/
ApplicationVersionId?: ApplicationVersionId;
/**
* Describes reference data sources configured for the application.
*/
ReferenceDataSourceDescriptions?: ReferenceDataSourceDescriptions;
}
export interface AddApplicationVpcConfigurationRequest {
/**
* The name of an existing application.
*/
ApplicationName: ApplicationName;
/**
* The version of the application to which you want to add the input processing configuration. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned.
*/
CurrentApplicationVersionId: ApplicationVersionId;
/**
* Description of the VPC to add to the application.
*/
VpcConfiguration: VpcConfiguration;
}
export interface AddApplicationVpcConfigurationResponse {
/**
* The ARN of the application.
*/
ApplicationARN?: ResourceARN;
/**
* Provides the current application version. Kinesis Data Analytics updates the ApplicationVersionId each time you update the application.
*/
ApplicationVersionId?: ApplicationVersionId;
/**
* The parameters of the new VPC configuration.
*/
VpcConfigurationDescription?: VpcConfigurationDescription;
}
export interface ApplicationCodeConfiguration {
/**
* The location and type of the application code.
*/
CodeContent?: CodeContent;
/**
* Specifies whether the code content is in text or zip format.
*/
CodeContentType: CodeContentType;
}
export interface ApplicationCodeConfigurationDescription {
/**
* Specifies whether the code content is in text or zip format.
*/
CodeContentType: CodeContentType;
/**
* Describes details about the location and format of the application code.
*/
CodeContentDescription?: CodeContentDescription;
}
export interface ApplicationCodeConfigurationUpdate {
/**
* Describes updates to the code content type.
*/
CodeContentTypeUpdate?: CodeContentType;
/**
* Describes updates to the code content of an application.
*/
CodeContentUpdate?: CodeContentUpdate;
}
export interface ApplicationConfiguration {
/**
* The creation and update parameters for an SQL-based Kinesis Data Analytics application.
*/
SqlApplicationConfiguration?: SqlApplicationConfiguration;
/**
* The creation and update parameters for a Java-based Kinesis Data Analytics application.
*/
FlinkApplicationConfiguration?: FlinkApplicationConfiguration;
/**
* Describes execution properties for a Java-based Kinesis Data Analytics application.
*/
EnvironmentProperties?: EnvironmentProperties;
/**
* The code location and type parameters for a Java-based Kinesis Data Analytics application.
*/
ApplicationCodeConfiguration: ApplicationCodeConfiguration;
/**
* Describes whether snapshots are enabled for a Java-based Kinesis Data Analytics application.
*/
ApplicationSnapshotConfiguration?: ApplicationSnapshotConfiguration;
/**
* The array of descriptions of VPC configurations available to the application.
*/
VpcConfigurations?: VpcConfigurations;
}
export interface ApplicationConfigurationDescription {
/**
* The details about inputs, outputs, and reference data sources for an SQL-based Kinesis Data Analytics application.
*/
SqlApplicationConfigurationDescription?: SqlApplicationConfigurationDescription;
/**
* The details about the application code for a Java-based Kinesis Data Analytics application.
*/
ApplicationCodeConfigurationDescription?: ApplicationCodeConfigurationDescription;
/**
* The details about the starting properties for a Kinesis Data Analytics application.
*/
RunConfigurationDescription?: RunConfigurationDescription;
/**
* The details about a Java-based Kinesis Data Analytics application.
*/
FlinkApplicationConfigurationDescription?: FlinkApplicationConfigurationDescription;
/**
* Describes execution properties for a Java-based Kinesis Data Analytics application.
*/
EnvironmentPropertyDescriptions?: EnvironmentPropertyDescriptions;
/**
* Describes whether snapshots are enabled for a Java-based Kinesis Data Analytics application.
*/
ApplicationSnapshotConfigurationDescription?: ApplicationSnapshotConfigurationDescription;
/**
* The array of descriptions of VPC configurations available to the application.
*/
VpcConfigurationDescriptions?: VpcConfigurationDescriptions;
}
export interface ApplicationConfigurationUpdate {
/**
* Describes updates to an SQL-based Kinesis Data Analytics application's configuration.
*/
SqlApplicationConfigurationUpdate?: SqlApplicationConfigurationUpdate;
/**
* Describes updates to a Java-based Kinesis Data Analytics application's code configuration.
*/
ApplicationCodeConfigurationUpdate?: ApplicationCodeConfigurationUpdate;
/**
* Describes updates to a Java-based Kinesis Data Analytics application's configuration.
*/
FlinkApplicationConfigurationUpdate?: FlinkApplicationConfigurationUpdate;
/**
* Describes updates to the environment properties for a Java-based Kinesis Data Analytics application.
*/
EnvironmentPropertyUpdates?: EnvironmentPropertyUpdates;
/**
* Describes whether snapshots are enabled for a Java-based Kinesis Data Analytics application.
*/
ApplicationSnapshotConfigurationUpdate?: ApplicationSnapshotConfigurationUpdate;
/**
* Updates to the array of descriptions of VPC configurations available to the application.
*/
VpcConfigurationUpdates?: VpcConfigurationUpdates;
}
export type ApplicationDescription = string;
export interface ApplicationDetail {
/**
* The ARN of the application.
*/
ApplicationARN: ResourceARN;
/**
* The description of the application.
*/
ApplicationDescription?: ApplicationDescription;
/**
* The name of the application.
*/
ApplicationName: ApplicationName;
/**
* The runtime environment for the application (SQL-1.0 or FLINK-1_6).
*/
RuntimeEnvironment: RuntimeEnvironment;
/**
* Specifies the IAM role that the application uses to access external resources.
*/
ServiceExecutionRole?: RoleARN;
/**
* The status of the application.
*/
ApplicationStatus: ApplicationStatus;
/**
* Provides the current application version. Kinesis Data Analytics updates the ApplicationVersionId each time you update the application.
*/
ApplicationVersionId: ApplicationVersionId;
/**
* The current timestamp when the application was created.
*/
CreateTimestamp?: Timestamp;
/**
* The current timestamp when the application was last updated.
*/
LastUpdateTimestamp?: Timestamp;
/**
* Provides details about the application's SQL or Java code and starting parameters.
*/
ApplicationConfigurationDescription?: ApplicationConfigurationDescription;
/**
* Describes the application Amazon CloudWatch logging options.
*/
CloudWatchLoggingOptionDescriptions?: CloudWatchLoggingOptionDescriptions;
}
export type ApplicationName = string;
export interface ApplicationRestoreConfiguration {
/**
* Specifies how the application should be restored.
*/
ApplicationRestoreType: ApplicationRestoreType;
/**
* The identifier of an existing snapshot of application state to use to restart an application. The application uses this value if RESTORE_FROM_CUSTOM_SNAPSHOT is specified for the ApplicationRestoreType.
*/
SnapshotName?: SnapshotName;
}
export type ApplicationRestoreType = "SKIP_RESTORE_FROM_SNAPSHOT"|"RESTORE_FROM_LATEST_SNAPSHOT"|"RESTORE_FROM_CUSTOM_SNAPSHOT"|string;
export interface ApplicationSnapshotConfiguration {
/**
* Describes whether snapshots are enabled for a Java-based Kinesis Data Analytics application.
*/
SnapshotsEnabled: BooleanObject;
}
export interface ApplicationSnapshotConfigurationDescription {
/**
* Describes whether snapshots are enabled for a Java-based Kinesis Data Analytics application.
*/
SnapshotsEnabled: BooleanObject;
}
export interface ApplicationSnapshotConfigurationUpdate {
/**
* Describes updates to whether snapshots are enabled for a Java-based Kinesis Data Analytics application.
*/
SnapshotsEnabledUpdate: BooleanObject;
}
export type ApplicationStatus = "DELETING"|"STARTING"|"STOPPING"|"READY"|"RUNNING"|"UPDATING"|"AUTOSCALING"|string;
export type ApplicationSummaries = ApplicationSummary[];
export interface ApplicationSummary {
/**
* The name of the application.
*/
ApplicationName: ApplicationName;
/**
* The ARN of the application.
*/
ApplicationARN: ResourceARN;
/**
* The status of the application.
*/
ApplicationStatus: ApplicationStatus;
/**
* Provides the current application version.
*/
ApplicationVersionId: ApplicationVersionId;
/**
* The runtime environment for the application (SQL-1.0 or FLINK-1_6).
*/
RuntimeEnvironment: RuntimeEnvironment;
}
export type ApplicationVersionId = number;
export type BooleanObject = boolean;
export type BucketARN = string;
export interface CSVMappingParameters {
/**
* The row delimiter. For example, in a CSV format, '\n' is the typical row delimiter.
*/
RecordRowDelimiter: RecordRowDelimiter;
/**
* The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.
*/
RecordColumnDelimiter: RecordColumnDelimiter;
}
export interface CheckpointConfiguration {
/**
* Describes whether the application uses Amazon Kinesis Data Analytics' default checkpointing behavior. You must set this property to CUSTOM in order to set the CheckpointingEnabled, CheckpointInterval, or MinPauseBetweenCheckpoints parameters. If this value is set to DEFAULT, the application will use the following values, even if they are set to other values using APIs or application code: CheckpointingEnabled: true CheckpointInterval: 60000 MinPauseBetweenCheckpoints: 5000
*/
ConfigurationType: ConfigurationType;
/**
* Describes whether checkpointing is enabled for a Java-based Kinesis Data Analytics application. If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a CheckpointingEnabled value of true, even if this value is set to another value using this API or in application code.
*/
CheckpointingEnabled?: BooleanObject;
/**
* Describes the interval in milliseconds between checkpoint operations. If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a CheckpointInterval vaue of 60000, even if this value is set to another value using this API or in application code.
*/
CheckpointInterval?: CheckpointInterval;
/**
* Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start. If a checkpoint operation takes longer than the CheckpointInterval, the application otherwise performs continual checkpoint operations. For more information, see Tuning Checkpointing in the Apache Flink Documentation. If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a MinPauseBetweenCheckpoints value of 5000, even if this value is set using this API or in application code.
*/
MinPauseBetweenCheckpoints?: MinPauseBetweenCheckpoints;
}
export interface CheckpointConfigurationDescription {
/**
* Describes whether the application uses the default checkpointing behavior in Kinesis Data Analytics. If this value is set to DEFAULT, the application will use the following values, even if they are set to other values using APIs or application code: CheckpointingEnabled: true CheckpointInterval: 60000 MinPauseBetweenCheckpoints: 5000
*/
ConfigurationType?: ConfigurationType;
/**
* Describes whether checkpointing is enabled for a Java-based Kinesis Data Analytics application. If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a CheckpointingEnabled value of true, even if this value is set to another value using this API or in application code.
*/
CheckpointingEnabled?: BooleanObject;
/**
* Describes the interval in milliseconds between checkpoint operations. If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a CheckpointInterval vaue of 60000, even if this value is set to another value using this API or in application code.
*/
CheckpointInterval?: CheckpointInterval;
/**
* Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start. If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a MinPauseBetweenCheckpoints value of 5000, even if this value is set using this API or in application code.
*/
MinPauseBetweenCheckpoints?: MinPauseBetweenCheckpoints;
}
export interface CheckpointConfigurationUpdate {
/**
* Describes updates to whether the application uses the default checkpointing behavior of Kinesis Data Analytics. You must set this property to CUSTOM in order to set the CheckpointingEnabled, CheckpointInterval, or MinPauseBetweenCheckpoints parameters. If this value is set to DEFAULT, the application will use the following values, even if they are set to other values using APIs or application code: CheckpointingEnabled: true CheckpointInterval: 60000 MinPauseBetweenCheckpoints: 5000
*/
ConfigurationTypeUpdate?: ConfigurationType;
/**
* Describes updates to whether checkpointing is enabled for an application. If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a CheckpointingEnabled value of true, even if this value is set to another value using this API or in application code.
*/
CheckpointingEnabledUpdate?: BooleanObject;
/**
* Describes updates to the interval in milliseconds between checkpoint operations. If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a CheckpointInterval vaue of 60000, even if this value is set to another value using this API or in application code.
*/
CheckpointIntervalUpdate?: CheckpointInterval;
/**
* Describes updates to the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start. If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a MinPauseBetweenCheckpoints value of 5000, even if this value is set using this API or in application code.
*/
MinPauseBetweenCheckpointsUpdate?: MinPauseBetweenCheckpoints;
}
export type CheckpointInterval = number;
export interface CloudWatchLoggingOption {
/**
* The ARN of the CloudWatch log to receive application messages.
*/
LogStreamARN: LogStreamARN;
}
export interface CloudWatchLoggingOptionDescription {
/**
* The ID of the CloudWatch logging option description.
*/
CloudWatchLoggingOptionId?: Id;
/**
* The Amazon Resource Name (ARN) of the CloudWatch log to receive application messages.
*/
LogStreamARN: LogStreamARN;
/**
* The IAM ARN of the role to use to send application messages. Provided for backward compatibility. Applications created with the current API version have an application-level service execution role rather than a resource-level role.
*/
RoleARN?: RoleARN;
}
export type CloudWatchLoggingOptionDescriptions = CloudWatchLoggingOptionDescription[];
export interface CloudWatchLoggingOptionUpdate {
/**
* The ID of the CloudWatch logging option to update
*/
CloudWatchLoggingOptionId: Id;
/**
* The Amazon Resource Name (ARN) of the CloudWatch log to receive application messages.
*/
LogStreamARNUpdate?: LogStreamARN;
}
export type CloudWatchLoggingOptionUpdates = CloudWatchLoggingOptionUpdate[];
export type CloudWatchLoggingOptions = CloudWatchLoggingOption[];
export interface CodeContent {
/**
* The text-format code for a Java-based Kinesis Data Analytics application.
*/
TextContent?: TextContent;
/**
* The zip-format code for a Java-based Kinesis Data Analytics application.
*/
ZipFileContent?: ZipFileContent;
/**
* Information about the Amazon S3 bucket containing the application code.
*/
S3ContentLocation?: S3ContentLocation;
}
export interface CodeContentDescription {
/**
* The text-format code
*/
TextContent?: TextContent;
/**
* The checksum that can be used to validate zip-format code.
*/
CodeMD5?: CodeMD5;
/**
* The size in bytes of the application code. Can be used to validate zip-format code.
*/
CodeSize?: CodeSize;
/**
* The S3 bucke