UNPKG

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