UNPKG

107 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {ServiceConfigurationOptions} from '../lib/service';
6import {ConfigBase as Config} from '../lib/config';
7interface Blob {}
8declare class KinesisAnalyticsV2 extends Service {
9 /**
10 * Constructs a service object. This object has one method for each API operation.
11 */
12 constructor(options?: KinesisAnalyticsV2.Types.ClientConfiguration)
13 config: Config & KinesisAnalyticsV2.Types.ClientConfiguration;
14 /**
15 * Adds an Amazon CloudWatch log stream to monitor application configuration errors.
16 */
17 addApplicationCloudWatchLoggingOption(params: KinesisAnalyticsV2.Types.AddApplicationCloudWatchLoggingOptionRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.AddApplicationCloudWatchLoggingOptionResponse) => void): Request<KinesisAnalyticsV2.Types.AddApplicationCloudWatchLoggingOptionResponse, AWSError>;
18 /**
19 * Adds an Amazon CloudWatch log stream to monitor application configuration errors.
20 */
21 addApplicationCloudWatchLoggingOption(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.AddApplicationCloudWatchLoggingOptionResponse) => void): Request<KinesisAnalyticsV2.Types.AddApplicationCloudWatchLoggingOptionResponse, AWSError>;
22 /**
23 * 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.
24 */
25 addApplicationInput(params: KinesisAnalyticsV2.Types.AddApplicationInputRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.AddApplicationInputResponse) => void): Request<KinesisAnalyticsV2.Types.AddApplicationInputResponse, AWSError>;
26 /**
27 * 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.
28 */
29 addApplicationInput(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.AddApplicationInputResponse) => void): Request<KinesisAnalyticsV2.Types.AddApplicationInputResponse, AWSError>;
30 /**
31 * 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.
32 */
33 addApplicationInputProcessingConfiguration(params: KinesisAnalyticsV2.Types.AddApplicationInputProcessingConfigurationRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.AddApplicationInputProcessingConfigurationResponse) => void): Request<KinesisAnalyticsV2.Types.AddApplicationInputProcessingConfigurationResponse, AWSError>;
34 /**
35 * 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.
36 */
37 addApplicationInputProcessingConfiguration(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.AddApplicationInputProcessingConfigurationResponse) => void): Request<KinesisAnalyticsV2.Types.AddApplicationInputProcessingConfigurationResponse, AWSError>;
38 /**
39 * 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.
40 */
41 addApplicationOutput(params: KinesisAnalyticsV2.Types.AddApplicationOutputRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.AddApplicationOutputResponse) => void): Request<KinesisAnalyticsV2.Types.AddApplicationOutputResponse, AWSError>;
42 /**
43 * 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.
44 */
45 addApplicationOutput(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.AddApplicationOutputResponse) => void): Request<KinesisAnalyticsV2.Types.AddApplicationOutputResponse, AWSError>;
46 /**
47 * 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.
48 */
49 addApplicationReferenceDataSource(params: KinesisAnalyticsV2.Types.AddApplicationReferenceDataSourceRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.AddApplicationReferenceDataSourceResponse) => void): Request<KinesisAnalyticsV2.Types.AddApplicationReferenceDataSourceResponse, AWSError>;
50 /**
51 * 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.
52 */
53 addApplicationReferenceDataSource(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.AddApplicationReferenceDataSourceResponse) => void): Request<KinesisAnalyticsV2.Types.AddApplicationReferenceDataSourceResponse, AWSError>;
54 /**
55 * 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.
56 */
57 addApplicationVpcConfiguration(params: KinesisAnalyticsV2.Types.AddApplicationVpcConfigurationRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.AddApplicationVpcConfigurationResponse) => void): Request<KinesisAnalyticsV2.Types.AddApplicationVpcConfigurationResponse, AWSError>;
58 /**
59 * 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.
60 */
61 addApplicationVpcConfiguration(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.AddApplicationVpcConfigurationResponse) => void): Request<KinesisAnalyticsV2.Types.AddApplicationVpcConfigurationResponse, AWSError>;
62 /**
63 * Creates an Amazon Kinesis Data Analytics application. For information about creating a Kinesis Data Analytics application, see Creating an Application.
64 */
65 createApplication(params: KinesisAnalyticsV2.Types.CreateApplicationRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.CreateApplicationResponse) => void): Request<KinesisAnalyticsV2.Types.CreateApplicationResponse, AWSError>;
66 /**
67 * Creates an Amazon Kinesis Data Analytics application. For information about creating a Kinesis Data Analytics application, see Creating an Application.
68 */
69 createApplication(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.CreateApplicationResponse) => void): Request<KinesisAnalyticsV2.Types.CreateApplicationResponse, AWSError>;
70 /**
71 * Creates a snapshot of the application's state data.
72 */
73 createApplicationSnapshot(params: KinesisAnalyticsV2.Types.CreateApplicationSnapshotRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.CreateApplicationSnapshotResponse) => void): Request<KinesisAnalyticsV2.Types.CreateApplicationSnapshotResponse, AWSError>;
74 /**
75 * Creates a snapshot of the application's state data.
76 */
77 createApplicationSnapshot(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.CreateApplicationSnapshotResponse) => void): Request<KinesisAnalyticsV2.Types.CreateApplicationSnapshotResponse, AWSError>;
78 /**
79 * Deletes the specified application. Kinesis Data Analytics halts application execution and deletes the application.
80 */
81 deleteApplication(params: KinesisAnalyticsV2.Types.DeleteApplicationRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DeleteApplicationResponse) => void): Request<KinesisAnalyticsV2.Types.DeleteApplicationResponse, AWSError>;
82 /**
83 * Deletes the specified application. Kinesis Data Analytics halts application execution and deletes the application.
84 */
85 deleteApplication(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DeleteApplicationResponse) => void): Request<KinesisAnalyticsV2.Types.DeleteApplicationResponse, AWSError>;
86 /**
87 * Deletes an Amazon CloudWatch log stream from an Amazon Kinesis Data Analytics application.
88 */
89 deleteApplicationCloudWatchLoggingOption(params: KinesisAnalyticsV2.Types.DeleteApplicationCloudWatchLoggingOptionRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DeleteApplicationCloudWatchLoggingOptionResponse) => void): Request<KinesisAnalyticsV2.Types.DeleteApplicationCloudWatchLoggingOptionResponse, AWSError>;
90 /**
91 * Deletes an Amazon CloudWatch log stream from an Amazon Kinesis Data Analytics application.
92 */
93 deleteApplicationCloudWatchLoggingOption(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DeleteApplicationCloudWatchLoggingOptionResponse) => void): Request<KinesisAnalyticsV2.Types.DeleteApplicationCloudWatchLoggingOptionResponse, AWSError>;
94 /**
95 * Deletes an InputProcessingConfiguration from an input.
96 */
97 deleteApplicationInputProcessingConfiguration(params: KinesisAnalyticsV2.Types.DeleteApplicationInputProcessingConfigurationRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DeleteApplicationInputProcessingConfigurationResponse) => void): Request<KinesisAnalyticsV2.Types.DeleteApplicationInputProcessingConfigurationResponse, AWSError>;
98 /**
99 * Deletes an InputProcessingConfiguration from an input.
100 */
101 deleteApplicationInputProcessingConfiguration(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DeleteApplicationInputProcessingConfigurationResponse) => void): Request<KinesisAnalyticsV2.Types.DeleteApplicationInputProcessingConfigurationResponse, AWSError>;
102 /**
103 * 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.
104 */
105 deleteApplicationOutput(params: KinesisAnalyticsV2.Types.DeleteApplicationOutputRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DeleteApplicationOutputResponse) => void): Request<KinesisAnalyticsV2.Types.DeleteApplicationOutputResponse, AWSError>;
106 /**
107 * 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.
108 */
109 deleteApplicationOutput(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DeleteApplicationOutputResponse) => void): Request<KinesisAnalyticsV2.Types.DeleteApplicationOutputResponse, AWSError>;
110 /**
111 * 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.
112 */
113 deleteApplicationReferenceDataSource(params: KinesisAnalyticsV2.Types.DeleteApplicationReferenceDataSourceRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DeleteApplicationReferenceDataSourceResponse) => void): Request<KinesisAnalyticsV2.Types.DeleteApplicationReferenceDataSourceResponse, AWSError>;
114 /**
115 * 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.
116 */
117 deleteApplicationReferenceDataSource(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DeleteApplicationReferenceDataSourceResponse) => void): Request<KinesisAnalyticsV2.Types.DeleteApplicationReferenceDataSourceResponse, AWSError>;
118 /**
119 * Deletes a snapshot of application state.
120 */
121 deleteApplicationSnapshot(params: KinesisAnalyticsV2.Types.DeleteApplicationSnapshotRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DeleteApplicationSnapshotResponse) => void): Request<KinesisAnalyticsV2.Types.DeleteApplicationSnapshotResponse, AWSError>;
122 /**
123 * Deletes a snapshot of application state.
124 */
125 deleteApplicationSnapshot(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DeleteApplicationSnapshotResponse) => void): Request<KinesisAnalyticsV2.Types.DeleteApplicationSnapshotResponse, AWSError>;
126 /**
127 * Removes a VPC configuration from a Kinesis Data Analytics application.
128 */
129 deleteApplicationVpcConfiguration(params: KinesisAnalyticsV2.Types.DeleteApplicationVpcConfigurationRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DeleteApplicationVpcConfigurationResponse) => void): Request<KinesisAnalyticsV2.Types.DeleteApplicationVpcConfigurationResponse, AWSError>;
130 /**
131 * Removes a VPC configuration from a Kinesis Data Analytics application.
132 */
133 deleteApplicationVpcConfiguration(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DeleteApplicationVpcConfigurationResponse) => void): Request<KinesisAnalyticsV2.Types.DeleteApplicationVpcConfigurationResponse, AWSError>;
134 /**
135 * 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.
136 */
137 describeApplication(params: KinesisAnalyticsV2.Types.DescribeApplicationRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DescribeApplicationResponse) => void): Request<KinesisAnalyticsV2.Types.DescribeApplicationResponse, AWSError>;
138 /**
139 * 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.
140 */
141 describeApplication(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DescribeApplicationResponse) => void): Request<KinesisAnalyticsV2.Types.DescribeApplicationResponse, AWSError>;
142 /**
143 * Returns information about a snapshot of application state data.
144 */
145 describeApplicationSnapshot(params: KinesisAnalyticsV2.Types.DescribeApplicationSnapshotRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DescribeApplicationSnapshotResponse) => void): Request<KinesisAnalyticsV2.Types.DescribeApplicationSnapshotResponse, AWSError>;
146 /**
147 * Returns information about a snapshot of application state data.
148 */
149 describeApplicationSnapshot(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DescribeApplicationSnapshotResponse) => void): Request<KinesisAnalyticsV2.Types.DescribeApplicationSnapshotResponse, AWSError>;
150 /**
151 * 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.
152 */
153 discoverInputSchema(params: KinesisAnalyticsV2.Types.DiscoverInputSchemaRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DiscoverInputSchemaResponse) => void): Request<KinesisAnalyticsV2.Types.DiscoverInputSchemaResponse, AWSError>;
154 /**
155 * 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.
156 */
157 discoverInputSchema(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.DiscoverInputSchemaResponse) => void): Request<KinesisAnalyticsV2.Types.DiscoverInputSchemaResponse, AWSError>;
158 /**
159 * Lists information about the current application snapshots.
160 */
161 listApplicationSnapshots(params: KinesisAnalyticsV2.Types.ListApplicationSnapshotsRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.ListApplicationSnapshotsResponse) => void): Request<KinesisAnalyticsV2.Types.ListApplicationSnapshotsResponse, AWSError>;
162 /**
163 * Lists information about the current application snapshots.
164 */
165 listApplicationSnapshots(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.ListApplicationSnapshotsResponse) => void): Request<KinesisAnalyticsV2.Types.ListApplicationSnapshotsResponse, AWSError>;
166 /**
167 * 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.
168 */
169 listApplications(params: KinesisAnalyticsV2.Types.ListApplicationsRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.ListApplicationsResponse) => void): Request<KinesisAnalyticsV2.Types.ListApplicationsResponse, AWSError>;
170 /**
171 * 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.
172 */
173 listApplications(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.ListApplicationsResponse) => void): Request<KinesisAnalyticsV2.Types.ListApplicationsResponse, AWSError>;
174 /**
175 * Retrieves the list of key-value tags assigned to the application. For more information, see Using Tagging.
176 */
177 listTagsForResource(params: KinesisAnalyticsV2.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.ListTagsForResourceResponse) => void): Request<KinesisAnalyticsV2.Types.ListTagsForResourceResponse, AWSError>;
178 /**
179 * Retrieves the list of key-value tags assigned to the application. For more information, see Using Tagging.
180 */
181 listTagsForResource(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.ListTagsForResourceResponse) => void): Request<KinesisAnalyticsV2.Types.ListTagsForResourceResponse, AWSError>;
182 /**
183 * Starts the specified Amazon Kinesis Data Analytics application. After creating an application, you must exclusively call this operation to start your application.
184 */
185 startApplication(params: KinesisAnalyticsV2.Types.StartApplicationRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.StartApplicationResponse) => void): Request<KinesisAnalyticsV2.Types.StartApplicationResponse, AWSError>;
186 /**
187 * Starts the specified Amazon Kinesis Data Analytics application. After creating an application, you must exclusively call this operation to start your application.
188 */
189 startApplication(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.StartApplicationResponse) => void): Request<KinesisAnalyticsV2.Types.StartApplicationResponse, AWSError>;
190 /**
191 * 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.
192 */
193 stopApplication(params: KinesisAnalyticsV2.Types.StopApplicationRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.StopApplicationResponse) => void): Request<KinesisAnalyticsV2.Types.StopApplicationResponse, AWSError>;
194 /**
195 * 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.
196 */
197 stopApplication(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.StopApplicationResponse) => void): Request<KinesisAnalyticsV2.Types.StopApplicationResponse, AWSError>;
198 /**
199 * 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.
200 */
201 tagResource(params: KinesisAnalyticsV2.Types.TagResourceRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.TagResourceResponse) => void): Request<KinesisAnalyticsV2.Types.TagResourceResponse, AWSError>;
202 /**
203 * 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.
204 */
205 tagResource(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.TagResourceResponse) => void): Request<KinesisAnalyticsV2.Types.TagResourceResponse, AWSError>;
206 /**
207 * Removes one or more tags from a Kinesis Analytics application. For more information, see Using Tagging.
208 */
209 untagResource(params: KinesisAnalyticsV2.Types.UntagResourceRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.UntagResourceResponse) => void): Request<KinesisAnalyticsV2.Types.UntagResourceResponse, AWSError>;
210 /**
211 * Removes one or more tags from a Kinesis Analytics application. For more information, see Using Tagging.
212 */
213 untagResource(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.UntagResourceResponse) => void): Request<KinesisAnalyticsV2.Types.UntagResourceResponse, AWSError>;
214 /**
215 * 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.
216 */
217 updateApplication(params: KinesisAnalyticsV2.Types.UpdateApplicationRequest, callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.UpdateApplicationResponse) => void): Request<KinesisAnalyticsV2.Types.UpdateApplicationResponse, AWSError>;
218 /**
219 * 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.
220 */
221 updateApplication(callback?: (err: AWSError, data: KinesisAnalyticsV2.Types.UpdateApplicationResponse) => void): Request<KinesisAnalyticsV2.Types.UpdateApplicationResponse, AWSError>;
222}
223declare namespace KinesisAnalyticsV2 {
224 export interface AddApplicationCloudWatchLoggingOptionRequest {
225 /**
226 * The Kinesis Data Analytics application name.
227 */
228 ApplicationName: ApplicationName;
229 /**
230 * The version ID of the Kinesis Data Analytics application. You can retrieve the application version ID using DescribeApplication.
231 */
232 CurrentApplicationVersionId: ApplicationVersionId;
233 /**
234 * Provides the Amazon CloudWatch log stream Amazon Resource Name (ARN).
235 */
236 CloudWatchLoggingOption: CloudWatchLoggingOption;
237 }
238 export interface AddApplicationCloudWatchLoggingOptionResponse {
239 /**
240 * The application's ARN.
241 */
242 ApplicationARN?: ResourceARN;
243 /**
244 * The new version ID of the Kinesis Data Analytics application. Kinesis Data Analytics updates the ApplicationVersionId each time you change the CloudWatch logging options.
245 */
246 ApplicationVersionId?: ApplicationVersionId;
247 /**
248 * The descriptions of the current CloudWatch logging options for the Kinesis Data Analytics application.
249 */
250 CloudWatchLoggingOptionDescriptions?: CloudWatchLoggingOptionDescriptions;
251 }
252 export interface AddApplicationInputProcessingConfigurationRequest {
253 /**
254 * The name of the application to which you want to add the input processing configuration.
255 */
256 ApplicationName: ApplicationName;
257 /**
258 * 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.
259 */
260 CurrentApplicationVersionId: ApplicationVersionId;
261 /**
262 * 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.
263 */
264 InputId: Id;
265 /**
266 * The InputProcessingConfiguration to add to the application.
267 */
268 InputProcessingConfiguration: InputProcessingConfiguration;
269 }
270 export interface AddApplicationInputProcessingConfigurationResponse {
271 /**
272 * The Amazon Resource Name (ARN) of the application.
273 */
274 ApplicationARN?: ResourceARN;
275 /**
276 * Provides the current application version.
277 */
278 ApplicationVersionId?: ApplicationVersionId;
279 /**
280 * 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.
281 */
282 InputId?: Id;
283 /**
284 * The description of the preprocessor that executes on records in this input before the application's code is run.
285 */
286 InputProcessingConfigurationDescription?: InputProcessingConfigurationDescription;
287 }
288 export interface AddApplicationInputRequest {
289 /**
290 * The name of your existing application to which you want to add the streaming source.
291 */
292 ApplicationName: ApplicationName;
293 /**
294 * The current version of your application. You can use the DescribeApplication operation to find the current application version.
295 */
296 CurrentApplicationVersionId: ApplicationVersionId;
297 /**
298 * The Input to add.
299 */
300 Input: Input;
301 }
302 export interface AddApplicationInputResponse {
303 /**
304 * The Amazon Resource Name (ARN) of the application.
305 */
306 ApplicationARN?: ResourceARN;
307 /**
308 * Provides the current application version.
309 */
310 ApplicationVersionId?: ApplicationVersionId;
311 /**
312 * Describes the application input configuration.
313 */
314 InputDescriptions?: InputDescriptions;
315 }
316 export interface AddApplicationOutputRequest {
317 /**
318 * The name of the application to which you want to add the output configuration.
319 */
320 ApplicationName: ApplicationName;
321 /**
322 * 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.
323 */
324 CurrentApplicationVersionId: ApplicationVersionId;
325 /**
326 * 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.
327 */
328 Output: Output;
329 }
330 export interface AddApplicationOutputResponse {
331 /**
332 * The application Amazon Resource Name (ARN).
333 */
334 ApplicationARN?: ResourceARN;
335 /**
336 * The updated application version ID. Kinesis Data Analytics increments this ID when the application is updated.
337 */
338 ApplicationVersionId?: ApplicationVersionId;
339 /**
340 * Describes the application output configuration. For more information, see Configuring Application Output.
341 */
342 OutputDescriptions?: OutputDescriptions;
343 }
344 export interface AddApplicationReferenceDataSourceRequest {
345 /**
346 * The name of an existing application.
347 */
348 ApplicationName: ApplicationName;
349 /**
350 * 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.
351 */
352 CurrentApplicationVersionId: ApplicationVersionId;
353 /**
354 * 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.
355 */
356 ReferenceDataSource: ReferenceDataSource;
357 }
358 export interface AddApplicationReferenceDataSourceResponse {
359 /**
360 * The application Amazon Resource Name (ARN).
361 */
362 ApplicationARN?: ResourceARN;
363 /**
364 * The updated application version ID. Amazon Kinesis Data Analytics increments this ID when the application is updated.
365 */
366 ApplicationVersionId?: ApplicationVersionId;
367 /**
368 * Describes reference data sources configured for the application.
369 */
370 ReferenceDataSourceDescriptions?: ReferenceDataSourceDescriptions;
371 }
372 export interface AddApplicationVpcConfigurationRequest {
373 /**
374 * The name of an existing application.
375 */
376 ApplicationName: ApplicationName;
377 /**
378 * 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.
379 */
380 CurrentApplicationVersionId: ApplicationVersionId;
381 /**
382 * Description of the VPC to add to the application.
383 */
384 VpcConfiguration: VpcConfiguration;
385 }
386 export interface AddApplicationVpcConfigurationResponse {
387 /**
388 * The ARN of the application.
389 */
390 ApplicationARN?: ResourceARN;
391 /**
392 * Provides the current application version. Kinesis Data Analytics updates the ApplicationVersionId each time you update the application.
393 */
394 ApplicationVersionId?: ApplicationVersionId;
395 /**
396 * The parameters of the new VPC configuration.
397 */
398 VpcConfigurationDescription?: VpcConfigurationDescription;
399 }
400 export interface ApplicationCodeConfiguration {
401 /**
402 * The location and type of the application code.
403 */
404 CodeContent?: CodeContent;
405 /**
406 * Specifies whether the code content is in text or zip format.
407 */
408 CodeContentType: CodeContentType;
409 }
410 export interface ApplicationCodeConfigurationDescription {
411 /**
412 * Specifies whether the code content is in text or zip format.
413 */
414 CodeContentType: CodeContentType;
415 /**
416 * Describes details about the location and format of the application code.
417 */
418 CodeContentDescription?: CodeContentDescription;
419 }
420 export interface ApplicationCodeConfigurationUpdate {
421 /**
422 * Describes updates to the code content type.
423 */
424 CodeContentTypeUpdate?: CodeContentType;
425 /**
426 * Describes updates to the code content of an application.
427 */
428 CodeContentUpdate?: CodeContentUpdate;
429 }
430 export interface ApplicationConfiguration {
431 /**
432 * The creation and update parameters for an SQL-based Kinesis Data Analytics application.
433 */
434 SqlApplicationConfiguration?: SqlApplicationConfiguration;
435 /**
436 * The creation and update parameters for a Java-based Kinesis Data Analytics application.
437 */
438 FlinkApplicationConfiguration?: FlinkApplicationConfiguration;
439 /**
440 * Describes execution properties for a Java-based Kinesis Data Analytics application.
441 */
442 EnvironmentProperties?: EnvironmentProperties;
443 /**
444 * The code location and type parameters for a Java-based Kinesis Data Analytics application.
445 */
446 ApplicationCodeConfiguration: ApplicationCodeConfiguration;
447 /**
448 * Describes whether snapshots are enabled for a Java-based Kinesis Data Analytics application.
449 */
450 ApplicationSnapshotConfiguration?: ApplicationSnapshotConfiguration;
451 /**
452 * The array of descriptions of VPC configurations available to the application.
453 */
454 VpcConfigurations?: VpcConfigurations;
455 }
456 export interface ApplicationConfigurationDescription {
457 /**
458 * The details about inputs, outputs, and reference data sources for an SQL-based Kinesis Data Analytics application.
459 */
460 SqlApplicationConfigurationDescription?: SqlApplicationConfigurationDescription;
461 /**
462 * The details about the application code for a Java-based Kinesis Data Analytics application.
463 */
464 ApplicationCodeConfigurationDescription?: ApplicationCodeConfigurationDescription;
465 /**
466 * The details about the starting properties for a Kinesis Data Analytics application.
467 */
468 RunConfigurationDescription?: RunConfigurationDescription;
469 /**
470 * The details about a Java-based Kinesis Data Analytics application.
471 */
472 FlinkApplicationConfigurationDescription?: FlinkApplicationConfigurationDescription;
473 /**
474 * Describes execution properties for a Java-based Kinesis Data Analytics application.
475 */
476 EnvironmentPropertyDescriptions?: EnvironmentPropertyDescriptions;
477 /**
478 * Describes whether snapshots are enabled for a Java-based Kinesis Data Analytics application.
479 */
480 ApplicationSnapshotConfigurationDescription?: ApplicationSnapshotConfigurationDescription;
481 /**
482 * The array of descriptions of VPC configurations available to the application.
483 */
484 VpcConfigurationDescriptions?: VpcConfigurationDescriptions;
485 }
486 export interface ApplicationConfigurationUpdate {
487 /**
488 * Describes updates to an SQL-based Kinesis Data Analytics application's configuration.
489 */
490 SqlApplicationConfigurationUpdate?: SqlApplicationConfigurationUpdate;
491 /**
492 * Describes updates to a Java-based Kinesis Data Analytics application's code configuration.
493 */
494 ApplicationCodeConfigurationUpdate?: ApplicationCodeConfigurationUpdate;
495 /**
496 * Describes updates to a Java-based Kinesis Data Analytics application's configuration.
497 */
498 FlinkApplicationConfigurationUpdate?: FlinkApplicationConfigurationUpdate;
499 /**
500 * Describes updates to the environment properties for a Java-based Kinesis Data Analytics application.
501 */
502 EnvironmentPropertyUpdates?: EnvironmentPropertyUpdates;
503 /**
504 * Describes whether snapshots are enabled for a Java-based Kinesis Data Analytics application.
505 */
506 ApplicationSnapshotConfigurationUpdate?: ApplicationSnapshotConfigurationUpdate;
507 /**
508 * Updates to the array of descriptions of VPC configurations available to the application.
509 */
510 VpcConfigurationUpdates?: VpcConfigurationUpdates;
511 }
512 export type ApplicationDescription = string;
513 export interface ApplicationDetail {
514 /**
515 * The ARN of the application.
516 */
517 ApplicationARN: ResourceARN;
518 /**
519 * The description of the application.
520 */
521 ApplicationDescription?: ApplicationDescription;
522 /**
523 * The name of the application.
524 */
525 ApplicationName: ApplicationName;
526 /**
527 * The runtime environment for the application (SQL-1.0 or FLINK-1_6).
528 */
529 RuntimeEnvironment: RuntimeEnvironment;
530 /**
531 * Specifies the IAM role that the application uses to access external resources.
532 */
533 ServiceExecutionRole?: RoleARN;
534 /**
535 * The status of the application.
536 */
537 ApplicationStatus: ApplicationStatus;
538 /**
539 * Provides the current application version. Kinesis Data Analytics updates the ApplicationVersionId each time you update the application.
540 */
541 ApplicationVersionId: ApplicationVersionId;
542 /**
543 * The current timestamp when the application was created.
544 */
545 CreateTimestamp?: Timestamp;
546 /**
547 * The current timestamp when the application was last updated.
548 */
549 LastUpdateTimestamp?: Timestamp;
550 /**
551 * Provides details about the application's SQL or Java code and starting parameters.
552 */
553 ApplicationConfigurationDescription?: ApplicationConfigurationDescription;
554 /**
555 * Describes the application Amazon CloudWatch logging options.
556 */
557 CloudWatchLoggingOptionDescriptions?: CloudWatchLoggingOptionDescriptions;
558 }
559 export type ApplicationName = string;
560 export interface ApplicationRestoreConfiguration {
561 /**
562 * Specifies how the application should be restored.
563 */
564 ApplicationRestoreType: ApplicationRestoreType;
565 /**
566 * 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.
567 */
568 SnapshotName?: SnapshotName;
569 }
570 export type ApplicationRestoreType = "SKIP_RESTORE_FROM_SNAPSHOT"|"RESTORE_FROM_LATEST_SNAPSHOT"|"RESTORE_FROM_CUSTOM_SNAPSHOT"|string;
571 export interface ApplicationSnapshotConfiguration {
572 /**
573 * Describes whether snapshots are enabled for a Java-based Kinesis Data Analytics application.
574 */
575 SnapshotsEnabled: BooleanObject;
576 }
577 export interface ApplicationSnapshotConfigurationDescription {
578 /**
579 * Describes whether snapshots are enabled for a Java-based Kinesis Data Analytics application.
580 */
581 SnapshotsEnabled: BooleanObject;
582 }
583 export interface ApplicationSnapshotConfigurationUpdate {
584 /**
585 * Describes updates to whether snapshots are enabled for a Java-based Kinesis Data Analytics application.
586 */
587 SnapshotsEnabledUpdate: BooleanObject;
588 }
589 export type ApplicationStatus = "DELETING"|"STARTING"|"STOPPING"|"READY"|"RUNNING"|"UPDATING"|string;
590 export type ApplicationSummaries = ApplicationSummary[];
591 export interface ApplicationSummary {
592 /**
593 * The name of the application.
594 */
595 ApplicationName: ApplicationName;
596 /**
597 * The ARN of the application.
598 */
599 ApplicationARN: ResourceARN;
600 /**
601 * The status of the application.
602 */
603 ApplicationStatus: ApplicationStatus;
604 /**
605 * Provides the current application version.
606 */
607 ApplicationVersionId: ApplicationVersionId;
608 /**
609 * The runtime environment for the application (SQL-1.0 or FLINK-1_6).
610 */
611 RuntimeEnvironment: RuntimeEnvironment;
612 }
613 export type ApplicationVersionId = number;
614 export type BooleanObject = boolean;
615 export type BucketARN = string;
616 export interface CSVMappingParameters {
617 /**
618 * The row delimiter. For example, in a CSV format, '\n' is the typical row delimiter.
619 */
620 RecordRowDelimiter: RecordRowDelimiter;
621 /**
622 * The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.
623 */
624 RecordColumnDelimiter: RecordColumnDelimiter;
625 }
626 export interface CheckpointConfiguration {
627 /**
628 * 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
629 */
630 ConfigurationType: ConfigurationType;
631 /**
632 * 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.
633 */
634 CheckpointingEnabled?: BooleanObject;
635 /**
636 * 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.
637 */
638 CheckpointInterval?: CheckpointInterval;
639 /**
640 * 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.
641 */
642 MinPauseBetweenCheckpoints?: MinPauseBetweenCheckpoints;
643 }
644 export interface CheckpointConfigurationDescription {
645 /**
646 * 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
647 */
648 ConfigurationType?: ConfigurationType;
649 /**
650 * 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.
651 */
652 CheckpointingEnabled?: BooleanObject;
653 /**
654 * 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.
655 */
656 CheckpointInterval?: CheckpointInterval;
657 /**
658 * 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.
659 */
660 MinPauseBetweenCheckpoints?: MinPauseBetweenCheckpoints;
661 }
662 export interface CheckpointConfigurationUpdate {
663 /**
664 * 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
665 */
666 ConfigurationTypeUpdate?: ConfigurationType;
667 /**
668 * 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.
669 */
670 CheckpointingEnabledUpdate?: BooleanObject;
671 /**
672 * 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.
673 */
674 CheckpointIntervalUpdate?: CheckpointInterval;
675 /**
676 * 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.
677 */
678 MinPauseBetweenCheckpointsUpdate?: MinPauseBetweenCheckpoints;
679 }
680 export type CheckpointInterval = number;
681 export interface CloudWatchLoggingOption {
682 /**
683 * The ARN of the CloudWatch log to receive application messages.
684 */
685 LogStreamARN: LogStreamARN;
686 }
687 export interface CloudWatchLoggingOptionDescription {
688 /**
689 * The ID of the CloudWatch logging option description.
690 */
691 CloudWatchLoggingOptionId?: Id;
692 /**
693 * The Amazon Resource Name (ARN) of the CloudWatch log to receive application messages.
694 */
695 LogStreamARN: LogStreamARN;
696 /**
697 * 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.
698 */
699 RoleARN?: RoleARN;
700 }
701 export type CloudWatchLoggingOptionDescriptions = CloudWatchLoggingOptionDescription[];
702 export interface CloudWatchLoggingOptionUpdate {
703 /**
704 * The ID of the CloudWatch logging option to update
705 */
706 CloudWatchLoggingOptionId: Id;
707 /**
708 * The Amazon Resource Name (ARN) of the CloudWatch log to receive application messages.
709 */
710 LogStreamARNUpdate?: LogStreamARN;
711 }
712 export type CloudWatchLoggingOptionUpdates = CloudWatchLoggingOptionUpdate[];
713 export type CloudWatchLoggingOptions = CloudWatchLoggingOption[];
714 export interface CodeContent {
715 /**
716 * The text-format code for a Java-based Kinesis Data Analytics application.
717 */
718 TextContent?: TextContent;
719 /**
720 * The zip-format code for a Java-based Kinesis Data Analytics application.
721 */
722 ZipFileContent?: ZipFileContent;
723 /**
724 * Information about the Amazon S3 bucket containing the application code.
725 */
726 S3ContentLocation?: S3ContentLocation;
727 }
728 export interface CodeContentDescription {
729 /**
730 * The text-format code
731 */
732 TextContent?: TextContent;
733 /**
734 * The checksum that can be used to validate zip-format code.
735 */
736 CodeMD5?: CodeMD5;
737 /**
738 * The size in bytes of the application code. Can be used to validate zip-format code.
739 */
740 CodeSize?: CodeSize;
741 /**
742 * The S3 bucket Amazon Resource Name (ARN), file key, and object version of the application code stored in Amazon S3.
743 */
744 S3ApplicationCodeLocationDescription?: S3ApplicationCodeLocationDescription;
745 }
746 export type CodeContentType = "PLAINTEXT"|"ZIPFILE"|string;
747 export interface CodeContentUpdate {
748 /**
749 * Describes an update to the text code for an application.
750 */
751 TextContentUpdate?: TextContent;
752 /**
753 * Describes an update to the zipped code for an application.
754 */
755 ZipFileContentUpdate?: ZipFileContent;
756 /**
757 * Describes an update to the location of code for an application.
758 */
759 S3ContentLocationUpdate?: S3ContentLocationUpdate;
760 }
761 export type CodeMD5 = string;
762 export type CodeSize = number;
763 export type ConfigurationType = "DEFAULT"|"CUSTOM"|string;
764 export interface CreateApplicationRequest {
765 /**
766 * The name of your application (for example, sample-app).
767 */
768 ApplicationName: ApplicationName;
769 /**
770 * A summary description of the application.
771 */
772 ApplicationDescription?: ApplicationDescription;
773 /**
774 * The runtime environment for the application (SQL-1.0 or FLINK-1_6).
775 */
776 RuntimeEnvironment: RuntimeEnvironment;
777 /**
778 * The IAM role used by the application to access Kinesis data streams, Kinesis Data Firehose delivery streams, Amazon S3 objects, and other external resources.
779 */
780 ServiceExecutionRole: RoleARN;
781 /**
782 * Use this parameter to configure the application.
783 */
784 ApplicationConfiguration?: ApplicationConfiguration;
785 /**
786 * Use this parameter to configure an Amazon CloudWatch log stream to monitor application configuration errors.
787 */
788 CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
789 /**
790 * A list of one or more tags to assign to the application. A tag is a key-value pair that identifies an 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.
791 */
792 Tags?: Tags;
793 }
794 export interface CreateApplicationResponse {
795 /**
796 * In response to your CreateApplication request, Kinesis Data Analytics returns a response with details of the application it created.
797 */
798 ApplicationDetail: ApplicationDetail;
799 }
800 export interface CreateApplicationSnapshotRequest {
801 /**
802 * The name of an existing application
803 */
804 ApplicationName: ApplicationName;
805 /**
806 * An identifier for the application snapshot.
807 */
808 SnapshotName: SnapshotName;
809 }
810 export interface CreateApplicationSnapshotResponse {
811 }
812 export interface DeleteApplicationCloudWatchLoggingOptionRequest {
813 /**
814 * The application name.
815 */
816 ApplicationName: ApplicationName;
817 /**
818 * The version ID of the application. You can retrieve the application version ID using DescribeApplication.
819 */
820 CurrentApplicationVersionId: ApplicationVersionId;
821 /**
822 * The CloudWatchLoggingOptionId of the Amazon CloudWatch logging option to delete. You can get the CloudWatchLoggingOptionId by using the DescribeApplication operation.
823 */
824 CloudWatchLoggingOptionId: Id;
825 }
826 export interface DeleteApplicationCloudWatchLoggingOptionResponse {
827 /**
828 * The application's Amazon Resource Name (ARN).
829 */
830 ApplicationARN?: ResourceARN;
831 /**
832 * The version ID of the application. Kinesis Data Analytics updates the ApplicationVersionId each time you change the CloudWatch logging options.
833 */
834 ApplicationVersionId?: ApplicationVersionId;
835 /**
836 * The descriptions of the remaining CloudWatch logging options for the application.
837 */
838 CloudWatchLoggingOptionDescriptions?: CloudWatchLoggingOptionDescriptions;
839 }
840 export interface DeleteApplicationInputProcessingConfigurationRequest {
841 /**
842 * The name of the application.
843 */
844 ApplicationName: ApplicationName;
845 /**
846 * The application version. 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.
847 */
848 CurrentApplicationVersionId: ApplicationVersionId;
849 /**
850 * The ID of the input configuration from which to delete the input processing configuration. You can get a list of the input IDs for an application by using the DescribeApplication operation.
851 */
852 InputId: Id;
853 }
854 export interface DeleteApplicationInputProcessingConfigurationResponse {
855 /**
856 * The Amazon Resource Name (ARN) of the application.
857 */
858 ApplicationARN?: ResourceARN;
859 /**
860 * The current application version ID.
861 */
862 ApplicationVersionId?: ApplicationVersionId;
863 }
864 export interface DeleteApplicationOutputRequest {
865 /**
866 * The application name.
867 */
868 ApplicationName: ApplicationName;
869 /**
870 * The application version. 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.
871 */
872 CurrentApplicationVersionId: ApplicationVersionId;
873 /**
874 * The ID of the configuration to delete. Each output configuration that is added to the application (either when the application is created or later) using the AddApplicationOutput operation has a unique ID. You need to provide the ID to uniquely identify the output configuration that you want to delete from the application configuration. You can use the DescribeApplication operation to get the specific OutputId.
875 */
876 OutputId: Id;
877 }
878 export interface DeleteApplicationOutputResponse {
879 /**
880 * The application Amazon Resource Name (ARN).
881 */
882 ApplicationARN?: ResourceARN;
883 /**
884 * The current application version ID.
885 */
886 ApplicationVersionId?: ApplicationVersionId;
887 }
888 export interface DeleteApplicationReferenceDataSourceRequest {
889 /**
890 * The name of an existing application.
891 */
892 ApplicationName: ApplicationName;
893 /**
894 * The current application version. 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.
895 */
896 CurrentApplicationVersionId: ApplicationVersionId;
897 /**
898 * The ID of the reference data source. When you add a reference data source to your application using the AddApplicationReferenceDataSource, Kinesis Data Analytics assigns an ID. You can use the DescribeApplication operation to get the reference ID.
899 */
900 ReferenceId: Id;
901 }
902 export interface DeleteApplicationReferenceDataSourceResponse {
903 /**
904 * The application Amazon Resource Name (ARN).
905 */
906 ApplicationARN?: ResourceARN;
907 /**
908 * The updated version ID of the application.
909 */
910 ApplicationVersionId?: ApplicationVersionId;
911 }
912 export interface DeleteApplicationRequest {
913 /**
914 * The name of the application to delete.
915 */
916 ApplicationName: ApplicationName;
917 /**
918 * Use the DescribeApplication operation to get this value.
919 */
920 CreateTimestamp: Timestamp;
921 }
922 export interface DeleteApplicationResponse {
923 }
924 export interface DeleteApplicationSnapshotRequest {
925 /**
926 * The name of an existing application.
927 */
928 ApplicationName: ApplicationName;
929 /**
930 * The identifier for the snapshot delete.
931 */
932 SnapshotName: SnapshotName;
933 /**
934 * The creation timestamp of the application snapshot to delete. You can retrieve this value using or .
935 */
936 SnapshotCreationTimestamp: Timestamp;
937 }
938 export interface DeleteApplicationSnapshotResponse {
939 }
940 export interface DeleteApplicationVpcConfigurationRequest {
941 /**
942 * The name of an existing application.
943 */
944 ApplicationName: ApplicationName;
945 /**
946 * The current application version ID. You can retrieve the application version ID using DescribeApplication.
947 */
948 CurrentApplicationVersionId: ApplicationVersionId;
949 /**
950 * The ID of the VPC configuration to delete.
951 */
952 VpcConfigurationId: Id;
953 }
954 export interface DeleteApplicationVpcConfigurationResponse {
955 /**
956 * The ARN of the Kinesis Data Analytics application.
957 */
958 ApplicationARN?: ResourceARN;
959 /**
960 * The updated version ID of the application.
961 */
962 ApplicationVersionId?: ApplicationVersionId;
963 }
964 export interface DescribeApplicationRequest {
965 /**
966 * The name of the application.
967 */
968 ApplicationName: ApplicationName;
969 /**
970 * Displays verbose information about a Kinesis Data Analytics application, including the application's job plan.
971 */
972 IncludeAdditionalDetails?: BooleanObject;
973 }
974 export interface DescribeApplicationResponse {
975 /**
976 * Provides a description of the application, such as the application's Amazon Resource Name (ARN), status, and latest version.
977 */
978 ApplicationDetail: ApplicationDetail;
979 }
980 export interface DescribeApplicationSnapshotRequest {
981 /**
982 * The name of an existing application.
983 */
984 ApplicationName: ApplicationName;
985 /**
986 * The identifier of an application snapshot. You can retrieve this value using .
987 */
988 SnapshotName: SnapshotName;
989 }
990 export interface DescribeApplicationSnapshotResponse {
991 /**
992 * An object containing information about the application snapshot.
993 */
994 SnapshotDetails: SnapshotDetails;
995 }
996 export interface DestinationSchema {
997 /**
998 * Specifies the format of the records on the output stream.
999 */
1000 RecordFormatType: RecordFormatType;
1001 }
1002 export interface DiscoverInputSchemaRequest {
1003 /**
1004 * The Amazon Resource Name (ARN) of the streaming source.
1005 */
1006 ResourceARN?: ResourceARN;
1007 /**
1008 * The ARN of the role that is used to access the streaming source.
1009 */
1010 ServiceExecutionRole: RoleARN;
1011 /**
1012 * The point at which you want Kinesis Data Analytics to start reading records from the specified streaming source discovery purposes.
1013 */
1014 InputStartingPositionConfiguration?: InputStartingPositionConfiguration;
1015 /**
1016 * Specify this parameter to discover a schema from data in an Amazon S3 object.
1017 */
1018 S3Configuration?: S3Configuration;
1019 /**
1020 * The InputProcessingConfiguration to use to preprocess the records before discovering the schema of the records.
1021 */
1022 InputProcessingConfiguration?: InputProcessingConfiguration;
1023 }
1024 export interface DiscoverInputSchemaResponse {
1025 /**
1026 * The schema inferred from the streaming source. It identifies the format of the data in the streaming source and how each data element maps to corresponding columns in the in-application stream that you can create.
1027 */
1028 InputSchema?: SourceSchema;
1029 /**
1030 * An array of elements, where each element corresponds to a row in a stream record (a stream record can have more than one row).
1031 */
1032 ParsedInputRecords?: ParsedInputRecords;
1033 /**
1034 * The stream data that was modified by the processor specified in the InputProcessingConfiguration parameter.
1035 */
1036 ProcessedInputRecords?: ProcessedInputRecords;
1037 /**
1038 * The raw stream data that was sampled to infer the schema.
1039 */
1040 RawInputRecords?: RawInputRecords;
1041 }
1042 export interface EnvironmentProperties {
1043 /**
1044 * Describes the execution property groups.
1045 */
1046 PropertyGroups: PropertyGroups;
1047 }
1048 export interface EnvironmentPropertyDescriptions {
1049 /**
1050 * Describes the execution property groups.
1051 */
1052 PropertyGroupDescriptions?: PropertyGroups;
1053 }
1054 export interface EnvironmentPropertyUpdates {
1055 /**
1056 * Describes updates to the execution property groups.
1057 */
1058 PropertyGroups: PropertyGroups;
1059 }
1060 export type FileKey = string;
1061 export interface FlinkApplicationConfiguration {
1062 /**
1063 * Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance. For more information, see Checkpoints for Fault Tolerance in the Apache Flink Documentation.
1064 */
1065 CheckpointConfiguration?: CheckpointConfiguration;
1066 /**
1067 * Describes configuration parameters for Amazon CloudWatch logging for an application.
1068 */
1069 MonitoringConfiguration?: MonitoringConfiguration;
1070 /**
1071 * Describes parameters for how an application executes multiple tasks simultaneously.
1072 */
1073 ParallelismConfiguration?: ParallelismConfiguration;
1074 }
1075 export interface FlinkApplicationConfigurationDescription {
1076 /**
1077 * Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance.
1078 */
1079 CheckpointConfigurationDescription?: CheckpointConfigurationDescription;
1080 /**
1081 * Describes configuration parameters for Amazon CloudWatch logging for an application.
1082 */
1083 MonitoringConfigurationDescription?: MonitoringConfigurationDescription;
1084 /**
1085 * Describes parameters for how an application executes multiple tasks simultaneously.
1086 */
1087 ParallelismConfigurationDescription?: ParallelismConfigurationDescription;
1088 /**
1089 * The job plan for an application. For more information about the job plan, see Jobs and Scheduling in the Apache Flink Documentation. To retrieve the job plan for the application, use the DescribeApplicationRequest$IncludeAdditionalDetails parameter of the DescribeApplication operation.
1090 */
1091 JobPlanDescription?: JobPlanDescription;
1092 }
1093 export interface FlinkApplicationConfigurationUpdate {
1094 /**
1095 * Describes updates to an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance.
1096 */
1097 CheckpointConfigurationUpdate?: CheckpointConfigurationUpdate;
1098 /**
1099 * Describes updates to the configuration parameters for Amazon CloudWatch logging for an application.
1100 */
1101 MonitoringConfigurationUpdate?: MonitoringConfigurationUpdate;
1102 /**
1103 * Describes updates to the parameters for how an application executes multiple tasks simultaneously.
1104 */
1105 ParallelismConfigurationUpdate?: ParallelismConfigurationUpdate;
1106 }
1107 export interface FlinkRunConfiguration {
1108 /**
1109 * When restoring from a savepoint, specifies whether the runtime is allowed to skip a state that cannot be mapped to the new program. This will happen if the program is updated between savepoints to remove stateful parameters, and state data in the savepoint no longer corresponds to valid application data. For more information, see Allowing Non-Restored State in the Apache Flink documentation.
1110 */
1111 AllowNonRestoredState?: BooleanObject;
1112 }
1113 export type Id = string;
1114 export type InAppStreamName = string;
1115 export type InAppStreamNames = InAppStreamName[];
1116 export type InAppTableName = string;
1117 export interface Input {
1118 /**
1119 * The name prefix to use when creating an in-application stream. Suppose that you specify a prefix "MyInApplicationStream." Kinesis Data Analytics then creates one or more (as per the InputParallelism count you specified) in-application streams with the names "MyInApplicationStream_001," "MyInApplicationStream_002," and so on.
1120 */
1121 NamePrefix: InAppStreamName;
1122 /**
1123 * The InputProcessingConfiguration for the input. An input processor transforms records as they are received from the stream, before the application's SQL code executes. Currently, the only input processing configuration available is InputLambdaProcessor.
1124 */
1125 InputProcessingConfiguration?: InputProcessingConfiguration;
1126 /**
1127 * If the streaming source is an Amazon Kinesis data stream, identifies the stream's Amazon Resource Name (ARN).
1128 */
1129 KinesisStreamsInput?: KinesisStreamsInput;
1130 /**
1131 * If the streaming source is an Amazon Kinesis Data Firehose delivery stream, identifies the delivery stream's ARN.
1132 */
1133 KinesisFirehoseInput?: KinesisFirehoseInput;
1134 /**
1135 * Describes the number of in-application streams to create.
1136 */
1137 InputParallelism?: InputParallelism;
1138 /**
1139 * Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created. Also used to describe the format of the reference data source.
1140 */
1141 InputSchema: SourceSchema;
1142 }
1143 export interface InputDescription {
1144 /**
1145 * The input ID that is associated with the application input. This is the ID that Kinesis Data Analytics assigns to each input configuration that you add to your application.
1146 */
1147 InputId?: Id;
1148 /**
1149 * The in-application name prefix.
1150 */
1151 NamePrefix?: InAppStreamName;
1152 /**
1153 * Returns the in-application stream names that are mapped to the stream source.
1154 */
1155 InAppStreamNames?: InAppStreamNames;
1156 /**
1157 * The description of the preprocessor that executes on records in this input before the application's code is run.
1158 */
1159 InputProcessingConfigurationDescription?: InputProcessingConfigurationDescription;
1160 /**
1161 * If a Kinesis data stream is configured as a streaming source, provides the Kinesis data stream's Amazon Resource Name (ARN).
1162 */
1163 KinesisStreamsInputDescription?: KinesisStreamsInputDescription;
1164 /**
1165 * If a Kinesis Data Firehose delivery stream is configured as a streaming source, provides the delivery stream's ARN.
1166 */
1167 KinesisFirehoseInputDescription?: KinesisFirehoseInputDescription;
1168 /**
1169 * Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created.
1170 */
1171 InputSchema?: SourceSchema;
1172 /**
1173 * Describes the configured parallelism (number of in-application streams mapped to the streaming source).
1174 */
1175 InputParallelism?: InputParallelism;
1176 /**
1177 * The point at which the application is configured to read from the input stream.
1178 */
1179 InputStartingPositionConfiguration?: InputStartingPositionConfiguration;
1180 }
1181 export type InputDescriptions = InputDescription[];
1182 export interface InputLambdaProcessor {
1183 /**
1184 * The ARN of the AWS Lambda function that operates on records in the stream. To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda
1185 */
1186 ResourceARN: ResourceARN;
1187 }
1188 export interface InputLambdaProcessorDescription {
1189 /**
1190 * The ARN of the AWS Lambda function that is used to preprocess the records in the stream. To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda
1191 */
1192 ResourceARN: ResourceARN;
1193 /**
1194 * The ARN of the IAM role that is used to access the AWS Lambda function. Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
1195 */
1196 RoleARN?: RoleARN;
1197 }
1198 export interface InputLambdaProcessorUpdate {
1199 /**
1200 * The Amazon Resource Name (ARN) of the new AWS Lambda function that is used to preprocess the records in the stream. To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda
1201 */
1202 ResourceARNUpdate: ResourceARN;
1203 }
1204 export interface InputParallelism {
1205 /**
1206 * The number of in-application streams to create.
1207 */
1208 Count?: InputParallelismCount;
1209 }
1210 export type InputParallelismCount = number;
1211 export interface InputParallelismUpdate {
1212 /**
1213 * The number of in-application streams to create for the specified streaming source.
1214 */
1215 CountUpdate: InputParallelismCount;
1216 }
1217 export interface InputProcessingConfiguration {
1218 /**
1219 * The InputLambdaProcessor that is used to preprocess the records in the stream before being processed by your application code.
1220 */
1221 InputLambdaProcessor: InputLambdaProcessor;
1222 }
1223 export interface InputProcessingConfigurationDescription {
1224 /**
1225 * Provides configuration information about the associated InputLambdaProcessorDescription
1226 */
1227 InputLambdaProcessorDescription?: InputLambdaProcessorDescription;
1228 }
1229 export interface InputProcessingConfigurationUpdate {
1230 /**
1231 * Provides update information for an InputLambdaProcessor.
1232 */
1233 InputLambdaProcessorUpdate: InputLambdaProcessorUpdate;
1234 }
1235 export interface InputSchemaUpdate {
1236 /**
1237 * Specifies the format of the records on the streaming source.
1238 */
1239 RecordFormatUpdate?: RecordFormat;
1240 /**
1241 * Specifies the encoding of the records in the streaming source; for example, UTF-8.
1242 */
1243 RecordEncodingUpdate?: RecordEncoding;
1244 /**
1245 * A list of RecordColumn objects. Each object describes the mapping of the streaming source element to the corresponding column in the in-application stream.
1246 */
1247 RecordColumnUpdates?: RecordColumns;
1248 }
1249 export type InputStartingPosition = "NOW"|"TRIM_HORIZON"|"LAST_STOPPED_POINT"|string;
1250 export interface InputStartingPositionConfiguration {
1251 /**
1252 * The starting position on the stream. NOW - Start reading just after the most recent record in the stream, and start at the request timestamp that the customer issued. TRIM_HORIZON - Start reading at the last untrimmed record in the stream, which is the oldest record available in the stream. This option is not available for an Amazon Kinesis Data Firehose delivery stream. LAST_STOPPED_POINT - Resume reading from where the application last stopped reading.
1253 */
1254 InputStartingPosition?: InputStartingPosition;
1255 }
1256 export interface InputUpdate {
1257 /**
1258 * The input ID of the application input to be updated.
1259 */
1260 InputId: Id;
1261 /**
1262 * The name prefix for in-application streams that Kinesis Data Analytics creates for the specific streaming source.
1263 */
1264 NamePrefixUpdate?: InAppStreamName;
1265 /**
1266 * Describes updates to an InputProcessingConfiguration.
1267 */
1268 InputProcessingConfigurationUpdate?: InputProcessingConfigurationUpdate;
1269 /**
1270 * If a Kinesis data stream is the streaming source to be updated, provides an updated stream Amazon Resource Name (ARN).
1271 */
1272 KinesisStreamsInputUpdate?: KinesisStreamsInputUpdate;
1273 /**
1274 * If a Kinesis Data Firehose delivery stream is the streaming source to be updated, provides an updated stream ARN.
1275 */
1276 KinesisFirehoseInputUpdate?: KinesisFirehoseInputUpdate;
1277 /**
1278 * Describes the data format on the streaming source, and how record elements on the streaming source map to columns of the in-application stream that is created.
1279 */
1280 InputSchemaUpdate?: InputSchemaUpdate;
1281 /**
1282 * Describes the parallelism updates (the number of in-application streams Kinesis Data Analytics creates for the specific streaming source).
1283 */
1284 InputParallelismUpdate?: InputParallelismUpdate;
1285 }
1286 export type InputUpdates = InputUpdate[];
1287 export type Inputs = Input[];
1288 export interface JSONMappingParameters {
1289 /**
1290 * The path to the top-level parent that contains the records.
1291 */
1292 RecordRowPath: RecordRowPath;
1293 }
1294 export type JobPlanDescription = string;
1295 export type KinesisAnalyticsARN = string;
1296 export interface KinesisFirehoseInput {
1297 /**
1298 * The Amazon Resource Name (ARN) of the delivery stream.
1299 */
1300 ResourceARN: ResourceARN;
1301 }
1302 export interface KinesisFirehoseInputDescription {
1303 /**
1304 * The Amazon Resource Name (ARN) of the delivery stream.
1305 */
1306 ResourceARN: ResourceARN;
1307 /**
1308 * The ARN of the IAM role that Kinesis Data Analytics assumes to access the stream. Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
1309 */
1310 RoleARN?: RoleARN;
1311 }
1312 export interface KinesisFirehoseInputUpdate {
1313 /**
1314 * The Amazon Resource Name (ARN) of the input delivery stream to read.
1315 */
1316 ResourceARNUpdate: ResourceARN;
1317 }
1318 export interface KinesisFirehoseOutput {
1319 /**
1320 * The ARN of the destination delivery stream to write to.
1321 */
1322 ResourceARN: ResourceARN;
1323 }
1324 export interface KinesisFirehoseOutputDescription {
1325 /**
1326 * The Amazon Resource Name (ARN) of the delivery stream.
1327 */
1328 ResourceARN: ResourceARN;
1329 /**
1330 * The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream. Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
1331 */
1332 RoleARN?: RoleARN;
1333 }
1334 export interface KinesisFirehoseOutputUpdate {
1335 /**
1336 * The Amazon Resource Name (ARN) of the delivery stream to write to.
1337 */
1338 ResourceARNUpdate: ResourceARN;
1339 }
1340 export interface KinesisStreamsInput {
1341 /**
1342 * The ARN of the input Kinesis data stream to read.
1343 */
1344 ResourceARN: ResourceARN;
1345 }
1346 export interface KinesisStreamsInputDescription {
1347 /**
1348 * The Amazon Resource Name (ARN) of the Kinesis data stream.
1349 */
1350 ResourceARN: ResourceARN;
1351 /**
1352 * The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream. Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
1353 */
1354 RoleARN?: RoleARN;
1355 }
1356 export interface KinesisStreamsInputUpdate {
1357 /**
1358 * The Amazon Resource Name (ARN) of the input Kinesis data stream to read.
1359 */
1360 ResourceARNUpdate: ResourceARN;
1361 }
1362 export interface KinesisStreamsOutput {
1363 /**
1364 * The ARN of the destination Kinesis data stream to write to.
1365 */
1366 ResourceARN: ResourceARN;
1367 }
1368 export interface KinesisStreamsOutputDescription {
1369 /**
1370 * The Amazon Resource Name (ARN) of the Kinesis data stream.
1371 */
1372 ResourceARN: ResourceARN;
1373 /**
1374 * The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream. Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
1375 */
1376 RoleARN?: RoleARN;
1377 }
1378 export interface KinesisStreamsOutputUpdate {
1379 /**
1380 * The Amazon Resource Name (ARN) of the Kinesis data stream where you want to write the output.
1381 */
1382 ResourceARNUpdate: ResourceARN;
1383 }
1384 export interface LambdaOutput {
1385 /**
1386 * The Amazon Resource Name (ARN) of the destination Lambda function to write to. To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda
1387 */
1388 ResourceARN: ResourceARN;
1389 }
1390 export interface LambdaOutputDescription {
1391 /**
1392 * The Amazon Resource Name (ARN) of the destination Lambda function.
1393 */
1394 ResourceARN: ResourceARN;
1395 /**
1396 * The ARN of the IAM role that Kinesis Data Analytics can assume to write to the destination function. Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
1397 */
1398 RoleARN?: RoleARN;
1399 }
1400 export interface LambdaOutputUpdate {
1401 /**
1402 * The Amazon Resource Name (ARN) of the destination AWS Lambda function. To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda
1403 */
1404 ResourceARNUpdate: ResourceARN;
1405 }
1406 export interface ListApplicationSnapshotsRequest {
1407 /**
1408 * The name of an existing application.
1409 */
1410 ApplicationName: ApplicationName;
1411 /**
1412 * The maximum number of application snapshots to list.
1413 */
1414 Limit?: ListSnapshotsInputLimit;
1415 /**
1416 * Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.
1417 */
1418 NextToken?: NextToken;
1419 }
1420 export interface ListApplicationSnapshotsResponse {
1421 /**
1422 * A collection of objects containing information about the application snapshots.
1423 */
1424 SnapshotSummaries?: SnapshotSummaries;
1425 /**
1426 * The token for the next set of results, or null if there are no additional results.
1427 */
1428 NextToken?: NextToken;
1429 }
1430 export type ListApplicationsInputLimit = number;
1431 export interface ListApplicationsRequest {
1432 /**
1433 * The maximum number of applications to list.
1434 */
1435 Limit?: ListApplicationsInputLimit;
1436 /**
1437 * If a previous command returned a pagination token, pass it into this value to retrieve the next set of results. For more information about pagination, see Using the AWS Command Line Interface's Pagination Options.
1438 */
1439 NextToken?: ApplicationName;
1440 }
1441 export interface ListApplicationsResponse {
1442 /**
1443 * A list of ApplicationSummary objects.
1444 */
1445 ApplicationSummaries: ApplicationSummaries;
1446 /**
1447 * The pagination token for the next set of results, or null if there are no additional results. Pass this token into a subsequent command to retrieve the next set of items For more information about pagination, see Using the AWS Command Line Interface's Pagination Options.
1448 */
1449 NextToken?: ApplicationName;
1450 }
1451 export type ListSnapshotsInputLimit = number;
1452 export interface ListTagsForResourceRequest {
1453 /**
1454 * The ARN of the application for which to retrieve tags.
1455 */
1456 ResourceARN: KinesisAnalyticsARN;
1457 }
1458 export interface ListTagsForResourceResponse {
1459 /**
1460 * The key-value tags assigned to the application.
1461 */
1462 Tags?: Tags;
1463 }
1464 export type LogLevel = "INFO"|"WARN"|"ERROR"|"DEBUG"|string;
1465 export type LogStreamARN = string;
1466 export interface MappingParameters {
1467 /**
1468 * Provides additional mapping information when JSON is the record format on the streaming source.
1469 */
1470 JSONMappingParameters?: JSONMappingParameters;
1471 /**
1472 * Provides additional mapping information when the record format uses delimiters (for example, CSV).
1473 */
1474 CSVMappingParameters?: CSVMappingParameters;
1475 }
1476 export type MetricsLevel = "APPLICATION"|"TASK"|"OPERATOR"|"PARALLELISM"|string;
1477 export type MinPauseBetweenCheckpoints = number;
1478 export interface MonitoringConfiguration {
1479 /**
1480 * Describes whether to use the default CloudWatch logging configuration for an application. You must set this property to CUSTOM in order to set the LogLevel or MetricsLevel parameters.
1481 */
1482 ConfigurationType: ConfigurationType;
1483 /**
1484 * Describes the granularity of the CloudWatch Logs for an application.
1485 */
1486 MetricsLevel?: MetricsLevel;
1487 /**
1488 * Describes the verbosity of the CloudWatch Logs for an application.
1489 */
1490 LogLevel?: LogLevel;
1491 }
1492 export interface MonitoringConfigurationDescription {
1493 /**
1494 * Describes whether to use the default CloudWatch logging configuration for an application.
1495 */
1496 ConfigurationType?: ConfigurationType;
1497 /**
1498 * Describes the granularity of the CloudWatch Logs for an application.
1499 */
1500 MetricsLevel?: MetricsLevel;
1501 /**
1502 * Describes the verbosity of the CloudWatch Logs for an application.
1503 */
1504 LogLevel?: LogLevel;
1505 }
1506 export interface MonitoringConfigurationUpdate {
1507 /**
1508 * Describes updates to whether to use the default CloudWatch logging configuration for an application. You must set this property to CUSTOM in order to set the LogLevel or MetricsLevel parameters.
1509 */
1510 ConfigurationTypeUpdate?: ConfigurationType;
1511 /**
1512 * Describes updates to the granularity of the CloudWatch Logs for an application.
1513 */
1514 MetricsLevelUpdate?: MetricsLevel;
1515 /**
1516 * Describes updates to the verbosity of the CloudWatch Logs for an application.
1517 */
1518 LogLevelUpdate?: LogLevel;
1519 }
1520 export type NextToken = string;
1521 export type ObjectVersion = string;
1522 export interface Output {
1523 /**
1524 * The name of the in-application stream.
1525 */
1526 Name: InAppStreamName;
1527 /**
1528 * Identifies an Amazon Kinesis data stream as the destination.
1529 */
1530 KinesisStreamsOutput?: KinesisStreamsOutput;
1531 /**
1532 * Identifies an Amazon Kinesis Data Firehose delivery stream as the destination.
1533 */
1534 KinesisFirehoseOutput?: KinesisFirehoseOutput;
1535 /**
1536 * Identifies an AWS Lambda function as the destination.
1537 */
1538 LambdaOutput?: LambdaOutput;
1539 /**
1540 * Describes the data format when records are written to the destination.
1541 */
1542 DestinationSchema: DestinationSchema;
1543 }
1544 export interface OutputDescription {
1545 /**
1546 * A unique identifier for the output configuration.
1547 */
1548 OutputId?: Id;
1549 /**
1550 * The name of the in-application stream that is configured as output.
1551 */
1552 Name?: InAppStreamName;
1553 /**
1554 * Describes the Kinesis data stream that is configured as the destination where output is written.
1555 */
1556 KinesisStreamsOutputDescription?: KinesisStreamsOutputDescription;
1557 /**
1558 * Describes the Kinesis Data Firehose delivery stream that is configured as the destination where output is written.
1559 */
1560 KinesisFirehoseOutputDescription?: KinesisFirehoseOutputDescription;
1561 /**
1562 * Describes the Lambda function that is configured as the destination where output is written.
1563 */
1564 LambdaOutputDescription?: LambdaOutputDescription;
1565 /**
1566 * The data format used for writing data to the destination.
1567 */
1568 DestinationSchema?: DestinationSchema;
1569 }
1570 export type OutputDescriptions = OutputDescription[];
1571 export interface OutputUpdate {
1572 /**
1573 * Identifies the specific output configuration that you want to update.
1574 */
1575 OutputId: Id;
1576 /**
1577 * If you want to specify a different in-application stream for this output configuration, use this field to specify the new in-application stream name.
1578 */
1579 NameUpdate?: InAppStreamName;
1580 /**
1581 * Describes a Kinesis data stream as the destination for the output.
1582 */
1583 KinesisStreamsOutputUpdate?: KinesisStreamsOutputUpdate;
1584 /**
1585 * Describes a Kinesis Data Firehose delivery stream as the destination for the output.
1586 */
1587 KinesisFirehoseOutputUpdate?: KinesisFirehoseOutputUpdate;
1588 /**
1589 * Describes an AWS Lambda function as the destination for the output.
1590 */
1591 LambdaOutputUpdate?: LambdaOutputUpdate;
1592 /**
1593 * Describes the data format when records are written to the destination.
1594 */
1595 DestinationSchemaUpdate?: DestinationSchema;
1596 }
1597 export type OutputUpdates = OutputUpdate[];
1598 export type Outputs = Output[];
1599 export type Parallelism = number;
1600 export interface ParallelismConfiguration {
1601 /**
1602 * Describes whether the application uses the default parallelism for the Kinesis Data Analytics service. You must set this property to CUSTOM in order to change your application's AutoScalingEnabled, Parallelism, or ParallelismPerKPU properties.
1603 */
1604 ConfigurationType: ConfigurationType;
1605 /**
1606 * Describes the initial number of parallel tasks that a Java-based Kinesis Data Analytics application can perform. If AutoScalingEnabled is set to True, Kinesis Data Analytics increases the CurrentParallelism value in response to application load. The service can increase the CurrentParallelism value up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism value down to the Parallelism setting.
1607 */
1608 Parallelism?: Parallelism;
1609 /**
1610 * Describes the number of parallel tasks that a Java-based Kinesis Data Analytics application can perform per Kinesis Processing Unit (KPU) used by the application. For more information about KPUs, see Amazon Kinesis Data Analytics Pricing.
1611 */
1612 ParallelismPerKPU?: ParallelismPerKPU;
1613 /**
1614 * Describes whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput.
1615 */
1616 AutoScalingEnabled?: BooleanObject;
1617 }
1618 export interface ParallelismConfigurationDescription {
1619 /**
1620 * Describes whether the application uses the default parallelism for the Kinesis Data Analytics service.
1621 */
1622 ConfigurationType?: ConfigurationType;
1623 /**
1624 * Describes the initial number of parallel tasks that a Java-based Kinesis Data Analytics application can perform. If AutoScalingEnabled is set to True, then Kinesis Data Analytics can increase the CurrentParallelism value in response to application load. The service can increase CurrentParallelism up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism value down to the Parallelism setting.
1625 */
1626 Parallelism?: Parallelism;
1627 /**
1628 * Describes the number of parallel tasks that a Java-based Kinesis Data Analytics application can perform per Kinesis Processing Unit (KPU) used by the application.
1629 */
1630 ParallelismPerKPU?: ParallelismPerKPU;
1631 /**
1632 * Describes the current number of parallel tasks that a Java-based Kinesis Data Analytics application can perform. If AutoScalingEnabled is set to True, Kinesis Data Analytics can increase this value in response to application load. The service can increase this value up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism value down to the Parallelism setting.
1633 */
1634 CurrentParallelism?: Parallelism;
1635 /**
1636 * Describes whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput.
1637 */
1638 AutoScalingEnabled?: BooleanObject;
1639 }
1640 export interface ParallelismConfigurationUpdate {
1641 /**
1642 * Describes updates to whether the application uses the default parallelism for the Kinesis Data Analytics service, or if a custom parallelism is used. You must set this property to CUSTOM in order to change your application's AutoScalingEnabled, Parallelism, or ParallelismPerKPU properties.
1643 */
1644 ConfigurationTypeUpdate?: ConfigurationType;
1645 /**
1646 * Describes updates to the initial number of parallel tasks an application can perform. If AutoScalingEnabled is set to True, then Kinesis Data Analytics can increase the CurrentParallelism value in response to application load. The service can increase CurrentParallelism up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service will reduce CurrentParallelism down to the Parallelism setting.
1647 */
1648 ParallelismUpdate?: Parallelism;
1649 /**
1650 * Describes updates to the number of parallel tasks an application can perform per Kinesis Processing Unit (KPU) used by the application.
1651 */
1652 ParallelismPerKPUUpdate?: ParallelismPerKPU;
1653 /**
1654 * Describes updates to whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput.
1655 */
1656 AutoScalingEnabledUpdate?: BooleanObject;
1657 }
1658 export type ParallelismPerKPU = number;
1659 export type ParsedInputRecord = ParsedInputRecordField[];
1660 export type ParsedInputRecordField = string;
1661 export type ParsedInputRecords = ParsedInputRecord[];
1662 export type ProcessedInputRecord = string;
1663 export type ProcessedInputRecords = ProcessedInputRecord[];
1664 export interface PropertyGroup {
1665 /**
1666 * Describes the key of an application execution property key-value pair.
1667 */
1668 PropertyGroupId: Id;
1669 /**
1670 * Describes the value of an application execution property key-value pair.
1671 */
1672 PropertyMap: PropertyMap;
1673 }
1674 export type PropertyGroups = PropertyGroup[];
1675 export type PropertyKey = string;
1676 export type PropertyMap = {[key: string]: PropertyValue};
1677 export type PropertyValue = string;
1678 export type RawInputRecord = string;
1679 export type RawInputRecords = RawInputRecord[];
1680 export interface RecordColumn {
1681 /**
1682 * The name of the column that is created in the in-application input stream or reference table.
1683 */
1684 Name: RecordColumnName;
1685 /**
1686 * A reference to the data element in the streaming input or the reference data source.
1687 */
1688 Mapping?: RecordColumnMapping;
1689 /**
1690 * The type of column created in the in-application input stream or reference table.
1691 */
1692 SqlType: RecordColumnSqlType;
1693 }
1694 export type RecordColumnDelimiter = string;
1695 export type RecordColumnMapping = string;
1696 export type RecordColumnName = string;
1697 export type RecordColumnSqlType = string;
1698 export type RecordColumns = RecordColumn[];
1699 export type RecordEncoding = string;
1700 export interface RecordFormat {
1701 /**
1702 * The type of record format.
1703 */
1704 RecordFormatType: RecordFormatType;
1705 /**
1706 * When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.
1707 */
1708 MappingParameters?: MappingParameters;
1709 }
1710 export type RecordFormatType = "JSON"|"CSV"|string;
1711 export type RecordRowDelimiter = string;
1712 export type RecordRowPath = string;
1713 export interface ReferenceDataSource {
1714 /**
1715 * The name of the in-application table to create.
1716 */
1717 TableName: InAppTableName;
1718 /**
1719 * Identifies the S3 bucket and object that contains the reference data. A Kinesis Data Analytics application loads reference data only once. If the data changes, you call the UpdateApplication operation to trigger reloading of data into your application.
1720 */
1721 S3ReferenceDataSource?: S3ReferenceDataSource;
1722 /**
1723 * Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.
1724 */
1725 ReferenceSchema: SourceSchema;
1726 }
1727 export interface ReferenceDataSourceDescription {
1728 /**
1729 * The ID of the reference data source. This is the ID that Kinesis Data Analytics assigns when you add the reference data source to your application using the CreateApplication or UpdateApplication operation.
1730 */
1731 ReferenceId: Id;
1732 /**
1733 * The in-application table name created by the specific reference data source configuration.
1734 */
1735 TableName: InAppTableName;
1736 /**
1737 * Provides the Amazon S3 bucket name, the object key name that contains the reference data.
1738 */
1739 S3ReferenceDataSourceDescription: S3ReferenceDataSourceDescription;
1740 /**
1741 * Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.
1742 */
1743 ReferenceSchema?: SourceSchema;
1744 }
1745 export type ReferenceDataSourceDescriptions = ReferenceDataSourceDescription[];
1746 export interface ReferenceDataSourceUpdate {
1747 /**
1748 * The ID of the reference data source that is being updated. You can use the DescribeApplication operation to get this value.
1749 */
1750 ReferenceId: Id;
1751 /**
1752 * The in-application table name that is created by this update.
1753 */
1754 TableNameUpdate?: InAppTableName;
1755 /**
1756 * Describes the S3 bucket name, object key name, and IAM role that Kinesis Data Analytics can assume to read the Amazon S3 object on your behalf and populate the in-application reference table.
1757 */
1758 S3ReferenceDataSourceUpdate?: S3ReferenceDataSourceUpdate;
1759 /**
1760 * Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.
1761 */
1762 ReferenceSchemaUpdate?: SourceSchema;
1763 }
1764 export type ReferenceDataSourceUpdates = ReferenceDataSourceUpdate[];
1765 export type ReferenceDataSources = ReferenceDataSource[];
1766 export type ResourceARN = string;
1767 export type RoleARN = string;
1768 export interface RunConfiguration {
1769 /**
1770 * Describes the starting parameters for an Apache Flink-based Kinesis Data Analytics application.
1771 */
1772 FlinkRunConfiguration?: FlinkRunConfiguration;
1773 /**
1774 * Describes the starting parameters for an SQL-based Kinesis Data Analytics application.
1775 */
1776 SqlRunConfigurations?: SqlRunConfigurations;
1777 /**
1778 * Describes the restore behavior of a restarting application.
1779 */
1780 ApplicationRestoreConfiguration?: ApplicationRestoreConfiguration;
1781 }
1782 export interface RunConfigurationDescription {
1783 /**
1784 * Describes the restore behavior of a restarting application.
1785 */
1786 ApplicationRestoreConfigurationDescription?: ApplicationRestoreConfiguration;
1787 }
1788 export interface RunConfigurationUpdate {
1789 /**
1790 * Describes the starting parameters for an Apache Flink-based Kinesis Data Analytics application.
1791 */
1792 FlinkRunConfiguration?: FlinkRunConfiguration;
1793 /**
1794 * Describes updates to the restore behavior of a restarting application.
1795 */
1796 ApplicationRestoreConfiguration?: ApplicationRestoreConfiguration;
1797 }
1798 export type RuntimeEnvironment = "SQL-1_0"|"FLINK-1_6"|"FLINK-1_8"|string;
1799 export interface S3ApplicationCodeLocationDescription {
1800 /**
1801 * The Amazon Resource Name (ARN) for the S3 bucket containing the application code.
1802 */
1803 BucketARN: BucketARN;
1804 /**
1805 * The file key for the object containing the application code.
1806 */
1807 FileKey: FileKey;
1808 /**
1809 * The version of the object containing the application code.
1810 */
1811 ObjectVersion?: ObjectVersion;
1812 }
1813 export interface S3Configuration {
1814 /**
1815 * The ARN of the S3 bucket that contains the data.
1816 */
1817 BucketARN: BucketARN;
1818 /**
1819 * The name of the object that contains the data.
1820 */
1821 FileKey: FileKey;
1822 }
1823 export interface S3ContentLocation {
1824 /**
1825 * The Amazon Resource Name (ARN) for the S3 bucket containing the application code.
1826 */
1827 BucketARN: BucketARN;
1828 /**
1829 * The file key for the object containing the application code.
1830 */
1831 FileKey: FileKey;
1832 /**
1833 * The version of the object containing the application code.
1834 */
1835 ObjectVersion?: ObjectVersion;
1836 }
1837 export interface S3ContentLocationUpdate {
1838 /**
1839 * The new Amazon Resource Name (ARN) for the S3 bucket containing the application code.
1840 */
1841 BucketARNUpdate?: BucketARN;
1842 /**
1843 * The new file key for the object containing the application code.
1844 */
1845 FileKeyUpdate?: FileKey;
1846 /**
1847 * The new version of the object containing the application code.
1848 */
1849 ObjectVersionUpdate?: ObjectVersion;
1850 }
1851 export interface S3ReferenceDataSource {
1852 /**
1853 * The Amazon Resource Name (ARN) of the S3 bucket.
1854 */
1855 BucketARN?: BucketARN;
1856 /**
1857 * The object key name containing the reference data.
1858 */
1859 FileKey?: FileKey;
1860 }
1861 export interface S3ReferenceDataSourceDescription {
1862 /**
1863 * The Amazon Resource Name (ARN) of the S3 bucket.
1864 */
1865 BucketARN: BucketARN;
1866 /**
1867 * Amazon S3 object key name.
1868 */
1869 FileKey: FileKey;
1870 /**
1871 * The ARN of the IAM role that Kinesis Data Analytics can assume to read the Amazon S3 object on your behalf to populate the in-application reference table. Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
1872 */
1873 ReferenceRoleARN?: RoleARN;
1874 }
1875 export interface S3ReferenceDataSourceUpdate {
1876 /**
1877 * The Amazon Resource Name (ARN) of the S3 bucket.
1878 */
1879 BucketARNUpdate?: BucketARN;
1880 /**
1881 * The object key name.
1882 */
1883 FileKeyUpdate?: FileKey;
1884 }
1885 export type SecurityGroupId = string;
1886 export type SecurityGroupIds = SecurityGroupId[];
1887 export interface SnapshotDetails {
1888 /**
1889 * The identifier for the application snapshot.
1890 */
1891 SnapshotName: SnapshotName;
1892 /**
1893 * The status of the application snapshot.
1894 */
1895 SnapshotStatus: SnapshotStatus;
1896 /**
1897 * The current application version ID when the snapshot was created.
1898 */
1899 ApplicationVersionId: ApplicationVersionId;
1900 /**
1901 * The timestamp of the application snapshot.
1902 */
1903 SnapshotCreationTimestamp?: Timestamp;
1904 }
1905 export type SnapshotName = string;
1906 export type SnapshotStatus = "CREATING"|"READY"|"DELETING"|"FAILED"|string;
1907 export type SnapshotSummaries = SnapshotDetails[];
1908 export interface SourceSchema {
1909 /**
1910 * Specifies the format of the records on the streaming source.
1911 */
1912 RecordFormat: RecordFormat;
1913 /**
1914 * Specifies the encoding of the records in the streaming source. For example, UTF-8.
1915 */
1916 RecordEncoding?: RecordEncoding;
1917 /**
1918 * A list of RecordColumn objects.
1919 */
1920 RecordColumns: RecordColumns;
1921 }
1922 export interface SqlApplicationConfiguration {
1923 /**
1924 * The array of Input objects describing the input streams used by the application.
1925 */
1926 Inputs?: Inputs;
1927 /**
1928 * The array of Output objects describing the destination streams used by the application.
1929 */
1930 Outputs?: Outputs;
1931 /**
1932 * The array of ReferenceDataSource objects describing the reference data sources used by the application.
1933 */
1934 ReferenceDataSources?: ReferenceDataSources;
1935 }
1936 export interface SqlApplicationConfigurationDescription {
1937 /**
1938 * The array of InputDescription objects describing the input streams used by the application.
1939 */
1940 InputDescriptions?: InputDescriptions;
1941 /**
1942 * The array of OutputDescription objects describing the destination streams used by the application.
1943 */
1944 OutputDescriptions?: OutputDescriptions;
1945 /**
1946 * The array of ReferenceDataSourceDescription objects describing the reference data sources used by the application.
1947 */
1948 ReferenceDataSourceDescriptions?: ReferenceDataSourceDescriptions;
1949 }
1950 export interface SqlApplicationConfigurationUpdate {
1951 /**
1952 * The array of InputUpdate objects describing the new input streams used by the application.
1953 */
1954 InputUpdates?: InputUpdates;
1955 /**
1956 * The array of OutputUpdate objects describing the new destination streams used by the application.
1957 */
1958 OutputUpdates?: OutputUpdates;
1959 /**
1960 * The array of ReferenceDataSourceUpdate objects describing the new reference data sources used by the application.
1961 */
1962 ReferenceDataSourceUpdates?: ReferenceDataSourceUpdates;
1963 }
1964 export interface SqlRunConfiguration {
1965 /**
1966 * The input source ID. You can get this ID by calling the DescribeApplication operation.
1967 */
1968 InputId: Id;
1969 /**
1970 * The point at which you want the application to start processing records from the streaming source.
1971 */
1972 InputStartingPositionConfiguration: InputStartingPositionConfiguration;
1973 }
1974 export type SqlRunConfigurations = SqlRunConfiguration[];
1975 export interface StartApplicationRequest {
1976 /**
1977 * The name of the application.
1978 */
1979 ApplicationName: ApplicationName;
1980 /**
1981 * Identifies the run configuration (start parameters) of a Kinesis Data Analytics application.
1982 */
1983 RunConfiguration: RunConfiguration;
1984 }
1985 export interface StartApplicationResponse {
1986 }
1987 export interface StopApplicationRequest {
1988 /**
1989 * The name of the running application to stop.
1990 */
1991 ApplicationName: ApplicationName;
1992 }
1993 export interface StopApplicationResponse {
1994 }
1995 export type SubnetId = string;
1996 export type SubnetIds = SubnetId[];
1997 export interface Tag {
1998 /**
1999 * The key of the key-value tag.
2000 */
2001 Key: TagKey;
2002 /**
2003 * The value of the key-value tag. The value is optional.
2004 */
2005 Value?: TagValue;
2006 }
2007 export type TagKey = string;
2008 export type TagKeys = TagKey[];
2009 export interface TagResourceRequest {
2010 /**
2011 * The ARN of the application to assign the tags.
2012 */
2013 ResourceARN: KinesisAnalyticsARN;
2014 /**
2015 * The key-value tags to assign to the application.
2016 */
2017 Tags: Tags;
2018 }
2019 export interface TagResourceResponse {
2020 }
2021 export type TagValue = string;
2022 export type Tags = Tag[];
2023 export type TextContent = string;
2024 export type Timestamp = Date;
2025 export interface UntagResourceRequest {
2026 /**
2027 * The ARN of the Kinesis Analytics application from which to remove the tags.
2028 */
2029 ResourceARN: KinesisAnalyticsARN;
2030 /**
2031 * A list of keys of tags to remove from the specified application.
2032 */
2033 TagKeys: TagKeys;
2034 }
2035 export interface UntagResourceResponse {
2036 }
2037 export interface UpdateApplicationRequest {
2038 /**
2039 * The name of the application to update.
2040 */
2041 ApplicationName: ApplicationName;
2042 /**
2043 * The current application version ID. You can retrieve the application version ID using DescribeApplication.
2044 */
2045 CurrentApplicationVersionId: ApplicationVersionId;
2046 /**
2047 * Describes application configuration updates.
2048 */
2049 ApplicationConfigurationUpdate?: ApplicationConfigurationUpdate;
2050 /**
2051 * Describes updates to the service execution role.
2052 */
2053 ServiceExecutionRoleUpdate?: RoleARN;
2054 /**
2055 * Describes updates to the application's starting parameters.
2056 */
2057 RunConfigurationUpdate?: RunConfigurationUpdate;
2058 /**
2059 * Describes application Amazon CloudWatch logging option updates. You can only update existing CloudWatch logging options with this action. To add a new CloudWatch logging option, use AddApplicationCloudWatchLoggingOption.
2060 */
2061 CloudWatchLoggingOptionUpdates?: CloudWatchLoggingOptionUpdates;
2062 }
2063 export interface UpdateApplicationResponse {
2064 /**
2065 * Describes application updates.
2066 */
2067 ApplicationDetail: ApplicationDetail;
2068 }
2069 export interface VpcConfiguration {
2070 /**
2071 * The array of Subnet IDs used by the VPC configuration.
2072 */
2073 SubnetIds: SubnetIds;
2074 /**
2075 * The array of SecurityGroup IDs used by the VPC configuration.
2076 */
2077 SecurityGroupIds: SecurityGroupIds;
2078 }
2079 export interface VpcConfigurationDescription {
2080 /**
2081 * The ID of the VPC configuration.
2082 */
2083 VpcConfigurationId: Id;
2084 /**
2085 * The ID of the associated VPC.
2086 */
2087 VpcId: VpcId;
2088 /**
2089 * The array of Subnet IDs used by the VPC configuration.
2090 */
2091 SubnetIds: SubnetIds;
2092 /**
2093 * The array of SecurityGroup IDs used by the VPC configuration.
2094 */
2095 SecurityGroupIds: SecurityGroupIds;
2096 }
2097 export type VpcConfigurationDescriptions = VpcConfigurationDescription[];
2098 export interface VpcConfigurationUpdate {
2099 /**
2100 * Describes an update to the ID of the VPC configuration.
2101 */
2102 VpcConfigurationId: Id;
2103 /**
2104 * Describes updates to the array of Subnet IDs used by the VPC configuration.
2105 */
2106 SubnetIdUpdates?: SubnetIds;
2107 /**
2108 * Describes updates to the array of SecurityGroup IDs used by the VPC configuration.
2109 */
2110 SecurityGroupIdUpdates?: SecurityGroupIds;
2111 }
2112 export type VpcConfigurationUpdates = VpcConfigurationUpdate[];
2113 export type VpcConfigurations = VpcConfiguration[];
2114 export type VpcId = string;
2115 export type ZipFileContent = Buffer|Uint8Array|Blob|string;
2116 /**
2117 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
2118 */
2119 export type apiVersion = "2018-05-23"|"latest"|string;
2120 export interface ClientApiVersions {
2121 /**
2122 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
2123 */
2124 apiVersion?: apiVersion;
2125 }
2126 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
2127 /**
2128 * Contains interfaces for use with the KinesisAnalyticsV2 client.
2129 */
2130 export import Types = KinesisAnalyticsV2;
2131}
2132export = KinesisAnalyticsV2;