@aws-sdk/client-kinesis-analytics 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,10 +7,12 @@ import { KinesisAnalyticsServiceException as __BaseException } from "./KinesisAn
7
7
  */
8
8
  export interface CloudWatchLoggingOption {
9
9
  /**
10
+ * @public
10
11
  * <p>ARN of the CloudWatch log to receive application messages.</p>
11
12
  */
12
13
  LogStreamARN: string | undefined;
13
14
  /**
15
+ * @public
14
16
  * <p>IAM ARN of the role to use to send application messages. Note: To write application
15
17
  * messages to CloudWatch, the IAM role that is used must have the
16
18
  * <code>PutLogEvents</code> policy action enabled.</p>
@@ -22,14 +24,17 @@ export interface CloudWatchLoggingOption {
22
24
  */
23
25
  export interface AddApplicationCloudWatchLoggingOptionRequest {
24
26
  /**
27
+ * @public
25
28
  * <p>The Kinesis Analytics application name.</p>
26
29
  */
27
30
  ApplicationName: string | undefined;
28
31
  /**
32
+ * @public
29
33
  * <p>The version ID of the Kinesis Analytics application.</p>
30
34
  */
31
35
  CurrentApplicationVersionId: number | undefined;
32
36
  /**
37
+ * @public
33
38
  * <p>Provides the CloudWatch log stream Amazon Resource Name (ARN) and the IAM role ARN.
34
39
  * Note: To write application messages to CloudWatch, the IAM role that is used must have
35
40
  * the <code>PutLogEvents</code> policy action enabled.</p>
@@ -110,6 +115,7 @@ export declare class UnsupportedOperationException extends __BaseException {
110
115
  */
111
116
  export interface InputParallelism {
112
117
  /**
118
+ * @public
113
119
  * <p>Number of in-application streams to create.
114
120
  * For more information, see <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html">Limits</a>.
115
121
  * </p>
@@ -124,6 +130,7 @@ export interface InputParallelism {
124
130
  */
125
131
  export interface InputLambdaProcessor {
126
132
  /**
133
+ * @public
127
134
  * <p>The ARN of the <a href="https://docs.aws.amazon.com/lambda/">AWS Lambda</a> function that operates
128
135
  * on records in the stream.</p>
129
136
  * <note>
@@ -133,6 +140,7 @@ export interface InputLambdaProcessor {
133
140
  */
134
141
  ResourceARN: string | undefined;
135
142
  /**
143
+ * @public
136
144
  * <p>The ARN of the IAM role that is used to access the AWS Lambda function.</p>
137
145
  */
138
146
  RoleARN: string | undefined;
@@ -146,6 +154,7 @@ export interface InputLambdaProcessor {
146
154
  */
147
155
  export interface InputProcessingConfiguration {
148
156
  /**
157
+ * @public
149
158
  * <p>The <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputLambdaProcessor.html">InputLambdaProcessor</a> that is used to preprocess the records
150
159
  * in the stream before being processed by your application code.</p>
151
160
  */
@@ -159,15 +168,18 @@ export interface InputProcessingConfiguration {
159
168
  */
160
169
  export interface RecordColumn {
161
170
  /**
171
+ * @public
162
172
  * <p>Name of the column created in the in-application input stream or reference table.</p>
163
173
  */
164
174
  Name: string | undefined;
165
175
  /**
176
+ * @public
166
177
  * <p>Reference to the data element in the streaming input or the reference data source. This element
167
178
  * is required if the <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_RecordFormat.html#analytics-Type-RecordFormat-RecordFormatTypel">RecordFormatType</a> is <code>JSON</code>.</p>
168
179
  */
169
180
  Mapping?: string;
170
181
  /**
182
+ * @public
171
183
  * <p>Type of column created in the in-application input stream or reference table.</p>
172
184
  */
173
185
  SqlType: string | undefined;
@@ -188,10 +200,12 @@ export interface RecordColumn {
188
200
  */
189
201
  export interface CSVMappingParameters {
190
202
  /**
203
+ * @public
191
204
  * <p>Row delimiter. For example, in a CSV format, <i>'\n'</i> is the typical row delimiter.</p>
192
205
  */
193
206
  RecordRowDelimiter: string | undefined;
194
207
  /**
208
+ * @public
195
209
  * <p>Column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.</p>
196
210
  */
197
211
  RecordColumnDelimiter: string | undefined;
@@ -202,6 +216,7 @@ export interface CSVMappingParameters {
202
216
  */
203
217
  export interface JSONMappingParameters {
204
218
  /**
219
+ * @public
205
220
  * <p>Path to the top-level parent that contains the records.</p>
206
221
  */
207
222
  RecordRowPath: string | undefined;
@@ -216,10 +231,12 @@ export interface JSONMappingParameters {
216
231
  */
217
232
  export interface MappingParameters {
218
233
  /**
234
+ * @public
219
235
  * <p>Provides additional mapping information when JSON is the record format on the streaming source.</p>
220
236
  */
221
237
  JSONMappingParameters?: JSONMappingParameters;
222
238
  /**
239
+ * @public
223
240
  * <p>Provides additional mapping information when the record format uses delimiters
224
241
  * (for example, CSV).</p>
225
242
  */
@@ -246,10 +263,12 @@ export type RecordFormatType = (typeof RecordFormatType)[keyof typeof RecordForm
246
263
  */
247
264
  export interface RecordFormat {
248
265
  /**
266
+ * @public
249
267
  * <p>The type of record format.</p>
250
268
  */
251
269
  RecordFormatType: RecordFormatType | string | undefined;
252
270
  /**
271
+ * @public
253
272
  * <p>When configuring application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.</p>
254
273
  */
255
274
  MappingParameters?: MappingParameters;
@@ -260,14 +279,17 @@ export interface RecordFormat {
260
279
  */
261
280
  export interface SourceSchema {
262
281
  /**
282
+ * @public
263
283
  * <p>Specifies the format of the records on the streaming source.</p>
264
284
  */
265
285
  RecordFormat: RecordFormat | undefined;
266
286
  /**
287
+ * @public
267
288
  * <p>Specifies the encoding of the records in the streaming source. For example, UTF-8.</p>
268
289
  */
269
290
  RecordEncoding?: string;
270
291
  /**
292
+ * @public
271
293
  * <p>A list of <code>RecordColumn</code> objects.</p>
272
294
  */
273
295
  RecordColumns: RecordColumn[] | undefined;
@@ -280,10 +302,12 @@ export interface SourceSchema {
280
302
  */
281
303
  export interface KinesisFirehoseInput {
282
304
  /**
305
+ * @public
283
306
  * <p>ARN of the input delivery stream.</p>
284
307
  */
285
308
  ResourceARN: string | undefined;
286
309
  /**
310
+ * @public
287
311
  * <p>ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream
288
312
  * on your behalf. You need to make sure that the role has the necessary permissions to
289
313
  * access the stream.</p>
@@ -298,10 +322,12 @@ export interface KinesisFirehoseInput {
298
322
  */
299
323
  export interface KinesisStreamsInput {
300
324
  /**
325
+ * @public
301
326
  * <p>ARN of the input Amazon Kinesis stream to read.</p>
302
327
  */
303
328
  ResourceARN: string | undefined;
304
329
  /**
330
+ * @public
305
331
  * <p>ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to grant the necessary permissions to this role.</p>
306
332
  */
307
333
  RoleARN: string | undefined;
@@ -315,6 +341,7 @@ export interface KinesisStreamsInput {
315
341
  */
316
342
  export interface Input {
317
343
  /**
344
+ * @public
318
345
  * <p>Name prefix to use when creating an in-application stream. Suppose that you specify
319
346
  * a prefix "MyInApplicationStream." Amazon Kinesis Analytics then creates one or more (as
320
347
  * per the <code>InputParallelism</code> count you specified) in-application streams with
@@ -322,6 +349,7 @@ export interface Input {
322
349
  */
323
350
  NamePrefix: string | undefined;
324
351
  /**
352
+ * @public
325
353
  * <p>The <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html">InputProcessingConfiguration</a> for the input. An input
326
354
  * processor transforms records as they are received from the stream, before the
327
355
  * application's SQL code executes. Currently, the only input processing configuration
@@ -329,6 +357,7 @@ export interface Input {
329
357
  */
330
358
  InputProcessingConfiguration?: InputProcessingConfiguration;
331
359
  /**
360
+ * @public
332
361
  * <p>If the streaming source is an Amazon Kinesis stream,
333
362
  * identifies the stream's Amazon Resource Name (ARN) and an IAM role
334
363
  * that enables Amazon Kinesis Analytics to access the stream on your behalf.</p>
@@ -336,6 +365,7 @@ export interface Input {
336
365
  */
337
366
  KinesisStreamsInput?: KinesisStreamsInput;
338
367
  /**
368
+ * @public
339
369
  * <p>If the streaming source is an Amazon Kinesis Firehose delivery stream, identifies
340
370
  * the delivery stream's ARN and an IAM role that enables Amazon Kinesis Analytics to
341
371
  * access the stream on your behalf.</p>
@@ -343,12 +373,14 @@ export interface Input {
343
373
  */
344
374
  KinesisFirehoseInput?: KinesisFirehoseInput;
345
375
  /**
376
+ * @public
346
377
  * <p>Describes the number of in-application streams to create. </p>
347
378
  * <p>Data from your source is routed to these in-application input streams.</p>
348
379
  * <p> (see <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html">Configuring Application Input</a>.</p>
349
380
  */
350
381
  InputParallelism?: InputParallelism;
351
382
  /**
383
+ * @public
352
384
  * <p>Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created.</p>
353
385
  * <p>Also used to describe the format of the reference data source.</p>
354
386
  */
@@ -360,15 +392,18 @@ export interface Input {
360
392
  */
361
393
  export interface AddApplicationInputRequest {
362
394
  /**
395
+ * @public
363
396
  * <p>Name of your existing Amazon Kinesis Analytics application to which you want to add the streaming source.</p>
364
397
  */
365
398
  ApplicationName: string | undefined;
366
399
  /**
400
+ * @public
367
401
  * <p>Current version of your Amazon Kinesis Analytics application. You can use the <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html">DescribeApplication</a> operation
368
402
  * to find the current application version.</p>
369
403
  */
370
404
  CurrentApplicationVersionId: number | undefined;
371
405
  /**
406
+ * @public
372
407
  * <p>The <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_Input.html">Input</a> to add.</p>
373
408
  */
374
409
  Input: Input | undefined;
@@ -396,21 +431,25 @@ export declare class CodeValidationException extends __BaseException {
396
431
  */
397
432
  export interface AddApplicationInputProcessingConfigurationRequest {
398
433
  /**
434
+ * @public
399
435
  * <p>Name of the application to which you want to add the input processing configuration.</p>
400
436
  */
401
437
  ApplicationName: string | undefined;
402
438
  /**
439
+ * @public
403
440
  * <p>Version of the application to which you want to add the input processing configuration. You can use the <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html">DescribeApplication</a>
404
441
  * operation to get the current application version. If the version specified is not the current version, the
405
442
  * <code>ConcurrentModificationException</code> is returned.</p>
406
443
  */
407
444
  CurrentApplicationVersionId: number | undefined;
408
445
  /**
446
+ * @public
409
447
  * <p>The ID of the input configuration to add the input processing configuration to. You
410
448
  * can get a list of the input IDs for an application using the <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html">DescribeApplication</a> operation.</p>
411
449
  */
412
450
  InputId: string | undefined;
413
451
  /**
452
+ * @public
414
453
  * <p>The <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html">InputProcessingConfiguration</a> to add to the application.</p>
415
454
  */
416
455
  InputProcessingConfiguration: InputProcessingConfiguration | undefined;
@@ -431,6 +470,7 @@ export interface AddApplicationInputProcessingConfigurationResponse {
431
470
  */
432
471
  export interface DestinationSchema {
433
472
  /**
473
+ * @public
434
474
  * <p>Specifies the format of the records on the output stream.</p>
435
475
  */
436
476
  RecordFormatType: RecordFormatType | string | undefined;
@@ -444,10 +484,12 @@ export interface DestinationSchema {
444
484
  */
445
485
  export interface KinesisFirehoseOutput {
446
486
  /**
487
+ * @public
447
488
  * <p>ARN of the destination Amazon Kinesis Firehose delivery stream to write to.</p>
448
489
  */
449
490
  ResourceARN: string | undefined;
450
491
  /**
492
+ * @public
451
493
  * <p>ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination stream on your behalf. You need to grant the necessary permissions to this role.</p>
452
494
  */
453
495
  RoleARN: string | undefined;
@@ -460,10 +502,12 @@ export interface KinesisFirehoseOutput {
460
502
  */
461
503
  export interface KinesisStreamsOutput {
462
504
  /**
505
+ * @public
463
506
  * <p>ARN of the destination Amazon Kinesis stream to write to.</p>
464
507
  */
465
508
  ResourceARN: string | undefined;
466
509
  /**
510
+ * @public
467
511
  * <p>ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination stream on your behalf. You need to grant the necessary permissions to this role.</p>
468
512
  */
469
513
  RoleARN: string | undefined;
@@ -476,6 +520,7 @@ export interface KinesisStreamsOutput {
476
520
  */
477
521
  export interface LambdaOutput {
478
522
  /**
523
+ * @public
479
524
  * <p>Amazon Resource Name (ARN) of the destination Lambda function to write
480
525
  * to.</p>
481
526
  * <note>
@@ -485,6 +530,7 @@ export interface LambdaOutput {
485
530
  */
486
531
  ResourceARN: string | undefined;
487
532
  /**
533
+ * @public
488
534
  * <p>ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination function on your behalf. You need to grant the necessary permissions to this role. </p>
489
535
  */
490
536
  RoleARN: string | undefined;
@@ -506,23 +552,28 @@ export interface LambdaOutput {
506
552
  */
507
553
  export interface Output {
508
554
  /**
555
+ * @public
509
556
  * <p>Name of the in-application stream.</p>
510
557
  */
511
558
  Name: string | undefined;
512
559
  /**
560
+ * @public
513
561
  * <p>Identifies an Amazon Kinesis stream
514
562
  * as the destination.</p>
515
563
  */
516
564
  KinesisStreamsOutput?: KinesisStreamsOutput;
517
565
  /**
566
+ * @public
518
567
  * <p>Identifies an Amazon Kinesis Firehose delivery stream as the destination.</p>
519
568
  */
520
569
  KinesisFirehoseOutput?: KinesisFirehoseOutput;
521
570
  /**
571
+ * @public
522
572
  * <p>Identifies an AWS Lambda function as the destination.</p>
523
573
  */
524
574
  LambdaOutput?: LambdaOutput;
525
575
  /**
576
+ * @public
526
577
  * <p>Describes the data format when records are written to the destination. For more information, see <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html">Configuring Application Output</a>.</p>
527
578
  */
528
579
  DestinationSchema: DestinationSchema | undefined;
@@ -533,10 +584,12 @@ export interface Output {
533
584
  */
534
585
  export interface AddApplicationOutputRequest {
535
586
  /**
587
+ * @public
536
588
  * <p>Name of the application to which you want to add the output configuration.</p>
537
589
  */
538
590
  ApplicationName: string | undefined;
539
591
  /**
592
+ * @public
540
593
  * <p>Version of the application to which you want to add the output configuration. You
541
594
  * can use the <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html">DescribeApplication</a> operation to get the current
542
595
  * application version. If the version specified is not the current version, the
@@ -544,6 +597,7 @@ export interface AddApplicationOutputRequest {
544
597
  */
545
598
  CurrentApplicationVersionId: number | undefined;
546
599
  /**
600
+ * @public
547
601
  * <p>An array of objects, each describing one output configuration. In the output
548
602
  * configuration, you specify the name of an in-application stream, a destination (that is,
549
603
  * an Amazon Kinesis stream, an Amazon Kinesis Firehose delivery stream, or an AWS Lambda
@@ -566,14 +620,17 @@ export interface AddApplicationOutputResponse {
566
620
  */
567
621
  export interface S3ReferenceDataSource {
568
622
  /**
623
+ * @public
569
624
  * <p>Amazon Resource Name (ARN) of the S3 bucket.</p>
570
625
  */
571
626
  BucketARN: string | undefined;
572
627
  /**
628
+ * @public
573
629
  * <p>Object key name containing reference data.</p>
574
630
  */
575
631
  FileKey: string | undefined;
576
632
  /**
633
+ * @public
577
634
  * <p>ARN of the IAM role that the service can assume to read data on your behalf. This role must have permission for the <code>s3:GetObject</code> action on the object and trust policy that allows Amazon Kinesis Analytics service principal to assume this role.</p>
578
635
  */
579
636
  ReferenceRoleARN: string | undefined;
@@ -584,16 +641,19 @@ export interface S3ReferenceDataSource {
584
641
  */
585
642
  export interface ReferenceDataSource {
586
643
  /**
644
+ * @public
587
645
  * <p>Name of the in-application table to create.</p>
588
646
  */
589
647
  TableName: string | undefined;
590
648
  /**
649
+ * @public
591
650
  * <p>Identifies the S3 bucket and object that contains the reference data. Also identifies the IAM role Amazon Kinesis Analytics can assume to read this object on your behalf.
592
651
  *
593
652
  * An Amazon Kinesis Analytics application loads reference data only once. If the data changes, you call the <code>UpdateApplication</code> operation to trigger reloading of data into your application. </p>
594
653
  */
595
654
  S3ReferenceDataSource?: S3ReferenceDataSource;
596
655
  /**
656
+ * @public
597
657
  * <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>
598
658
  */
599
659
  ReferenceSchema: SourceSchema | undefined;
@@ -604,10 +664,12 @@ export interface ReferenceDataSource {
604
664
  */
605
665
  export interface AddApplicationReferenceDataSourceRequest {
606
666
  /**
667
+ * @public
607
668
  * <p>Name of an existing application.</p>
608
669
  */
609
670
  ApplicationName: string | undefined;
610
671
  /**
672
+ * @public
611
673
  * <p>Version of the application for which you are adding the reference data source.
612
674
  * You can use the <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html">DescribeApplication</a> operation to get the current application version.
613
675
  * If the version specified is not the current version, the
@@ -615,6 +677,7 @@ export interface AddApplicationReferenceDataSourceRequest {
615
677
  */
616
678
  CurrentApplicationVersionId: number | undefined;
617
679
  /**
680
+ * @public
618
681
  * <p>The reference data source can be an object in your Amazon S3 bucket. Amazon Kinesis Analytics reads the object and copies the data into the in-application table that is created. You provide an S3 bucket, object key name, and the resulting in-application table that is created. You must also provide an IAM role with the necessary permissions that Amazon Kinesis Analytics can assume to read the object from your S3 bucket on your behalf.</p>
619
682
  */
620
683
  ReferenceDataSource: ReferenceDataSource | undefined;
@@ -647,14 +710,17 @@ export type ApplicationStatus = (typeof ApplicationStatus)[keyof typeof Applicat
647
710
  */
648
711
  export interface CloudWatchLoggingOptionDescription {
649
712
  /**
713
+ * @public
650
714
  * <p>ID of the CloudWatch logging option description.</p>
651
715
  */
652
716
  CloudWatchLoggingOptionId?: string;
653
717
  /**
718
+ * @public
654
719
  * <p>ARN of the CloudWatch log to receive application messages.</p>
655
720
  */
656
721
  LogStreamARN: string | undefined;
657
722
  /**
723
+ * @public
658
724
  * <p>IAM ARN of the role to use to send application messages. Note: To write application messages to CloudWatch, the IAM role used must have the <code>PutLogEvents</code> policy action enabled.</p>
659
725
  */
660
726
  RoleARN: string | undefined;
@@ -667,10 +733,12 @@ export interface CloudWatchLoggingOptionDescription {
667
733
  */
668
734
  export interface InputLambdaProcessorDescription {
669
735
  /**
736
+ * @public
670
737
  * <p>The ARN of the <a href="https://docs.aws.amazon.com/lambda/">AWS Lambda</a> function that is used to preprocess the records in the stream.</p>
671
738
  */
672
739
  ResourceARN?: string;
673
740
  /**
741
+ * @public
674
742
  * <p>The ARN of the IAM role that is used to access the AWS Lambda function.</p>
675
743
  */
676
744
  RoleARN?: string;
@@ -682,6 +750,7 @@ export interface InputLambdaProcessorDescription {
682
750
  */
683
751
  export interface InputProcessingConfigurationDescription {
684
752
  /**
753
+ * @public
685
754
  * <p>Provides configuration information about the associated <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputLambdaProcessorDescription.html">InputLambdaProcessorDescription</a>.</p>
686
755
  */
687
756
  InputLambdaProcessorDescription?: InputLambdaProcessorDescription;
@@ -706,6 +775,7 @@ export type InputStartingPosition = (typeof InputStartingPosition)[keyof typeof
706
775
  */
707
776
  export interface InputStartingPositionConfiguration {
708
777
  /**
778
+ * @public
709
779
  * <p>The starting position on the stream.</p>
710
780
  * <ul>
711
781
  * <li>
@@ -738,10 +808,12 @@ export interface InputStartingPositionConfiguration {
738
808
  */
739
809
  export interface KinesisFirehoseInputDescription {
740
810
  /**
811
+ * @public
741
812
  * <p>Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream.</p>
742
813
  */
743
814
  ResourceARN?: string;
744
815
  /**
816
+ * @public
745
817
  * <p>ARN of the IAM role that Amazon Kinesis Analytics assumes to access the stream.</p>
746
818
  */
747
819
  RoleARN?: string;
@@ -755,10 +827,12 @@ export interface KinesisFirehoseInputDescription {
755
827
  */
756
828
  export interface KinesisStreamsInputDescription {
757
829
  /**
830
+ * @public
758
831
  * <p>Amazon Resource Name (ARN) of the Amazon Kinesis stream.</p>
759
832
  */
760
833
  ResourceARN?: string;
761
834
  /**
835
+ * @public
762
836
  * <p>ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream.</p>
763
837
  */
764
838
  RoleARN?: string;
@@ -772,47 +846,56 @@ export interface KinesisStreamsInputDescription {
772
846
  */
773
847
  export interface InputDescription {
774
848
  /**
849
+ * @public
775
850
  * <p>Input ID associated with the application input.
776
851
  * This is the ID that Amazon Kinesis Analytics assigns to each
777
852
  * input configuration you add to your application. </p>
778
853
  */
779
854
  InputId?: string;
780
855
  /**
856
+ * @public
781
857
  * <p>In-application name prefix.</p>
782
858
  */
783
859
  NamePrefix?: string;
784
860
  /**
861
+ * @public
785
862
  * <p>Returns the in-application stream names that are mapped to the
786
863
  * stream source.</p>
787
864
  */
788
865
  InAppStreamNames?: string[];
789
866
  /**
867
+ * @public
790
868
  * <p>The description of the preprocessor that executes on records in this input before the application's code is run.</p>
791
869
  */
792
870
  InputProcessingConfigurationDescription?: InputProcessingConfigurationDescription;
793
871
  /**
872
+ * @public
794
873
  * <p>If an Amazon Kinesis stream is configured as streaming source, provides Amazon
795
874
  * Kinesis stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis
796
875
  * Analytics to access the stream on your behalf.</p>
797
876
  */
798
877
  KinesisStreamsInputDescription?: KinesisStreamsInputDescription;
799
878
  /**
879
+ * @public
800
880
  * <p>If an Amazon Kinesis Firehose delivery stream is configured as a streaming source,
801
881
  * provides the delivery stream's ARN and an IAM role that enables Amazon Kinesis Analytics
802
882
  * to access the stream on your behalf.</p>
803
883
  */
804
884
  KinesisFirehoseInputDescription?: KinesisFirehoseInputDescription;
805
885
  /**
886
+ * @public
806
887
  * <p>Describes the format of the data in the streaming source, and how each data element maps to corresponding
807
888
  * columns in the in-application stream that is being created. </p>
808
889
  */
809
890
  InputSchema?: SourceSchema;
810
891
  /**
892
+ * @public
811
893
  * <p>Describes the configured parallelism (number of in-application streams
812
894
  * mapped to the streaming source).</p>
813
895
  */
814
896
  InputParallelism?: InputParallelism;
815
897
  /**
898
+ * @public
816
899
  * <p>Point at which the application is configured to read from the input stream.</p>
817
900
  */
818
901
  InputStartingPositionConfiguration?: InputStartingPositionConfiguration;
@@ -826,10 +909,12 @@ export interface InputDescription {
826
909
  */
827
910
  export interface KinesisFirehoseOutputDescription {
828
911
  /**
912
+ * @public
829
913
  * <p>Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream.</p>
830
914
  */
831
915
  ResourceARN?: string;
832
916
  /**
917
+ * @public
833
918
  * <p>ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream.</p>
834
919
  */
835
920
  RoleARN?: string;
@@ -843,10 +928,12 @@ export interface KinesisFirehoseOutputDescription {
843
928
  */
844
929
  export interface KinesisStreamsOutputDescription {
845
930
  /**
931
+ * @public
846
932
  * <p>Amazon Resource Name (ARN) of the Amazon Kinesis stream.</p>
847
933
  */
848
934
  ResourceARN?: string;
849
935
  /**
936
+ * @public
850
937
  * <p>ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream.</p>
851
938
  */
852
939
  RoleARN?: string;
@@ -858,10 +945,12 @@ export interface KinesisStreamsOutputDescription {
858
945
  */
859
946
  export interface LambdaOutputDescription {
860
947
  /**
948
+ * @public
861
949
  * <p>Amazon Resource Name (ARN) of the destination Lambda function.</p>
862
950
  */
863
951
  ResourceARN?: string;
864
952
  /**
953
+ * @public
865
954
  * <p>ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination function.</p>
866
955
  */
867
956
  RoleARN?: string;
@@ -876,29 +965,35 @@ export interface LambdaOutputDescription {
876
965
  */
877
966
  export interface OutputDescription {
878
967
  /**
968
+ * @public
879
969
  * <p>A unique identifier for the output configuration.</p>
880
970
  */
881
971
  OutputId?: string;
882
972
  /**
973
+ * @public
883
974
  * <p>Name of the in-application stream configured as output.</p>
884
975
  */
885
976
  Name?: string;
886
977
  /**
978
+ * @public
887
979
  * <p>Describes Amazon Kinesis stream configured as the
888
980
  * destination where output is written.</p>
889
981
  */
890
982
  KinesisStreamsOutputDescription?: KinesisStreamsOutputDescription;
891
983
  /**
984
+ * @public
892
985
  * <p>Describes the Amazon Kinesis Firehose delivery stream configured as the
893
986
  * destination where output is written.</p>
894
987
  */
895
988
  KinesisFirehoseOutputDescription?: KinesisFirehoseOutputDescription;
896
989
  /**
990
+ * @public
897
991
  * <p>Describes the AWS Lambda function configured as the destination where output is
898
992
  * written.</p>
899
993
  */
900
994
  LambdaOutputDescription?: LambdaOutputDescription;
901
995
  /**
996
+ * @public
902
997
  * <p>Data format used for writing data to the destination.</p>
903
998
  */
904
999
  DestinationSchema?: DestinationSchema;
@@ -909,14 +1004,17 @@ export interface OutputDescription {
909
1004
  */
910
1005
  export interface S3ReferenceDataSourceDescription {
911
1006
  /**
1007
+ * @public
912
1008
  * <p>Amazon Resource Name (ARN) of the S3 bucket.</p>
913
1009
  */
914
1010
  BucketARN: string | undefined;
915
1011
  /**
1012
+ * @public
916
1013
  * <p>Amazon S3 object key name.</p>
917
1014
  */
918
1015
  FileKey: string | undefined;
919
1016
  /**
1017
+ * @public
920
1018
  * <p>ARN of the IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object on your behalf to populate the in-application reference table.</p>
921
1019
  */
922
1020
  ReferenceRoleARN: string | undefined;
@@ -927,20 +1025,24 @@ export interface S3ReferenceDataSourceDescription {
927
1025
  */
928
1026
  export interface ReferenceDataSourceDescription {
929
1027
  /**
1028
+ * @public
930
1029
  * <p>ID of the reference data source. This is the ID
931
1030
  * that Amazon Kinesis Analytics assigns when you add the reference data source
932
1031
  * to your application using the <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_AddApplicationReferenceDataSource.html">AddApplicationReferenceDataSource</a> operation.</p>
933
1032
  */
934
1033
  ReferenceId: string | undefined;
935
1034
  /**
1035
+ * @public
936
1036
  * <p>The in-application table name created by the specific reference data source configuration.</p>
937
1037
  */
938
1038
  TableName: string | undefined;
939
1039
  /**
1040
+ * @public
940
1041
  * <p>Provides the S3 bucket name, the object key name that contains the reference data. It also provides the Amazon Resource Name (ARN) of the IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object and populate the in-application reference table.</p>
941
1042
  */
942
1043
  S3ReferenceDataSourceDescription: S3ReferenceDataSourceDescription | undefined;
943
1044
  /**
1045
+ * @public
944
1046
  * <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>
945
1047
  */
946
1048
  ReferenceSchema?: SourceSchema;
@@ -954,30 +1056,37 @@ export interface ReferenceDataSourceDescription {
954
1056
  */
955
1057
  export interface ApplicationDetail {
956
1058
  /**
1059
+ * @public
957
1060
  * <p>Name of the application.</p>
958
1061
  */
959
1062
  ApplicationName: string | undefined;
960
1063
  /**
1064
+ * @public
961
1065
  * <p>Description of the application.</p>
962
1066
  */
963
1067
  ApplicationDescription?: string;
964
1068
  /**
1069
+ * @public
965
1070
  * <p>ARN of the application.</p>
966
1071
  */
967
1072
  ApplicationARN: string | undefined;
968
1073
  /**
1074
+ * @public
969
1075
  * <p>Status of the application.</p>
970
1076
  */
971
1077
  ApplicationStatus: ApplicationStatus | string | undefined;
972
1078
  /**
1079
+ * @public
973
1080
  * <p>Time stamp when the application version was created.</p>
974
1081
  */
975
1082
  CreateTimestamp?: Date;
976
1083
  /**
1084
+ * @public
977
1085
  * <p>Time stamp when the application was last updated.</p>
978
1086
  */
979
1087
  LastUpdateTimestamp?: Date;
980
1088
  /**
1089
+ * @public
981
1090
  * <p>Describes the application input configuration.
982
1091
  * For more information,
983
1092
  * see <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html">Configuring Application Input</a>.
@@ -986,6 +1095,7 @@ export interface ApplicationDetail {
986
1095
  */
987
1096
  InputDescriptions?: InputDescription[];
988
1097
  /**
1098
+ * @public
989
1099
  * <p>Describes the application output configuration.
990
1100
  * For more information,
991
1101
  * see <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html">Configuring Application Output</a>.
@@ -994,6 +1104,7 @@ export interface ApplicationDetail {
994
1104
  */
995
1105
  OutputDescriptions?: OutputDescription[];
996
1106
  /**
1107
+ * @public
997
1108
  * <p>Describes reference data sources configured for the application.
998
1109
  *
999
1110
  * For more information,
@@ -1003,6 +1114,7 @@ export interface ApplicationDetail {
1003
1114
  */
1004
1115
  ReferenceDataSourceDescriptions?: ReferenceDataSourceDescription[];
1005
1116
  /**
1117
+ * @public
1006
1118
  * <p>Describes the CloudWatch log streams that are configured to receive application
1007
1119
  * messages. For more information about using CloudWatch log streams with Amazon Kinesis
1008
1120
  * Analytics applications, see <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/cloudwatch-logs.html">Working with Amazon
@@ -1010,10 +1122,12 @@ export interface ApplicationDetail {
1010
1122
  */
1011
1123
  CloudWatchLoggingOptionDescriptions?: CloudWatchLoggingOptionDescription[];
1012
1124
  /**
1125
+ * @public
1013
1126
  * <p>Returns the application code that you provided to perform data analysis on any of the in-application streams in your application.</p>
1014
1127
  */
1015
1128
  ApplicationCode?: string;
1016
1129
  /**
1130
+ * @public
1017
1131
  * <p>Provides the current application version.</p>
1018
1132
  */
1019
1133
  ApplicationVersionId: number | undefined;
@@ -1027,14 +1141,17 @@ export interface ApplicationDetail {
1027
1141
  */
1028
1142
  export interface ApplicationSummary {
1029
1143
  /**
1144
+ * @public
1030
1145
  * <p>Name of the application.</p>
1031
1146
  */
1032
1147
  ApplicationName: string | undefined;
1033
1148
  /**
1149
+ * @public
1034
1150
  * <p>ARN of the application.</p>
1035
1151
  */
1036
1152
  ApplicationARN: string | undefined;
1037
1153
  /**
1154
+ * @public
1038
1155
  * <p>Status of the application.</p>
1039
1156
  */
1040
1157
  ApplicationStatus: ApplicationStatus | string | undefined;
@@ -1045,14 +1162,17 @@ export interface ApplicationSummary {
1045
1162
  */
1046
1163
  export interface CloudWatchLoggingOptionUpdate {
1047
1164
  /**
1165
+ * @public
1048
1166
  * <p>ID of the CloudWatch logging option to update</p>
1049
1167
  */
1050
1168
  CloudWatchLoggingOptionId: string | undefined;
1051
1169
  /**
1170
+ * @public
1052
1171
  * <p>ARN of the CloudWatch log to receive application messages.</p>
1053
1172
  */
1054
1173
  LogStreamARNUpdate?: string;
1055
1174
  /**
1175
+ * @public
1056
1176
  * <p>IAM ARN of the role to use to send application messages. Note: To write application messages to CloudWatch, the IAM role used must have the <code>PutLogEvents</code> policy action enabled.</p>
1057
1177
  */
1058
1178
  RoleARNUpdate?: string;
@@ -1063,6 +1183,7 @@ export interface CloudWatchLoggingOptionUpdate {
1063
1183
  */
1064
1184
  export interface InputParallelismUpdate {
1065
1185
  /**
1186
+ * @public
1066
1187
  * <p>Number of in-application streams to create for the specified
1067
1188
  * streaming source.</p>
1068
1189
  */
@@ -1074,6 +1195,7 @@ export interface InputParallelismUpdate {
1074
1195
  */
1075
1196
  export interface InputLambdaProcessorUpdate {
1076
1197
  /**
1198
+ * @public
1077
1199
  * <p>The Amazon Resource Name (ARN) of the new <a href="https://docs.aws.amazon.com/lambda/">AWS Lambda</a> function that
1078
1200
  * is used to preprocess the records in the stream.</p>
1079
1201
  * <note>
@@ -1083,6 +1205,7 @@ export interface InputLambdaProcessorUpdate {
1083
1205
  */
1084
1206
  ResourceARNUpdate?: string;
1085
1207
  /**
1208
+ * @public
1086
1209
  * <p>The ARN of the new IAM role that is used to access the AWS Lambda
1087
1210
  * function.</p>
1088
1211
  */
@@ -1094,6 +1217,7 @@ export interface InputLambdaProcessorUpdate {
1094
1217
  */
1095
1218
  export interface InputProcessingConfigurationUpdate {
1096
1219
  /**
1220
+ * @public
1097
1221
  * <p>Provides update information for an <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputLambdaProcessor.html">InputLambdaProcessor</a>.</p>
1098
1222
  */
1099
1223
  InputLambdaProcessorUpdate: InputLambdaProcessorUpdate | undefined;
@@ -1104,14 +1228,17 @@ export interface InputProcessingConfigurationUpdate {
1104
1228
  */
1105
1229
  export interface InputSchemaUpdate {
1106
1230
  /**
1231
+ * @public
1107
1232
  * <p>Specifies the format of the records on the streaming source.</p>
1108
1233
  */
1109
1234
  RecordFormatUpdate?: RecordFormat;
1110
1235
  /**
1236
+ * @public
1111
1237
  * <p>Specifies the encoding of the records in the streaming source. For example, UTF-8.</p>
1112
1238
  */
1113
1239
  RecordEncodingUpdate?: string;
1114
1240
  /**
1241
+ * @public
1115
1242
  * <p>A list of <code>RecordColumn</code> objects. Each object describes the mapping
1116
1243
  * of the streaming source element to the corresponding column in the in-application stream. </p>
1117
1244
  */
@@ -1124,11 +1251,13 @@ export interface InputSchemaUpdate {
1124
1251
  */
1125
1252
  export interface KinesisFirehoseInputUpdate {
1126
1253
  /**
1254
+ * @public
1127
1255
  * <p>Amazon Resource Name (ARN) of the input Amazon Kinesis Firehose delivery stream to
1128
1256
  * read.</p>
1129
1257
  */
1130
1258
  ResourceARNUpdate?: string;
1131
1259
  /**
1260
+ * @public
1132
1261
  * <p>ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream
1133
1262
  * on your behalf. You need to grant the necessary permissions to this role.</p>
1134
1263
  */
@@ -1141,10 +1270,12 @@ export interface KinesisFirehoseInputUpdate {
1141
1270
  */
1142
1271
  export interface KinesisStreamsInputUpdate {
1143
1272
  /**
1273
+ * @public
1144
1274
  * <p>Amazon Resource Name (ARN) of the input Amazon Kinesis stream to read.</p>
1145
1275
  */
1146
1276
  ResourceARNUpdate?: string;
1147
1277
  /**
1278
+ * @public
1148
1279
  * <p>ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to grant the necessary permissions to this role.</p>
1149
1280
  */
1150
1281
  RoleARNUpdate?: string;
@@ -1156,34 +1287,41 @@ export interface KinesisStreamsInputUpdate {
1156
1287
  */
1157
1288
  export interface InputUpdate {
1158
1289
  /**
1290
+ * @public
1159
1291
  * <p>Input ID of the application input to be updated.</p>
1160
1292
  */
1161
1293
  InputId: string | undefined;
1162
1294
  /**
1295
+ * @public
1163
1296
  * <p>Name prefix for in-application streams that Amazon Kinesis Analytics creates
1164
1297
  * for the specific streaming source.</p>
1165
1298
  */
1166
1299
  NamePrefixUpdate?: string;
1167
1300
  /**
1301
+ * @public
1168
1302
  * <p>Describes updates for an input processing configuration.</p>
1169
1303
  */
1170
1304
  InputProcessingConfigurationUpdate?: InputProcessingConfigurationUpdate;
1171
1305
  /**
1306
+ * @public
1172
1307
  * <p>If an Amazon Kinesis stream is the streaming source to be updated, provides an
1173
1308
  * updated stream Amazon Resource Name (ARN) and IAM role ARN.</p>
1174
1309
  */
1175
1310
  KinesisStreamsInputUpdate?: KinesisStreamsInputUpdate;
1176
1311
  /**
1312
+ * @public
1177
1313
  * <p>If an Amazon Kinesis Firehose delivery stream is the streaming source to be
1178
1314
  * updated, provides an updated stream ARN and IAM role ARN.</p>
1179
1315
  */
1180
1316
  KinesisFirehoseInputUpdate?: KinesisFirehoseInputUpdate;
1181
1317
  /**
1318
+ * @public
1182
1319
  * <p>Describes the data format on the streaming source, and
1183
1320
  * how record elements on the streaming source map to columns of the in-application stream that is created.</p>
1184
1321
  */
1185
1322
  InputSchemaUpdate?: InputSchemaUpdate;
1186
1323
  /**
1324
+ * @public
1187
1325
  * <p>Describes the parallelism updates (the number in-application
1188
1326
  * streams Amazon Kinesis Analytics creates for the specific streaming source).</p>
1189
1327
  */
@@ -1200,10 +1338,12 @@ export interface InputUpdate {
1200
1338
  */
1201
1339
  export interface KinesisFirehoseOutputUpdate {
1202
1340
  /**
1341
+ * @public
1203
1342
  * <p>Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream to write to.</p>
1204
1343
  */
1205
1344
  ResourceARNUpdate?: string;
1206
1345
  /**
1346
+ * @public
1207
1347
  * <p>ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream
1208
1348
  * on your behalf. You need to grant the necessary permissions to this role.</p>
1209
1349
  */
@@ -1220,10 +1360,12 @@ export interface KinesisFirehoseOutputUpdate {
1220
1360
  */
1221
1361
  export interface KinesisStreamsOutputUpdate {
1222
1362
  /**
1363
+ * @public
1223
1364
  * <p>Amazon Resource Name (ARN) of the Amazon Kinesis stream where you want to write the output.</p>
1224
1365
  */
1225
1366
  ResourceARNUpdate?: string;
1226
1367
  /**
1368
+ * @public
1227
1369
  * <p>ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to grant the necessary permissions to this role.</p>
1228
1370
  */
1229
1371
  RoleARNUpdate?: string;
@@ -1236,6 +1378,7 @@ export interface KinesisStreamsOutputUpdate {
1236
1378
  */
1237
1379
  export interface LambdaOutputUpdate {
1238
1380
  /**
1381
+ * @public
1239
1382
  * <p>Amazon Resource Name (ARN) of the destination Lambda function.</p>
1240
1383
  * <note>
1241
1384
  * <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="/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-lambda">Example ARNs: AWS Lambda</a>
@@ -1244,6 +1387,7 @@ export interface LambdaOutputUpdate {
1244
1387
  */
1245
1388
  ResourceARNUpdate?: string;
1246
1389
  /**
1390
+ * @public
1247
1391
  * <p>ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination function on your behalf. You need to grant the necessary permissions to this role. </p>
1248
1392
  */
1249
1393
  RoleARNUpdate?: string;
@@ -1257,29 +1401,35 @@ export interface LambdaOutputUpdate {
1257
1401
  */
1258
1402
  export interface OutputUpdate {
1259
1403
  /**
1404
+ * @public
1260
1405
  * <p>Identifies the specific output configuration that you want to update.</p>
1261
1406
  */
1262
1407
  OutputId: string | undefined;
1263
1408
  /**
1409
+ * @public
1264
1410
  * <p>If you want to specify a different in-application stream
1265
1411
  * for this output configuration, use this field to
1266
1412
  * specify the new in-application stream name.</p>
1267
1413
  */
1268
1414
  NameUpdate?: string;
1269
1415
  /**
1416
+ * @public
1270
1417
  * <p>Describes an Amazon Kinesis stream as the destination for the output.</p>
1271
1418
  */
1272
1419
  KinesisStreamsOutputUpdate?: KinesisStreamsOutputUpdate;
1273
1420
  /**
1421
+ * @public
1274
1422
  * <p>Describes an Amazon Kinesis Firehose delivery stream as the destination for the
1275
1423
  * output.</p>
1276
1424
  */
1277
1425
  KinesisFirehoseOutputUpdate?: KinesisFirehoseOutputUpdate;
1278
1426
  /**
1427
+ * @public
1279
1428
  * <p>Describes an AWS Lambda function as the destination for the output.</p>
1280
1429
  */
1281
1430
  LambdaOutputUpdate?: LambdaOutputUpdate;
1282
1431
  /**
1432
+ * @public
1283
1433
  * <p>Describes the data format when records are written to the destination. For more information, see <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html">Configuring Application Output</a>.</p>
1284
1434
  */
1285
1435
  DestinationSchemaUpdate?: DestinationSchema;
@@ -1290,14 +1440,17 @@ export interface OutputUpdate {
1290
1440
  */
1291
1441
  export interface S3ReferenceDataSourceUpdate {
1292
1442
  /**
1443
+ * @public
1293
1444
  * <p>Amazon Resource Name (ARN) of the S3 bucket.</p>
1294
1445
  */
1295
1446
  BucketARNUpdate?: string;
1296
1447
  /**
1448
+ * @public
1297
1449
  * <p>Object key name.</p>
1298
1450
  */
1299
1451
  FileKeyUpdate?: string;
1300
1452
  /**
1453
+ * @public
1301
1454
  * <p>ARN of the IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object and populate the in-application.</p>
1302
1455
  */
1303
1456
  ReferenceRoleARNUpdate?: string;
@@ -1308,19 +1461,23 @@ export interface S3ReferenceDataSourceUpdate {
1308
1461
  */
1309
1462
  export interface ReferenceDataSourceUpdate {
1310
1463
  /**
1464
+ * @public
1311
1465
  * <p>ID of the reference data source being updated. You can use the
1312
1466
  * <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html">DescribeApplication</a> operation to get this value.</p>
1313
1467
  */
1314
1468
  ReferenceId: string | undefined;
1315
1469
  /**
1470
+ * @public
1316
1471
  * <p>In-application table name that is created by this update.</p>
1317
1472
  */
1318
1473
  TableNameUpdate?: string;
1319
1474
  /**
1475
+ * @public
1320
1476
  * <p>Describes the S3 bucket name, object key name, and IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object on your behalf and populate the in-application reference table.</p>
1321
1477
  */
1322
1478
  S3ReferenceDataSourceUpdate?: S3ReferenceDataSourceUpdate;
1323
1479
  /**
1480
+ * @public
1324
1481
  * <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>
1325
1482
  */
1326
1483
  ReferenceSchemaUpdate?: SourceSchema;
@@ -1331,22 +1488,27 @@ export interface ReferenceDataSourceUpdate {
1331
1488
  */
1332
1489
  export interface ApplicationUpdate {
1333
1490
  /**
1491
+ * @public
1334
1492
  * <p>Describes application input configuration updates.</p>
1335
1493
  */
1336
1494
  InputUpdates?: InputUpdate[];
1337
1495
  /**
1496
+ * @public
1338
1497
  * <p>Describes application code updates.</p>
1339
1498
  */
1340
1499
  ApplicationCodeUpdate?: string;
1341
1500
  /**
1501
+ * @public
1342
1502
  * <p>Describes application output configuration updates.</p>
1343
1503
  */
1344
1504
  OutputUpdates?: OutputUpdate[];
1345
1505
  /**
1506
+ * @public
1346
1507
  * <p>Describes application reference data source updates.</p>
1347
1508
  */
1348
1509
  ReferenceDataSourceUpdates?: ReferenceDataSourceUpdate[];
1349
1510
  /**
1511
+ * @public
1350
1512
  * <p>Describes application CloudWatch logging option updates.</p>
1351
1513
  */
1352
1514
  CloudWatchLoggingOptionUpdates?: CloudWatchLoggingOptionUpdate[];
@@ -1359,10 +1521,12 @@ export interface ApplicationUpdate {
1359
1521
  */
1360
1522
  export interface Tag {
1361
1523
  /**
1524
+ * @public
1362
1525
  * <p>The key of the key-value tag.</p>
1363
1526
  */
1364
1527
  Key: string | undefined;
1365
1528
  /**
1529
+ * @public
1366
1530
  * <p>The value of the key-value tag. The value is optional.</p>
1367
1531
  */
1368
1532
  Value?: string;
@@ -1373,14 +1537,17 @@ export interface Tag {
1373
1537
  */
1374
1538
  export interface CreateApplicationRequest {
1375
1539
  /**
1540
+ * @public
1376
1541
  * <p>Name of your Amazon Kinesis Analytics application (for example, <code>sample-app</code>).</p>
1377
1542
  */
1378
1543
  ApplicationName: string | undefined;
1379
1544
  /**
1545
+ * @public
1380
1546
  * <p>Summary description of the application.</p>
1381
1547
  */
1382
1548
  ApplicationDescription?: string;
1383
1549
  /**
1550
+ * @public
1384
1551
  * <p>Use this parameter to configure the application input.</p>
1385
1552
  * <p>You can configure your application to receive input from a single streaming source. In this configuration, you map this streaming source to an in-application stream that is created. Your application code can then query the in-application stream like a table (you can think of it as a constantly updating table).</p>
1386
1553
  * <p>For the streaming source, you provide its Amazon Resource Name (ARN) and format of
@@ -1390,6 +1557,7 @@ export interface CreateApplicationRequest {
1390
1557
  */
1391
1558
  Inputs?: Input[];
1392
1559
  /**
1560
+ * @public
1393
1561
  * <p>You can configure application output to write data from any of the in-application streams to up to three destinations.</p>
1394
1562
  * <p>These destinations can be Amazon Kinesis streams, Amazon Kinesis Firehose delivery
1395
1563
  * streams, AWS Lambda destinations, or any combination of the three.</p>
@@ -1401,12 +1569,14 @@ export interface CreateApplicationRequest {
1401
1569
  */
1402
1570
  Outputs?: Output[];
1403
1571
  /**
1572
+ * @public
1404
1573
  * <p>Use this parameter to configure a CloudWatch log stream to monitor application
1405
1574
  * configuration errors. For more information, see <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/cloudwatch-logs.html">Working with Amazon
1406
1575
  * CloudWatch Logs</a>.</p>
1407
1576
  */
1408
1577
  CloudWatchLoggingOptions?: CloudWatchLoggingOption[];
1409
1578
  /**
1579
+ * @public
1410
1580
  * <p>One or more SQL statements that read input data, transform it, and generate output.
1411
1581
  * For example, you can write a SQL statement that reads data from one in-application
1412
1582
  * stream, generates a running average of the number of advertisement clicks by vendor, and
@@ -1427,6 +1597,7 @@ export interface CreateApplicationRequest {
1427
1597
  */
1428
1598
  ApplicationCode?: string;
1429
1599
  /**
1600
+ * @public
1430
1601
  * <p>A list of one or more tags to assign to the application. A tag is a key-value pair that identifies an application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50.
1431
1602
  * For more information, see <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-tagging.html">Using Tagging</a>.</p>
1432
1603
  */
@@ -1438,6 +1609,7 @@ export interface CreateApplicationRequest {
1438
1609
  */
1439
1610
  export interface CreateApplicationResponse {
1440
1611
  /**
1612
+ * @public
1441
1613
  * <p>In response to your <code>CreateApplication</code> request, Amazon Kinesis Analytics returns a
1442
1614
  * response with a summary of the application it created, including the application Amazon Resource Name (ARN),
1443
1615
  * name, and status.</p>
@@ -1474,10 +1646,12 @@ export declare class TooManyTagsException extends __BaseException {
1474
1646
  */
1475
1647
  export interface DeleteApplicationRequest {
1476
1648
  /**
1649
+ * @public
1477
1650
  * <p>Name of the Amazon Kinesis Analytics application to delete.</p>
1478
1651
  */
1479
1652
  ApplicationName: string | undefined;
1480
1653
  /**
1654
+ * @public
1481
1655
  * <p>
1482
1656
  * You can use the <code>DescribeApplication</code> operation to get this value.
1483
1657
  * </p>
@@ -1495,14 +1669,17 @@ export interface DeleteApplicationResponse {
1495
1669
  */
1496
1670
  export interface DeleteApplicationCloudWatchLoggingOptionRequest {
1497
1671
  /**
1672
+ * @public
1498
1673
  * <p>The Kinesis Analytics application name.</p>
1499
1674
  */
1500
1675
  ApplicationName: string | undefined;
1501
1676
  /**
1677
+ * @public
1502
1678
  * <p>The version ID of the Kinesis Analytics application.</p>
1503
1679
  */
1504
1680
  CurrentApplicationVersionId: number | undefined;
1505
1681
  /**
1682
+ * @public
1506
1683
  * <p>The <code>CloudWatchLoggingOptionId</code> of the CloudWatch logging option to
1507
1684
  * delete. You can get the <code>CloudWatchLoggingOptionId</code> by using the <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html">DescribeApplication</a> operation. </p>
1508
1685
  */
@@ -1518,14 +1695,17 @@ export interface DeleteApplicationCloudWatchLoggingOptionResponse {
1518
1695
  */
1519
1696
  export interface DeleteApplicationInputProcessingConfigurationRequest {
1520
1697
  /**
1698
+ * @public
1521
1699
  * <p>The Kinesis Analytics application name.</p>
1522
1700
  */
1523
1701
  ApplicationName: string | undefined;
1524
1702
  /**
1703
+ * @public
1525
1704
  * <p>The version ID of the Kinesis Analytics application.</p>
1526
1705
  */
1527
1706
  CurrentApplicationVersionId: number | undefined;
1528
1707
  /**
1708
+ * @public
1529
1709
  * <p>The ID of the input configuration from which to delete the input processing
1530
1710
  * configuration. You can get a list of the input IDs for an application by using the <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html">DescribeApplication</a> operation.</p>
1531
1711
  */
@@ -1542,10 +1722,12 @@ export interface DeleteApplicationInputProcessingConfigurationResponse {
1542
1722
  */
1543
1723
  export interface DeleteApplicationOutputRequest {
1544
1724
  /**
1725
+ * @public
1545
1726
  * <p>Amazon Kinesis Analytics application name.</p>
1546
1727
  */
1547
1728
  ApplicationName: string | undefined;
1548
1729
  /**
1730
+ * @public
1549
1731
  * <p>Amazon Kinesis Analytics application version.
1550
1732
  * You can use the <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html">DescribeApplication</a> operation to get the current application version.
1551
1733
  * If the version specified is not the current version, the
@@ -1554,6 +1736,7 @@ export interface DeleteApplicationOutputRequest {
1554
1736
  */
1555
1737
  CurrentApplicationVersionId: number | undefined;
1556
1738
  /**
1739
+ * @public
1557
1740
  * <p>The ID of the configuration to delete.
1558
1741
  * Each output configuration that is added to the application, either when the application is
1559
1742
  * created or later using the <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_AddApplicationOutput.html">AddApplicationOutput</a> operation, has a unique ID.
@@ -1576,10 +1759,12 @@ export interface DeleteApplicationOutputResponse {
1576
1759
  */
1577
1760
  export interface DeleteApplicationReferenceDataSourceRequest {
1578
1761
  /**
1762
+ * @public
1579
1763
  * <p>Name of an existing application.</p>
1580
1764
  */
1581
1765
  ApplicationName: string | undefined;
1582
1766
  /**
1767
+ * @public
1583
1768
  * <p>Version of the application.
1584
1769
  * You can use the <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html">DescribeApplication</a> operation to get the current application version.
1585
1770
  * If the version specified
@@ -1587,6 +1772,7 @@ export interface DeleteApplicationReferenceDataSourceRequest {
1587
1772
  */
1588
1773
  CurrentApplicationVersionId: number | undefined;
1589
1774
  /**
1775
+ * @public
1590
1776
  * <p>ID of the reference data source. When you add a reference data source to your
1591
1777
  * application using the
1592
1778
  * <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_AddApplicationReferenceDataSource.html">AddApplicationReferenceDataSource</a>, Amazon Kinesis Analytics assigns an ID.
@@ -1606,6 +1792,7 @@ export interface DeleteApplicationReferenceDataSourceResponse {
1606
1792
  */
1607
1793
  export interface DescribeApplicationRequest {
1608
1794
  /**
1795
+ * @public
1609
1796
  * <p>Name of the application.</p>
1610
1797
  */
1611
1798
  ApplicationName: string | undefined;
@@ -1616,6 +1803,7 @@ export interface DescribeApplicationRequest {
1616
1803
  */
1617
1804
  export interface DescribeApplicationResponse {
1618
1805
  /**
1806
+ * @public
1619
1807
  * <p>Provides a description of the application, such as the application Amazon Resource Name (ARN), status, latest version, and input and output configuration details.</p>
1620
1808
  */
1621
1809
  ApplicationDetail: ApplicationDetail | undefined;
@@ -1628,14 +1816,17 @@ export interface DescribeApplicationResponse {
1628
1816
  */
1629
1817
  export interface S3Configuration {
1630
1818
  /**
1819
+ * @public
1631
1820
  * <p>IAM ARN of the role used to access the data.</p>
1632
1821
  */
1633
1822
  RoleARN: string | undefined;
1634
1823
  /**
1824
+ * @public
1635
1825
  * <p>ARN of the S3 bucket that contains the data.</p>
1636
1826
  */
1637
1827
  BucketARN: string | undefined;
1638
1828
  /**
1829
+ * @public
1639
1830
  * <p>The name of the object that contains the data.</p>
1640
1831
  */
1641
1832
  FileKey: string | undefined;
@@ -1645,23 +1836,28 @@ export interface S3Configuration {
1645
1836
  */
1646
1837
  export interface DiscoverInputSchemaRequest {
1647
1838
  /**
1839
+ * @public
1648
1840
  * <p>Amazon Resource Name (ARN) of the streaming source.</p>
1649
1841
  */
1650
1842
  ResourceARN?: string;
1651
1843
  /**
1844
+ * @public
1652
1845
  * <p>ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf.</p>
1653
1846
  */
1654
1847
  RoleARN?: string;
1655
1848
  /**
1849
+ * @public
1656
1850
  * <p>Point at which you want Amazon Kinesis Analytics to start reading records from the specified streaming source discovery purposes.</p>
1657
1851
  */
1658
1852
  InputStartingPositionConfiguration?: InputStartingPositionConfiguration;
1659
1853
  /**
1854
+ * @public
1660
1855
  * <p>Specify this parameter to discover a schema from data in an Amazon S3
1661
1856
  * object.</p>
1662
1857
  */
1663
1858
  S3Configuration?: S3Configuration;
1664
1859
  /**
1860
+ * @public
1665
1861
  * <p>The <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html">InputProcessingConfiguration</a> to use to preprocess the records before discovering the schema of the records.</p>
1666
1862
  */
1667
1863
  InputProcessingConfiguration?: InputProcessingConfiguration;
@@ -1672,18 +1868,22 @@ export interface DiscoverInputSchemaRequest {
1672
1868
  */
1673
1869
  export interface DiscoverInputSchemaResponse {
1674
1870
  /**
1871
+ * @public
1675
1872
  * <p>Schema inferred from the streaming source. It identifies the format of the data in the streaming source and how each data element maps to corresponding columns in the in-application stream that you can create.</p>
1676
1873
  */
1677
1874
  InputSchema?: SourceSchema;
1678
1875
  /**
1876
+ * @public
1679
1877
  * <p>An array of elements, where each element corresponds to a row in a stream record (a stream record can have more than one row).</p>
1680
1878
  */
1681
1879
  ParsedInputRecords?: string[][];
1682
1880
  /**
1881
+ * @public
1683
1882
  * <p>Stream data that was modified by the processor specified in the <code>InputProcessingConfiguration</code> parameter.</p>
1684
1883
  */
1685
1884
  ProcessedInputRecords?: string[];
1686
1885
  /**
1886
+ * @public
1687
1887
  * <p>Raw stream data that was sampled to infer the schema.</p>
1688
1888
  */
1689
1889
  RawInputRecords?: string[];
@@ -1739,11 +1939,13 @@ export declare class UnableToDetectSchemaException extends __BaseException {
1739
1939
  */
1740
1940
  export interface InputConfiguration {
1741
1941
  /**
1942
+ * @public
1742
1943
  * <p>Input source ID. You can get this ID by calling
1743
1944
  * the <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html">DescribeApplication</a> operation.</p>
1744
1945
  */
1745
1946
  Id: string | undefined;
1746
1947
  /**
1948
+ * @public
1747
1949
  * <p>Point at which you want the application to start processing
1748
1950
  * records from the streaming source.</p>
1749
1951
  */
@@ -1767,10 +1969,12 @@ export declare class InvalidApplicationConfigurationException extends __BaseExce
1767
1969
  */
1768
1970
  export interface ListApplicationsRequest {
1769
1971
  /**
1972
+ * @public
1770
1973
  * <p>Maximum number of applications to list.</p>
1771
1974
  */
1772
1975
  Limit?: number;
1773
1976
  /**
1977
+ * @public
1774
1978
  * <p>Name of the application to start the list with. When using pagination to retrieve the list, you don't need to specify this parameter in the first request. However, in subsequent requests, you add the last application name from the previous response to get the next page of applications.</p>
1775
1979
  */
1776
1980
  ExclusiveStartApplicationName?: string;
@@ -1781,10 +1985,12 @@ export interface ListApplicationsRequest {
1781
1985
  */
1782
1986
  export interface ListApplicationsResponse {
1783
1987
  /**
1988
+ * @public
1784
1989
  * <p>List of <code>ApplicationSummary</code> objects. </p>
1785
1990
  */
1786
1991
  ApplicationSummaries: ApplicationSummary[] | undefined;
1787
1992
  /**
1993
+ * @public
1788
1994
  * <p>Returns true if there are more applications to retrieve.</p>
1789
1995
  */
1790
1996
  HasMoreApplications: boolean | undefined;
@@ -1794,6 +2000,7 @@ export interface ListApplicationsResponse {
1794
2000
  */
1795
2001
  export interface ListTagsForResourceRequest {
1796
2002
  /**
2003
+ * @public
1797
2004
  * <p>The ARN of the application for which to retrieve tags.</p>
1798
2005
  */
1799
2006
  ResourceARN: string | undefined;
@@ -1803,6 +2010,7 @@ export interface ListTagsForResourceRequest {
1803
2010
  */
1804
2011
  export interface ListTagsForResourceResponse {
1805
2012
  /**
2013
+ * @public
1806
2014
  * <p>The key-value tags assigned to the application.</p>
1807
2015
  */
1808
2016
  Tags?: Tag[];
@@ -1813,10 +2021,12 @@ export interface ListTagsForResourceResponse {
1813
2021
  */
1814
2022
  export interface StartApplicationRequest {
1815
2023
  /**
2024
+ * @public
1816
2025
  * <p>Name of the application.</p>
1817
2026
  */
1818
2027
  ApplicationName: string | undefined;
1819
2028
  /**
2029
+ * @public
1820
2030
  * <p>Identifies the specific input, by ID, that the application starts consuming. Amazon Kinesis Analytics starts reading the streaming source associated with the input. You can also specify where in the streaming source you want Amazon Kinesis Analytics to start reading.</p>
1821
2031
  */
1822
2032
  InputConfigurations: InputConfiguration[] | undefined;
@@ -1833,6 +2043,7 @@ export interface StartApplicationResponse {
1833
2043
  */
1834
2044
  export interface StopApplicationRequest {
1835
2045
  /**
2046
+ * @public
1836
2047
  * <p>Name of the running application to stop.</p>
1837
2048
  */
1838
2049
  ApplicationName: string | undefined;
@@ -1848,10 +2059,12 @@ export interface StopApplicationResponse {
1848
2059
  */
1849
2060
  export interface TagResourceRequest {
1850
2061
  /**
2062
+ * @public
1851
2063
  * <p>The ARN of the application to assign the tags.</p>
1852
2064
  */
1853
2065
  ResourceARN: string | undefined;
1854
2066
  /**
2067
+ * @public
1855
2068
  * <p>The key-value tags to assign to the application.</p>
1856
2069
  */
1857
2070
  Tags: Tag[] | undefined;
@@ -1866,10 +2079,12 @@ export interface TagResourceResponse {
1866
2079
  */
1867
2080
  export interface UntagResourceRequest {
1868
2081
  /**
2082
+ * @public
1869
2083
  * <p>The ARN of the Kinesis Analytics application from which to remove the tags.</p>
1870
2084
  */
1871
2085
  ResourceARN: string | undefined;
1872
2086
  /**
2087
+ * @public
1873
2088
  * <p>A list of keys of tags to remove from the specified application.</p>
1874
2089
  */
1875
2090
  TagKeys: string[] | undefined;
@@ -1884,15 +2099,18 @@ export interface UntagResourceResponse {
1884
2099
  */
1885
2100
  export interface UpdateApplicationRequest {
1886
2101
  /**
2102
+ * @public
1887
2103
  * <p>Name of the Amazon Kinesis Analytics application to update.</p>
1888
2104
  */
1889
2105
  ApplicationName: string | undefined;
1890
2106
  /**
2107
+ * @public
1891
2108
  * <p>The current application version ID. You can use the
1892
2109
  * <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html">DescribeApplication</a> operation to get this value.</p>
1893
2110
  */
1894
2111
  CurrentApplicationVersionId: number | undefined;
1895
2112
  /**
2113
+ * @public
1896
2114
  * <p>Describes application updates.</p>
1897
2115
  */
1898
2116
  ApplicationUpdate: ApplicationUpdate | undefined;