UNPKG

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