@aws-sdk/client-kinesis-analytics-v2 3.378.0 → 3.382.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -7,6 +7,7 @@ import { KinesisAnalyticsV2ServiceException as __BaseException } from "./Kinesis
|
|
|
7
7
|
*/
|
|
8
8
|
export interface CloudWatchLoggingOption {
|
|
9
9
|
/**
|
|
10
|
+
* @public
|
|
10
11
|
* <p>The ARN of the CloudWatch log to receive application messages.</p>
|
|
11
12
|
*/
|
|
12
13
|
LogStreamARN: string | undefined;
|
|
@@ -16,10 +17,12 @@ export interface CloudWatchLoggingOption {
|
|
|
16
17
|
*/
|
|
17
18
|
export interface AddApplicationCloudWatchLoggingOptionRequest {
|
|
18
19
|
/**
|
|
20
|
+
* @public
|
|
19
21
|
* <p>The Kinesis Data Analytics application name.</p>
|
|
20
22
|
*/
|
|
21
23
|
ApplicationName: string | undefined;
|
|
22
24
|
/**
|
|
25
|
+
* @public
|
|
23
26
|
* <p>The version ID of the Kinesis Data Analytics application. You must provide the
|
|
24
27
|
* <code>CurrentApplicationVersionId</code> or the <code>ConditionalToken</code>.You can
|
|
25
28
|
* retrieve the application version ID using <a>DescribeApplication</a>. For better
|
|
@@ -28,10 +31,12 @@ export interface AddApplicationCloudWatchLoggingOptionRequest {
|
|
|
28
31
|
*/
|
|
29
32
|
CurrentApplicationVersionId?: number;
|
|
30
33
|
/**
|
|
34
|
+
* @public
|
|
31
35
|
* <p>Provides the Amazon CloudWatch log stream Amazon Resource Name (ARN). </p>
|
|
32
36
|
*/
|
|
33
37
|
CloudWatchLoggingOption: CloudWatchLoggingOption | undefined;
|
|
34
38
|
/**
|
|
39
|
+
* @public
|
|
35
40
|
* <p>A value you use to implement strong concurrency for application updates. You must
|
|
36
41
|
* provide the <code>CurrentApplicationVersionId</code> or the <code>ConditionalToken</code>. You
|
|
37
42
|
* get the application's current <code>ConditionalToken</code> using <a>DescribeApplication</a>. For better concurrency support, use the
|
|
@@ -46,15 +51,18 @@ export interface AddApplicationCloudWatchLoggingOptionRequest {
|
|
|
46
51
|
*/
|
|
47
52
|
export interface CloudWatchLoggingOptionDescription {
|
|
48
53
|
/**
|
|
54
|
+
* @public
|
|
49
55
|
* <p>The ID of the CloudWatch logging option description.</p>
|
|
50
56
|
*/
|
|
51
57
|
CloudWatchLoggingOptionId?: string;
|
|
52
58
|
/**
|
|
59
|
+
* @public
|
|
53
60
|
* <p>The Amazon Resource Name (ARN) of the CloudWatch log to receive application
|
|
54
61
|
* messages.</p>
|
|
55
62
|
*/
|
|
56
63
|
LogStreamARN: string | undefined;
|
|
57
64
|
/**
|
|
65
|
+
* @public
|
|
58
66
|
* <p>The IAM ARN of the role to use to send application messages. </p>
|
|
59
67
|
* <note>
|
|
60
68
|
* <p>Provided for backward compatibility. Applications created with the current API version have an
|
|
@@ -68,16 +76,19 @@ export interface CloudWatchLoggingOptionDescription {
|
|
|
68
76
|
*/
|
|
69
77
|
export interface AddApplicationCloudWatchLoggingOptionResponse {
|
|
70
78
|
/**
|
|
79
|
+
* @public
|
|
71
80
|
* <p>The application's ARN.</p>
|
|
72
81
|
*/
|
|
73
82
|
ApplicationARN?: string;
|
|
74
83
|
/**
|
|
84
|
+
* @public
|
|
75
85
|
* <p>The new version ID of the Kinesis Data Analytics application. Kinesis Data Analytics
|
|
76
86
|
* updates the <code>ApplicationVersionId</code> each time you change the CloudWatch logging
|
|
77
87
|
* options. </p>
|
|
78
88
|
*/
|
|
79
89
|
ApplicationVersionId?: number;
|
|
80
90
|
/**
|
|
91
|
+
* @public
|
|
81
92
|
* <p>The descriptions of the current CloudWatch logging options for the Kinesis Data Analytics application.</p>
|
|
82
93
|
*/
|
|
83
94
|
CloudWatchLoggingOptionDescriptions?: CloudWatchLoggingOptionDescription[];
|
|
@@ -169,6 +180,7 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
169
180
|
*/
|
|
170
181
|
export interface InputParallelism {
|
|
171
182
|
/**
|
|
183
|
+
* @public
|
|
172
184
|
* <p>The number of in-application streams to create.</p>
|
|
173
185
|
*/
|
|
174
186
|
Count?: number;
|
|
@@ -180,6 +192,7 @@ export interface InputParallelism {
|
|
|
180
192
|
*/
|
|
181
193
|
export interface InputLambdaProcessor {
|
|
182
194
|
/**
|
|
195
|
+
* @public
|
|
183
196
|
* <p>The ARN of the Amazon Lambda function that operates on records in the stream.</p>
|
|
184
197
|
* <note>
|
|
185
198
|
* <p>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 <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-lambda">Example ARNs: Amazon Lambda</a>
|
|
@@ -196,6 +209,7 @@ export interface InputLambdaProcessor {
|
|
|
196
209
|
*/
|
|
197
210
|
export interface InputProcessingConfiguration {
|
|
198
211
|
/**
|
|
212
|
+
* @public
|
|
199
213
|
* <p>The <a>InputLambdaProcessor</a> that is used to preprocess the records
|
|
200
214
|
* in the stream before being processed by your application code.</p>
|
|
201
215
|
*/
|
|
@@ -210,16 +224,19 @@ export interface InputProcessingConfiguration {
|
|
|
210
224
|
*/
|
|
211
225
|
export interface RecordColumn {
|
|
212
226
|
/**
|
|
227
|
+
* @public
|
|
213
228
|
* <p>The name of the column that is created in the in-application input stream or reference
|
|
214
229
|
* table.</p>
|
|
215
230
|
*/
|
|
216
231
|
Name: string | undefined;
|
|
217
232
|
/**
|
|
233
|
+
* @public
|
|
218
234
|
* <p>A reference to the data element in the streaming input or the reference data
|
|
219
235
|
* source.</p>
|
|
220
236
|
*/
|
|
221
237
|
Mapping?: string;
|
|
222
238
|
/**
|
|
239
|
+
* @public
|
|
223
240
|
* <p>The type of column created in the in-application input stream or reference table.</p>
|
|
224
241
|
*/
|
|
225
242
|
SqlType: string | undefined;
|
|
@@ -240,11 +257,13 @@ export interface RecordColumn {
|
|
|
240
257
|
*/
|
|
241
258
|
export interface CSVMappingParameters {
|
|
242
259
|
/**
|
|
260
|
+
* @public
|
|
243
261
|
* <p>The row delimiter. For example, in a CSV format, <i>'\n'</i> is the typical
|
|
244
262
|
* row delimiter.</p>
|
|
245
263
|
*/
|
|
246
264
|
RecordRowDelimiter: string | undefined;
|
|
247
265
|
/**
|
|
266
|
+
* @public
|
|
248
267
|
* <p>The column delimiter. For example, in a CSV format, a comma (",") is the typical column
|
|
249
268
|
* delimiter.</p>
|
|
250
269
|
*/
|
|
@@ -257,6 +276,7 @@ export interface CSVMappingParameters {
|
|
|
257
276
|
*/
|
|
258
277
|
export interface JSONMappingParameters {
|
|
259
278
|
/**
|
|
279
|
+
* @public
|
|
260
280
|
* <p>The path to the top-level parent that contains the records.</p>
|
|
261
281
|
*/
|
|
262
282
|
RecordRowPath: string | undefined;
|
|
@@ -270,10 +290,12 @@ export interface JSONMappingParameters {
|
|
|
270
290
|
*/
|
|
271
291
|
export interface MappingParameters {
|
|
272
292
|
/**
|
|
293
|
+
* @public
|
|
273
294
|
* <p>Provides additional mapping information when JSON is the record format on the streaming source.</p>
|
|
274
295
|
*/
|
|
275
296
|
JSONMappingParameters?: JSONMappingParameters;
|
|
276
297
|
/**
|
|
298
|
+
* @public
|
|
277
299
|
* <p>Provides additional mapping information when the record format uses delimiters
|
|
278
300
|
* (for example, CSV).</p>
|
|
279
301
|
*/
|
|
@@ -299,10 +321,12 @@ export type RecordFormatType = (typeof RecordFormatType)[keyof typeof RecordForm
|
|
|
299
321
|
*/
|
|
300
322
|
export interface RecordFormat {
|
|
301
323
|
/**
|
|
324
|
+
* @public
|
|
302
325
|
* <p>The type of record format.</p>
|
|
303
326
|
*/
|
|
304
327
|
RecordFormatType: RecordFormatType | string | undefined;
|
|
305
328
|
/**
|
|
329
|
+
* @public
|
|
306
330
|
* <p>When you configure application input at the time of creating or updating an application,
|
|
307
331
|
* provides additional mapping information specific to the record format (such as JSON, CSV, or
|
|
308
332
|
* record fields delimited by some delimiter) on the streaming source.</p>
|
|
@@ -317,14 +341,17 @@ export interface RecordFormat {
|
|
|
317
341
|
*/
|
|
318
342
|
export interface SourceSchema {
|
|
319
343
|
/**
|
|
344
|
+
* @public
|
|
320
345
|
* <p>Specifies the format of the records on the streaming source.</p>
|
|
321
346
|
*/
|
|
322
347
|
RecordFormat: RecordFormat | undefined;
|
|
323
348
|
/**
|
|
349
|
+
* @public
|
|
324
350
|
* <p>Specifies the encoding of the records in the streaming source. For example, UTF-8.</p>
|
|
325
351
|
*/
|
|
326
352
|
RecordEncoding?: string;
|
|
327
353
|
/**
|
|
354
|
+
* @public
|
|
328
355
|
* <p>A list of <code>RecordColumn</code> objects. </p>
|
|
329
356
|
*/
|
|
330
357
|
RecordColumns: RecordColumn[] | undefined;
|
|
@@ -337,6 +364,7 @@ export interface SourceSchema {
|
|
|
337
364
|
*/
|
|
338
365
|
export interface KinesisFirehoseInput {
|
|
339
366
|
/**
|
|
367
|
+
* @public
|
|
340
368
|
* <p>The Amazon Resource Name (ARN) of the delivery stream.</p>
|
|
341
369
|
*/
|
|
342
370
|
ResourceARN: string | undefined;
|
|
@@ -348,6 +376,7 @@ export interface KinesisFirehoseInput {
|
|
|
348
376
|
*/
|
|
349
377
|
export interface KinesisStreamsInput {
|
|
350
378
|
/**
|
|
379
|
+
* @public
|
|
351
380
|
* <p>The ARN of the input Kinesis data stream to read.</p>
|
|
352
381
|
*/
|
|
353
382
|
ResourceARN: string | undefined;
|
|
@@ -360,6 +389,7 @@ export interface KinesisStreamsInput {
|
|
|
360
389
|
*/
|
|
361
390
|
export interface Input {
|
|
362
391
|
/**
|
|
392
|
+
* @public
|
|
363
393
|
* <p>The name prefix to use when creating an in-application stream. Suppose that you specify a
|
|
364
394
|
* prefix "<code>MyInApplicationStream</code>." Kinesis Data Analytics then creates one or more
|
|
365
395
|
* (as per the <code>InputParallelism</code> count you specified) in-application streams with the
|
|
@@ -368,24 +398,29 @@ export interface Input {
|
|
|
368
398
|
*/
|
|
369
399
|
NamePrefix: string | undefined;
|
|
370
400
|
/**
|
|
401
|
+
* @public
|
|
371
402
|
* <p>The <a>InputProcessingConfiguration</a> for the input. An input processor transforms records as they are received
|
|
372
403
|
* from the stream, before the application's SQL code executes. Currently, the only input processing configuration available is
|
|
373
404
|
* <a>InputLambdaProcessor</a>. </p>
|
|
374
405
|
*/
|
|
375
406
|
InputProcessingConfiguration?: InputProcessingConfiguration;
|
|
376
407
|
/**
|
|
408
|
+
* @public
|
|
377
409
|
* <p>If the streaming source is an Amazon Kinesis data stream, identifies the stream's Amazon Resource Name (ARN). </p>
|
|
378
410
|
*/
|
|
379
411
|
KinesisStreamsInput?: KinesisStreamsInput;
|
|
380
412
|
/**
|
|
413
|
+
* @public
|
|
381
414
|
* <p>If the streaming source is an Amazon Kinesis Data Firehose delivery stream, identifies the delivery stream's ARN.</p>
|
|
382
415
|
*/
|
|
383
416
|
KinesisFirehoseInput?: KinesisFirehoseInput;
|
|
384
417
|
/**
|
|
418
|
+
* @public
|
|
385
419
|
* <p>Describes the number of in-application streams to create. </p>
|
|
386
420
|
*/
|
|
387
421
|
InputParallelism?: InputParallelism;
|
|
388
422
|
/**
|
|
423
|
+
* @public
|
|
389
424
|
* <p>Describes the format of the data in the streaming source, and how each data element maps
|
|
390
425
|
* to corresponding columns in the in-application stream that is being created.</p>
|
|
391
426
|
* <p>Also used to describe the format of the reference data source.</p>
|
|
@@ -397,16 +432,19 @@ export interface Input {
|
|
|
397
432
|
*/
|
|
398
433
|
export interface AddApplicationInputRequest {
|
|
399
434
|
/**
|
|
435
|
+
* @public
|
|
400
436
|
* <p>The name of your existing application to which you want to add the streaming
|
|
401
437
|
* source.</p>
|
|
402
438
|
*/
|
|
403
439
|
ApplicationName: string | undefined;
|
|
404
440
|
/**
|
|
441
|
+
* @public
|
|
405
442
|
* <p>The current version of your application.
|
|
406
443
|
* You must provide the <code>ApplicationVersionID</code> or the <code>ConditionalToken</code>.You can use the <a>DescribeApplication</a> operation to find the current application version.</p>
|
|
407
444
|
*/
|
|
408
445
|
CurrentApplicationVersionId: number | undefined;
|
|
409
446
|
/**
|
|
447
|
+
* @public
|
|
410
448
|
* <p>The <a>Input</a> to add.</p>
|
|
411
449
|
*/
|
|
412
450
|
Input: Input | undefined;
|
|
@@ -419,6 +457,7 @@ export interface AddApplicationInputRequest {
|
|
|
419
457
|
*/
|
|
420
458
|
export interface InputLambdaProcessorDescription {
|
|
421
459
|
/**
|
|
460
|
+
* @public
|
|
422
461
|
* <p>The ARN of the Amazon Lambda function that is used to preprocess the records in the
|
|
423
462
|
* stream.</p>
|
|
424
463
|
* <note>
|
|
@@ -428,6 +467,7 @@ export interface InputLambdaProcessorDescription {
|
|
|
428
467
|
*/
|
|
429
468
|
ResourceARN: string | undefined;
|
|
430
469
|
/**
|
|
470
|
+
* @public
|
|
431
471
|
* <p>The ARN of the IAM role that is used to access the Amazon Lambda function.</p>
|
|
432
472
|
* <note>
|
|
433
473
|
* <p>Provided for backward compatibility. Applications that are created with the current API
|
|
@@ -444,6 +484,7 @@ export interface InputLambdaProcessorDescription {
|
|
|
444
484
|
*/
|
|
445
485
|
export interface InputProcessingConfigurationDescription {
|
|
446
486
|
/**
|
|
487
|
+
* @public
|
|
447
488
|
* <p>Provides configuration information about the associated <a>InputLambdaProcessorDescription</a>
|
|
448
489
|
* </p>
|
|
449
490
|
*/
|
|
@@ -469,6 +510,7 @@ export type InputStartingPosition = (typeof InputStartingPosition)[keyof typeof
|
|
|
469
510
|
*/
|
|
470
511
|
export interface InputStartingPositionConfiguration {
|
|
471
512
|
/**
|
|
513
|
+
* @public
|
|
472
514
|
* <p>The starting position on the stream.</p>
|
|
473
515
|
* <ul>
|
|
474
516
|
* <li>
|
|
@@ -499,10 +541,12 @@ export interface InputStartingPositionConfiguration {
|
|
|
499
541
|
*/
|
|
500
542
|
export interface KinesisFirehoseInputDescription {
|
|
501
543
|
/**
|
|
544
|
+
* @public
|
|
502
545
|
* <p>The Amazon Resource Name (ARN) of the delivery stream.</p>
|
|
503
546
|
*/
|
|
504
547
|
ResourceARN: string | undefined;
|
|
505
548
|
/**
|
|
549
|
+
* @public
|
|
506
550
|
* <p>The ARN of the IAM role that Kinesis Data Analytics assumes to access the stream.</p>
|
|
507
551
|
* <note>
|
|
508
552
|
* <p>Provided for backward compatibility. Applications that are created with the current API
|
|
@@ -519,10 +563,12 @@ export interface KinesisFirehoseInputDescription {
|
|
|
519
563
|
*/
|
|
520
564
|
export interface KinesisStreamsInputDescription {
|
|
521
565
|
/**
|
|
566
|
+
* @public
|
|
522
567
|
* <p>The Amazon Resource Name (ARN) of the Kinesis data stream.</p>
|
|
523
568
|
*/
|
|
524
569
|
ResourceARN: string | undefined;
|
|
525
570
|
/**
|
|
571
|
+
* @public
|
|
526
572
|
* <p>The ARN of the IAM role that Kinesis Data Analytics can assume to access the
|
|
527
573
|
* stream.</p>
|
|
528
574
|
* <note>
|
|
@@ -539,41 +585,50 @@ export interface KinesisStreamsInputDescription {
|
|
|
539
585
|
*/
|
|
540
586
|
export interface InputDescription {
|
|
541
587
|
/**
|
|
588
|
+
* @public
|
|
542
589
|
* <p>The input ID that is associated with the application input. This is the ID that Kinesis Data Analytics assigns to each input
|
|
543
590
|
* configuration that you add to your application. </p>
|
|
544
591
|
*/
|
|
545
592
|
InputId?: string;
|
|
546
593
|
/**
|
|
594
|
+
* @public
|
|
547
595
|
* <p>The in-application name prefix.</p>
|
|
548
596
|
*/
|
|
549
597
|
NamePrefix?: string;
|
|
550
598
|
/**
|
|
599
|
+
* @public
|
|
551
600
|
* <p>Returns the in-application stream names that are mapped to the stream source. </p>
|
|
552
601
|
*/
|
|
553
602
|
InAppStreamNames?: string[];
|
|
554
603
|
/**
|
|
604
|
+
* @public
|
|
555
605
|
* <p>The description of the preprocessor that executes on records in this input before the application's code is run. </p>
|
|
556
606
|
*/
|
|
557
607
|
InputProcessingConfigurationDescription?: InputProcessingConfigurationDescription;
|
|
558
608
|
/**
|
|
609
|
+
* @public
|
|
559
610
|
* <p>If a Kinesis data stream is configured as a streaming source, provides the Kinesis data
|
|
560
611
|
* stream's Amazon Resource Name (ARN). </p>
|
|
561
612
|
*/
|
|
562
613
|
KinesisStreamsInputDescription?: KinesisStreamsInputDescription;
|
|
563
614
|
/**
|
|
615
|
+
* @public
|
|
564
616
|
* <p>If a Kinesis Data Firehose delivery stream is configured as a streaming source, provides the delivery stream's ARN. </p>
|
|
565
617
|
*/
|
|
566
618
|
KinesisFirehoseInputDescription?: KinesisFirehoseInputDescription;
|
|
567
619
|
/**
|
|
620
|
+
* @public
|
|
568
621
|
* <p>Describes the format of the data in the streaming source, and how each data element maps to corresponding columns
|
|
569
622
|
* in the in-application stream that is being created. </p>
|
|
570
623
|
*/
|
|
571
624
|
InputSchema?: SourceSchema;
|
|
572
625
|
/**
|
|
626
|
+
* @public
|
|
573
627
|
* <p>Describes the configured parallelism (number of in-application streams mapped to the streaming source). </p>
|
|
574
628
|
*/
|
|
575
629
|
InputParallelism?: InputParallelism;
|
|
576
630
|
/**
|
|
631
|
+
* @public
|
|
577
632
|
* <p>The point at which the application is configured to read from the input stream.</p>
|
|
578
633
|
*/
|
|
579
634
|
InputStartingPositionConfiguration?: InputStartingPositionConfiguration;
|
|
@@ -583,14 +638,17 @@ export interface InputDescription {
|
|
|
583
638
|
*/
|
|
584
639
|
export interface AddApplicationInputResponse {
|
|
585
640
|
/**
|
|
641
|
+
* @public
|
|
586
642
|
* <p>The Amazon Resource Name (ARN) of the application.</p>
|
|
587
643
|
*/
|
|
588
644
|
ApplicationARN?: string;
|
|
589
645
|
/**
|
|
646
|
+
* @public
|
|
590
647
|
* <p>Provides the current application version.</p>
|
|
591
648
|
*/
|
|
592
649
|
ApplicationVersionId?: number;
|
|
593
650
|
/**
|
|
651
|
+
* @public
|
|
594
652
|
* <p>Describes the application input configuration.
|
|
595
653
|
*
|
|
596
654
|
*
|
|
@@ -617,11 +675,13 @@ export declare class CodeValidationException extends __BaseException {
|
|
|
617
675
|
*/
|
|
618
676
|
export interface AddApplicationInputProcessingConfigurationRequest {
|
|
619
677
|
/**
|
|
678
|
+
* @public
|
|
620
679
|
* <p>The name of the application to which you want to add the input processing
|
|
621
680
|
* configuration.</p>
|
|
622
681
|
*/
|
|
623
682
|
ApplicationName: string | undefined;
|
|
624
683
|
/**
|
|
684
|
+
* @public
|
|
625
685
|
* <p>The version of the application to which you want to add the input processing
|
|
626
686
|
* configuration. You can use the <a>DescribeApplication</a> operation to get the
|
|
627
687
|
* current application version. If the version specified is not the current version, the
|
|
@@ -629,11 +689,13 @@ export interface AddApplicationInputProcessingConfigurationRequest {
|
|
|
629
689
|
*/
|
|
630
690
|
CurrentApplicationVersionId: number | undefined;
|
|
631
691
|
/**
|
|
692
|
+
* @public
|
|
632
693
|
* <p>The ID of the input configuration to add the input processing configuration to. You
|
|
633
694
|
* can get a list of the input IDs for an application using the <a>DescribeApplication</a> operation.</p>
|
|
634
695
|
*/
|
|
635
696
|
InputId: string | undefined;
|
|
636
697
|
/**
|
|
698
|
+
* @public
|
|
637
699
|
* <p>The <a>InputProcessingConfiguration</a> to add to the application.</p>
|
|
638
700
|
*/
|
|
639
701
|
InputProcessingConfiguration: InputProcessingConfiguration | undefined;
|
|
@@ -643,20 +705,24 @@ export interface AddApplicationInputProcessingConfigurationRequest {
|
|
|
643
705
|
*/
|
|
644
706
|
export interface AddApplicationInputProcessingConfigurationResponse {
|
|
645
707
|
/**
|
|
708
|
+
* @public
|
|
646
709
|
* <p>The Amazon Resource Name (ARN) of the application.</p>
|
|
647
710
|
*/
|
|
648
711
|
ApplicationARN?: string;
|
|
649
712
|
/**
|
|
713
|
+
* @public
|
|
650
714
|
* <p>Provides the current application version. </p>
|
|
651
715
|
*/
|
|
652
716
|
ApplicationVersionId?: number;
|
|
653
717
|
/**
|
|
718
|
+
* @public
|
|
654
719
|
* <p>The input ID that is associated with the application input. This is the ID that Kinesis Data Analytics assigns
|
|
655
720
|
* to each input configuration that you add to your
|
|
656
721
|
* application.</p>
|
|
657
722
|
*/
|
|
658
723
|
InputId?: string;
|
|
659
724
|
/**
|
|
725
|
+
* @public
|
|
660
726
|
* <p>The description of the preprocessor that executes on records in this input before the application's code is run.</p>
|
|
661
727
|
*/
|
|
662
728
|
InputProcessingConfigurationDescription?: InputProcessingConfigurationDescription;
|
|
@@ -667,6 +733,7 @@ export interface AddApplicationInputProcessingConfigurationResponse {
|
|
|
667
733
|
*/
|
|
668
734
|
export interface DestinationSchema {
|
|
669
735
|
/**
|
|
736
|
+
* @public
|
|
670
737
|
* <p>Specifies the format of the records on the output stream.</p>
|
|
671
738
|
*/
|
|
672
739
|
RecordFormatType: RecordFormatType | string | undefined;
|
|
@@ -679,6 +746,7 @@ export interface DestinationSchema {
|
|
|
679
746
|
*/
|
|
680
747
|
export interface KinesisFirehoseOutput {
|
|
681
748
|
/**
|
|
749
|
+
* @public
|
|
682
750
|
* <p>The ARN of the destination delivery stream to write to.</p>
|
|
683
751
|
*/
|
|
684
752
|
ResourceARN: string | undefined;
|
|
@@ -691,6 +759,7 @@ export interface KinesisFirehoseOutput {
|
|
|
691
759
|
*/
|
|
692
760
|
export interface KinesisStreamsOutput {
|
|
693
761
|
/**
|
|
762
|
+
* @public
|
|
694
763
|
* <p>The ARN of the destination Kinesis data stream to write to.</p>
|
|
695
764
|
*/
|
|
696
765
|
ResourceARN: string | undefined;
|
|
@@ -703,6 +772,7 @@ export interface KinesisStreamsOutput {
|
|
|
703
772
|
*/
|
|
704
773
|
export interface LambdaOutput {
|
|
705
774
|
/**
|
|
775
|
+
* @public
|
|
706
776
|
* <p>The Amazon Resource Name (ARN) of the destination Lambda function to write to.</p>
|
|
707
777
|
* <note>
|
|
708
778
|
* <p>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 <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-lambda">Example ARNs: Amazon Lambda</a>
|
|
@@ -722,23 +792,28 @@ export interface LambdaOutput {
|
|
|
722
792
|
*/
|
|
723
793
|
export interface Output {
|
|
724
794
|
/**
|
|
795
|
+
* @public
|
|
725
796
|
* <p>The name of the in-application stream.</p>
|
|
726
797
|
*/
|
|
727
798
|
Name: string | undefined;
|
|
728
799
|
/**
|
|
800
|
+
* @public
|
|
729
801
|
* <p>Identifies a Kinesis data stream
|
|
730
802
|
* as the destination.</p>
|
|
731
803
|
*/
|
|
732
804
|
KinesisStreamsOutput?: KinesisStreamsOutput;
|
|
733
805
|
/**
|
|
806
|
+
* @public
|
|
734
807
|
* <p>Identifies a Kinesis Data Firehose delivery stream as the destination.</p>
|
|
735
808
|
*/
|
|
736
809
|
KinesisFirehoseOutput?: KinesisFirehoseOutput;
|
|
737
810
|
/**
|
|
811
|
+
* @public
|
|
738
812
|
* <p>Identifies an Amazon Lambda function as the destination.</p>
|
|
739
813
|
*/
|
|
740
814
|
LambdaOutput?: LambdaOutput;
|
|
741
815
|
/**
|
|
816
|
+
* @public
|
|
742
817
|
* <p>Describes the data format when records are written to the destination.
|
|
743
818
|
* </p>
|
|
744
819
|
*/
|
|
@@ -749,10 +824,12 @@ export interface Output {
|
|
|
749
824
|
*/
|
|
750
825
|
export interface AddApplicationOutputRequest {
|
|
751
826
|
/**
|
|
827
|
+
* @public
|
|
752
828
|
* <p>The name of the application to which you want to add the output configuration.</p>
|
|
753
829
|
*/
|
|
754
830
|
ApplicationName: string | undefined;
|
|
755
831
|
/**
|
|
832
|
+
* @public
|
|
756
833
|
* <p>The version of the application to which you want to add the output configuration. You can
|
|
757
834
|
* use the <a>DescribeApplication</a> operation to get the current application
|
|
758
835
|
* version. If the version specified is not the current version, the
|
|
@@ -760,6 +837,7 @@ export interface AddApplicationOutputRequest {
|
|
|
760
837
|
*/
|
|
761
838
|
CurrentApplicationVersionId: number | undefined;
|
|
762
839
|
/**
|
|
840
|
+
* @public
|
|
763
841
|
* <p>An array of objects, each describing one output configuration. In the output
|
|
764
842
|
* configuration, you specify the name of an in-application stream, a destination (that is, a
|
|
765
843
|
* Kinesis data stream, a Kinesis Data Firehose delivery stream, or an Amazon Lambda function), and
|
|
@@ -774,10 +852,12 @@ export interface AddApplicationOutputRequest {
|
|
|
774
852
|
*/
|
|
775
853
|
export interface KinesisFirehoseOutputDescription {
|
|
776
854
|
/**
|
|
855
|
+
* @public
|
|
777
856
|
* <p>The Amazon Resource Name (ARN) of the delivery stream.</p>
|
|
778
857
|
*/
|
|
779
858
|
ResourceARN: string | undefined;
|
|
780
859
|
/**
|
|
860
|
+
* @public
|
|
781
861
|
* <p>The ARN of the IAM role that Kinesis Data Analytics can assume to access the
|
|
782
862
|
* stream.</p>
|
|
783
863
|
* <note>
|
|
@@ -795,10 +875,12 @@ export interface KinesisFirehoseOutputDescription {
|
|
|
795
875
|
*/
|
|
796
876
|
export interface KinesisStreamsOutputDescription {
|
|
797
877
|
/**
|
|
878
|
+
* @public
|
|
798
879
|
* <p>The Amazon Resource Name (ARN) of the Kinesis data stream.</p>
|
|
799
880
|
*/
|
|
800
881
|
ResourceARN: string | undefined;
|
|
801
882
|
/**
|
|
883
|
+
* @public
|
|
802
884
|
* <p>The ARN of the IAM role that Kinesis Data Analytics can assume to access the
|
|
803
885
|
* stream.</p>
|
|
804
886
|
* <note>
|
|
@@ -816,10 +898,12 @@ export interface KinesisStreamsOutputDescription {
|
|
|
816
898
|
*/
|
|
817
899
|
export interface LambdaOutputDescription {
|
|
818
900
|
/**
|
|
901
|
+
* @public
|
|
819
902
|
* <p>The Amazon Resource Name (ARN) of the destination Lambda function.</p>
|
|
820
903
|
*/
|
|
821
904
|
ResourceARN: string | undefined;
|
|
822
905
|
/**
|
|
906
|
+
* @public
|
|
823
907
|
* <p>The ARN of the IAM role that Kinesis Data Analytics can assume to write to the destination
|
|
824
908
|
* function.</p>
|
|
825
909
|
* <note>
|
|
@@ -839,29 +923,35 @@ export interface LambdaOutputDescription {
|
|
|
839
923
|
*/
|
|
840
924
|
export interface OutputDescription {
|
|
841
925
|
/**
|
|
926
|
+
* @public
|
|
842
927
|
* <p>A unique identifier for the output configuration.</p>
|
|
843
928
|
*/
|
|
844
929
|
OutputId?: string;
|
|
845
930
|
/**
|
|
931
|
+
* @public
|
|
846
932
|
* <p>The name of the in-application stream that is configured as output.</p>
|
|
847
933
|
*/
|
|
848
934
|
Name?: string;
|
|
849
935
|
/**
|
|
936
|
+
* @public
|
|
850
937
|
* <p>Describes the Kinesis data stream that is configured as the destination where output is
|
|
851
938
|
* written.</p>
|
|
852
939
|
*/
|
|
853
940
|
KinesisStreamsOutputDescription?: KinesisStreamsOutputDescription;
|
|
854
941
|
/**
|
|
942
|
+
* @public
|
|
855
943
|
* <p>Describes the Kinesis Data Firehose delivery stream that is configured as the destination
|
|
856
944
|
* where output is written.</p>
|
|
857
945
|
*/
|
|
858
946
|
KinesisFirehoseOutputDescription?: KinesisFirehoseOutputDescription;
|
|
859
947
|
/**
|
|
948
|
+
* @public
|
|
860
949
|
* <p>Describes the Lambda function that is configured as the destination where output is
|
|
861
950
|
* written.</p>
|
|
862
951
|
*/
|
|
863
952
|
LambdaOutputDescription?: LambdaOutputDescription;
|
|
864
953
|
/**
|
|
954
|
+
* @public
|
|
865
955
|
* <p>The data format used for writing data to the destination.</p>
|
|
866
956
|
*/
|
|
867
957
|
DestinationSchema?: DestinationSchema;
|
|
@@ -871,15 +961,18 @@ export interface OutputDescription {
|
|
|
871
961
|
*/
|
|
872
962
|
export interface AddApplicationOutputResponse {
|
|
873
963
|
/**
|
|
964
|
+
* @public
|
|
874
965
|
* <p>The application Amazon Resource Name (ARN).</p>
|
|
875
966
|
*/
|
|
876
967
|
ApplicationARN?: string;
|
|
877
968
|
/**
|
|
969
|
+
* @public
|
|
878
970
|
* <p>The updated application version ID. Kinesis Data Analytics increments this ID when the application is
|
|
879
971
|
* updated.</p>
|
|
880
972
|
*/
|
|
881
973
|
ApplicationVersionId?: number;
|
|
882
974
|
/**
|
|
975
|
+
* @public
|
|
883
976
|
* <p>Describes the application output configuration.
|
|
884
977
|
* For more information,
|
|
885
978
|
* see <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html">Configuring Application Output</a>.
|
|
@@ -898,10 +991,12 @@ export interface AddApplicationOutputResponse {
|
|
|
898
991
|
*/
|
|
899
992
|
export interface S3ReferenceDataSource {
|
|
900
993
|
/**
|
|
994
|
+
* @public
|
|
901
995
|
* <p>The Amazon Resource Name (ARN) of the S3 bucket.</p>
|
|
902
996
|
*/
|
|
903
997
|
BucketARN?: string;
|
|
904
998
|
/**
|
|
999
|
+
* @public
|
|
905
1000
|
* <p>The object key name containing the reference data.</p>
|
|
906
1001
|
*/
|
|
907
1002
|
FileKey?: string;
|
|
@@ -915,16 +1010,19 @@ export interface S3ReferenceDataSource {
|
|
|
915
1010
|
*/
|
|
916
1011
|
export interface ReferenceDataSource {
|
|
917
1012
|
/**
|
|
1013
|
+
* @public
|
|
918
1014
|
* <p>The name of the in-application table to create.</p>
|
|
919
1015
|
*/
|
|
920
1016
|
TableName: string | undefined;
|
|
921
1017
|
/**
|
|
1018
|
+
* @public
|
|
922
1019
|
* <p>Identifies the S3 bucket and object that contains the reference data.
|
|
923
1020
|
*
|
|
924
1021
|
* A Kinesis Data Analytics application loads reference data only once. If the data changes, you call the <a>UpdateApplication</a> operation to trigger reloading of data into your application. </p>
|
|
925
1022
|
*/
|
|
926
1023
|
S3ReferenceDataSource?: S3ReferenceDataSource;
|
|
927
1024
|
/**
|
|
1025
|
+
* @public
|
|
928
1026
|
* <p>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.</p>
|
|
929
1027
|
*/
|
|
930
1028
|
ReferenceSchema: SourceSchema | undefined;
|
|
@@ -934,10 +1032,12 @@ export interface ReferenceDataSource {
|
|
|
934
1032
|
*/
|
|
935
1033
|
export interface AddApplicationReferenceDataSourceRequest {
|
|
936
1034
|
/**
|
|
1035
|
+
* @public
|
|
937
1036
|
* <p>The name of an existing application.</p>
|
|
938
1037
|
*/
|
|
939
1038
|
ApplicationName: string | undefined;
|
|
940
1039
|
/**
|
|
1040
|
+
* @public
|
|
941
1041
|
* <p>The version of the application for which you are adding the reference data source.
|
|
942
1042
|
* You can
|
|
943
1043
|
* use the <a>DescribeApplication</a> operation to get the current application
|
|
@@ -946,6 +1046,7 @@ export interface AddApplicationReferenceDataSourceRequest {
|
|
|
946
1046
|
*/
|
|
947
1047
|
CurrentApplicationVersionId: number | undefined;
|
|
948
1048
|
/**
|
|
1049
|
+
* @public
|
|
949
1050
|
* <p>The reference data source can be an object in your Amazon S3 bucket. Kinesis Data Analytics reads the object and copies the data
|
|
950
1051
|
* into the in-application table that is created. You provide an S3 bucket, object key name, and the resulting
|
|
951
1052
|
* in-application table that is
|
|
@@ -960,14 +1061,17 @@ export interface AddApplicationReferenceDataSourceRequest {
|
|
|
960
1061
|
*/
|
|
961
1062
|
export interface S3ReferenceDataSourceDescription {
|
|
962
1063
|
/**
|
|
1064
|
+
* @public
|
|
963
1065
|
* <p>The Amazon Resource Name (ARN) of the S3 bucket.</p>
|
|
964
1066
|
*/
|
|
965
1067
|
BucketARN: string | undefined;
|
|
966
1068
|
/**
|
|
1069
|
+
* @public
|
|
967
1070
|
* <p>Amazon S3 object key name.</p>
|
|
968
1071
|
*/
|
|
969
1072
|
FileKey: string | undefined;
|
|
970
1073
|
/**
|
|
1074
|
+
* @public
|
|
971
1075
|
* <p>The ARN of the IAM role that Kinesis Data Analytics can assume to read the Amazon S3
|
|
972
1076
|
* object on your behalf to populate the in-application reference table. </p>
|
|
973
1077
|
* <note>
|
|
@@ -985,19 +1089,23 @@ export interface S3ReferenceDataSourceDescription {
|
|
|
985
1089
|
*/
|
|
986
1090
|
export interface ReferenceDataSourceDescription {
|
|
987
1091
|
/**
|
|
1092
|
+
* @public
|
|
988
1093
|
* <p>The ID of the reference data source. This is the ID that Kinesis Data Analytics assigns
|
|
989
1094
|
* when you add the reference data source to your application using the <a>CreateApplication</a> or <a>UpdateApplication</a> operation.</p>
|
|
990
1095
|
*/
|
|
991
1096
|
ReferenceId: string | undefined;
|
|
992
1097
|
/**
|
|
1098
|
+
* @public
|
|
993
1099
|
* <p>The in-application table name created by the specific reference data source configuration.</p>
|
|
994
1100
|
*/
|
|
995
1101
|
TableName: string | undefined;
|
|
996
1102
|
/**
|
|
1103
|
+
* @public
|
|
997
1104
|
* <p>Provides the Amazon S3 bucket name, the object key name that contains the reference data. </p>
|
|
998
1105
|
*/
|
|
999
1106
|
S3ReferenceDataSourceDescription: S3ReferenceDataSourceDescription | undefined;
|
|
1000
1107
|
/**
|
|
1108
|
+
* @public
|
|
1001
1109
|
* <p>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.</p>
|
|
1002
1110
|
*/
|
|
1003
1111
|
ReferenceSchema?: SourceSchema;
|
|
@@ -1007,15 +1115,18 @@ export interface ReferenceDataSourceDescription {
|
|
|
1007
1115
|
*/
|
|
1008
1116
|
export interface AddApplicationReferenceDataSourceResponse {
|
|
1009
1117
|
/**
|
|
1118
|
+
* @public
|
|
1010
1119
|
* <p>The application Amazon Resource Name (ARN).</p>
|
|
1011
1120
|
*/
|
|
1012
1121
|
ApplicationARN?: string;
|
|
1013
1122
|
/**
|
|
1123
|
+
* @public
|
|
1014
1124
|
* <p>The updated application version ID. Kinesis Data Analytics increments this ID when
|
|
1015
1125
|
* the application is updated.</p>
|
|
1016
1126
|
*/
|
|
1017
1127
|
ApplicationVersionId?: number;
|
|
1018
1128
|
/**
|
|
1129
|
+
* @public
|
|
1019
1130
|
* <p>Describes reference data sources configured for the application.
|
|
1020
1131
|
*
|
|
1021
1132
|
*
|
|
@@ -1030,11 +1141,13 @@ export interface AddApplicationReferenceDataSourceResponse {
|
|
|
1030
1141
|
*/
|
|
1031
1142
|
export interface VpcConfiguration {
|
|
1032
1143
|
/**
|
|
1144
|
+
* @public
|
|
1033
1145
|
* <p>The array of <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Subnet.html">Subnet</a> IDs
|
|
1034
1146
|
* used by the VPC configuration.</p>
|
|
1035
1147
|
*/
|
|
1036
1148
|
SubnetIds: string[] | undefined;
|
|
1037
1149
|
/**
|
|
1150
|
+
* @public
|
|
1038
1151
|
* <p>The array of <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SecurityGroup.html">SecurityGroup</a>
|
|
1039
1152
|
* IDs used by the VPC configuration.</p>
|
|
1040
1153
|
*/
|
|
@@ -1045,10 +1158,12 @@ export interface VpcConfiguration {
|
|
|
1045
1158
|
*/
|
|
1046
1159
|
export interface AddApplicationVpcConfigurationRequest {
|
|
1047
1160
|
/**
|
|
1161
|
+
* @public
|
|
1048
1162
|
* <p>The name of an existing application.</p>
|
|
1049
1163
|
*/
|
|
1050
1164
|
ApplicationName: string | undefined;
|
|
1051
1165
|
/**
|
|
1166
|
+
* @public
|
|
1052
1167
|
* <p>The version of the application to which you want to add the VPC configuration. You must
|
|
1053
1168
|
* provide the <code>CurrentApplicationVersionId</code> or the <code>ConditionalToken</code>. You
|
|
1054
1169
|
* can use the <a>DescribeApplication</a> operation to get the current application
|
|
@@ -1059,10 +1174,12 @@ export interface AddApplicationVpcConfigurationRequest {
|
|
|
1059
1174
|
*/
|
|
1060
1175
|
CurrentApplicationVersionId?: number;
|
|
1061
1176
|
/**
|
|
1177
|
+
* @public
|
|
1062
1178
|
* <p>Description of the VPC to add to the application.</p>
|
|
1063
1179
|
*/
|
|
1064
1180
|
VpcConfiguration: VpcConfiguration | undefined;
|
|
1065
1181
|
/**
|
|
1182
|
+
* @public
|
|
1066
1183
|
* <p>A value you use to implement strong concurrency for application updates. You must
|
|
1067
1184
|
* provide the <code>ApplicationVersionID</code> or the <code>ConditionalToken</code>. You get
|
|
1068
1185
|
* the application's current <code>ConditionalToken</code> using <a>DescribeApplication</a>. For better concurrency support, use the
|
|
@@ -1077,19 +1194,23 @@ export interface AddApplicationVpcConfigurationRequest {
|
|
|
1077
1194
|
*/
|
|
1078
1195
|
export interface VpcConfigurationDescription {
|
|
1079
1196
|
/**
|
|
1197
|
+
* @public
|
|
1080
1198
|
* <p>The ID of the VPC configuration.</p>
|
|
1081
1199
|
*/
|
|
1082
1200
|
VpcConfigurationId: string | undefined;
|
|
1083
1201
|
/**
|
|
1202
|
+
* @public
|
|
1084
1203
|
* <p>The ID of the associated VPC.</p>
|
|
1085
1204
|
*/
|
|
1086
1205
|
VpcId: string | undefined;
|
|
1087
1206
|
/**
|
|
1207
|
+
* @public
|
|
1088
1208
|
* <p>The array of <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Subnet.html">Subnet</a>
|
|
1089
1209
|
* IDs used by the VPC configuration.</p>
|
|
1090
1210
|
*/
|
|
1091
1211
|
SubnetIds: string[] | undefined;
|
|
1092
1212
|
/**
|
|
1213
|
+
* @public
|
|
1093
1214
|
* <p>The array of <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SecurityGroup.html">SecurityGroup</a>
|
|
1094
1215
|
* IDs used by the VPC configuration.</p>
|
|
1095
1216
|
*/
|
|
@@ -1100,15 +1221,18 @@ export interface VpcConfigurationDescription {
|
|
|
1100
1221
|
*/
|
|
1101
1222
|
export interface AddApplicationVpcConfigurationResponse {
|
|
1102
1223
|
/**
|
|
1224
|
+
* @public
|
|
1103
1225
|
* <p>The ARN of the application.</p>
|
|
1104
1226
|
*/
|
|
1105
1227
|
ApplicationARN?: string;
|
|
1106
1228
|
/**
|
|
1229
|
+
* @public
|
|
1107
1230
|
* <p>Provides the current application version. Kinesis Data Analytics updates the ApplicationVersionId each
|
|
1108
1231
|
* time you update the application.</p>
|
|
1109
1232
|
*/
|
|
1110
1233
|
ApplicationVersionId?: number;
|
|
1111
1234
|
/**
|
|
1235
|
+
* @public
|
|
1112
1236
|
* <p>The parameters of the new VPC configuration.</p>
|
|
1113
1237
|
*/
|
|
1114
1238
|
VpcConfigurationDescription?: VpcConfigurationDescription;
|
|
@@ -1122,14 +1246,17 @@ export interface AddApplicationVpcConfigurationResponse {
|
|
|
1122
1246
|
*/
|
|
1123
1247
|
export interface S3ContentLocation {
|
|
1124
1248
|
/**
|
|
1249
|
+
* @public
|
|
1125
1250
|
* <p>The Amazon Resource Name (ARN) for the S3 bucket containing the application code.</p>
|
|
1126
1251
|
*/
|
|
1127
1252
|
BucketARN: string | undefined;
|
|
1128
1253
|
/**
|
|
1254
|
+
* @public
|
|
1129
1255
|
* <p>The file key for the object containing the application code.</p>
|
|
1130
1256
|
*/
|
|
1131
1257
|
FileKey: string | undefined;
|
|
1132
1258
|
/**
|
|
1259
|
+
* @public
|
|
1133
1260
|
* <p>The version of the object containing the application code.</p>
|
|
1134
1261
|
*/
|
|
1135
1262
|
ObjectVersion?: string;
|
|
@@ -1141,14 +1268,17 @@ export interface S3ContentLocation {
|
|
|
1141
1268
|
*/
|
|
1142
1269
|
export interface CodeContent {
|
|
1143
1270
|
/**
|
|
1271
|
+
* @public
|
|
1144
1272
|
* <p>The text-format code for a Flink-based Kinesis Data Analytics application.</p>
|
|
1145
1273
|
*/
|
|
1146
1274
|
TextContent?: string;
|
|
1147
1275
|
/**
|
|
1276
|
+
* @public
|
|
1148
1277
|
* <p>The zip-format code for a Flink-based Kinesis Data Analytics application.</p>
|
|
1149
1278
|
*/
|
|
1150
1279
|
ZipFileContent?: Uint8Array;
|
|
1151
1280
|
/**
|
|
1281
|
+
* @public
|
|
1152
1282
|
* <p>Information about the Amazon S3 bucket that contains the application code.</p>
|
|
1153
1283
|
*/
|
|
1154
1284
|
S3ContentLocation?: S3ContentLocation;
|
|
@@ -1171,10 +1301,12 @@ export type CodeContentType = (typeof CodeContentType)[keyof typeof CodeContentT
|
|
|
1171
1301
|
*/
|
|
1172
1302
|
export interface ApplicationCodeConfiguration {
|
|
1173
1303
|
/**
|
|
1304
|
+
* @public
|
|
1174
1305
|
* <p>The location and type of the application code.</p>
|
|
1175
1306
|
*/
|
|
1176
1307
|
CodeContent?: CodeContent;
|
|
1177
1308
|
/**
|
|
1309
|
+
* @public
|
|
1178
1310
|
* <p>Specifies whether the code content is in text or zip format.</p>
|
|
1179
1311
|
*/
|
|
1180
1312
|
CodeContentType: CodeContentType | string | undefined;
|
|
@@ -1185,14 +1317,17 @@ export interface ApplicationCodeConfiguration {
|
|
|
1185
1317
|
*/
|
|
1186
1318
|
export interface S3ApplicationCodeLocationDescription {
|
|
1187
1319
|
/**
|
|
1320
|
+
* @public
|
|
1188
1321
|
* <p>The Amazon Resource Name (ARN) for the S3 bucket containing the application code.</p>
|
|
1189
1322
|
*/
|
|
1190
1323
|
BucketARN: string | undefined;
|
|
1191
1324
|
/**
|
|
1325
|
+
* @public
|
|
1192
1326
|
* <p>The file key for the object containing the application code.</p>
|
|
1193
1327
|
*/
|
|
1194
1328
|
FileKey: string | undefined;
|
|
1195
1329
|
/**
|
|
1330
|
+
* @public
|
|
1196
1331
|
* <p>The version of the object containing the application code.</p>
|
|
1197
1332
|
*/
|
|
1198
1333
|
ObjectVersion?: string;
|
|
@@ -1203,18 +1338,22 @@ export interface S3ApplicationCodeLocationDescription {
|
|
|
1203
1338
|
*/
|
|
1204
1339
|
export interface CodeContentDescription {
|
|
1205
1340
|
/**
|
|
1341
|
+
* @public
|
|
1206
1342
|
* <p>The text-format code</p>
|
|
1207
1343
|
*/
|
|
1208
1344
|
TextContent?: string;
|
|
1209
1345
|
/**
|
|
1346
|
+
* @public
|
|
1210
1347
|
* <p>The checksum that can be used to validate zip-format code.</p>
|
|
1211
1348
|
*/
|
|
1212
1349
|
CodeMD5?: string;
|
|
1213
1350
|
/**
|
|
1351
|
+
* @public
|
|
1214
1352
|
* <p>The size in bytes of the application code. Can be used to validate zip-format code.</p>
|
|
1215
1353
|
*/
|
|
1216
1354
|
CodeSize?: number;
|
|
1217
1355
|
/**
|
|
1356
|
+
* @public
|
|
1218
1357
|
* <p>The S3 bucket Amazon Resource Name (ARN), file key, and object version of the application
|
|
1219
1358
|
* code stored in Amazon S3.</p>
|
|
1220
1359
|
*/
|
|
@@ -1226,10 +1365,12 @@ export interface CodeContentDescription {
|
|
|
1226
1365
|
*/
|
|
1227
1366
|
export interface ApplicationCodeConfigurationDescription {
|
|
1228
1367
|
/**
|
|
1368
|
+
* @public
|
|
1229
1369
|
* <p>Specifies whether the code content is in text or zip format.</p>
|
|
1230
1370
|
*/
|
|
1231
1371
|
CodeContentType: CodeContentType | string | undefined;
|
|
1232
1372
|
/**
|
|
1373
|
+
* @public
|
|
1233
1374
|
* <p>Describes details about the location and format of the application code.</p>
|
|
1234
1375
|
*/
|
|
1235
1376
|
CodeContentDescription?: CodeContentDescription;
|
|
@@ -1240,14 +1381,17 @@ export interface ApplicationCodeConfigurationDescription {
|
|
|
1240
1381
|
*/
|
|
1241
1382
|
export interface S3ContentLocationUpdate {
|
|
1242
1383
|
/**
|
|
1384
|
+
* @public
|
|
1243
1385
|
* <p>The new Amazon Resource Name (ARN) for the S3 bucket containing the application code.</p>
|
|
1244
1386
|
*/
|
|
1245
1387
|
BucketARNUpdate?: string;
|
|
1246
1388
|
/**
|
|
1389
|
+
* @public
|
|
1247
1390
|
* <p>The new file key for the object containing the application code.</p>
|
|
1248
1391
|
*/
|
|
1249
1392
|
FileKeyUpdate?: string;
|
|
1250
1393
|
/**
|
|
1394
|
+
* @public
|
|
1251
1395
|
* <p>The new version of the object containing the application code.</p>
|
|
1252
1396
|
*/
|
|
1253
1397
|
ObjectVersionUpdate?: string;
|
|
@@ -1258,14 +1402,17 @@ export interface S3ContentLocationUpdate {
|
|
|
1258
1402
|
*/
|
|
1259
1403
|
export interface CodeContentUpdate {
|
|
1260
1404
|
/**
|
|
1405
|
+
* @public
|
|
1261
1406
|
* <p>Describes an update to the text code for an application.</p>
|
|
1262
1407
|
*/
|
|
1263
1408
|
TextContentUpdate?: string;
|
|
1264
1409
|
/**
|
|
1410
|
+
* @public
|
|
1265
1411
|
* <p>Describes an update to the zipped code for an application.</p>
|
|
1266
1412
|
*/
|
|
1267
1413
|
ZipFileContentUpdate?: Uint8Array;
|
|
1268
1414
|
/**
|
|
1415
|
+
* @public
|
|
1269
1416
|
* <p>Describes an update to the location of code for an application.</p>
|
|
1270
1417
|
*/
|
|
1271
1418
|
S3ContentLocationUpdate?: S3ContentLocationUpdate;
|
|
@@ -1276,10 +1423,12 @@ export interface CodeContentUpdate {
|
|
|
1276
1423
|
*/
|
|
1277
1424
|
export interface ApplicationCodeConfigurationUpdate {
|
|
1278
1425
|
/**
|
|
1426
|
+
* @public
|
|
1279
1427
|
* <p>Describes updates to the code content type.</p>
|
|
1280
1428
|
*/
|
|
1281
1429
|
CodeContentTypeUpdate?: CodeContentType | string;
|
|
1282
1430
|
/**
|
|
1431
|
+
* @public
|
|
1283
1432
|
* <p>Describes updates to the code content of an application.</p>
|
|
1284
1433
|
*/
|
|
1285
1434
|
CodeContentUpdate?: CodeContentUpdate;
|
|
@@ -1290,6 +1439,7 @@ export interface ApplicationCodeConfigurationUpdate {
|
|
|
1290
1439
|
*/
|
|
1291
1440
|
export interface ApplicationSnapshotConfiguration {
|
|
1292
1441
|
/**
|
|
1442
|
+
* @public
|
|
1293
1443
|
* <p>Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.</p>
|
|
1294
1444
|
*/
|
|
1295
1445
|
SnapshotsEnabled: boolean | undefined;
|
|
@@ -1300,10 +1450,12 @@ export interface ApplicationSnapshotConfiguration {
|
|
|
1300
1450
|
*/
|
|
1301
1451
|
export interface PropertyGroup {
|
|
1302
1452
|
/**
|
|
1453
|
+
* @public
|
|
1303
1454
|
* <p>Describes the key of an application execution property key-value pair.</p>
|
|
1304
1455
|
*/
|
|
1305
1456
|
PropertyGroupId: string | undefined;
|
|
1306
1457
|
/**
|
|
1458
|
+
* @public
|
|
1307
1459
|
* <p>Describes the value of an application execution property key-value pair.</p>
|
|
1308
1460
|
*/
|
|
1309
1461
|
PropertyMap: Record<string, string> | undefined;
|
|
@@ -1314,6 +1466,7 @@ export interface PropertyGroup {
|
|
|
1314
1466
|
*/
|
|
1315
1467
|
export interface EnvironmentProperties {
|
|
1316
1468
|
/**
|
|
1469
|
+
* @public
|
|
1317
1470
|
* <p>Describes the execution property groups.</p>
|
|
1318
1471
|
*/
|
|
1319
1472
|
PropertyGroups: PropertyGroup[] | undefined;
|
|
@@ -1341,6 +1494,7 @@ export type ConfigurationType = (typeof ConfigurationType)[keyof typeof Configur
|
|
|
1341
1494
|
*/
|
|
1342
1495
|
export interface CheckpointConfiguration {
|
|
1343
1496
|
/**
|
|
1497
|
+
* @public
|
|
1344
1498
|
* <p>Describes whether the application uses Kinesis Data Analytics' default checkpointing behavior.
|
|
1345
1499
|
* You must set this property to <code>CUSTOM</code> in order to set the
|
|
1346
1500
|
* <code>CheckpointingEnabled</code>, <code>CheckpointInterval</code>, or <code>MinPauseBetweenCheckpoints</code> parameters.</p>
|
|
@@ -1365,6 +1519,7 @@ export interface CheckpointConfiguration {
|
|
|
1365
1519
|
*/
|
|
1366
1520
|
ConfigurationType: ConfigurationType | string | undefined;
|
|
1367
1521
|
/**
|
|
1522
|
+
* @public
|
|
1368
1523
|
* <p>Describes whether checkpointing is enabled for a Flink-based Kinesis Data Analytics application.</p>
|
|
1369
1524
|
* <note>
|
|
1370
1525
|
* <p>If <code>CheckpointConfiguration.ConfigurationType</code> is <code>DEFAULT</code>,
|
|
@@ -1374,6 +1529,7 @@ export interface CheckpointConfiguration {
|
|
|
1374
1529
|
*/
|
|
1375
1530
|
CheckpointingEnabled?: boolean;
|
|
1376
1531
|
/**
|
|
1532
|
+
* @public
|
|
1377
1533
|
* <p>Describes the interval in milliseconds between checkpoint operations. </p>
|
|
1378
1534
|
* <note>
|
|
1379
1535
|
* <p>If <code>CheckpointConfiguration.ConfigurationType</code> is <code>DEFAULT</code>,
|
|
@@ -1383,6 +1539,7 @@ export interface CheckpointConfiguration {
|
|
|
1383
1539
|
*/
|
|
1384
1540
|
CheckpointInterval?: number;
|
|
1385
1541
|
/**
|
|
1542
|
+
* @public
|
|
1386
1543
|
* <p>Describes the minimum time in milliseconds after a checkpoint operation completes that a
|
|
1387
1544
|
* new checkpoint operation can start. If a checkpoint operation takes longer than the
|
|
1388
1545
|
* <code>CheckpointInterval</code>, the application otherwise performs continual checkpoint
|
|
@@ -1430,17 +1587,20 @@ export type MetricsLevel = (typeof MetricsLevel)[keyof typeof MetricsLevel];
|
|
|
1430
1587
|
*/
|
|
1431
1588
|
export interface MonitoringConfiguration {
|
|
1432
1589
|
/**
|
|
1590
|
+
* @public
|
|
1433
1591
|
* <p>Describes whether to use the default CloudWatch logging configuration for an application.
|
|
1434
1592
|
* You must set this property to <code>CUSTOM</code> in order to set the <code>LogLevel</code> or
|
|
1435
1593
|
* <code>MetricsLevel</code> parameters.</p>
|
|
1436
1594
|
*/
|
|
1437
1595
|
ConfigurationType: ConfigurationType | string | undefined;
|
|
1438
1596
|
/**
|
|
1597
|
+
* @public
|
|
1439
1598
|
* <p>Describes the granularity of the CloudWatch Logs for an application. The <code>Parallelism</code>
|
|
1440
1599
|
* level is not recommended for applications with a Parallelism over 64 due to excessive costs.</p>
|
|
1441
1600
|
*/
|
|
1442
1601
|
MetricsLevel?: MetricsLevel | string;
|
|
1443
1602
|
/**
|
|
1603
|
+
* @public
|
|
1444
1604
|
* <p>Describes the verbosity of the CloudWatch Logs for an application.</p>
|
|
1445
1605
|
*/
|
|
1446
1606
|
LogLevel?: LogLevel | string;
|
|
@@ -1454,11 +1614,13 @@ export interface MonitoringConfiguration {
|
|
|
1454
1614
|
*/
|
|
1455
1615
|
export interface ParallelismConfiguration {
|
|
1456
1616
|
/**
|
|
1617
|
+
* @public
|
|
1457
1618
|
* <p>Describes whether the application uses the default parallelism for the Kinesis Data Analytics service. You must set this property to <code>CUSTOM</code>
|
|
1458
1619
|
* in order to change your application's <code>AutoScalingEnabled</code>, <code>Parallelism</code>, or <code>ParallelismPerKPU</code> properties.</p>
|
|
1459
1620
|
*/
|
|
1460
1621
|
ConfigurationType: ConfigurationType | string | undefined;
|
|
1461
1622
|
/**
|
|
1623
|
+
* @public
|
|
1462
1624
|
* <p>Describes the initial number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform. If <code>AutoScalingEnabled</code>
|
|
1463
1625
|
* is set to True, Kinesis Data Analytics increases the <code>CurrentParallelism</code> value in response to application
|
|
1464
1626
|
* load. The service can increase the <code>CurrentParallelism</code> value up to the maximum parallelism, which is
|
|
@@ -1469,12 +1631,14 @@ export interface ParallelismConfiguration {
|
|
|
1469
1631
|
*/
|
|
1470
1632
|
Parallelism?: number;
|
|
1471
1633
|
/**
|
|
1634
|
+
* @public
|
|
1472
1635
|
* <p>Describes the number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform per Kinesis Processing Unit
|
|
1473
1636
|
* (KPU) used by the application. For more
|
|
1474
1637
|
* information about KPUs, see <a href="http://aws.amazon.com/kinesis/data-analytics/pricing/">Amazon Kinesis Data Analytics Pricing</a>.</p>
|
|
1475
1638
|
*/
|
|
1476
1639
|
ParallelismPerKPU?: number;
|
|
1477
1640
|
/**
|
|
1641
|
+
* @public
|
|
1478
1642
|
* <p>Describes whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput.</p>
|
|
1479
1643
|
*/
|
|
1480
1644
|
AutoScalingEnabled?: boolean;
|
|
@@ -1485,6 +1649,7 @@ export interface ParallelismConfiguration {
|
|
|
1485
1649
|
*/
|
|
1486
1650
|
export interface FlinkApplicationConfiguration {
|
|
1487
1651
|
/**
|
|
1652
|
+
* @public
|
|
1488
1653
|
* <p>Describes an application's checkpointing configuration. Checkpointing is the
|
|
1489
1654
|
* process of persisting application state for fault tolerance.
|
|
1490
1655
|
* For more information, see
|
|
@@ -1494,11 +1659,13 @@ export interface FlinkApplicationConfiguration {
|
|
|
1494
1659
|
*/
|
|
1495
1660
|
CheckpointConfiguration?: CheckpointConfiguration;
|
|
1496
1661
|
/**
|
|
1662
|
+
* @public
|
|
1497
1663
|
* <p>Describes configuration parameters for Amazon CloudWatch logging for an
|
|
1498
1664
|
* application.</p>
|
|
1499
1665
|
*/
|
|
1500
1666
|
MonitoringConfiguration?: MonitoringConfiguration;
|
|
1501
1667
|
/**
|
|
1668
|
+
* @public
|
|
1502
1669
|
* <p>Describes parameters for how an application executes multiple tasks simultaneously.</p>
|
|
1503
1670
|
*/
|
|
1504
1671
|
ParallelismConfiguration?: ParallelismConfiguration;
|
|
@@ -1509,16 +1676,19 @@ export interface FlinkApplicationConfiguration {
|
|
|
1509
1676
|
*/
|
|
1510
1677
|
export interface SqlApplicationConfiguration {
|
|
1511
1678
|
/**
|
|
1679
|
+
* @public
|
|
1512
1680
|
* <p>The array of <a>Input</a> objects describing the input streams used by the
|
|
1513
1681
|
* application.</p>
|
|
1514
1682
|
*/
|
|
1515
1683
|
Inputs?: Input[];
|
|
1516
1684
|
/**
|
|
1685
|
+
* @public
|
|
1517
1686
|
* <p>The array of <a>Output</a> objects describing the destination streams used by
|
|
1518
1687
|
* the application.</p>
|
|
1519
1688
|
*/
|
|
1520
1689
|
Outputs?: Output[];
|
|
1521
1690
|
/**
|
|
1691
|
+
* @public
|
|
1522
1692
|
* <p>The array of <a>ReferenceDataSource</a> objects describing the reference data
|
|
1523
1693
|
* sources used by the application.</p>
|
|
1524
1694
|
*/
|
|
@@ -1530,6 +1700,7 @@ export interface SqlApplicationConfiguration {
|
|
|
1530
1700
|
*/
|
|
1531
1701
|
export interface GlueDataCatalogConfiguration {
|
|
1532
1702
|
/**
|
|
1703
|
+
* @public
|
|
1533
1704
|
* <p>The Amazon Resource Name (ARN) of the database.</p>
|
|
1534
1705
|
*/
|
|
1535
1706
|
DatabaseARN: string | undefined;
|
|
@@ -1540,6 +1711,7 @@ export interface GlueDataCatalogConfiguration {
|
|
|
1540
1711
|
*/
|
|
1541
1712
|
export interface CatalogConfiguration {
|
|
1542
1713
|
/**
|
|
1714
|
+
* @public
|
|
1543
1715
|
* <p>The configuration parameters for the default Amazon Glue database. You use this database for Apache Flink SQL queries and table API transforms that you write in a Kinesis Data Analytics Studio notebook.</p>
|
|
1544
1716
|
*/
|
|
1545
1717
|
GlueDataCatalogConfiguration: GlueDataCatalogConfiguration | undefined;
|
|
@@ -1562,14 +1734,17 @@ export type ArtifactType = (typeof ArtifactType)[keyof typeof ArtifactType];
|
|
|
1562
1734
|
*/
|
|
1563
1735
|
export interface MavenReference {
|
|
1564
1736
|
/**
|
|
1737
|
+
* @public
|
|
1565
1738
|
* <p>The group ID of the Maven reference.</p>
|
|
1566
1739
|
*/
|
|
1567
1740
|
GroupId: string | undefined;
|
|
1568
1741
|
/**
|
|
1742
|
+
* @public
|
|
1569
1743
|
* <p>The artifact ID of the Maven reference.</p>
|
|
1570
1744
|
*/
|
|
1571
1745
|
ArtifactId: string | undefined;
|
|
1572
1746
|
/**
|
|
1747
|
+
* @public
|
|
1573
1748
|
* <p>The version of the Maven reference.</p>
|
|
1574
1749
|
*/
|
|
1575
1750
|
Version: string | undefined;
|
|
@@ -1580,11 +1755,13 @@ export interface MavenReference {
|
|
|
1580
1755
|
*/
|
|
1581
1756
|
export interface CustomArtifactConfiguration {
|
|
1582
1757
|
/**
|
|
1758
|
+
* @public
|
|
1583
1759
|
* <p>
|
|
1584
1760
|
* <code>UDF</code> stands for user-defined functions. This type of artifact must be in an S3 bucket. A <code>DEPENDENCY_JAR</code> can be in either Maven or an S3 bucket.</p>
|
|
1585
1761
|
*/
|
|
1586
1762
|
ArtifactType: ArtifactType | string | undefined;
|
|
1587
1763
|
/**
|
|
1764
|
+
* @public
|
|
1588
1765
|
* <p>For a Kinesis Data Analytics application provides a
|
|
1589
1766
|
* description of an Amazon S3 object, including the Amazon Resource Name (ARN) of the S3 bucket,
|
|
1590
1767
|
* the name of the Amazon S3 object that contains the data, and the version number of the Amazon
|
|
@@ -1592,6 +1769,7 @@ export interface CustomArtifactConfiguration {
|
|
|
1592
1769
|
*/
|
|
1593
1770
|
S3ContentLocation?: S3ContentLocation;
|
|
1594
1771
|
/**
|
|
1772
|
+
* @public
|
|
1595
1773
|
* <p>The parameters required to fully specify a Maven reference.</p>
|
|
1596
1774
|
*/
|
|
1597
1775
|
MavenReference?: MavenReference;
|
|
@@ -1602,10 +1780,12 @@ export interface CustomArtifactConfiguration {
|
|
|
1602
1780
|
*/
|
|
1603
1781
|
export interface S3ContentBaseLocation {
|
|
1604
1782
|
/**
|
|
1783
|
+
* @public
|
|
1605
1784
|
* <p>The Amazon Resource Name (ARN) of the S3 bucket.</p>
|
|
1606
1785
|
*/
|
|
1607
1786
|
BucketARN: string | undefined;
|
|
1608
1787
|
/**
|
|
1788
|
+
* @public
|
|
1609
1789
|
* <p>The base path for the S3 bucket.</p>
|
|
1610
1790
|
*/
|
|
1611
1791
|
BasePath?: string;
|
|
@@ -1616,6 +1796,7 @@ export interface S3ContentBaseLocation {
|
|
|
1616
1796
|
*/
|
|
1617
1797
|
export interface DeployAsApplicationConfiguration {
|
|
1618
1798
|
/**
|
|
1799
|
+
* @public
|
|
1619
1800
|
* <p>The description of an Amazon S3 object that contains the Amazon Data Analytics application, including the Amazon Resource Name (ARN) of the S3 bucket, the name of the Amazon S3 object that contains the data, and the version number of the Amazon S3 object that contains the data.
|
|
1620
1801
|
* </p>
|
|
1621
1802
|
*/
|
|
@@ -1627,6 +1808,7 @@ export interface DeployAsApplicationConfiguration {
|
|
|
1627
1808
|
*/
|
|
1628
1809
|
export interface ZeppelinMonitoringConfiguration {
|
|
1629
1810
|
/**
|
|
1811
|
+
* @public
|
|
1630
1812
|
* <p>The verbosity of the CloudWatch Logs for an application.</p>
|
|
1631
1813
|
*/
|
|
1632
1814
|
LogLevel: LogLevel | string | undefined;
|
|
@@ -1637,18 +1819,22 @@ export interface ZeppelinMonitoringConfiguration {
|
|
|
1637
1819
|
*/
|
|
1638
1820
|
export interface ZeppelinApplicationConfiguration {
|
|
1639
1821
|
/**
|
|
1822
|
+
* @public
|
|
1640
1823
|
* <p>The monitoring configuration of a Kinesis Data Analytics Studio notebook.</p>
|
|
1641
1824
|
*/
|
|
1642
1825
|
MonitoringConfiguration?: ZeppelinMonitoringConfiguration;
|
|
1643
1826
|
/**
|
|
1827
|
+
* @public
|
|
1644
1828
|
* <p>The Amazon Glue Data Catalog that you use in queries in a Kinesis Data Analytics Studio notebook.</p>
|
|
1645
1829
|
*/
|
|
1646
1830
|
CatalogConfiguration?: CatalogConfiguration;
|
|
1647
1831
|
/**
|
|
1832
|
+
* @public
|
|
1648
1833
|
* <p>The information required to deploy a Kinesis Data Analytics Studio notebook as an application with durable state.</p>
|
|
1649
1834
|
*/
|
|
1650
1835
|
DeployAsApplicationConfiguration?: DeployAsApplicationConfiguration;
|
|
1651
1836
|
/**
|
|
1837
|
+
* @public
|
|
1652
1838
|
* <p>Custom artifacts are dependency JARs and user-defined functions (UDF).</p>
|
|
1653
1839
|
*/
|
|
1654
1840
|
CustomArtifactsConfiguration?: CustomArtifactConfiguration[];
|
|
@@ -1659,30 +1845,37 @@ export interface ZeppelinApplicationConfiguration {
|
|
|
1659
1845
|
*/
|
|
1660
1846
|
export interface ApplicationConfiguration {
|
|
1661
1847
|
/**
|
|
1848
|
+
* @public
|
|
1662
1849
|
* <p>The creation and update parameters for a SQL-based Kinesis Data Analytics application.</p>
|
|
1663
1850
|
*/
|
|
1664
1851
|
SqlApplicationConfiguration?: SqlApplicationConfiguration;
|
|
1665
1852
|
/**
|
|
1853
|
+
* @public
|
|
1666
1854
|
* <p>The creation and update parameters for a Flink-based Kinesis Data Analytics application.</p>
|
|
1667
1855
|
*/
|
|
1668
1856
|
FlinkApplicationConfiguration?: FlinkApplicationConfiguration;
|
|
1669
1857
|
/**
|
|
1858
|
+
* @public
|
|
1670
1859
|
* <p>Describes execution properties for a Flink-based Kinesis Data Analytics application.</p>
|
|
1671
1860
|
*/
|
|
1672
1861
|
EnvironmentProperties?: EnvironmentProperties;
|
|
1673
1862
|
/**
|
|
1863
|
+
* @public
|
|
1674
1864
|
* <p>The code location and type parameters for a Flink-based Kinesis Data Analytics application.</p>
|
|
1675
1865
|
*/
|
|
1676
1866
|
ApplicationCodeConfiguration?: ApplicationCodeConfiguration;
|
|
1677
1867
|
/**
|
|
1868
|
+
* @public
|
|
1678
1869
|
* <p>Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.</p>
|
|
1679
1870
|
*/
|
|
1680
1871
|
ApplicationSnapshotConfiguration?: ApplicationSnapshotConfiguration;
|
|
1681
1872
|
/**
|
|
1873
|
+
* @public
|
|
1682
1874
|
* <p>The array of descriptions of VPC configurations available to the application.</p>
|
|
1683
1875
|
*/
|
|
1684
1876
|
VpcConfigurations?: VpcConfiguration[];
|
|
1685
1877
|
/**
|
|
1878
|
+
* @public
|
|
1686
1879
|
* <p>The configuration parameters for a Kinesis Data Analytics Studio notebook.</p>
|
|
1687
1880
|
*/
|
|
1688
1881
|
ZeppelinApplicationConfiguration?: ZeppelinApplicationConfiguration;
|
|
@@ -1693,6 +1886,7 @@ export interface ApplicationConfiguration {
|
|
|
1693
1886
|
*/
|
|
1694
1887
|
export interface ApplicationSnapshotConfigurationDescription {
|
|
1695
1888
|
/**
|
|
1889
|
+
* @public
|
|
1696
1890
|
* <p>Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.</p>
|
|
1697
1891
|
*/
|
|
1698
1892
|
SnapshotsEnabled: boolean | undefined;
|
|
@@ -1703,6 +1897,7 @@ export interface ApplicationSnapshotConfigurationDescription {
|
|
|
1703
1897
|
*/
|
|
1704
1898
|
export interface EnvironmentPropertyDescriptions {
|
|
1705
1899
|
/**
|
|
1900
|
+
* @public
|
|
1706
1901
|
* <p>Describes the execution property groups.</p>
|
|
1707
1902
|
*/
|
|
1708
1903
|
PropertyGroupDescriptions?: PropertyGroup[];
|
|
@@ -1713,6 +1908,7 @@ export interface EnvironmentPropertyDescriptions {
|
|
|
1713
1908
|
*/
|
|
1714
1909
|
export interface CheckpointConfigurationDescription {
|
|
1715
1910
|
/**
|
|
1911
|
+
* @public
|
|
1716
1912
|
* <p>Describes whether the application uses the default checkpointing behavior in Kinesis Data Analytics. </p>
|
|
1717
1913
|
* <note>
|
|
1718
1914
|
* <p>If this value is set to <code>DEFAULT</code>, the application will use the following values,
|
|
@@ -1736,6 +1932,7 @@ export interface CheckpointConfigurationDescription {
|
|
|
1736
1932
|
*/
|
|
1737
1933
|
ConfigurationType?: ConfigurationType | string;
|
|
1738
1934
|
/**
|
|
1935
|
+
* @public
|
|
1739
1936
|
* <p>Describes whether checkpointing is enabled for a Flink-based Kinesis Data Analytics application.</p>
|
|
1740
1937
|
* <note>
|
|
1741
1938
|
* <p>If <code>CheckpointConfiguration.ConfigurationType</code> is <code>DEFAULT</code>,
|
|
@@ -1745,6 +1942,7 @@ export interface CheckpointConfigurationDescription {
|
|
|
1745
1942
|
*/
|
|
1746
1943
|
CheckpointingEnabled?: boolean;
|
|
1747
1944
|
/**
|
|
1945
|
+
* @public
|
|
1748
1946
|
* <p>Describes the interval in milliseconds between checkpoint operations. </p>
|
|
1749
1947
|
* <note>
|
|
1750
1948
|
* <p>If <code>CheckpointConfiguration.ConfigurationType</code> is <code>DEFAULT</code>,
|
|
@@ -1754,6 +1952,7 @@ export interface CheckpointConfigurationDescription {
|
|
|
1754
1952
|
*/
|
|
1755
1953
|
CheckpointInterval?: number;
|
|
1756
1954
|
/**
|
|
1955
|
+
* @public
|
|
1757
1956
|
* <p>Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation
|
|
1758
1957
|
* can start. </p>
|
|
1759
1958
|
* <note>
|
|
@@ -1770,14 +1969,17 @@ export interface CheckpointConfigurationDescription {
|
|
|
1770
1969
|
*/
|
|
1771
1970
|
export interface MonitoringConfigurationDescription {
|
|
1772
1971
|
/**
|
|
1972
|
+
* @public
|
|
1773
1973
|
* <p>Describes whether to use the default CloudWatch logging configuration for an application.</p>
|
|
1774
1974
|
*/
|
|
1775
1975
|
ConfigurationType?: ConfigurationType | string;
|
|
1776
1976
|
/**
|
|
1977
|
+
* @public
|
|
1777
1978
|
* <p>Describes the granularity of the CloudWatch Logs for an application.</p>
|
|
1778
1979
|
*/
|
|
1779
1980
|
MetricsLevel?: MetricsLevel | string;
|
|
1780
1981
|
/**
|
|
1982
|
+
* @public
|
|
1781
1983
|
* <p>Describes the verbosity of the CloudWatch Logs for an application.</p>
|
|
1782
1984
|
*/
|
|
1783
1985
|
LogLevel?: LogLevel | string;
|
|
@@ -1789,10 +1991,12 @@ export interface MonitoringConfigurationDescription {
|
|
|
1789
1991
|
*/
|
|
1790
1992
|
export interface ParallelismConfigurationDescription {
|
|
1791
1993
|
/**
|
|
1994
|
+
* @public
|
|
1792
1995
|
* <p>Describes whether the application uses the default parallelism for the Kinesis Data Analytics service. </p>
|
|
1793
1996
|
*/
|
|
1794
1997
|
ConfigurationType?: ConfigurationType | string;
|
|
1795
1998
|
/**
|
|
1999
|
+
* @public
|
|
1796
2000
|
* <p>Describes the initial number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform.
|
|
1797
2001
|
* If <code>AutoScalingEnabled</code> is set to True, then Kinesis Data Analytics can increase the <code>CurrentParallelism</code> value in response to application
|
|
1798
2002
|
* load. The service can increase <code>CurrentParallelism</code> up to the maximum parallelism, which is <code>ParalellismPerKPU</code> times the maximum KPUs for the application.
|
|
@@ -1801,11 +2005,13 @@ export interface ParallelismConfigurationDescription {
|
|
|
1801
2005
|
*/
|
|
1802
2006
|
Parallelism?: number;
|
|
1803
2007
|
/**
|
|
2008
|
+
* @public
|
|
1804
2009
|
* <p>Describes the number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform per
|
|
1805
2010
|
* Kinesis Processing Unit (KPU) used by the application.</p>
|
|
1806
2011
|
*/
|
|
1807
2012
|
ParallelismPerKPU?: number;
|
|
1808
2013
|
/**
|
|
2014
|
+
* @public
|
|
1809
2015
|
* <p>Describes the current number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform.
|
|
1810
2016
|
* If <code>AutoScalingEnabled</code> is set to True, Kinesis Data Analytics can increase this value in response to application
|
|
1811
2017
|
* load. The service can increase this value up to the maximum parallelism, which is <code>ParalellismPerKPU</code> times the maximum KPUs for the application.
|
|
@@ -1814,6 +2020,7 @@ export interface ParallelismConfigurationDescription {
|
|
|
1814
2020
|
*/
|
|
1815
2021
|
CurrentParallelism?: number;
|
|
1816
2022
|
/**
|
|
2023
|
+
* @public
|
|
1817
2024
|
* <p>Describes whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput.</p>
|
|
1818
2025
|
*/
|
|
1819
2026
|
AutoScalingEnabled?: boolean;
|
|
@@ -1824,20 +2031,24 @@ export interface ParallelismConfigurationDescription {
|
|
|
1824
2031
|
*/
|
|
1825
2032
|
export interface FlinkApplicationConfigurationDescription {
|
|
1826
2033
|
/**
|
|
2034
|
+
* @public
|
|
1827
2035
|
* <p>Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state
|
|
1828
2036
|
* for fault tolerance.</p>
|
|
1829
2037
|
*/
|
|
1830
2038
|
CheckpointConfigurationDescription?: CheckpointConfigurationDescription;
|
|
1831
2039
|
/**
|
|
2040
|
+
* @public
|
|
1832
2041
|
* <p>Describes configuration parameters for Amazon CloudWatch logging for an
|
|
1833
2042
|
* application.</p>
|
|
1834
2043
|
*/
|
|
1835
2044
|
MonitoringConfigurationDescription?: MonitoringConfigurationDescription;
|
|
1836
2045
|
/**
|
|
2046
|
+
* @public
|
|
1837
2047
|
* <p>Describes parameters for how an application executes multiple tasks simultaneously.</p>
|
|
1838
2048
|
*/
|
|
1839
2049
|
ParallelismConfigurationDescription?: ParallelismConfigurationDescription;
|
|
1840
2050
|
/**
|
|
2051
|
+
* @public
|
|
1841
2052
|
* <p>The job plan for an application. For more information about the job plan, see <a href="https://ci.apache.org/projects/flink/flink-docs-release-1.8/internals/job_scheduling.html">Jobs and Scheduling</a> in the <a href="https://ci.apache.org/projects/flink/flink-docs-release-1.8/">Apache Flink
|
|
1842
2053
|
* Documentation</a>. To retrieve the job plan for the application, use the <a>DescribeApplicationRequest$IncludeAdditionalDetails</a> parameter of the <a>DescribeApplication</a> operation.</p>
|
|
1843
2054
|
*/
|
|
@@ -1862,10 +2073,12 @@ export type ApplicationRestoreType = (typeof ApplicationRestoreType)[keyof typeo
|
|
|
1862
2073
|
*/
|
|
1863
2074
|
export interface ApplicationRestoreConfiguration {
|
|
1864
2075
|
/**
|
|
2076
|
+
* @public
|
|
1865
2077
|
* <p>Specifies how the application should be restored.</p>
|
|
1866
2078
|
*/
|
|
1867
2079
|
ApplicationRestoreType: ApplicationRestoreType | string | undefined;
|
|
1868
2080
|
/**
|
|
2081
|
+
* @public
|
|
1869
2082
|
* <p>The identifier of an existing snapshot of application state to use to restart an application.
|
|
1870
2083
|
* The application uses this value if <code>RESTORE_FROM_CUSTOM_SNAPSHOT</code> is specified for the
|
|
1871
2084
|
* <code>ApplicationRestoreType</code>.</p>
|
|
@@ -1878,6 +2091,7 @@ export interface ApplicationRestoreConfiguration {
|
|
|
1878
2091
|
*/
|
|
1879
2092
|
export interface FlinkRunConfiguration {
|
|
1880
2093
|
/**
|
|
2094
|
+
* @public
|
|
1881
2095
|
* <p>When restoring from a snapshot, specifies whether the runtime is allowed to skip a state that cannot
|
|
1882
2096
|
* be mapped to the new program.
|
|
1883
2097
|
* This will happen if the program is updated between snapshots to remove stateful parameters, and
|
|
@@ -1900,10 +2114,12 @@ export interface FlinkRunConfiguration {
|
|
|
1900
2114
|
*/
|
|
1901
2115
|
export interface RunConfigurationDescription {
|
|
1902
2116
|
/**
|
|
2117
|
+
* @public
|
|
1903
2118
|
* <p>Describes the restore behavior of a restarting application.</p>
|
|
1904
2119
|
*/
|
|
1905
2120
|
ApplicationRestoreConfigurationDescription?: ApplicationRestoreConfiguration;
|
|
1906
2121
|
/**
|
|
2122
|
+
* @public
|
|
1907
2123
|
* <p>Describes the starting parameters for a Flink-based Kinesis Data Analytics application.</p>
|
|
1908
2124
|
*/
|
|
1909
2125
|
FlinkRunConfigurationDescription?: FlinkRunConfiguration;
|
|
@@ -1914,16 +2130,19 @@ export interface RunConfigurationDescription {
|
|
|
1914
2130
|
*/
|
|
1915
2131
|
export interface SqlApplicationConfigurationDescription {
|
|
1916
2132
|
/**
|
|
2133
|
+
* @public
|
|
1917
2134
|
* <p>The array of <a>InputDescription</a> objects describing the input streams used
|
|
1918
2135
|
* by the application.</p>
|
|
1919
2136
|
*/
|
|
1920
2137
|
InputDescriptions?: InputDescription[];
|
|
1921
2138
|
/**
|
|
2139
|
+
* @public
|
|
1922
2140
|
* <p>The array of <a>OutputDescription</a> objects describing the destination
|
|
1923
2141
|
* streams used by the application.</p>
|
|
1924
2142
|
*/
|
|
1925
2143
|
OutputDescriptions?: OutputDescription[];
|
|
1926
2144
|
/**
|
|
2145
|
+
* @public
|
|
1927
2146
|
* <p>The array of <a>ReferenceDataSourceDescription</a> objects describing the
|
|
1928
2147
|
* reference data sources used by the application.</p>
|
|
1929
2148
|
*/
|
|
@@ -1935,6 +2154,7 @@ export interface SqlApplicationConfigurationDescription {
|
|
|
1935
2154
|
*/
|
|
1936
2155
|
export interface GlueDataCatalogConfigurationDescription {
|
|
1937
2156
|
/**
|
|
2157
|
+
* @public
|
|
1938
2158
|
* <p>The Amazon Resource Name (ARN) of the database.</p>
|
|
1939
2159
|
*/
|
|
1940
2160
|
DatabaseARN: string | undefined;
|
|
@@ -1945,6 +2165,7 @@ export interface GlueDataCatalogConfigurationDescription {
|
|
|
1945
2165
|
*/
|
|
1946
2166
|
export interface CatalogConfigurationDescription {
|
|
1947
2167
|
/**
|
|
2168
|
+
* @public
|
|
1948
2169
|
* <p>The configuration parameters for the default Amazon Glue database. You use this database for SQL queries that you write in a Kinesis Data Analytics Studio notebook.</p>
|
|
1949
2170
|
*/
|
|
1950
2171
|
GlueDataCatalogConfigurationDescription: GlueDataCatalogConfigurationDescription | undefined;
|
|
@@ -1955,11 +2176,13 @@ export interface CatalogConfigurationDescription {
|
|
|
1955
2176
|
*/
|
|
1956
2177
|
export interface CustomArtifactConfigurationDescription {
|
|
1957
2178
|
/**
|
|
2179
|
+
* @public
|
|
1958
2180
|
* <p>
|
|
1959
2181
|
* <code>UDF</code> stands for user-defined functions. This type of artifact must be in an S3 bucket. A <code>DEPENDENCY_JAR</code> can be in either Maven or an S3 bucket.</p>
|
|
1960
2182
|
*/
|
|
1961
2183
|
ArtifactType?: ArtifactType | string;
|
|
1962
2184
|
/**
|
|
2185
|
+
* @public
|
|
1963
2186
|
* <p>For a Kinesis Data Analytics application provides a
|
|
1964
2187
|
* description of an Amazon S3 object, including the Amazon Resource Name (ARN) of the S3 bucket,
|
|
1965
2188
|
* the name of the Amazon S3 object that contains the data, and the version number of the Amazon
|
|
@@ -1967,6 +2190,7 @@ export interface CustomArtifactConfigurationDescription {
|
|
|
1967
2190
|
*/
|
|
1968
2191
|
S3ContentLocationDescription?: S3ContentLocation;
|
|
1969
2192
|
/**
|
|
2193
|
+
* @public
|
|
1970
2194
|
* <p>The parameters that are required to specify a Maven dependency.</p>
|
|
1971
2195
|
*/
|
|
1972
2196
|
MavenReferenceDescription?: MavenReference;
|
|
@@ -1977,10 +2201,12 @@ export interface CustomArtifactConfigurationDescription {
|
|
|
1977
2201
|
*/
|
|
1978
2202
|
export interface S3ContentBaseLocationDescription {
|
|
1979
2203
|
/**
|
|
2204
|
+
* @public
|
|
1980
2205
|
* <p>The Amazon Resource Name (ARN) of the S3 bucket.</p>
|
|
1981
2206
|
*/
|
|
1982
2207
|
BucketARN: string | undefined;
|
|
1983
2208
|
/**
|
|
2209
|
+
* @public
|
|
1984
2210
|
* <p>The base path for the S3 bucket.</p>
|
|
1985
2211
|
*/
|
|
1986
2212
|
BasePath?: string;
|
|
@@ -1991,6 +2217,7 @@ export interface S3ContentBaseLocationDescription {
|
|
|
1991
2217
|
*/
|
|
1992
2218
|
export interface DeployAsApplicationConfigurationDescription {
|
|
1993
2219
|
/**
|
|
2220
|
+
* @public
|
|
1994
2221
|
* <p>The location that holds the data required to specify an Amazon Data Analytics application.</p>
|
|
1995
2222
|
*/
|
|
1996
2223
|
S3ContentLocationDescription: S3ContentBaseLocationDescription | undefined;
|
|
@@ -2001,6 +2228,7 @@ export interface DeployAsApplicationConfigurationDescription {
|
|
|
2001
2228
|
*/
|
|
2002
2229
|
export interface ZeppelinMonitoringConfigurationDescription {
|
|
2003
2230
|
/**
|
|
2231
|
+
* @public
|
|
2004
2232
|
* <p>Describes the verbosity of the CloudWatch Logs for an application.</p>
|
|
2005
2233
|
*/
|
|
2006
2234
|
LogLevel?: LogLevel | string;
|
|
@@ -2011,18 +2239,22 @@ export interface ZeppelinMonitoringConfigurationDescription {
|
|
|
2011
2239
|
*/
|
|
2012
2240
|
export interface ZeppelinApplicationConfigurationDescription {
|
|
2013
2241
|
/**
|
|
2242
|
+
* @public
|
|
2014
2243
|
* <p>The monitoring configuration of a Kinesis Data Analytics Studio notebook.</p>
|
|
2015
2244
|
*/
|
|
2016
2245
|
MonitoringConfigurationDescription: ZeppelinMonitoringConfigurationDescription | undefined;
|
|
2017
2246
|
/**
|
|
2247
|
+
* @public
|
|
2018
2248
|
* <p>The Amazon Glue Data Catalog that is associated with the Kinesis Data Analytics Studio notebook.</p>
|
|
2019
2249
|
*/
|
|
2020
2250
|
CatalogConfigurationDescription?: CatalogConfigurationDescription;
|
|
2021
2251
|
/**
|
|
2252
|
+
* @public
|
|
2022
2253
|
* <p>The parameters required to deploy a Kinesis Data Analytics Studio notebook as an application with durable state.</p>
|
|
2023
2254
|
*/
|
|
2024
2255
|
DeployAsApplicationConfigurationDescription?: DeployAsApplicationConfigurationDescription;
|
|
2025
2256
|
/**
|
|
2257
|
+
* @public
|
|
2026
2258
|
* <p>Custom artifacts are dependency JARs and user-defined functions (UDF).</p>
|
|
2027
2259
|
*/
|
|
2028
2260
|
CustomArtifactsConfigurationDescription?: CustomArtifactConfigurationDescription[];
|
|
@@ -2033,34 +2265,42 @@ export interface ZeppelinApplicationConfigurationDescription {
|
|
|
2033
2265
|
*/
|
|
2034
2266
|
export interface ApplicationConfigurationDescription {
|
|
2035
2267
|
/**
|
|
2268
|
+
* @public
|
|
2036
2269
|
* <p>The details about inputs, outputs, and reference data sources for a SQL-based Kinesis Data Analytics application.</p>
|
|
2037
2270
|
*/
|
|
2038
2271
|
SqlApplicationConfigurationDescription?: SqlApplicationConfigurationDescription;
|
|
2039
2272
|
/**
|
|
2273
|
+
* @public
|
|
2040
2274
|
* <p>The details about the application code for a Flink-based Kinesis Data Analytics application.</p>
|
|
2041
2275
|
*/
|
|
2042
2276
|
ApplicationCodeConfigurationDescription?: ApplicationCodeConfigurationDescription;
|
|
2043
2277
|
/**
|
|
2278
|
+
* @public
|
|
2044
2279
|
* <p>The details about the starting properties for a Kinesis Data Analytics application.</p>
|
|
2045
2280
|
*/
|
|
2046
2281
|
RunConfigurationDescription?: RunConfigurationDescription;
|
|
2047
2282
|
/**
|
|
2283
|
+
* @public
|
|
2048
2284
|
* <p>The details about a Flink-based Kinesis Data Analytics application.</p>
|
|
2049
2285
|
*/
|
|
2050
2286
|
FlinkApplicationConfigurationDescription?: FlinkApplicationConfigurationDescription;
|
|
2051
2287
|
/**
|
|
2288
|
+
* @public
|
|
2052
2289
|
* <p>Describes execution properties for a Flink-based Kinesis Data Analytics application.</p>
|
|
2053
2290
|
*/
|
|
2054
2291
|
EnvironmentPropertyDescriptions?: EnvironmentPropertyDescriptions;
|
|
2055
2292
|
/**
|
|
2293
|
+
* @public
|
|
2056
2294
|
* <p>Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.</p>
|
|
2057
2295
|
*/
|
|
2058
2296
|
ApplicationSnapshotConfigurationDescription?: ApplicationSnapshotConfigurationDescription;
|
|
2059
2297
|
/**
|
|
2298
|
+
* @public
|
|
2060
2299
|
* <p>The array of descriptions of VPC configurations available to the application.</p>
|
|
2061
2300
|
*/
|
|
2062
2301
|
VpcConfigurationDescriptions?: VpcConfigurationDescription[];
|
|
2063
2302
|
/**
|
|
2303
|
+
* @public
|
|
2064
2304
|
* <p>The configuration parameters for a Kinesis Data Analytics Studio notebook.</p>
|
|
2065
2305
|
*/
|
|
2066
2306
|
ZeppelinApplicationConfigurationDescription?: ZeppelinApplicationConfigurationDescription;
|
|
@@ -2071,6 +2311,7 @@ export interface ApplicationConfigurationDescription {
|
|
|
2071
2311
|
*/
|
|
2072
2312
|
export interface ApplicationSnapshotConfigurationUpdate {
|
|
2073
2313
|
/**
|
|
2314
|
+
* @public
|
|
2074
2315
|
* <p>Describes updates to whether snapshots are enabled for an application.</p>
|
|
2075
2316
|
*/
|
|
2076
2317
|
SnapshotsEnabledUpdate: boolean | undefined;
|
|
@@ -2081,6 +2322,7 @@ export interface ApplicationSnapshotConfigurationUpdate {
|
|
|
2081
2322
|
*/
|
|
2082
2323
|
export interface EnvironmentPropertyUpdates {
|
|
2083
2324
|
/**
|
|
2325
|
+
* @public
|
|
2084
2326
|
* <p>Describes updates to the execution property groups.</p>
|
|
2085
2327
|
*/
|
|
2086
2328
|
PropertyGroups: PropertyGroup[] | undefined;
|
|
@@ -2091,6 +2333,7 @@ export interface EnvironmentPropertyUpdates {
|
|
|
2091
2333
|
*/
|
|
2092
2334
|
export interface CheckpointConfigurationUpdate {
|
|
2093
2335
|
/**
|
|
2336
|
+
* @public
|
|
2094
2337
|
* <p>Describes updates to whether the application uses the default checkpointing behavior of
|
|
2095
2338
|
* Kinesis Data Analytics. You must set this property to <code>CUSTOM</code> in order to set the
|
|
2096
2339
|
* <code>CheckpointingEnabled</code>, <code>CheckpointInterval</code>, or <code>MinPauseBetweenCheckpoints</code> parameters.
|
|
@@ -2117,6 +2360,7 @@ export interface CheckpointConfigurationUpdate {
|
|
|
2117
2360
|
*/
|
|
2118
2361
|
ConfigurationTypeUpdate?: ConfigurationType | string;
|
|
2119
2362
|
/**
|
|
2363
|
+
* @public
|
|
2120
2364
|
* <p>Describes updates to whether checkpointing is enabled for an application.</p>
|
|
2121
2365
|
* <note>
|
|
2122
2366
|
* <p>If <code>CheckpointConfiguration.ConfigurationType</code> is <code>DEFAULT</code>,
|
|
@@ -2126,6 +2370,7 @@ export interface CheckpointConfigurationUpdate {
|
|
|
2126
2370
|
*/
|
|
2127
2371
|
CheckpointingEnabledUpdate?: boolean;
|
|
2128
2372
|
/**
|
|
2373
|
+
* @public
|
|
2129
2374
|
* <p>Describes updates to the interval in milliseconds between checkpoint operations.</p>
|
|
2130
2375
|
* <note>
|
|
2131
2376
|
* <p>If <code>CheckpointConfiguration.ConfigurationType</code> is <code>DEFAULT</code>,
|
|
@@ -2135,6 +2380,7 @@ export interface CheckpointConfigurationUpdate {
|
|
|
2135
2380
|
*/
|
|
2136
2381
|
CheckpointIntervalUpdate?: number;
|
|
2137
2382
|
/**
|
|
2383
|
+
* @public
|
|
2138
2384
|
* <p>Describes updates to the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation
|
|
2139
2385
|
* can start.</p>
|
|
2140
2386
|
* <note>
|
|
@@ -2151,17 +2397,20 @@ export interface CheckpointConfigurationUpdate {
|
|
|
2151
2397
|
*/
|
|
2152
2398
|
export interface MonitoringConfigurationUpdate {
|
|
2153
2399
|
/**
|
|
2400
|
+
* @public
|
|
2154
2401
|
* <p>Describes updates to whether to use the default CloudWatch logging configuration for
|
|
2155
2402
|
* an application. You must set this property to <code>CUSTOM</code> in order to set the <code>LogLevel</code> or
|
|
2156
2403
|
* <code>MetricsLevel</code> parameters.</p>
|
|
2157
2404
|
*/
|
|
2158
2405
|
ConfigurationTypeUpdate?: ConfigurationType | string;
|
|
2159
2406
|
/**
|
|
2407
|
+
* @public
|
|
2160
2408
|
* <p>Describes updates to the granularity of the CloudWatch Logs for an application. The <code>Parallelism</code>
|
|
2161
2409
|
* level is not recommended for applications with a Parallelism over 64 due to excessive costs.</p>
|
|
2162
2410
|
*/
|
|
2163
2411
|
MetricsLevelUpdate?: MetricsLevel | string;
|
|
2164
2412
|
/**
|
|
2413
|
+
* @public
|
|
2165
2414
|
* <p>Describes updates to the verbosity of the CloudWatch Logs for an application.</p>
|
|
2166
2415
|
*/
|
|
2167
2416
|
LogLevelUpdate?: LogLevel | string;
|
|
@@ -2172,12 +2421,14 @@ export interface MonitoringConfigurationUpdate {
|
|
|
2172
2421
|
*/
|
|
2173
2422
|
export interface ParallelismConfigurationUpdate {
|
|
2174
2423
|
/**
|
|
2424
|
+
* @public
|
|
2175
2425
|
* <p>Describes updates to whether the application uses the default parallelism for the Kinesis Data Analytics service, or if a custom parallelism is used.
|
|
2176
2426
|
* You must set this property to <code>CUSTOM</code>
|
|
2177
2427
|
* in order to change your application's <code>AutoScalingEnabled</code>, <code>Parallelism</code>, or <code>ParallelismPerKPU</code> properties.</p>
|
|
2178
2428
|
*/
|
|
2179
2429
|
ConfigurationTypeUpdate?: ConfigurationType | string;
|
|
2180
2430
|
/**
|
|
2431
|
+
* @public
|
|
2181
2432
|
* <p>Describes updates to the initial number of parallel tasks an application can perform. If <code>AutoScalingEnabled</code> is set to True, then
|
|
2182
2433
|
* Kinesis Data Analytics can increase the <code>CurrentParallelism</code> value in response to application
|
|
2183
2434
|
* load. The service can increase <code>CurrentParallelism</code> up to the maximum parallelism, which is <code>ParalellismPerKPU</code> times the maximum KPUs for the application.
|
|
@@ -2186,10 +2437,12 @@ export interface ParallelismConfigurationUpdate {
|
|
|
2186
2437
|
*/
|
|
2187
2438
|
ParallelismUpdate?: number;
|
|
2188
2439
|
/**
|
|
2440
|
+
* @public
|
|
2189
2441
|
* <p>Describes updates to the number of parallel tasks an application can perform per Kinesis Processing Unit (KPU) used by the application.</p>
|
|
2190
2442
|
*/
|
|
2191
2443
|
ParallelismPerKPUUpdate?: number;
|
|
2192
2444
|
/**
|
|
2445
|
+
* @public
|
|
2193
2446
|
* <p>Describes updates to whether the Kinesis Data Analytics service can increase the parallelism of a Flink-based Kinesis Data Analytics application in response to increased throughput.</p>
|
|
2194
2447
|
*/
|
|
2195
2448
|
AutoScalingEnabledUpdate?: boolean;
|
|
@@ -2200,16 +2453,19 @@ export interface ParallelismConfigurationUpdate {
|
|
|
2200
2453
|
*/
|
|
2201
2454
|
export interface FlinkApplicationConfigurationUpdate {
|
|
2202
2455
|
/**
|
|
2456
|
+
* @public
|
|
2203
2457
|
* <p>Describes updates to an application's checkpointing configuration. Checkpointing is the process of persisting
|
|
2204
2458
|
* application state for fault tolerance.</p>
|
|
2205
2459
|
*/
|
|
2206
2460
|
CheckpointConfigurationUpdate?: CheckpointConfigurationUpdate;
|
|
2207
2461
|
/**
|
|
2462
|
+
* @public
|
|
2208
2463
|
* <p>Describes updates to the configuration parameters for Amazon CloudWatch logging for an
|
|
2209
2464
|
* application.</p>
|
|
2210
2465
|
*/
|
|
2211
2466
|
MonitoringConfigurationUpdate?: MonitoringConfigurationUpdate;
|
|
2212
2467
|
/**
|
|
2468
|
+
* @public
|
|
2213
2469
|
* <p>Describes updates to the parameters for how an application executes multiple tasks simultaneously.</p>
|
|
2214
2470
|
*/
|
|
2215
2471
|
ParallelismConfigurationUpdate?: ParallelismConfigurationUpdate;
|
|
@@ -2221,6 +2477,7 @@ export interface FlinkApplicationConfigurationUpdate {
|
|
|
2221
2477
|
*/
|
|
2222
2478
|
export interface InputParallelismUpdate {
|
|
2223
2479
|
/**
|
|
2480
|
+
* @public
|
|
2224
2481
|
* <p>The number of in-application streams to create for the specified streaming source.</p>
|
|
2225
2482
|
*/
|
|
2226
2483
|
CountUpdate: number | undefined;
|
|
@@ -2233,6 +2490,7 @@ export interface InputParallelismUpdate {
|
|
|
2233
2490
|
*/
|
|
2234
2491
|
export interface InputLambdaProcessorUpdate {
|
|
2235
2492
|
/**
|
|
2493
|
+
* @public
|
|
2236
2494
|
* <p>The Amazon Resource Name (ARN) of the new Amazon Lambda function that is used to preprocess
|
|
2237
2495
|
* the records in the stream.</p>
|
|
2238
2496
|
* <note>
|
|
@@ -2248,6 +2506,7 @@ export interface InputLambdaProcessorUpdate {
|
|
|
2248
2506
|
*/
|
|
2249
2507
|
export interface InputProcessingConfigurationUpdate {
|
|
2250
2508
|
/**
|
|
2509
|
+
* @public
|
|
2251
2510
|
* <p>Provides update information for an <a>InputLambdaProcessor</a>.</p>
|
|
2252
2511
|
*/
|
|
2253
2512
|
InputLambdaProcessorUpdate: InputLambdaProcessorUpdate | undefined;
|
|
@@ -2259,14 +2518,17 @@ export interface InputProcessingConfigurationUpdate {
|
|
|
2259
2518
|
*/
|
|
2260
2519
|
export interface InputSchemaUpdate {
|
|
2261
2520
|
/**
|
|
2521
|
+
* @public
|
|
2262
2522
|
* <p>Specifies the format of the records on the streaming source.</p>
|
|
2263
2523
|
*/
|
|
2264
2524
|
RecordFormatUpdate?: RecordFormat;
|
|
2265
2525
|
/**
|
|
2526
|
+
* @public
|
|
2266
2527
|
* <p>Specifies the encoding of the records in the streaming source; for example, UTF-8.</p>
|
|
2267
2528
|
*/
|
|
2268
2529
|
RecordEncodingUpdate?: string;
|
|
2269
2530
|
/**
|
|
2531
|
+
* @public
|
|
2270
2532
|
* <p>A list of <code>RecordColumn</code> objects. Each object describes the mapping
|
|
2271
2533
|
* of the streaming source element to the corresponding column in the in-application stream.</p>
|
|
2272
2534
|
*/
|
|
@@ -2280,6 +2542,7 @@ export interface InputSchemaUpdate {
|
|
|
2280
2542
|
*/
|
|
2281
2543
|
export interface KinesisFirehoseInputUpdate {
|
|
2282
2544
|
/**
|
|
2545
|
+
* @public
|
|
2283
2546
|
* <p>The Amazon Resource Name (ARN) of the input delivery stream to read.</p>
|
|
2284
2547
|
*/
|
|
2285
2548
|
ResourceARNUpdate: string | undefined;
|
|
@@ -2292,6 +2555,7 @@ export interface KinesisFirehoseInputUpdate {
|
|
|
2292
2555
|
*/
|
|
2293
2556
|
export interface KinesisStreamsInputUpdate {
|
|
2294
2557
|
/**
|
|
2558
|
+
* @public
|
|
2295
2559
|
* <p>The Amazon Resource Name (ARN) of the input Kinesis data stream to read.</p>
|
|
2296
2560
|
*/
|
|
2297
2561
|
ResourceARNUpdate: string | undefined;
|
|
@@ -2303,34 +2567,41 @@ export interface KinesisStreamsInputUpdate {
|
|
|
2303
2567
|
*/
|
|
2304
2568
|
export interface InputUpdate {
|
|
2305
2569
|
/**
|
|
2570
|
+
* @public
|
|
2306
2571
|
* <p>The input ID of the application input to be updated.</p>
|
|
2307
2572
|
*/
|
|
2308
2573
|
InputId: string | undefined;
|
|
2309
2574
|
/**
|
|
2575
|
+
* @public
|
|
2310
2576
|
* <p>The name prefix for in-application streams that Kinesis Data Analytics creates for the
|
|
2311
2577
|
* specific streaming source.</p>
|
|
2312
2578
|
*/
|
|
2313
2579
|
NamePrefixUpdate?: string;
|
|
2314
2580
|
/**
|
|
2581
|
+
* @public
|
|
2315
2582
|
* <p>Describes updates to an <a>InputProcessingConfiguration</a>.</p>
|
|
2316
2583
|
*/
|
|
2317
2584
|
InputProcessingConfigurationUpdate?: InputProcessingConfigurationUpdate;
|
|
2318
2585
|
/**
|
|
2586
|
+
* @public
|
|
2319
2587
|
* <p>If a Kinesis data stream is the streaming source to be updated, provides an
|
|
2320
2588
|
* updated stream Amazon Resource Name (ARN).</p>
|
|
2321
2589
|
*/
|
|
2322
2590
|
KinesisStreamsInputUpdate?: KinesisStreamsInputUpdate;
|
|
2323
2591
|
/**
|
|
2592
|
+
* @public
|
|
2324
2593
|
* <p>If a Kinesis Data Firehose delivery stream is the streaming source to be
|
|
2325
2594
|
* updated, provides an updated stream ARN.</p>
|
|
2326
2595
|
*/
|
|
2327
2596
|
KinesisFirehoseInputUpdate?: KinesisFirehoseInputUpdate;
|
|
2328
2597
|
/**
|
|
2598
|
+
* @public
|
|
2329
2599
|
* <p>Describes the data format on the streaming source, and
|
|
2330
2600
|
* how record elements on the streaming source map to columns of the in-application stream that is created.</p>
|
|
2331
2601
|
*/
|
|
2332
2602
|
InputSchemaUpdate?: InputSchemaUpdate;
|
|
2333
2603
|
/**
|
|
2604
|
+
* @public
|
|
2334
2605
|
* <p>Describes the parallelism updates (the number of in-application streams Kinesis Data Analytics creates for the specific streaming source).</p>
|
|
2335
2606
|
*/
|
|
2336
2607
|
InputParallelismUpdate?: InputParallelismUpdate;
|
|
@@ -2343,6 +2614,7 @@ export interface InputUpdate {
|
|
|
2343
2614
|
*/
|
|
2344
2615
|
export interface KinesisFirehoseOutputUpdate {
|
|
2345
2616
|
/**
|
|
2617
|
+
* @public
|
|
2346
2618
|
* <p>The Amazon Resource Name (ARN) of the delivery stream to write to. </p>
|
|
2347
2619
|
*/
|
|
2348
2620
|
ResourceARNUpdate: string | undefined;
|
|
@@ -2355,6 +2627,7 @@ export interface KinesisFirehoseOutputUpdate {
|
|
|
2355
2627
|
*/
|
|
2356
2628
|
export interface KinesisStreamsOutputUpdate {
|
|
2357
2629
|
/**
|
|
2630
|
+
* @public
|
|
2358
2631
|
* <p>The Amazon Resource Name (ARN) of the Kinesis data stream where you want to write the
|
|
2359
2632
|
* output.</p>
|
|
2360
2633
|
*/
|
|
@@ -2368,6 +2641,7 @@ export interface KinesisStreamsOutputUpdate {
|
|
|
2368
2641
|
*/
|
|
2369
2642
|
export interface LambdaOutputUpdate {
|
|
2370
2643
|
/**
|
|
2644
|
+
* @public
|
|
2371
2645
|
* <p>The Amazon Resource Name (ARN) of the destination Amazon Lambda function.</p>
|
|
2372
2646
|
* <note>
|
|
2373
2647
|
* <p>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 <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-lambda">Example ARNs: Amazon Lambda</a>
|
|
@@ -2383,29 +2657,35 @@ export interface LambdaOutputUpdate {
|
|
|
2383
2657
|
*/
|
|
2384
2658
|
export interface OutputUpdate {
|
|
2385
2659
|
/**
|
|
2660
|
+
* @public
|
|
2386
2661
|
* <p>Identifies the specific output configuration that you want to update.</p>
|
|
2387
2662
|
*/
|
|
2388
2663
|
OutputId: string | undefined;
|
|
2389
2664
|
/**
|
|
2665
|
+
* @public
|
|
2390
2666
|
* <p>If you want to specify a different in-application stream
|
|
2391
2667
|
* for this output configuration, use this field to
|
|
2392
2668
|
* specify the new in-application stream name.</p>
|
|
2393
2669
|
*/
|
|
2394
2670
|
NameUpdate?: string;
|
|
2395
2671
|
/**
|
|
2672
|
+
* @public
|
|
2396
2673
|
* <p>Describes a Kinesis data stream as the destination for the output.</p>
|
|
2397
2674
|
*/
|
|
2398
2675
|
KinesisStreamsOutputUpdate?: KinesisStreamsOutputUpdate;
|
|
2399
2676
|
/**
|
|
2677
|
+
* @public
|
|
2400
2678
|
* <p>Describes a Kinesis Data Firehose delivery stream as the destination for the
|
|
2401
2679
|
* output.</p>
|
|
2402
2680
|
*/
|
|
2403
2681
|
KinesisFirehoseOutputUpdate?: KinesisFirehoseOutputUpdate;
|
|
2404
2682
|
/**
|
|
2683
|
+
* @public
|
|
2405
2684
|
* <p>Describes an Amazon Lambda function as the destination for the output.</p>
|
|
2406
2685
|
*/
|
|
2407
2686
|
LambdaOutputUpdate?: LambdaOutputUpdate;
|
|
2408
2687
|
/**
|
|
2688
|
+
* @public
|
|
2409
2689
|
* <p>Describes the data format when records are written to the destination.
|
|
2410
2690
|
* </p>
|
|
2411
2691
|
*/
|
|
@@ -2418,10 +2698,12 @@ export interface OutputUpdate {
|
|
|
2418
2698
|
*/
|
|
2419
2699
|
export interface S3ReferenceDataSourceUpdate {
|
|
2420
2700
|
/**
|
|
2701
|
+
* @public
|
|
2421
2702
|
* <p>The Amazon Resource Name (ARN) of the S3 bucket.</p>
|
|
2422
2703
|
*/
|
|
2423
2704
|
BucketARNUpdate?: string;
|
|
2424
2705
|
/**
|
|
2706
|
+
* @public
|
|
2425
2707
|
* <p>The object key name.</p>
|
|
2426
2708
|
*/
|
|
2427
2709
|
FileKeyUpdate?: string;
|
|
@@ -2436,19 +2718,23 @@ export interface S3ReferenceDataSourceUpdate {
|
|
|
2436
2718
|
*/
|
|
2437
2719
|
export interface ReferenceDataSourceUpdate {
|
|
2438
2720
|
/**
|
|
2721
|
+
* @public
|
|
2439
2722
|
* <p>The ID of the reference data source that is being updated. You can use the <a>DescribeApplication</a> operation to get this value.</p>
|
|
2440
2723
|
*/
|
|
2441
2724
|
ReferenceId: string | undefined;
|
|
2442
2725
|
/**
|
|
2726
|
+
* @public
|
|
2443
2727
|
* <p>The in-application table name that is created by this update.</p>
|
|
2444
2728
|
*/
|
|
2445
2729
|
TableNameUpdate?: string;
|
|
2446
2730
|
/**
|
|
2731
|
+
* @public
|
|
2447
2732
|
* <p>Describes the S3 bucket name, object key name, and IAM role that Kinesis Data Analytics can assume to read the
|
|
2448
2733
|
* Amazon S3 object on your behalf and populate the in-application reference table.</p>
|
|
2449
2734
|
*/
|
|
2450
2735
|
S3ReferenceDataSourceUpdate?: S3ReferenceDataSourceUpdate;
|
|
2451
2736
|
/**
|
|
2737
|
+
* @public
|
|
2452
2738
|
* <p>Describes the format of the data in the streaming source, and how each data element maps to
|
|
2453
2739
|
* corresponding columns created in the in-application stream. </p>
|
|
2454
2740
|
*/
|
|
@@ -2461,16 +2747,19 @@ export interface ReferenceDataSourceUpdate {
|
|
|
2461
2747
|
*/
|
|
2462
2748
|
export interface SqlApplicationConfigurationUpdate {
|
|
2463
2749
|
/**
|
|
2750
|
+
* @public
|
|
2464
2751
|
* <p>The array of <a>InputUpdate</a> objects describing the new input streams used
|
|
2465
2752
|
* by the application.</p>
|
|
2466
2753
|
*/
|
|
2467
2754
|
InputUpdates?: InputUpdate[];
|
|
2468
2755
|
/**
|
|
2756
|
+
* @public
|
|
2469
2757
|
* <p>The array of <a>OutputUpdate</a> objects describing the new destination streams
|
|
2470
2758
|
* used by the application.</p>
|
|
2471
2759
|
*/
|
|
2472
2760
|
OutputUpdates?: OutputUpdate[];
|
|
2473
2761
|
/**
|
|
2762
|
+
* @public
|
|
2474
2763
|
* <p>The array of <a>ReferenceDataSourceUpdate</a> objects describing the new
|
|
2475
2764
|
* reference data sources used by the application.</p>
|
|
2476
2765
|
*/
|
|
@@ -2482,16 +2771,19 @@ export interface SqlApplicationConfigurationUpdate {
|
|
|
2482
2771
|
*/
|
|
2483
2772
|
export interface VpcConfigurationUpdate {
|
|
2484
2773
|
/**
|
|
2774
|
+
* @public
|
|
2485
2775
|
* <p>Describes an update to the ID of the VPC configuration.</p>
|
|
2486
2776
|
*/
|
|
2487
2777
|
VpcConfigurationId: string | undefined;
|
|
2488
2778
|
/**
|
|
2779
|
+
* @public
|
|
2489
2780
|
* <p>Describes updates to the array of <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Subnet.html">Subnet</a>
|
|
2490
2781
|
* IDs
|
|
2491
2782
|
* used by the VPC configuration.</p>
|
|
2492
2783
|
*/
|
|
2493
2784
|
SubnetIdUpdates?: string[];
|
|
2494
2785
|
/**
|
|
2786
|
+
* @public
|
|
2495
2787
|
* <p>Describes updates to the array of
|
|
2496
2788
|
* <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SecurityGroup.html">SecurityGroup</a> IDs used by the VPC configuration.</p>
|
|
2497
2789
|
*/
|
|
@@ -2503,6 +2795,7 @@ export interface VpcConfigurationUpdate {
|
|
|
2503
2795
|
*/
|
|
2504
2796
|
export interface GlueDataCatalogConfigurationUpdate {
|
|
2505
2797
|
/**
|
|
2798
|
+
* @public
|
|
2506
2799
|
* <p>The updated Amazon Resource Name (ARN) of the database.</p>
|
|
2507
2800
|
*/
|
|
2508
2801
|
DatabaseARNUpdate: string | undefined;
|
|
@@ -2513,6 +2806,7 @@ export interface GlueDataCatalogConfigurationUpdate {
|
|
|
2513
2806
|
*/
|
|
2514
2807
|
export interface CatalogConfigurationUpdate {
|
|
2515
2808
|
/**
|
|
2809
|
+
* @public
|
|
2516
2810
|
* <p>Updates to the configuration parameters for the default Amazon Glue database. You use this database for SQL queries that you write in a Kinesis Data Analytics Studio notebook.</p>
|
|
2517
2811
|
*/
|
|
2518
2812
|
GlueDataCatalogConfigurationUpdate: GlueDataCatalogConfigurationUpdate | undefined;
|
|
@@ -2523,10 +2817,12 @@ export interface CatalogConfigurationUpdate {
|
|
|
2523
2817
|
*/
|
|
2524
2818
|
export interface S3ContentBaseLocationUpdate {
|
|
2525
2819
|
/**
|
|
2820
|
+
* @public
|
|
2526
2821
|
* <p>The updated Amazon Resource Name (ARN) of the S3 bucket.</p>
|
|
2527
2822
|
*/
|
|
2528
2823
|
BucketARNUpdate?: string;
|
|
2529
2824
|
/**
|
|
2825
|
+
* @public
|
|
2530
2826
|
* <p>The updated S3 bucket path.</p>
|
|
2531
2827
|
*/
|
|
2532
2828
|
BasePathUpdate?: string;
|
|
@@ -2537,6 +2833,7 @@ export interface S3ContentBaseLocationUpdate {
|
|
|
2537
2833
|
*/
|
|
2538
2834
|
export interface DeployAsApplicationConfigurationUpdate {
|
|
2539
2835
|
/**
|
|
2836
|
+
* @public
|
|
2540
2837
|
* <p>Updates to the location that holds the data required to specify an Amazon Data Analytics application.</p>
|
|
2541
2838
|
*/
|
|
2542
2839
|
S3ContentLocationUpdate?: S3ContentBaseLocationUpdate;
|
|
@@ -2547,6 +2844,7 @@ export interface DeployAsApplicationConfigurationUpdate {
|
|
|
2547
2844
|
*/
|
|
2548
2845
|
export interface ZeppelinMonitoringConfigurationUpdate {
|
|
2549
2846
|
/**
|
|
2847
|
+
* @public
|
|
2550
2848
|
* <p>Updates to the logging level for Apache Zeppelin within a Kinesis Data Analytics Studio notebook.</p>
|
|
2551
2849
|
*/
|
|
2552
2850
|
LogLevelUpdate: LogLevel | string | undefined;
|
|
@@ -2557,18 +2855,22 @@ export interface ZeppelinMonitoringConfigurationUpdate {
|
|
|
2557
2855
|
*/
|
|
2558
2856
|
export interface ZeppelinApplicationConfigurationUpdate {
|
|
2559
2857
|
/**
|
|
2858
|
+
* @public
|
|
2560
2859
|
* <p>Updates to the monitoring configuration of a Kinesis Data Analytics Studio notebook.</p>
|
|
2561
2860
|
*/
|
|
2562
2861
|
MonitoringConfigurationUpdate?: ZeppelinMonitoringConfigurationUpdate;
|
|
2563
2862
|
/**
|
|
2863
|
+
* @public
|
|
2564
2864
|
* <p>Updates to the configuration of the Amazon Glue Data Catalog that is associated with the Kinesis Data Analytics Studio notebook.</p>
|
|
2565
2865
|
*/
|
|
2566
2866
|
CatalogConfigurationUpdate?: CatalogConfigurationUpdate;
|
|
2567
2867
|
/**
|
|
2868
|
+
* @public
|
|
2568
2869
|
* <p>Updates to the configuration information required to deploy an Amazon Data Analytics Studio notebook as an application with durable state.</p>
|
|
2569
2870
|
*/
|
|
2570
2871
|
DeployAsApplicationConfigurationUpdate?: DeployAsApplicationConfigurationUpdate;
|
|
2571
2872
|
/**
|
|
2873
|
+
* @public
|
|
2572
2874
|
* <p>Updates to the customer artifacts. Custom artifacts are dependency JAR files and user-defined functions (UDF).</p>
|
|
2573
2875
|
*/
|
|
2574
2876
|
CustomArtifactsConfigurationUpdate?: CustomArtifactConfiguration[];
|
|
@@ -2579,32 +2881,39 @@ export interface ZeppelinApplicationConfigurationUpdate {
|
|
|
2579
2881
|
*/
|
|
2580
2882
|
export interface ApplicationConfigurationUpdate {
|
|
2581
2883
|
/**
|
|
2884
|
+
* @public
|
|
2582
2885
|
* <p>Describes updates to a SQL-based Kinesis Data Analytics application's
|
|
2583
2886
|
* configuration.</p>
|
|
2584
2887
|
*/
|
|
2585
2888
|
SqlApplicationConfigurationUpdate?: SqlApplicationConfigurationUpdate;
|
|
2586
2889
|
/**
|
|
2890
|
+
* @public
|
|
2587
2891
|
* <p>Describes updates to an application's code
|
|
2588
2892
|
* configuration.</p>
|
|
2589
2893
|
*/
|
|
2590
2894
|
ApplicationCodeConfigurationUpdate?: ApplicationCodeConfigurationUpdate;
|
|
2591
2895
|
/**
|
|
2896
|
+
* @public
|
|
2592
2897
|
* <p>Describes updates to a Flink-based Kinesis Data Analytics application's configuration.</p>
|
|
2593
2898
|
*/
|
|
2594
2899
|
FlinkApplicationConfigurationUpdate?: FlinkApplicationConfigurationUpdate;
|
|
2595
2900
|
/**
|
|
2901
|
+
* @public
|
|
2596
2902
|
* <p>Describes updates to the environment properties for a Flink-based Kinesis Data Analytics application.</p>
|
|
2597
2903
|
*/
|
|
2598
2904
|
EnvironmentPropertyUpdates?: EnvironmentPropertyUpdates;
|
|
2599
2905
|
/**
|
|
2906
|
+
* @public
|
|
2600
2907
|
* <p>Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.</p>
|
|
2601
2908
|
*/
|
|
2602
2909
|
ApplicationSnapshotConfigurationUpdate?: ApplicationSnapshotConfigurationUpdate;
|
|
2603
2910
|
/**
|
|
2911
|
+
* @public
|
|
2604
2912
|
* <p>Updates to the array of descriptions of VPC configurations available to the application.</p>
|
|
2605
2913
|
*/
|
|
2606
2914
|
VpcConfigurationUpdates?: VpcConfigurationUpdate[];
|
|
2607
2915
|
/**
|
|
2916
|
+
* @public
|
|
2608
2917
|
* <p>Updates to the configuration of a Kinesis Data Analytics Studio notebook.</p>
|
|
2609
2918
|
*/
|
|
2610
2919
|
ZeppelinApplicationConfigurationUpdate?: ZeppelinApplicationConfigurationUpdate;
|
|
@@ -2615,10 +2924,12 @@ export interface ApplicationConfigurationUpdate {
|
|
|
2615
2924
|
*/
|
|
2616
2925
|
export interface ApplicationMaintenanceConfigurationDescription {
|
|
2617
2926
|
/**
|
|
2927
|
+
* @public
|
|
2618
2928
|
* <p>The start time for the maintenance window.</p>
|
|
2619
2929
|
*/
|
|
2620
2930
|
ApplicationMaintenanceWindowStartTime: string | undefined;
|
|
2621
2931
|
/**
|
|
2932
|
+
* @public
|
|
2622
2933
|
* <p>The end time for the maintenance window.</p>
|
|
2623
2934
|
*/
|
|
2624
2935
|
ApplicationMaintenanceWindowEndTime: string | undefined;
|
|
@@ -2682,73 +2993,90 @@ export type RuntimeEnvironment = (typeof RuntimeEnvironment)[keyof typeof Runtim
|
|
|
2682
2993
|
*/
|
|
2683
2994
|
export interface ApplicationDetail {
|
|
2684
2995
|
/**
|
|
2996
|
+
* @public
|
|
2685
2997
|
* <p>The ARN of the application.</p>
|
|
2686
2998
|
*/
|
|
2687
2999
|
ApplicationARN: string | undefined;
|
|
2688
3000
|
/**
|
|
3001
|
+
* @public
|
|
2689
3002
|
* <p>The description of the application.</p>
|
|
2690
3003
|
*/
|
|
2691
3004
|
ApplicationDescription?: string;
|
|
2692
3005
|
/**
|
|
3006
|
+
* @public
|
|
2693
3007
|
* <p>The name of the application.</p>
|
|
2694
3008
|
*/
|
|
2695
3009
|
ApplicationName: string | undefined;
|
|
2696
3010
|
/**
|
|
3011
|
+
* @public
|
|
2697
3012
|
* <p>The runtime environment for the application.</p>
|
|
2698
3013
|
*/
|
|
2699
3014
|
RuntimeEnvironment: RuntimeEnvironment | string | undefined;
|
|
2700
3015
|
/**
|
|
3016
|
+
* @public
|
|
2701
3017
|
* <p>Specifies the IAM role that the application uses to access external resources.</p>
|
|
2702
3018
|
*/
|
|
2703
3019
|
ServiceExecutionRole?: string;
|
|
2704
3020
|
/**
|
|
3021
|
+
* @public
|
|
2705
3022
|
* <p>The status of the application.</p>
|
|
2706
3023
|
*/
|
|
2707
3024
|
ApplicationStatus: ApplicationStatus | string | undefined;
|
|
2708
3025
|
/**
|
|
3026
|
+
* @public
|
|
2709
3027
|
* <p>Provides the current application version. Kinesis Data Analytics updates the
|
|
2710
3028
|
* <code>ApplicationVersionId</code> each time you update the application.</p>
|
|
2711
3029
|
*/
|
|
2712
3030
|
ApplicationVersionId: number | undefined;
|
|
2713
3031
|
/**
|
|
3032
|
+
* @public
|
|
2714
3033
|
* <p>The current timestamp when the application was created.</p>
|
|
2715
3034
|
*/
|
|
2716
3035
|
CreateTimestamp?: Date;
|
|
2717
3036
|
/**
|
|
3037
|
+
* @public
|
|
2718
3038
|
* <p>The current timestamp when the application was last updated.</p>
|
|
2719
3039
|
*/
|
|
2720
3040
|
LastUpdateTimestamp?: Date;
|
|
2721
3041
|
/**
|
|
3042
|
+
* @public
|
|
2722
3043
|
* <p>Describes details about the application code and starting parameters for a Kinesis Data Analytics application.</p>
|
|
2723
3044
|
*/
|
|
2724
3045
|
ApplicationConfigurationDescription?: ApplicationConfigurationDescription;
|
|
2725
3046
|
/**
|
|
3047
|
+
* @public
|
|
2726
3048
|
* <p>Describes the application Amazon CloudWatch logging options.</p>
|
|
2727
3049
|
*/
|
|
2728
3050
|
CloudWatchLoggingOptionDescriptions?: CloudWatchLoggingOptionDescription[];
|
|
2729
3051
|
/**
|
|
3052
|
+
* @public
|
|
2730
3053
|
* <p>The details of the maintenance configuration for the application.</p>
|
|
2731
3054
|
*/
|
|
2732
3055
|
ApplicationMaintenanceConfigurationDescription?: ApplicationMaintenanceConfigurationDescription;
|
|
2733
3056
|
/**
|
|
3057
|
+
* @public
|
|
2734
3058
|
* <p>The previous application version before the latest application update. <a>RollbackApplication</a>
|
|
2735
3059
|
* reverts the application to this version.</p>
|
|
2736
3060
|
*/
|
|
2737
3061
|
ApplicationVersionUpdatedFrom?: number;
|
|
2738
3062
|
/**
|
|
3063
|
+
* @public
|
|
2739
3064
|
* <p>If you reverted the application using <a>RollbackApplication</a>,
|
|
2740
3065
|
* the application version when <code>RollbackApplication</code> was called.</p>
|
|
2741
3066
|
*/
|
|
2742
3067
|
ApplicationVersionRolledBackFrom?: number;
|
|
2743
3068
|
/**
|
|
3069
|
+
* @public
|
|
2744
3070
|
* <p>A value you use to implement strong concurrency for application updates.</p>
|
|
2745
3071
|
*/
|
|
2746
3072
|
ConditionalToken?: string;
|
|
2747
3073
|
/**
|
|
3074
|
+
* @public
|
|
2748
3075
|
* <p>The version to which you want to roll back the application.</p>
|
|
2749
3076
|
*/
|
|
2750
3077
|
ApplicationVersionRolledBackTo?: number;
|
|
2751
3078
|
/**
|
|
3079
|
+
* @public
|
|
2752
3080
|
* <p>To create a Kinesis Data Analytics Studio notebook, you must set the mode to <code>INTERACTIVE</code>. However, for a Kinesis Data Analytics for Apache Flink application, the mode is optional.</p>
|
|
2753
3081
|
*/
|
|
2754
3082
|
ApplicationMode?: ApplicationMode | string;
|
|
@@ -2759,6 +3087,7 @@ export interface ApplicationDetail {
|
|
|
2759
3087
|
*/
|
|
2760
3088
|
export interface ApplicationMaintenanceConfigurationUpdate {
|
|
2761
3089
|
/**
|
|
3090
|
+
* @public
|
|
2762
3091
|
* <p>The updated start time for the maintenance window.</p>
|
|
2763
3092
|
*/
|
|
2764
3093
|
ApplicationMaintenanceWindowStartTimeUpdate: string | undefined;
|
|
@@ -2769,26 +3098,32 @@ export interface ApplicationMaintenanceConfigurationUpdate {
|
|
|
2769
3098
|
*/
|
|
2770
3099
|
export interface ApplicationSummary {
|
|
2771
3100
|
/**
|
|
3101
|
+
* @public
|
|
2772
3102
|
* <p>The name of the application.</p>
|
|
2773
3103
|
*/
|
|
2774
3104
|
ApplicationName: string | undefined;
|
|
2775
3105
|
/**
|
|
3106
|
+
* @public
|
|
2776
3107
|
* <p>The ARN of the application.</p>
|
|
2777
3108
|
*/
|
|
2778
3109
|
ApplicationARN: string | undefined;
|
|
2779
3110
|
/**
|
|
3111
|
+
* @public
|
|
2780
3112
|
* <p>The status of the application.</p>
|
|
2781
3113
|
*/
|
|
2782
3114
|
ApplicationStatus: ApplicationStatus | string | undefined;
|
|
2783
3115
|
/**
|
|
3116
|
+
* @public
|
|
2784
3117
|
* <p>Provides the current application version.</p>
|
|
2785
3118
|
*/
|
|
2786
3119
|
ApplicationVersionId: number | undefined;
|
|
2787
3120
|
/**
|
|
3121
|
+
* @public
|
|
2788
3122
|
* <p>The runtime environment for the application.</p>
|
|
2789
3123
|
*/
|
|
2790
3124
|
RuntimeEnvironment: RuntimeEnvironment | string | undefined;
|
|
2791
3125
|
/**
|
|
3126
|
+
* @public
|
|
2792
3127
|
* <p>For a Kinesis Data Analytics for Apache Flink application, the mode is <code>STREAMING</code>. For a Kinesis Data Analytics Studio notebook, it is <code>INTERACTIVE</code>.</p>
|
|
2793
3128
|
*/
|
|
2794
3129
|
ApplicationMode?: ApplicationMode | string;
|
|
@@ -2799,10 +3134,12 @@ export interface ApplicationSummary {
|
|
|
2799
3134
|
*/
|
|
2800
3135
|
export interface ApplicationVersionSummary {
|
|
2801
3136
|
/**
|
|
3137
|
+
* @public
|
|
2802
3138
|
* <p>The ID of the application version. Kinesis Data Analytics updates the <code>ApplicationVersionId</code> each time you update the application.</p>
|
|
2803
3139
|
*/
|
|
2804
3140
|
ApplicationVersionId: number | undefined;
|
|
2805
3141
|
/**
|
|
3142
|
+
* @public
|
|
2806
3143
|
* <p>The status of the application.</p>
|
|
2807
3144
|
*/
|
|
2808
3145
|
ApplicationStatus: ApplicationStatus | string | undefined;
|
|
@@ -2813,10 +3150,12 @@ export interface ApplicationVersionSummary {
|
|
|
2813
3150
|
*/
|
|
2814
3151
|
export interface CloudWatchLoggingOptionUpdate {
|
|
2815
3152
|
/**
|
|
3153
|
+
* @public
|
|
2816
3154
|
* <p>The ID of the CloudWatch logging option to update</p>
|
|
2817
3155
|
*/
|
|
2818
3156
|
CloudWatchLoggingOptionId: string | undefined;
|
|
2819
3157
|
/**
|
|
3158
|
+
* @public
|
|
2820
3159
|
* <p>The Amazon Resource Name (ARN) of the CloudWatch log to receive application
|
|
2821
3160
|
* messages.</p>
|
|
2822
3161
|
*/
|
|
@@ -2834,10 +3173,12 @@ export interface CloudWatchLoggingOptionUpdate {
|
|
|
2834
3173
|
*/
|
|
2835
3174
|
export interface Tag {
|
|
2836
3175
|
/**
|
|
3176
|
+
* @public
|
|
2837
3177
|
* <p>The key of the key-value tag.</p>
|
|
2838
3178
|
*/
|
|
2839
3179
|
Key: string | undefined;
|
|
2840
3180
|
/**
|
|
3181
|
+
* @public
|
|
2841
3182
|
* <p>The value of the key-value tag. The value is optional.</p>
|
|
2842
3183
|
*/
|
|
2843
3184
|
Value?: string;
|
|
@@ -2847,33 +3188,40 @@ export interface Tag {
|
|
|
2847
3188
|
*/
|
|
2848
3189
|
export interface CreateApplicationRequest {
|
|
2849
3190
|
/**
|
|
3191
|
+
* @public
|
|
2850
3192
|
* <p>The name of your application (for example, <code>sample-app</code>).</p>
|
|
2851
3193
|
*/
|
|
2852
3194
|
ApplicationName: string | undefined;
|
|
2853
3195
|
/**
|
|
3196
|
+
* @public
|
|
2854
3197
|
* <p>A summary description of the application.</p>
|
|
2855
3198
|
*/
|
|
2856
3199
|
ApplicationDescription?: string;
|
|
2857
3200
|
/**
|
|
3201
|
+
* @public
|
|
2858
3202
|
* <p>The runtime environment for the application.</p>
|
|
2859
3203
|
*/
|
|
2860
3204
|
RuntimeEnvironment: RuntimeEnvironment | string | undefined;
|
|
2861
3205
|
/**
|
|
3206
|
+
* @public
|
|
2862
3207
|
* <p>The IAM role used by the application to access Kinesis data streams, Kinesis Data Firehose
|
|
2863
3208
|
* delivery streams, Amazon S3 objects, and other external resources.</p>
|
|
2864
3209
|
*/
|
|
2865
3210
|
ServiceExecutionRole: string | undefined;
|
|
2866
3211
|
/**
|
|
3212
|
+
* @public
|
|
2867
3213
|
* <p>Use this parameter to configure the application.</p>
|
|
2868
3214
|
*/
|
|
2869
3215
|
ApplicationConfiguration?: ApplicationConfiguration;
|
|
2870
3216
|
/**
|
|
3217
|
+
* @public
|
|
2871
3218
|
* <p>Use this parameter to configure an Amazon CloudWatch log stream to monitor application
|
|
2872
3219
|
* configuration errors.
|
|
2873
3220
|
* </p>
|
|
2874
3221
|
*/
|
|
2875
3222
|
CloudWatchLoggingOptions?: CloudWatchLoggingOption[];
|
|
2876
3223
|
/**
|
|
3224
|
+
* @public
|
|
2877
3225
|
* <p>A list of one or more tags to assign to the application. A tag is a key-value pair that identifies an
|
|
2878
3226
|
* application. Note that the maximum number of application tags includes system tags. The maximum number of
|
|
2879
3227
|
* user-defined application tags is 50.
|
|
@@ -2882,6 +3230,7 @@ export interface CreateApplicationRequest {
|
|
|
2882
3230
|
*/
|
|
2883
3231
|
Tags?: Tag[];
|
|
2884
3232
|
/**
|
|
3233
|
+
* @public
|
|
2885
3234
|
* <p>Use the <code>STREAMING</code> mode to create a Kinesis Data Analytics For Flink application. To create a Kinesis Data Analytics Studio notebook, use the
|
|
2886
3235
|
* <code>INTERACTIVE</code> mode.</p>
|
|
2887
3236
|
*/
|
|
@@ -2892,6 +3241,7 @@ export interface CreateApplicationRequest {
|
|
|
2892
3241
|
*/
|
|
2893
3242
|
export interface CreateApplicationResponse {
|
|
2894
3243
|
/**
|
|
3244
|
+
* @public
|
|
2895
3245
|
* <p>In response to your <code>CreateApplication</code> request, Kinesis Data Analytics returns a
|
|
2896
3246
|
* response with details of the application it created.</p>
|
|
2897
3247
|
*/
|
|
@@ -2954,15 +3304,18 @@ export type UrlType = (typeof UrlType)[keyof typeof UrlType];
|
|
|
2954
3304
|
*/
|
|
2955
3305
|
export interface CreateApplicationPresignedUrlRequest {
|
|
2956
3306
|
/**
|
|
3307
|
+
* @public
|
|
2957
3308
|
* <p>The name of the application.</p>
|
|
2958
3309
|
*/
|
|
2959
3310
|
ApplicationName: string | undefined;
|
|
2960
3311
|
/**
|
|
3312
|
+
* @public
|
|
2961
3313
|
* <p>The type of the extension for which to create and return a URL. Currently, the only valid
|
|
2962
3314
|
* extension URL type is <code>FLINK_DASHBOARD_URL</code>. </p>
|
|
2963
3315
|
*/
|
|
2964
3316
|
UrlType: UrlType | string | undefined;
|
|
2965
3317
|
/**
|
|
3318
|
+
* @public
|
|
2966
3319
|
* <p>The duration in seconds for which the returned URL will be valid.</p>
|
|
2967
3320
|
*/
|
|
2968
3321
|
SessionExpirationDurationInSeconds?: number;
|
|
@@ -2972,6 +3325,7 @@ export interface CreateApplicationPresignedUrlRequest {
|
|
|
2972
3325
|
*/
|
|
2973
3326
|
export interface CreateApplicationPresignedUrlResponse {
|
|
2974
3327
|
/**
|
|
3328
|
+
* @public
|
|
2975
3329
|
* <p>The URL of the extension.</p>
|
|
2976
3330
|
*/
|
|
2977
3331
|
AuthorizedUrl?: string;
|
|
@@ -2981,10 +3335,12 @@ export interface CreateApplicationPresignedUrlResponse {
|
|
|
2981
3335
|
*/
|
|
2982
3336
|
export interface CreateApplicationSnapshotRequest {
|
|
2983
3337
|
/**
|
|
3338
|
+
* @public
|
|
2984
3339
|
* <p>The name of an existing application</p>
|
|
2985
3340
|
*/
|
|
2986
3341
|
ApplicationName: string | undefined;
|
|
2987
3342
|
/**
|
|
3343
|
+
* @public
|
|
2988
3344
|
* <p>An identifier for the application snapshot.</p>
|
|
2989
3345
|
*/
|
|
2990
3346
|
SnapshotName: string | undefined;
|
|
@@ -2999,10 +3355,12 @@ export interface CreateApplicationSnapshotResponse {
|
|
|
2999
3355
|
*/
|
|
3000
3356
|
export interface DeleteApplicationRequest {
|
|
3001
3357
|
/**
|
|
3358
|
+
* @public
|
|
3002
3359
|
* <p>The name of the application to delete.</p>
|
|
3003
3360
|
*/
|
|
3004
3361
|
ApplicationName: string | undefined;
|
|
3005
3362
|
/**
|
|
3363
|
+
* @public
|
|
3006
3364
|
* <p>Use the <code>DescribeApplication</code> operation to get this value.</p>
|
|
3007
3365
|
*/
|
|
3008
3366
|
CreateTimestamp: Date | undefined;
|
|
@@ -3017,10 +3375,12 @@ export interface DeleteApplicationResponse {
|
|
|
3017
3375
|
*/
|
|
3018
3376
|
export interface DeleteApplicationCloudWatchLoggingOptionRequest {
|
|
3019
3377
|
/**
|
|
3378
|
+
* @public
|
|
3020
3379
|
* <p>The application name.</p>
|
|
3021
3380
|
*/
|
|
3022
3381
|
ApplicationName: string | undefined;
|
|
3023
3382
|
/**
|
|
3383
|
+
* @public
|
|
3024
3384
|
* <p>The version ID of the application. You must provide the
|
|
3025
3385
|
* <code>CurrentApplicationVersionId</code> or the <code>ConditionalToken</code>. You can
|
|
3026
3386
|
* retrieve the application version ID using <a>DescribeApplication</a>. For better
|
|
@@ -3029,11 +3389,13 @@ export interface DeleteApplicationCloudWatchLoggingOptionRequest {
|
|
|
3029
3389
|
*/
|
|
3030
3390
|
CurrentApplicationVersionId?: number;
|
|
3031
3391
|
/**
|
|
3392
|
+
* @public
|
|
3032
3393
|
* <p>The <code>CloudWatchLoggingOptionId</code> of the Amazon CloudWatch logging option to
|
|
3033
3394
|
* delete. You can get the <code>CloudWatchLoggingOptionId</code> by using the <a>DescribeApplication</a> operation. </p>
|
|
3034
3395
|
*/
|
|
3035
3396
|
CloudWatchLoggingOptionId: string | undefined;
|
|
3036
3397
|
/**
|
|
3398
|
+
* @public
|
|
3037
3399
|
* <p>A value you use to implement strong concurrency for application updates. You must provide
|
|
3038
3400
|
* the <code>CurrentApplicationVersionId</code> or the <code>ConditionalToken</code>. You get the
|
|
3039
3401
|
* application's current <code>ConditionalToken</code> using <a>DescribeApplication</a>. For better concurrency support, use the <code>ConditionalToken</code> parameter instead of
|
|
@@ -3046,16 +3408,19 @@ export interface DeleteApplicationCloudWatchLoggingOptionRequest {
|
|
|
3046
3408
|
*/
|
|
3047
3409
|
export interface DeleteApplicationCloudWatchLoggingOptionResponse {
|
|
3048
3410
|
/**
|
|
3411
|
+
* @public
|
|
3049
3412
|
* <p>The application's Amazon Resource Name (ARN).</p>
|
|
3050
3413
|
*/
|
|
3051
3414
|
ApplicationARN?: string;
|
|
3052
3415
|
/**
|
|
3416
|
+
* @public
|
|
3053
3417
|
* <p>The version ID of the application. Kinesis Data Analytics updates the
|
|
3054
3418
|
* <code>ApplicationVersionId</code> each time you change the CloudWatch logging
|
|
3055
3419
|
* options.</p>
|
|
3056
3420
|
*/
|
|
3057
3421
|
ApplicationVersionId?: number;
|
|
3058
3422
|
/**
|
|
3423
|
+
* @public
|
|
3059
3424
|
* <p>The descriptions of the remaining CloudWatch logging options for the application.</p>
|
|
3060
3425
|
*/
|
|
3061
3426
|
CloudWatchLoggingOptionDescriptions?: CloudWatchLoggingOptionDescription[];
|
|
@@ -3065,10 +3430,12 @@ export interface DeleteApplicationCloudWatchLoggingOptionResponse {
|
|
|
3065
3430
|
*/
|
|
3066
3431
|
export interface DeleteApplicationInputProcessingConfigurationRequest {
|
|
3067
3432
|
/**
|
|
3433
|
+
* @public
|
|
3068
3434
|
* <p>The name of the application.</p>
|
|
3069
3435
|
*/
|
|
3070
3436
|
ApplicationName: string | undefined;
|
|
3071
3437
|
/**
|
|
3438
|
+
* @public
|
|
3072
3439
|
* <p>The application version.
|
|
3073
3440
|
* You can use the <a>DescribeApplication</a> operation to get the current application version.
|
|
3074
3441
|
* If the version specified is not the current version, the
|
|
@@ -3077,6 +3444,7 @@ export interface DeleteApplicationInputProcessingConfigurationRequest {
|
|
|
3077
3444
|
*/
|
|
3078
3445
|
CurrentApplicationVersionId: number | undefined;
|
|
3079
3446
|
/**
|
|
3447
|
+
* @public
|
|
3080
3448
|
* <p>The ID of the input configuration from which to delete the input processing
|
|
3081
3449
|
* configuration. You can get a list of the input IDs for an application by using the <a>DescribeApplication</a> operation.</p>
|
|
3082
3450
|
*/
|
|
@@ -3087,10 +3455,12 @@ export interface DeleteApplicationInputProcessingConfigurationRequest {
|
|
|
3087
3455
|
*/
|
|
3088
3456
|
export interface DeleteApplicationInputProcessingConfigurationResponse {
|
|
3089
3457
|
/**
|
|
3458
|
+
* @public
|
|
3090
3459
|
* <p>The Amazon Resource Name (ARN) of the application.</p>
|
|
3091
3460
|
*/
|
|
3092
3461
|
ApplicationARN?: string;
|
|
3093
3462
|
/**
|
|
3463
|
+
* @public
|
|
3094
3464
|
* <p>The current application version ID.</p>
|
|
3095
3465
|
*/
|
|
3096
3466
|
ApplicationVersionId?: number;
|
|
@@ -3100,10 +3470,12 @@ export interface DeleteApplicationInputProcessingConfigurationResponse {
|
|
|
3100
3470
|
*/
|
|
3101
3471
|
export interface DeleteApplicationOutputRequest {
|
|
3102
3472
|
/**
|
|
3473
|
+
* @public
|
|
3103
3474
|
* <p>The application name.</p>
|
|
3104
3475
|
*/
|
|
3105
3476
|
ApplicationName: string | undefined;
|
|
3106
3477
|
/**
|
|
3478
|
+
* @public
|
|
3107
3479
|
* <p>The application version.
|
|
3108
3480
|
* You can use the <a>DescribeApplication</a> operation to get the current application version.
|
|
3109
3481
|
* If the version specified is not the current version, the
|
|
@@ -3112,6 +3484,7 @@ export interface DeleteApplicationOutputRequest {
|
|
|
3112
3484
|
*/
|
|
3113
3485
|
CurrentApplicationVersionId: number | undefined;
|
|
3114
3486
|
/**
|
|
3487
|
+
* @public
|
|
3115
3488
|
* <p>The ID of the configuration to delete. Each output configuration that is added to the
|
|
3116
3489
|
* application (either when the application is created or later) using the <a>AddApplicationOutput</a> operation has a unique ID. You need to provide the ID to
|
|
3117
3490
|
* uniquely identify the output configuration that you want to delete from the application
|
|
@@ -3125,10 +3498,12 @@ export interface DeleteApplicationOutputRequest {
|
|
|
3125
3498
|
*/
|
|
3126
3499
|
export interface DeleteApplicationOutputResponse {
|
|
3127
3500
|
/**
|
|
3501
|
+
* @public
|
|
3128
3502
|
* <p>The application Amazon Resource Name (ARN).</p>
|
|
3129
3503
|
*/
|
|
3130
3504
|
ApplicationARN?: string;
|
|
3131
3505
|
/**
|
|
3506
|
+
* @public
|
|
3132
3507
|
* <p>The current application version ID.</p>
|
|
3133
3508
|
*/
|
|
3134
3509
|
ApplicationVersionId?: number;
|
|
@@ -3138,10 +3513,12 @@ export interface DeleteApplicationOutputResponse {
|
|
|
3138
3513
|
*/
|
|
3139
3514
|
export interface DeleteApplicationReferenceDataSourceRequest {
|
|
3140
3515
|
/**
|
|
3516
|
+
* @public
|
|
3141
3517
|
* <p>The name of an existing application.</p>
|
|
3142
3518
|
*/
|
|
3143
3519
|
ApplicationName: string | undefined;
|
|
3144
3520
|
/**
|
|
3521
|
+
* @public
|
|
3145
3522
|
* <p>The current application version.
|
|
3146
3523
|
* You can use the <a>DescribeApplication</a> operation to get the current application version.
|
|
3147
3524
|
* If the version specified
|
|
@@ -3149,6 +3526,7 @@ export interface DeleteApplicationReferenceDataSourceRequest {
|
|
|
3149
3526
|
*/
|
|
3150
3527
|
CurrentApplicationVersionId: number | undefined;
|
|
3151
3528
|
/**
|
|
3529
|
+
* @public
|
|
3152
3530
|
* <p>The ID of the reference data source. When you add a reference data source to your
|
|
3153
3531
|
* application using the <a>AddApplicationReferenceDataSource</a>, Kinesis Data Analytics assigns an ID.
|
|
3154
3532
|
* You can use the <a>DescribeApplication</a> operation to
|
|
@@ -3161,10 +3539,12 @@ export interface DeleteApplicationReferenceDataSourceRequest {
|
|
|
3161
3539
|
*/
|
|
3162
3540
|
export interface DeleteApplicationReferenceDataSourceResponse {
|
|
3163
3541
|
/**
|
|
3542
|
+
* @public
|
|
3164
3543
|
* <p>The application Amazon Resource Name (ARN).</p>
|
|
3165
3544
|
*/
|
|
3166
3545
|
ApplicationARN?: string;
|
|
3167
3546
|
/**
|
|
3547
|
+
* @public
|
|
3168
3548
|
* <p>The updated version ID of the application.</p>
|
|
3169
3549
|
*/
|
|
3170
3550
|
ApplicationVersionId?: number;
|
|
@@ -3174,14 +3554,17 @@ export interface DeleteApplicationReferenceDataSourceResponse {
|
|
|
3174
3554
|
*/
|
|
3175
3555
|
export interface DeleteApplicationSnapshotRequest {
|
|
3176
3556
|
/**
|
|
3557
|
+
* @public
|
|
3177
3558
|
* <p>The name of an existing application.</p>
|
|
3178
3559
|
*/
|
|
3179
3560
|
ApplicationName: string | undefined;
|
|
3180
3561
|
/**
|
|
3562
|
+
* @public
|
|
3181
3563
|
* <p>The identifier for the snapshot delete.</p>
|
|
3182
3564
|
*/
|
|
3183
3565
|
SnapshotName: string | undefined;
|
|
3184
3566
|
/**
|
|
3567
|
+
* @public
|
|
3185
3568
|
* <p>The creation timestamp of the application snapshot to delete. You can retrieve this value
|
|
3186
3569
|
* using
|
|
3187
3570
|
* or .</p>
|
|
@@ -3198,10 +3581,12 @@ export interface DeleteApplicationSnapshotResponse {
|
|
|
3198
3581
|
*/
|
|
3199
3582
|
export interface DeleteApplicationVpcConfigurationRequest {
|
|
3200
3583
|
/**
|
|
3584
|
+
* @public
|
|
3201
3585
|
* <p>The name of an existing application.</p>
|
|
3202
3586
|
*/
|
|
3203
3587
|
ApplicationName: string | undefined;
|
|
3204
3588
|
/**
|
|
3589
|
+
* @public
|
|
3205
3590
|
* <p>The current application version ID. You must provide the
|
|
3206
3591
|
* <code>CurrentApplicationVersionId</code> or the <code>ConditionalToken</code>. You can
|
|
3207
3592
|
* retrieve the application version ID using <a>DescribeApplication</a>. For better
|
|
@@ -3210,10 +3595,12 @@ export interface DeleteApplicationVpcConfigurationRequest {
|
|
|
3210
3595
|
*/
|
|
3211
3596
|
CurrentApplicationVersionId?: number;
|
|
3212
3597
|
/**
|
|
3598
|
+
* @public
|
|
3213
3599
|
* <p>The ID of the VPC configuration to delete.</p>
|
|
3214
3600
|
*/
|
|
3215
3601
|
VpcConfigurationId: string | undefined;
|
|
3216
3602
|
/**
|
|
3603
|
+
* @public
|
|
3217
3604
|
* <p>A value you use to implement strong concurrency for application updates. You must provide
|
|
3218
3605
|
* the <code>CurrentApplicationVersionId</code> or the <code>ConditionalToken</code>. You get the
|
|
3219
3606
|
* application's current <code>ConditionalToken</code> using <a>DescribeApplication</a>. For better concurrency support, use the <code>ConditionalToken</code> parameter instead of
|
|
@@ -3226,10 +3613,12 @@ export interface DeleteApplicationVpcConfigurationRequest {
|
|
|
3226
3613
|
*/
|
|
3227
3614
|
export interface DeleteApplicationVpcConfigurationResponse {
|
|
3228
3615
|
/**
|
|
3616
|
+
* @public
|
|
3229
3617
|
* <p>The ARN of the Kinesis Data Analytics application.</p>
|
|
3230
3618
|
*/
|
|
3231
3619
|
ApplicationARN?: string;
|
|
3232
3620
|
/**
|
|
3621
|
+
* @public
|
|
3233
3622
|
* <p>The updated version ID of the application.</p>
|
|
3234
3623
|
*/
|
|
3235
3624
|
ApplicationVersionId?: number;
|
|
@@ -3239,10 +3628,12 @@ export interface DeleteApplicationVpcConfigurationResponse {
|
|
|
3239
3628
|
*/
|
|
3240
3629
|
export interface DescribeApplicationRequest {
|
|
3241
3630
|
/**
|
|
3631
|
+
* @public
|
|
3242
3632
|
* <p>The name of the application.</p>
|
|
3243
3633
|
*/
|
|
3244
3634
|
ApplicationName: string | undefined;
|
|
3245
3635
|
/**
|
|
3636
|
+
* @public
|
|
3246
3637
|
* <p>Displays verbose information about a Kinesis Data Analytics application, including the application's job plan.</p>
|
|
3247
3638
|
*/
|
|
3248
3639
|
IncludeAdditionalDetails?: boolean;
|
|
@@ -3252,6 +3643,7 @@ export interface DescribeApplicationRequest {
|
|
|
3252
3643
|
*/
|
|
3253
3644
|
export interface DescribeApplicationResponse {
|
|
3254
3645
|
/**
|
|
3646
|
+
* @public
|
|
3255
3647
|
* <p>Provides a description of the application, such as the application's Amazon Resource Name
|
|
3256
3648
|
* (ARN), status, and latest version.</p>
|
|
3257
3649
|
*/
|
|
@@ -3262,10 +3654,12 @@ export interface DescribeApplicationResponse {
|
|
|
3262
3654
|
*/
|
|
3263
3655
|
export interface DescribeApplicationSnapshotRequest {
|
|
3264
3656
|
/**
|
|
3657
|
+
* @public
|
|
3265
3658
|
* <p>The name of an existing application.</p>
|
|
3266
3659
|
*/
|
|
3267
3660
|
ApplicationName: string | undefined;
|
|
3268
3661
|
/**
|
|
3662
|
+
* @public
|
|
3269
3663
|
* <p>The identifier of an application snapshot. You can retrieve this value using
|
|
3270
3664
|
* .</p>
|
|
3271
3665
|
*/
|
|
@@ -3291,18 +3685,22 @@ export type SnapshotStatus = (typeof SnapshotStatus)[keyof typeof SnapshotStatus
|
|
|
3291
3685
|
*/
|
|
3292
3686
|
export interface SnapshotDetails {
|
|
3293
3687
|
/**
|
|
3688
|
+
* @public
|
|
3294
3689
|
* <p>The identifier for the application snapshot.</p>
|
|
3295
3690
|
*/
|
|
3296
3691
|
SnapshotName: string | undefined;
|
|
3297
3692
|
/**
|
|
3693
|
+
* @public
|
|
3298
3694
|
* <p>The status of the application snapshot.</p>
|
|
3299
3695
|
*/
|
|
3300
3696
|
SnapshotStatus: SnapshotStatus | string | undefined;
|
|
3301
3697
|
/**
|
|
3698
|
+
* @public
|
|
3302
3699
|
* <p>The current application version ID when the snapshot was created.</p>
|
|
3303
3700
|
*/
|
|
3304
3701
|
ApplicationVersionId: number | undefined;
|
|
3305
3702
|
/**
|
|
3703
|
+
* @public
|
|
3306
3704
|
* <p>The timestamp of the application snapshot.</p>
|
|
3307
3705
|
*/
|
|
3308
3706
|
SnapshotCreationTimestamp?: Date;
|
|
@@ -3312,6 +3710,7 @@ export interface SnapshotDetails {
|
|
|
3312
3710
|
*/
|
|
3313
3711
|
export interface DescribeApplicationSnapshotResponse {
|
|
3314
3712
|
/**
|
|
3713
|
+
* @public
|
|
3315
3714
|
* <p>An object containing information about the application snapshot.</p>
|
|
3316
3715
|
*/
|
|
3317
3716
|
SnapshotDetails: SnapshotDetails | undefined;
|
|
@@ -3321,10 +3720,12 @@ export interface DescribeApplicationSnapshotResponse {
|
|
|
3321
3720
|
*/
|
|
3322
3721
|
export interface DescribeApplicationVersionRequest {
|
|
3323
3722
|
/**
|
|
3723
|
+
* @public
|
|
3324
3724
|
* <p>The name of the application for which you want to get the version description.</p>
|
|
3325
3725
|
*/
|
|
3326
3726
|
ApplicationName: string | undefined;
|
|
3327
3727
|
/**
|
|
3728
|
+
* @public
|
|
3328
3729
|
* <p>The ID of the application version for which you want to get the description.</p>
|
|
3329
3730
|
*/
|
|
3330
3731
|
ApplicationVersionId: number | undefined;
|
|
@@ -3334,6 +3735,7 @@ export interface DescribeApplicationVersionRequest {
|
|
|
3334
3735
|
*/
|
|
3335
3736
|
export interface DescribeApplicationVersionResponse {
|
|
3336
3737
|
/**
|
|
3738
|
+
* @public
|
|
3337
3739
|
* <p>Describes the application, including the application Amazon Resource Name (ARN), status,
|
|
3338
3740
|
* latest version, and input and output configurations.</p>
|
|
3339
3741
|
*/
|
|
@@ -3347,10 +3749,12 @@ export interface DescribeApplicationVersionResponse {
|
|
|
3347
3749
|
*/
|
|
3348
3750
|
export interface S3Configuration {
|
|
3349
3751
|
/**
|
|
3752
|
+
* @public
|
|
3350
3753
|
* <p>The ARN of the S3 bucket that contains the data.</p>
|
|
3351
3754
|
*/
|
|
3352
3755
|
BucketARN: string | undefined;
|
|
3353
3756
|
/**
|
|
3757
|
+
* @public
|
|
3354
3758
|
* <p>The name of the object that contains the data.</p>
|
|
3355
3759
|
*/
|
|
3356
3760
|
FileKey: string | undefined;
|
|
@@ -3360,24 +3764,29 @@ export interface S3Configuration {
|
|
|
3360
3764
|
*/
|
|
3361
3765
|
export interface DiscoverInputSchemaRequest {
|
|
3362
3766
|
/**
|
|
3767
|
+
* @public
|
|
3363
3768
|
* <p>The Amazon Resource Name (ARN) of the streaming source.</p>
|
|
3364
3769
|
*/
|
|
3365
3770
|
ResourceARN?: string;
|
|
3366
3771
|
/**
|
|
3772
|
+
* @public
|
|
3367
3773
|
* <p>The ARN of the role that is used to access the streaming source.</p>
|
|
3368
3774
|
*/
|
|
3369
3775
|
ServiceExecutionRole: string | undefined;
|
|
3370
3776
|
/**
|
|
3777
|
+
* @public
|
|
3371
3778
|
* <p>The point at which you want Kinesis Data Analytics to start reading records from the
|
|
3372
3779
|
* specified streaming source discovery purposes.</p>
|
|
3373
3780
|
*/
|
|
3374
3781
|
InputStartingPositionConfiguration?: InputStartingPositionConfiguration;
|
|
3375
3782
|
/**
|
|
3783
|
+
* @public
|
|
3376
3784
|
* <p>Specify this parameter to discover a schema from data in an Amazon S3
|
|
3377
3785
|
* object.</p>
|
|
3378
3786
|
*/
|
|
3379
3787
|
S3Configuration?: S3Configuration;
|
|
3380
3788
|
/**
|
|
3789
|
+
* @public
|
|
3381
3790
|
* <p>The <a>InputProcessingConfiguration</a> to use to preprocess the records
|
|
3382
3791
|
* before discovering the schema of the records.</p>
|
|
3383
3792
|
*/
|
|
@@ -3388,22 +3797,26 @@ export interface DiscoverInputSchemaRequest {
|
|
|
3388
3797
|
*/
|
|
3389
3798
|
export interface DiscoverInputSchemaResponse {
|
|
3390
3799
|
/**
|
|
3800
|
+
* @public
|
|
3391
3801
|
* <p>The schema inferred from the streaming source. It identifies the format of the data in the
|
|
3392
3802
|
* streaming source and how each data element maps to corresponding columns in the in-application
|
|
3393
3803
|
* stream that you can create.</p>
|
|
3394
3804
|
*/
|
|
3395
3805
|
InputSchema?: SourceSchema;
|
|
3396
3806
|
/**
|
|
3807
|
+
* @public
|
|
3397
3808
|
* <p>An array of elements, where each element corresponds to a row in a stream record
|
|
3398
3809
|
* (a stream record can have more than one row).</p>
|
|
3399
3810
|
*/
|
|
3400
3811
|
ParsedInputRecords?: string[][];
|
|
3401
3812
|
/**
|
|
3813
|
+
* @public
|
|
3402
3814
|
* <p>The stream data that was modified by the processor specified in the
|
|
3403
3815
|
* <code>InputProcessingConfiguration</code> parameter.</p>
|
|
3404
3816
|
*/
|
|
3405
3817
|
ProcessedInputRecords?: string[];
|
|
3406
3818
|
/**
|
|
3819
|
+
* @public
|
|
3407
3820
|
* <p>The raw stream data that was sampled to infer the schema.</p>
|
|
3408
3821
|
*/
|
|
3409
3822
|
RawInputRecords?: string[];
|
|
@@ -3445,10 +3858,12 @@ export declare class UnableToDetectSchemaException extends __BaseException {
|
|
|
3445
3858
|
readonly $fault: "client";
|
|
3446
3859
|
Message?: string;
|
|
3447
3860
|
/**
|
|
3861
|
+
* @public
|
|
3448
3862
|
* <p>Raw stream data that was sampled to infer the schema.</p>
|
|
3449
3863
|
*/
|
|
3450
3864
|
RawInputRecords?: string[];
|
|
3451
3865
|
/**
|
|
3866
|
+
* @public
|
|
3452
3867
|
* <p>Stream data that was modified by the processor specified in the <code>InputProcessingConfiguration</code> parameter. </p>
|
|
3453
3868
|
*/
|
|
3454
3869
|
ProcessedInputRecords?: string[];
|
|
@@ -3462,10 +3877,12 @@ export declare class UnableToDetectSchemaException extends __BaseException {
|
|
|
3462
3877
|
*/
|
|
3463
3878
|
export interface ListApplicationsRequest {
|
|
3464
3879
|
/**
|
|
3880
|
+
* @public
|
|
3465
3881
|
* <p>The maximum number of applications to list.</p>
|
|
3466
3882
|
*/
|
|
3467
3883
|
Limit?: number;
|
|
3468
3884
|
/**
|
|
3885
|
+
* @public
|
|
3469
3886
|
* <p>If a previous command returned a pagination token,
|
|
3470
3887
|
* pass it into this value to retrieve the next set of results.
|
|
3471
3888
|
* For more information about pagination, see
|
|
@@ -3478,10 +3895,12 @@ export interface ListApplicationsRequest {
|
|
|
3478
3895
|
*/
|
|
3479
3896
|
export interface ListApplicationsResponse {
|
|
3480
3897
|
/**
|
|
3898
|
+
* @public
|
|
3481
3899
|
* <p>A list of <code>ApplicationSummary</code> objects.</p>
|
|
3482
3900
|
*/
|
|
3483
3901
|
ApplicationSummaries: ApplicationSummary[] | undefined;
|
|
3484
3902
|
/**
|
|
3903
|
+
* @public
|
|
3485
3904
|
* <p>The pagination token for the next set of results, or <code>null</code> if there are no additional results.
|
|
3486
3905
|
* Pass this token into a subsequent command to retrieve the next set of items
|
|
3487
3906
|
* For more information about pagination, see
|
|
@@ -3494,14 +3913,17 @@ export interface ListApplicationsResponse {
|
|
|
3494
3913
|
*/
|
|
3495
3914
|
export interface ListApplicationSnapshotsRequest {
|
|
3496
3915
|
/**
|
|
3916
|
+
* @public
|
|
3497
3917
|
* <p>The name of an existing application.</p>
|
|
3498
3918
|
*/
|
|
3499
3919
|
ApplicationName: string | undefined;
|
|
3500
3920
|
/**
|
|
3921
|
+
* @public
|
|
3501
3922
|
* <p>The maximum number of application snapshots to list.</p>
|
|
3502
3923
|
*/
|
|
3503
3924
|
Limit?: number;
|
|
3504
3925
|
/**
|
|
3926
|
+
* @public
|
|
3505
3927
|
* <p>Use this parameter if you receive a <code>NextToken</code> response in a previous request that indicates that there is more
|
|
3506
3928
|
* output available. Set it to the value of the previous call's <code>NextToken</code> response to indicate where the output should
|
|
3507
3929
|
* continue from. </p>
|
|
@@ -3513,10 +3935,12 @@ export interface ListApplicationSnapshotsRequest {
|
|
|
3513
3935
|
*/
|
|
3514
3936
|
export interface ListApplicationSnapshotsResponse {
|
|
3515
3937
|
/**
|
|
3938
|
+
* @public
|
|
3516
3939
|
* <p>A collection of objects containing information about the application snapshots.</p>
|
|
3517
3940
|
*/
|
|
3518
3941
|
SnapshotSummaries?: SnapshotDetails[];
|
|
3519
3942
|
/**
|
|
3943
|
+
* @public
|
|
3520
3944
|
* <p>The token for the next set of results, or <code>null</code> if there are no additional results.</p>
|
|
3521
3945
|
*/
|
|
3522
3946
|
NextToken?: string;
|
|
@@ -3526,14 +3950,17 @@ export interface ListApplicationSnapshotsResponse {
|
|
|
3526
3950
|
*/
|
|
3527
3951
|
export interface ListApplicationVersionsRequest {
|
|
3528
3952
|
/**
|
|
3953
|
+
* @public
|
|
3529
3954
|
* <p>The name of the application for which you want to list all versions.</p>
|
|
3530
3955
|
*/
|
|
3531
3956
|
ApplicationName: string | undefined;
|
|
3532
3957
|
/**
|
|
3958
|
+
* @public
|
|
3533
3959
|
* <p>The maximum number of versions to list in this invocation of the operation.</p>
|
|
3534
3960
|
*/
|
|
3535
3961
|
Limit?: number;
|
|
3536
3962
|
/**
|
|
3963
|
+
* @public
|
|
3537
3964
|
* <p>If a previous invocation of this operation returned a pagination token, pass it into this value to retrieve the next set of results. For more information about pagination, see
|
|
3538
3965
|
* <a href="https://docs.aws.amazon.com/cli/latest/userguide/pagination.html">Using the Amazon Command Line Interface's Pagination Options</a>.</p>
|
|
3539
3966
|
*/
|
|
@@ -3544,11 +3971,13 @@ export interface ListApplicationVersionsRequest {
|
|
|
3544
3971
|
*/
|
|
3545
3972
|
export interface ListApplicationVersionsResponse {
|
|
3546
3973
|
/**
|
|
3974
|
+
* @public
|
|
3547
3975
|
* <p>A list of the application versions and the associated configuration summaries. The list includes application versions that were rolled back.</p>
|
|
3548
3976
|
* <p>To get the complete description of a specific application version, invoke the <a>DescribeApplicationVersion</a> operation.</p>
|
|
3549
3977
|
*/
|
|
3550
3978
|
ApplicationVersionSummaries?: ApplicationVersionSummary[];
|
|
3551
3979
|
/**
|
|
3980
|
+
* @public
|
|
3552
3981
|
* <p>The pagination token for the next set of results, or <code>null</code> if there are no additional results.
|
|
3553
3982
|
* To retrieve the next set of items, pass this token into a subsequent invocation of this operation. For more information about pagination, see
|
|
3554
3983
|
* <a href="https://docs.aws.amazon.com/cli/latest/userguide/pagination.html">Using the Amazon Command Line Interface's Pagination Options</a>.</p>
|
|
@@ -3560,6 +3989,7 @@ export interface ListApplicationVersionsResponse {
|
|
|
3560
3989
|
*/
|
|
3561
3990
|
export interface ListTagsForResourceRequest {
|
|
3562
3991
|
/**
|
|
3992
|
+
* @public
|
|
3563
3993
|
* <p>The ARN of the application for which to retrieve tags.</p>
|
|
3564
3994
|
*/
|
|
3565
3995
|
ResourceARN: string | undefined;
|
|
@@ -3569,6 +3999,7 @@ export interface ListTagsForResourceRequest {
|
|
|
3569
3999
|
*/
|
|
3570
4000
|
export interface ListTagsForResourceResponse {
|
|
3571
4001
|
/**
|
|
4002
|
+
* @public
|
|
3572
4003
|
* <p>The key-value tags assigned to the application.</p>
|
|
3573
4004
|
*/
|
|
3574
4005
|
Tags?: Tag[];
|
|
@@ -3578,10 +4009,12 @@ export interface ListTagsForResourceResponse {
|
|
|
3578
4009
|
*/
|
|
3579
4010
|
export interface RollbackApplicationRequest {
|
|
3580
4011
|
/**
|
|
4012
|
+
* @public
|
|
3581
4013
|
* <p>The name of the application.</p>
|
|
3582
4014
|
*/
|
|
3583
4015
|
ApplicationName: string | undefined;
|
|
3584
4016
|
/**
|
|
4017
|
+
* @public
|
|
3585
4018
|
* <p>The current application version ID. You can retrieve the application version ID using
|
|
3586
4019
|
* <a>DescribeApplication</a>.</p>
|
|
3587
4020
|
*/
|
|
@@ -3592,6 +4025,7 @@ export interface RollbackApplicationRequest {
|
|
|
3592
4025
|
*/
|
|
3593
4026
|
export interface RollbackApplicationResponse {
|
|
3594
4027
|
/**
|
|
4028
|
+
* @public
|
|
3595
4029
|
* <p>Describes the application, including the application Amazon Resource Name (ARN), status,
|
|
3596
4030
|
* latest version, and input and output configurations.</p>
|
|
3597
4031
|
*/
|
|
@@ -3603,10 +4037,12 @@ export interface RollbackApplicationResponse {
|
|
|
3603
4037
|
*/
|
|
3604
4038
|
export interface SqlRunConfiguration {
|
|
3605
4039
|
/**
|
|
4040
|
+
* @public
|
|
3606
4041
|
* <p>The input source ID. You can get this ID by calling the <a>DescribeApplication</a> operation. </p>
|
|
3607
4042
|
*/
|
|
3608
4043
|
InputId: string | undefined;
|
|
3609
4044
|
/**
|
|
4045
|
+
* @public
|
|
3610
4046
|
* <p>The point at which you want the application to start processing records from the streaming
|
|
3611
4047
|
* source. </p>
|
|
3612
4048
|
*/
|
|
@@ -3618,15 +4054,18 @@ export interface SqlRunConfiguration {
|
|
|
3618
4054
|
*/
|
|
3619
4055
|
export interface RunConfiguration {
|
|
3620
4056
|
/**
|
|
4057
|
+
* @public
|
|
3621
4058
|
* <p>Describes the starting parameters for a Flink-based Kinesis Data Analytics application.</p>
|
|
3622
4059
|
*/
|
|
3623
4060
|
FlinkRunConfiguration?: FlinkRunConfiguration;
|
|
3624
4061
|
/**
|
|
4062
|
+
* @public
|
|
3625
4063
|
* <p>Describes the starting parameters for a SQL-based Kinesis Data Analytics application
|
|
3626
4064
|
* application.</p>
|
|
3627
4065
|
*/
|
|
3628
4066
|
SqlRunConfigurations?: SqlRunConfiguration[];
|
|
3629
4067
|
/**
|
|
4068
|
+
* @public
|
|
3630
4069
|
* <p>Describes the restore behavior of a restarting application.</p>
|
|
3631
4070
|
*/
|
|
3632
4071
|
ApplicationRestoreConfiguration?: ApplicationRestoreConfiguration;
|
|
@@ -3636,10 +4075,12 @@ export interface RunConfiguration {
|
|
|
3636
4075
|
*/
|
|
3637
4076
|
export interface StartApplicationRequest {
|
|
3638
4077
|
/**
|
|
4078
|
+
* @public
|
|
3639
4079
|
* <p>The name of the application.</p>
|
|
3640
4080
|
*/
|
|
3641
4081
|
ApplicationName: string | undefined;
|
|
3642
4082
|
/**
|
|
4083
|
+
* @public
|
|
3643
4084
|
* <p>Identifies the run configuration (start parameters) of a Kinesis Data Analytics application.</p>
|
|
3644
4085
|
*/
|
|
3645
4086
|
RunConfiguration?: RunConfiguration;
|
|
@@ -3654,10 +4095,12 @@ export interface StartApplicationResponse {
|
|
|
3654
4095
|
*/
|
|
3655
4096
|
export interface StopApplicationRequest {
|
|
3656
4097
|
/**
|
|
4098
|
+
* @public
|
|
3657
4099
|
* <p>The name of the running application to stop.</p>
|
|
3658
4100
|
*/
|
|
3659
4101
|
ApplicationName: string | undefined;
|
|
3660
4102
|
/**
|
|
4103
|
+
* @public
|
|
3661
4104
|
* <p>Set to <code>true</code> to force the application to stop. If you set <code>Force</code>
|
|
3662
4105
|
* to <code>true</code>, Kinesis Data Analytics stops the application without taking a snapshot.
|
|
3663
4106
|
* </p>
|
|
@@ -3683,10 +4126,12 @@ export interface StopApplicationResponse {
|
|
|
3683
4126
|
*/
|
|
3684
4127
|
export interface TagResourceRequest {
|
|
3685
4128
|
/**
|
|
4129
|
+
* @public
|
|
3686
4130
|
* <p>The ARN of the application to assign the tags.</p>
|
|
3687
4131
|
*/
|
|
3688
4132
|
ResourceARN: string | undefined;
|
|
3689
4133
|
/**
|
|
4134
|
+
* @public
|
|
3690
4135
|
* <p>The key-value tags to assign to the application.</p>
|
|
3691
4136
|
*/
|
|
3692
4137
|
Tags: Tag[] | undefined;
|
|
@@ -3701,10 +4146,12 @@ export interface TagResourceResponse {
|
|
|
3701
4146
|
*/
|
|
3702
4147
|
export interface UntagResourceRequest {
|
|
3703
4148
|
/**
|
|
4149
|
+
* @public
|
|
3704
4150
|
* <p>The ARN of the Kinesis Data Analytics application from which to remove the tags.</p>
|
|
3705
4151
|
*/
|
|
3706
4152
|
ResourceARN: string | undefined;
|
|
3707
4153
|
/**
|
|
4154
|
+
* @public
|
|
3708
4155
|
* <p>A list of keys of tags to remove from the specified application.</p>
|
|
3709
4156
|
*/
|
|
3710
4157
|
TagKeys: string[] | undefined;
|
|
@@ -3720,10 +4167,12 @@ export interface UntagResourceResponse {
|
|
|
3720
4167
|
*/
|
|
3721
4168
|
export interface RunConfigurationUpdate {
|
|
3722
4169
|
/**
|
|
4170
|
+
* @public
|
|
3723
4171
|
* <p>Describes the starting parameters for a Flink-based Kinesis Data Analytics application.</p>
|
|
3724
4172
|
*/
|
|
3725
4173
|
FlinkRunConfiguration?: FlinkRunConfiguration;
|
|
3726
4174
|
/**
|
|
4175
|
+
* @public
|
|
3727
4176
|
* <p>Describes updates to the restore behavior of a restarting application.</p>
|
|
3728
4177
|
*/
|
|
3729
4178
|
ApplicationRestoreConfiguration?: ApplicationRestoreConfiguration;
|
|
@@ -3733,10 +4182,12 @@ export interface RunConfigurationUpdate {
|
|
|
3733
4182
|
*/
|
|
3734
4183
|
export interface UpdateApplicationRequest {
|
|
3735
4184
|
/**
|
|
4185
|
+
* @public
|
|
3736
4186
|
* <p>The name of the application to update.</p>
|
|
3737
4187
|
*/
|
|
3738
4188
|
ApplicationName: string | undefined;
|
|
3739
4189
|
/**
|
|
4190
|
+
* @public
|
|
3740
4191
|
* <p>The current application version ID. You must provide the
|
|
3741
4192
|
* <code>CurrentApplicationVersionId</code> or the <code>ConditionalToken</code>.You can
|
|
3742
4193
|
* retrieve the application version ID using <a>DescribeApplication</a>. For better
|
|
@@ -3745,24 +4196,29 @@ export interface UpdateApplicationRequest {
|
|
|
3745
4196
|
*/
|
|
3746
4197
|
CurrentApplicationVersionId?: number;
|
|
3747
4198
|
/**
|
|
4199
|
+
* @public
|
|
3748
4200
|
* <p>Describes application configuration updates.</p>
|
|
3749
4201
|
*/
|
|
3750
4202
|
ApplicationConfigurationUpdate?: ApplicationConfigurationUpdate;
|
|
3751
4203
|
/**
|
|
4204
|
+
* @public
|
|
3752
4205
|
* <p>Describes updates to the service execution role.</p>
|
|
3753
4206
|
*/
|
|
3754
4207
|
ServiceExecutionRoleUpdate?: string;
|
|
3755
4208
|
/**
|
|
4209
|
+
* @public
|
|
3756
4210
|
* <p>Describes updates to the application's starting parameters.</p>
|
|
3757
4211
|
*/
|
|
3758
4212
|
RunConfigurationUpdate?: RunConfigurationUpdate;
|
|
3759
4213
|
/**
|
|
4214
|
+
* @public
|
|
3760
4215
|
* <p>Describes application Amazon CloudWatch logging option updates. You can only update
|
|
3761
4216
|
* existing CloudWatch logging options with this action. To add a new CloudWatch logging option,
|
|
3762
4217
|
* use <a>AddApplicationCloudWatchLoggingOption</a>.</p>
|
|
3763
4218
|
*/
|
|
3764
4219
|
CloudWatchLoggingOptionUpdates?: CloudWatchLoggingOptionUpdate[];
|
|
3765
4220
|
/**
|
|
4221
|
+
* @public
|
|
3766
4222
|
* <p>A value you use to implement strong concurrency for application updates. You must
|
|
3767
4223
|
* provide the <code>CurrentApplicationVersionId</code> or the <code>ConditionalToken</code>. You
|
|
3768
4224
|
* get the application's current <code>ConditionalToken</code> using <a>DescribeApplication</a>. For better concurrency support, use the
|
|
@@ -3776,6 +4232,7 @@ export interface UpdateApplicationRequest {
|
|
|
3776
4232
|
*/
|
|
3777
4233
|
export interface UpdateApplicationResponse {
|
|
3778
4234
|
/**
|
|
4235
|
+
* @public
|
|
3779
4236
|
* <p>Describes application updates.</p>
|
|
3780
4237
|
*/
|
|
3781
4238
|
ApplicationDetail: ApplicationDetail | undefined;
|
|
@@ -3785,10 +4242,12 @@ export interface UpdateApplicationResponse {
|
|
|
3785
4242
|
*/
|
|
3786
4243
|
export interface UpdateApplicationMaintenanceConfigurationRequest {
|
|
3787
4244
|
/**
|
|
4245
|
+
* @public
|
|
3788
4246
|
* <p>The name of the application for which you want to update the maintenance configuration.</p>
|
|
3789
4247
|
*/
|
|
3790
4248
|
ApplicationName: string | undefined;
|
|
3791
4249
|
/**
|
|
4250
|
+
* @public
|
|
3792
4251
|
* <p>Describes the application maintenance configuration update.</p>
|
|
3793
4252
|
*/
|
|
3794
4253
|
ApplicationMaintenanceConfigurationUpdate: ApplicationMaintenanceConfigurationUpdate | undefined;
|
|
@@ -3798,10 +4257,12 @@ export interface UpdateApplicationMaintenanceConfigurationRequest {
|
|
|
3798
4257
|
*/
|
|
3799
4258
|
export interface UpdateApplicationMaintenanceConfigurationResponse {
|
|
3800
4259
|
/**
|
|
4260
|
+
* @public
|
|
3801
4261
|
* <p>The Amazon Resource Name (ARN) of the application.</p>
|
|
3802
4262
|
*/
|
|
3803
4263
|
ApplicationARN?: string;
|
|
3804
4264
|
/**
|
|
4265
|
+
* @public
|
|
3805
4266
|
* <p>The application maintenance configuration description after the update.</p>
|
|
3806
4267
|
*/
|
|
3807
4268
|
ApplicationMaintenanceConfigurationDescription?: ApplicationMaintenanceConfigurationDescription;
|