forked from aws/aws-sdk-js
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathkinesisanalytics-2015-08-14.normal.json
1600 lines (1600 loc) · 75 KB
/
kinesisanalytics-2015-08-14.normal.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"version":"2.0",
"metadata":{
"uid":"kinesisanalytics-2015-08-14",
"apiVersion":"2015-08-14",
"endpointPrefix":"kinesisanalytics",
"jsonVersion":"1.1",
"protocol":"json",
"serviceAbbreviation":"Kinesis Analytics",
"serviceFullName":"Amazon Kinesis Analytics",
"signatureVersion":"v4",
"targetPrefix":"KinesisAnalytics_20150814",
"timestampFormat":"unixTimestamp"
},
"operations":{
"AddApplicationInput":{
"name":"AddApplicationInput",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AddApplicationInputRequest"},
"output":{"shape":"AddApplicationInputResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceInUseException"},
{"shape":"InvalidArgumentException"},
{"shape":"ConcurrentModificationException"}
],
"documentation":"<p> Adds a streaming source to your Amazon Kinesis application. For conceptual information, see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html\">Configuring Application Input</a>. </p> <p>You can add a streaming source either when you create an application or you can use this operation to add a streaming source after you create an application. For more information, see <a>CreateApplication</a>.</p> <p>Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the <a>DescribeApplication</a> operation to find the current application version. </p> <p>This operation requires permissions to perform the <code>kinesisanalytics:AddApplicationInput</code> action.</p>"
},
"AddApplicationOutput":{
"name":"AddApplicationOutput",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AddApplicationOutputRequest"},
"output":{"shape":"AddApplicationOutputResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceInUseException"},
{"shape":"InvalidArgumentException"},
{"shape":"ConcurrentModificationException"}
],
"documentation":"<p>Adds an external destination to your Amazon Kinesis Analytics application.</p> <p>If you want Amazon Kinesis Analytics to deliver data from an in-application stream within your application to an external destination (such as an Amazon Kinesis stream or a Firehose delivery stream), you add the relevant configuration to your application using this operation. You can configure one or more outputs for your application. Each output configuration maps an in-application stream and an external destination.</p> <p> You can use one of the output configurations to deliver data from your in-application error stream to an external destination so that you can analyze the errors. For conceptual information, see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html\">Understanding Application Output (Destination)</a>. </p> <p> Note that any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the <a>DescribeApplication</a> operation to find the current application version.</p> <p>For the limits on the number of application inputs and outputs you can configure, see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html\">Limits</a>.</p> <p>This operation requires permissions to perform the <code>kinesisanalytics:AddApplicationOutput</code> action.</p>"
},
"AddApplicationReferenceDataSource":{
"name":"AddApplicationReferenceDataSource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AddApplicationReferenceDataSourceRequest"},
"output":{"shape":"AddApplicationReferenceDataSourceResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceInUseException"},
{"shape":"InvalidArgumentException"},
{"shape":"ConcurrentModificationException"}
],
"documentation":"<p>Adds a reference data source to an existing application.</p> <p>Amazon Kinesis Analytics reads reference data (that is, an Amazon S3 object) and creates an in-application table within your application. In the request, you provide the source (S3 bucket name and object key name), name of the in-application table to create, and the necessary mapping information that describes how data in Amazon S3 object maps to columns in the resulting in-application table.</p> <p> For conceptual information, see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html\">Configuring Application Input</a>. For the limits on data sources you can add to your application, see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html\">Limits</a>. </p> <p> This operation requires permissions to perform the <code>kinesisanalytics:AddApplicationOutput</code> action. </p>"
},
"CreateApplication":{
"name":"CreateApplication",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateApplicationRequest"},
"output":{"shape":"CreateApplicationResponse"},
"errors":[
{"shape":"CodeValidationException"},
{"shape":"ResourceInUseException"},
{"shape":"LimitExceededException"},
{"shape":"InvalidArgumentException"}
],
"documentation":"<p> Creates an Amazon Kinesis Analytics application. You can configure each application with one streaming source as input, application code to process the input, and up to five streaming destinations where you want Amazon Kinesis Analytics to write the output data from your application. For an overview, see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works.html\">How it Works</a>. </p> <p>In the input configuration, you map the streaming source to an in-application stream, which you can think of as a constantly updating table. In the mapping, you must provide a schema for the in-application stream and map each data column in the in-application stream to a data element in the streaming source, with the option of renaming, casting and dropping columns as desired.</p> <p>Your application code is one or more SQL statements that read input data, transform it, and generate output. Your application code can create one or more SQL artifacts like SQL streams or pumps.</p> <p>In the output configuration, you can configure the application to write data from in-application streams created in your applications to up to five streaming destinations.</p> <p> To read data from your source stream or write data to destination streams, Amazon Kinesis Analytics needs your permissions. You grant these permissions by creating IAM roles. This operation requires permissions to perform the <code>kinesisanalytics:CreateApplication</code> action. </p> <p> For introductory exercises to create an Amazon Kinesis Analytics application, see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/getting-started.html\">Getting Started</a>. </p>"
},
"DeleteApplication":{
"name":"DeleteApplication",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteApplicationRequest"},
"output":{"shape":"DeleteApplicationResponse"},
"errors":[
{"shape":"ConcurrentModificationException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceInUseException"}
],
"documentation":"<p>Deletes the specified application. Amazon Kinesis Analytics halts application execution and deletes the application, including any application artifacts (such as in-application streams, reference table, and application code).</p> <p>This operation requires permissions to perform the <code>kinesisanalytics:DeleteApplication</code> action.</p>"
},
"DeleteApplicationOutput":{
"name":"DeleteApplicationOutput",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteApplicationOutputRequest"},
"output":{"shape":"DeleteApplicationOutputResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceInUseException"},
{"shape":"ConcurrentModificationException"}
],
"documentation":"<p>Deletes output destination configuration from your application configuration. Amazon Kinesis Analytics will no longer write data from the corresponding in-application stream to the external output destination.</p> <p>This operation requires permissions to perform the <code>kinesisanalytics:DeleteApplicationOutput</code> action.</p>"
},
"DeleteApplicationReferenceDataSource":{
"name":"DeleteApplicationReferenceDataSource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteApplicationReferenceDataSourceRequest"},
"output":{"shape":"DeleteApplicationReferenceDataSourceResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceInUseException"},
{"shape":"InvalidArgumentException"},
{"shape":"ConcurrentModificationException"}
],
"documentation":"<p>Deletes a reference data source configuration from the specified application configuration.</p> <p>If the application is running, Amazon Kinesis Analytics immediately removes the in-application table that you created using the <a>AddApplicationReferenceDataSource</a> operation. </p> <p>This operation requires permissions to perform the <code>kinesisanalytics.DeleteApplicationReferenceDataSource</code> action.</p>"
},
"DescribeApplication":{
"name":"DescribeApplication",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeApplicationRequest"},
"output":{"shape":"DescribeApplicationResponse"},
"errors":[
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Returns information about a specific Amazon Kinesis Analytics application.</p> <p>If you want to retrieve a list of all applications in your account, use the <a>ListApplications</a> operation.</p> <p>This operation requires permissions to perform the <code>kinesisanalytics:DescribeApplication</code> action. You can use <code>DescribeApplication</code> to get the current application versionId, which you need to call other operations such as <code>Update</code>. </p>"
},
"DiscoverInputSchema":{
"name":"DiscoverInputSchema",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DiscoverInputSchemaRequest"},
"output":{"shape":"DiscoverInputSchemaResponse"},
"errors":[
{"shape":"InvalidArgumentException"},
{"shape":"UnableToDetectSchemaException"},
{"shape":"ResourceProvisionedThroughputExceededException"}
],
"documentation":"<p>Infers a schema by evaluating sample records on the specified streaming source (Amazon Kinesis stream or Amazon Kinesis Firehose delivery stream). In the response, the operation returns the inferred schema and also the sample records that the operation used to infer the schema.</p> <p> You can use the inferred schema when configuring a streaming source for your application. For conceptual information, see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html\">Configuring Application Input</a>. Note that when you create an application using the Amazon Kinesis Analytics console, the console uses this operation to infer a schema and show it in the console user interface. </p> <p> This operation requires permissions to perform the <code>kinesisanalytics:DiscoverInputSchema</code> action. </p>"
},
"ListApplications":{
"name":"ListApplications",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListApplicationsRequest"},
"output":{"shape":"ListApplicationsResponse"},
"documentation":"<p>Returns a list of Amazon Kinesis Analytics applications in your account. For each application, the response includes the application name, Amazon Resource Name (ARN), and status. If the response returns the <code>HasMoreApplications</code> value as true, you can send another request by adding the <code>ExclusiveStartApplicationName</code> in the request body, and set the value of this to the last application name from the previous response. </p> <p>If you want detailed information about a specific application, use <a>DescribeApplication</a>.</p> <p>This operation requires permissions to perform the <code>kinesisanalytics:ListApplications</code> action.</p>"
},
"StartApplication":{
"name":"StartApplication",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"StartApplicationRequest"},
"output":{"shape":"StartApplicationResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceInUseException"},
{"shape":"InvalidArgumentException"},
{"shape":"InvalidApplicationConfigurationException"}
],
"documentation":"<p>Starts the specified Amazon Kinesis Analytics application. After creating an application, you must exclusively call this operation to start your application.</p> <p>After the application starts, it begins consuming the input data, processes it, and writes the output to the configured destination.</p> <p> The application status must be <code>READY</code> for you to start an application. You can get the application status in the console or using the <a>DescribeApplication</a> operation.</p> <p>After you start the application, you can stop the application from processing the input by calling the <a>StopApplication</a> operation.</p> <p>This operation requires permissions to perform the <code>kinesisanalytics:StartApplication</code> action.</p>"
},
"StopApplication":{
"name":"StopApplication",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"StopApplicationRequest"},
"output":{"shape":"StopApplicationResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceInUseException"}
],
"documentation":"<p>Stops the application from processing input data. You can stop an application only if it is in the running state. You can use the <a>DescribeApplication</a> operation to find the application state. After the application is stopped, Amazon Kinesis Analytics stops reading data from the input, the application stops processing data, and there is no output written to the destination. </p> <p>This operation requires permissions to perform the <code>kinesisanalytics:StopApplication</code> action.</p>"
},
"UpdateApplication":{
"name":"UpdateApplication",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateApplicationRequest"},
"output":{"shape":"UpdateApplicationResponse"},
"errors":[
{"shape":"CodeValidationException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceInUseException"},
{"shape":"InvalidArgumentException"},
{"shape":"ConcurrentModificationException"}
],
"documentation":"<p>Updates an existing Kinesis Analytics application. Using this API, you can update application code, input configuration, and output configuration. </p> <p>Note that Kinesis Analytics updates the <code>CurrentApplicationVersionId</code> each time you update your application. </p> <p>This opeation requires permission for the <code>kinesisanalytics:UpdateApplication</code> action.</p>"
}
},
"shapes":{
"AddApplicationInputRequest":{
"type":"structure",
"required":[
"ApplicationName",
"CurrentApplicationVersionId",
"Input"
],
"members":{
"ApplicationName":{
"shape":"ApplicationName",
"documentation":"<p>Name of your existing Amazon Kinesis Analytics application to which you want to add the streaming source.</p>"
},
"CurrentApplicationVersionId":{
"shape":"ApplicationVersionId",
"documentation":"<p>Current version of your Amazon Kinesis Analytics application. You can use the <a>DescribeApplication</a> operation to find the current application version.</p>"
},
"Input":{"shape":"Input"}
},
"documentation":"<p/>"
},
"AddApplicationInputResponse":{
"type":"structure",
"members":{
},
"documentation":"<p/>"
},
"AddApplicationOutputRequest":{
"type":"structure",
"required":[
"ApplicationName",
"CurrentApplicationVersionId",
"Output"
],
"members":{
"ApplicationName":{
"shape":"ApplicationName",
"documentation":"<p>Name of the application to which you want to add the output configuration.</p>"
},
"CurrentApplicationVersionId":{
"shape":"ApplicationVersionId",
"documentation":"<p>Version of the application to which you want add the output configuration. You can use the <a>DescribeApplication</a> operation to get the current application version. If the version specified is not the current version, the <code>ConcurrentModificationException</code> is returned. </p>"
},
"Output":{
"shape":"Output",
"documentation":"<p>An array of objects, each describing one output configuration. In the output configuration, you specify the name of an in-application stream, a destination (that is, an Amazon Kinesis stream or an Amazon Kinesis Firehose delivery stream), and record the formation to use when writing to the destination.</p>"
}
},
"documentation":"<p/>"
},
"AddApplicationOutputResponse":{
"type":"structure",
"members":{
},
"documentation":"<p/>"
},
"AddApplicationReferenceDataSourceRequest":{
"type":"structure",
"required":[
"ApplicationName",
"CurrentApplicationVersionId",
"ReferenceDataSource"
],
"members":{
"ApplicationName":{
"shape":"ApplicationName",
"documentation":"<p>Name of an existing application.</p>"
},
"CurrentApplicationVersionId":{
"shape":"ApplicationVersionId",
"documentation":"<p>Version of the application for which you are adding the reference data source. You can use the <a>DescribeApplication</a> operation to get the current application version. If the version specified is not the current version, the <code>ConcurrentModificationException</code> is returned.</p>"
},
"ReferenceDataSource":{
"shape":"ReferenceDataSource",
"documentation":"<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>"
}
},
"documentation":"<p/>"
},
"AddApplicationReferenceDataSourceResponse":{
"type":"structure",
"members":{
},
"documentation":"<p/>"
},
"ApplicationCode":{
"type":"string",
"max":51200,
"min":0
},
"ApplicationDescription":{
"type":"string",
"max":1024,
"min":0
},
"ApplicationDetail":{
"type":"structure",
"required":[
"ApplicationName",
"ApplicationARN",
"ApplicationStatus",
"ApplicationVersionId"
],
"members":{
"ApplicationName":{
"shape":"ApplicationName",
"documentation":"<p>Name of the application.</p>"
},
"ApplicationDescription":{
"shape":"ApplicationDescription",
"documentation":"<p>Description of the application.</p>"
},
"ApplicationARN":{
"shape":"ResourceARN",
"documentation":"<p>ARN of the application.</p>"
},
"ApplicationStatus":{
"shape":"ApplicationStatus",
"documentation":"<p>Status of the application.</p>"
},
"CreateTimestamp":{
"shape":"Timestamp",
"documentation":"<p>Timestamp when the application version was created.</p>"
},
"LastUpdateTimestamp":{
"shape":"Timestamp",
"documentation":"<p>Timestamp when the application was last updated.</p>"
},
"InputDescriptions":{
"shape":"InputDescriptions",
"documentation":"<p>Describes the application input configuration. For more information, see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html\">Configuring Application Input</a>. </p>"
},
"OutputDescriptions":{
"shape":"OutputDescriptions",
"documentation":"<p>Describes the application output configuration. For more information, see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html\">Configuring Application Output</a>. </p>"
},
"ReferenceDataSourceDescriptions":{
"shape":"ReferenceDataSourceDescriptions",
"documentation":"<p>Describes reference data sources configured for the application. For more information, see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html\">Configuring Application Input</a>. </p>"
},
"ApplicationCode":{
"shape":"ApplicationCode",
"documentation":"<p>Returns the application code that you provided to perform data analysis on any of the in-application streams in your application.</p>"
},
"ApplicationVersionId":{
"shape":"ApplicationVersionId",
"documentation":"<p>Provides the current application version.</p>"
}
},
"documentation":"<p>Provides a description of the application, including the application Amazon Resource Name (ARN), status, latest version, and input and output configuration.</p>"
},
"ApplicationName":{
"type":"string",
"max":128,
"min":1,
"pattern":"[a-zA-Z0-9_.-]+"
},
"ApplicationStatus":{
"type":"string",
"enum":[
"DELETING",
"STARTING",
"STOPPING",
"READY",
"RUNNING",
"UPDATING"
]
},
"ApplicationSummaries":{
"type":"list",
"member":{"shape":"ApplicationSummary"}
},
"ApplicationSummary":{
"type":"structure",
"required":[
"ApplicationName",
"ApplicationARN",
"ApplicationStatus"
],
"members":{
"ApplicationName":{
"shape":"ApplicationName",
"documentation":"<p>Name of the application.</p>"
},
"ApplicationARN":{
"shape":"ResourceARN",
"documentation":"<p>ARN of the application.</p>"
},
"ApplicationStatus":{
"shape":"ApplicationStatus",
"documentation":"<p>Status of the application.</p>"
}
},
"documentation":"<p>Provides application summary information, including the application Amazon Resource Name (ARN), name, and status.</p>"
},
"ApplicationUpdate":{
"type":"structure",
"members":{
"InputUpdates":{
"shape":"InputUpdates",
"documentation":"<p>Describes application input configuration updates.</p>"
},
"ApplicationCodeUpdate":{
"shape":"ApplicationCode",
"documentation":"<p>Describes application code updates.</p>"
},
"OutputUpdates":{
"shape":"OutputUpdates",
"documentation":"<p>Describes application output configuration updates.</p>"
},
"ReferenceDataSourceUpdates":{
"shape":"ReferenceDataSourceUpdates",
"documentation":"<p>Describes application reference data source updates.</p>"
}
},
"documentation":"<p>Describes updates to apply to an existing Kinesis Analytics application.</p>"
},
"ApplicationVersionId":{
"type":"long",
"max":999999999,
"min":1
},
"BooleanObject":{"type":"boolean"},
"BucketARN":{
"type":"string",
"max":2048,
"min":1,
"pattern":"arn:.*"
},
"CSVMappingParameters":{
"type":"structure",
"required":[
"RecordRowDelimiter",
"RecordColumnDelimiter"
],
"members":{
"RecordRowDelimiter":{
"shape":"RecordRowDelimiter",
"documentation":"<p>Row delimiter. For example, in a CSV format, <i>'\\n'</i> is the typical row delimiter.</p>"
},
"RecordColumnDelimiter":{
"shape":"RecordColumnDelimiter",
"documentation":"<p>Column delimiter. For example, in a CSV format, a comma (\",\") is the typical column delimiter.</p>"
}
},
"documentation":"<p>Provides additional mapping information when the record format uses delimiters, such as CSV. For example, the following sample records use CSV format, where the records use the <i>'\\n'</i> as the row delimiter and a comma (\",\") as the column delimiter: </p> <p> <code>\"name1\", \"address1\" </code> </p> <p> <code>\"name2, \"address2\"</code> </p>"
},
"CodeValidationException":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"<p>Test</p>"
}
},
"documentation":"<p>User-provided application code (query) is invalid. This can be a simple syntax error.</p>",
"exception":true
},
"ConcurrentModificationException":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"<p/>"
}
},
"documentation":"<p>Exception thrown as a result of concurrent modification to an application. For example, two individuals attempting to edit the same application at the same time.</p>",
"exception":true
},
"CreateApplicationRequest":{
"type":"structure",
"required":["ApplicationName"],
"members":{
"ApplicationName":{
"shape":"ApplicationName",
"documentation":"<p>Name of your Amazon Kinesis Analytics application (for example, <code>sample-app</code>).</p>"
},
"ApplicationDescription":{
"shape":"ApplicationDescription",
"documentation":"<p>Summary description of the application.</p>"
},
"Inputs":{
"shape":"Inputs",
"documentation":"<p>Use this parameter to configure the application input.</p> <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> <p>For the streaming source, you provide its Amazon Resource Name (ARN) and format of data on the stream (for example, JSON, CSV, etc). You also must provide an IAM role that Amazon Kinesis Analytics can assume to read this stream on your behalf.</p> <p>To create the in-application stream, you need to specify a schema to transform your data into a schematized version used in SQL. In the schema, you provide the necessary mapping of the data elements in the streaming source to record columns in the in-app stream.</p>"
},
"Outputs":{
"shape":"Outputs",
"documentation":"<p>You can configure application output to write data from any of the in-application streams to up to five destinations.</p> <p>These destinations can be Amazon Kinesis streams, Amazon Kinesis Firehose delivery streams, or both.</p> <p>In the configuration, you specify the in-application stream name, the destination stream Amazon Resource Name (ARN), and the format to use when writing data. You must also provide an IAM role that Amazon Kinesis Analytics can assume to write to the destination stream on your behalf.</p> <p>In the output configuration, you also provide the output stream Amazon Resource Name (ARN) and the format of data in the stream (for example, JSON, CSV). You also must provide an IAM role that Amazon Kinesis Analytics can assume to write to this stream on your behalf.</p>"
},
"ApplicationCode":{
"shape":"ApplicationCode",
"documentation":"<p>One or more SQL statements that read input data, transform it, and generate output. For example, you can write a SQL statement that reads input data and generates a running average of the number of advertisement clicks by vendor.</p> <p>You can also provide a series of SQL statements, where output of one statement can be used as the input for the next statement.</p> <p>Note that the application code must create the streams with names specified in the <code>Outputs</code>. For example, if your <code>Outputs</code> defines output streams named <code>ExampleOutputStream1</code> and <code>ExampleOutputStream2</code>, then your application code must create these streams. </p>"
}
},
"documentation":"<p>TBD</p>"
},
"CreateApplicationResponse":{
"type":"structure",
"required":["ApplicationSummary"],
"members":{
"ApplicationSummary":{
"shape":"ApplicationSummary",
"documentation":"<p>In response to your <code>CreateApplication</code> request, Amazon Kinesis Analytics returns a response with a summary of the application it created, including the application Amazon Resource Name (ARN), name, and status.</p>"
}
},
"documentation":"<p>TBD</p>"
},
"DeleteApplicationOutputRequest":{
"type":"structure",
"required":[
"ApplicationName",
"CurrentApplicationVersionId",
"OutputId"
],
"members":{
"ApplicationName":{
"shape":"ApplicationName",
"documentation":"<p>Amazon Kinesis Analytics application name.</p>"
},
"CurrentApplicationVersionId":{
"shape":"ApplicationVersionId",
"documentation":"<p>Amazon Kinesis Analytics application version. You can use the <a>DescribeApplication</a> operation to get the current application version. If the version specified is not the current version, the <code>ConcurrentModificationException</code> is returned. </p>"
},
"OutputId":{
"shape":"Id",
"documentation":"<p>The ID of the configuration to delete. Each output configuration that is added to the application, either when the application is created or later using the <a>AddApplicationOutput</a> operation, has a unique ID. You need to provide the ID to uniquely identify the output configuration that you want to delete from the application configuration. You can use the <a>DescribeApplication</a> operation to get the specific <code>OutputId</code>. </p>"
}
},
"documentation":"<p/>"
},
"DeleteApplicationOutputResponse":{
"type":"structure",
"members":{
},
"documentation":"<p/>"
},
"DeleteApplicationReferenceDataSourceRequest":{
"type":"structure",
"required":[
"ApplicationName",
"CurrentApplicationVersionId",
"ReferenceId"
],
"members":{
"ApplicationName":{
"shape":"ApplicationName",
"documentation":"<p>Name of an existing application.</p>"
},
"CurrentApplicationVersionId":{
"shape":"ApplicationVersionId",
"documentation":"<p>Version of the application. You can use the <a>DescribeApplication</a> operation to get the current application version. If the version specified is not the current version, the <code>ConcurrentModificationException</code> is returned.</p>"
},
"ReferenceId":{
"shape":"Id",
"documentation":"<p>ID of the reference data source. When you add a reference data source to your application using the <a>AddApplicationReferenceDataSource</a>, Amazon Kinesis Analytics assigns an ID. You can use the <a>DescribeApplication</a> operation to get the reference ID. </p>"
}
}
},
"DeleteApplicationReferenceDataSourceResponse":{
"type":"structure",
"members":{
}
},
"DeleteApplicationRequest":{
"type":"structure",
"required":[
"ApplicationName",
"CreateTimestamp"
],
"members":{
"ApplicationName":{
"shape":"ApplicationName",
"documentation":"<p>Name of the Amazon Kinesis Analytics application to delete.</p>"
},
"CreateTimestamp":{
"shape":"Timestamp",
"documentation":"<p> You can use the <code>DescribeApplication</code> operation to get this value. </p>"
}
},
"documentation":"<p/>"
},
"DeleteApplicationResponse":{
"type":"structure",
"members":{
},
"documentation":"<p/>"
},
"DescribeApplicationRequest":{
"type":"structure",
"required":["ApplicationName"],
"members":{
"ApplicationName":{
"shape":"ApplicationName",
"documentation":"<p>Name of the application.</p>"
}
},
"documentation":"<p/>"
},
"DescribeApplicationResponse":{
"type":"structure",
"required":["ApplicationDetail"],
"members":{
"ApplicationDetail":{
"shape":"ApplicationDetail",
"documentation":"<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>"
}
},
"documentation":"<p/>"
},
"DestinationSchema":{
"type":"structure",
"members":{
"RecordFormatType":{
"shape":"RecordFormatType",
"documentation":"<p>Specifies the format of the records on the output stream.</p>"
}
},
"documentation":"<p>Describes the data format when records are written to the destination. For more information, see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html\">Configuring Application Output</a>. </p>"
},
"DiscoverInputSchemaRequest":{
"type":"structure",
"required":[
"ResourceARN",
"RoleARN",
"InputStartingPositionConfiguration"
],
"members":{
"ResourceARN":{
"shape":"ResourceARN",
"documentation":"<p>Amazon Resource Name (ARN) of the streaming source.</p>"
},
"RoleARN":{
"shape":"RoleARN",
"documentation":"<p>ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf.</p>"
},
"InputStartingPositionConfiguration":{
"shape":"InputStartingPositionConfiguration",
"documentation":"<p>Point at which you want Amazon Kinesis Analytics to start reading records from the specified streaming source discovery purposes.</p>"
}
},
"documentation":"<p/>"
},
"DiscoverInputSchemaResponse":{
"type":"structure",
"members":{
"InputSchema":{
"shape":"SourceSchema",
"documentation":"<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>"
},
"ParsedInputRecords":{
"shape":"ParsedInputRecords",
"documentation":"<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>"
},
"RawInputRecords":{
"shape":"RawInputRecords",
"documentation":"<p>Raw stream data that was sampled to infer the schema.</p>"
}
},
"documentation":"<p/>"
},
"ErrorMessage":{"type":"string"},
"FileKey":{"type":"string"},
"Id":{
"type":"string",
"max":50,
"min":1,
"pattern":"[a-zA-Z0-9_.-]+"
},
"InAppStreamName":{
"type":"string",
"max":32,
"min":1,
"pattern":"[a-zA-Z][a-zA-Z0-9_]+"
},
"InAppStreamNames":{
"type":"list",
"member":{"shape":"InAppStreamName"}
},
"InAppTableName":{
"type":"string",
"max":32,
"min":1,
"pattern":"[a-zA-Z][a-zA-Z0-9_]+"
},
"Input":{
"type":"structure",
"required":[
"NamePrefix",
"InputSchema"
],
"members":{
"NamePrefix":{
"shape":"InAppStreamName",
"documentation":"<p>Name prefix to use when creating in-application stream. Suppose you specify a prefix \"MyInApplicationStream\". Kinesis Analytics will then create one or more (as per the <code>InputParallelism</code> count you specified) in-application streams with names \"MyInApplicationStream_001\", \"MyInApplicationStream_002\" and so on. </p>"
},
"KinesisStreamsInput":{
"shape":"KinesisStreamsInput",
"documentation":"<p>If the streaming source is an Amazon Kinesis stream, identifies the stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.</p>"
},
"KinesisFirehoseInput":{
"shape":"KinesisFirehoseInput",
"documentation":"<p>If the streaming source is an Amazon Kinesis Firehose delivery stream, identifies the Firehose delivery stream's ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.</p>"
},
"InputParallelism":{
"shape":"InputParallelism",
"documentation":"<p>Describes the number of in-application streams to create. </p> <p>Data from your source will be routed to these in-application input streams.</p> <p> (see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html\">Configuring Application Input</a>.</p>"
},
"InputSchema":{
"shape":"SourceSchema",
"documentation":"<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> <p>Also used to describe the format of the reference data source.</p>"
}
},
"documentation":"<p>When you configure the application input, you specify the streaming source, the in-application stream name that is created, and the mapping between the two. For more information, see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html\">Configuring Application Input</a>. </p>"
},
"InputConfiguration":{
"type":"structure",
"required":[
"Id",
"InputStartingPositionConfiguration"
],
"members":{
"Id":{
"shape":"Id",
"documentation":"<p>Input source ID. You can get this ID by calling the <a>DescribeApplication</a> operation.</p>"
},
"InputStartingPositionConfiguration":{
"shape":"InputStartingPositionConfiguration",
"documentation":"<p>Point at which you want the application to start processing records from the streaming source.</p>"
}
},
"documentation":"<p>When you start your application, you provide this configuration, which identifies the input source and the point in the input source at which you want the application to start processing records.</p>"
},
"InputConfigurations":{
"type":"list",
"member":{"shape":"InputConfiguration"}
},
"InputDescription":{
"type":"structure",
"members":{
"InputId":{
"shape":"Id",
"documentation":"<p>Input ID associated with the application input. This is the ID that Amazon Kinesis Analytics assigns to each input configuration you add to your application. </p>"
},
"NamePrefix":{
"shape":"InAppStreamName",
"documentation":"<p>In-application name prefix.</p>"
},
"InAppStreamNames":{
"shape":"InAppStreamNames",
"documentation":"<p>Returns the in-application stream names that are mapped to the stream source.</p>"
},
"KinesisStreamsInputDescription":{
"shape":"KinesisStreamsInputDescription",
"documentation":"<p>If an Amazon Kinesis stream is configured as streaming source, provides Amazon Kinesis stream's ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.</p>"
},
"KinesisFirehoseInputDescription":{
"shape":"KinesisFirehoseInputDescription",
"documentation":"<p>If an Amazon Kinesis Firehose delivery stream is configured as a streaming source, provides the Firehose delivery stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.</p>"
},
"InputSchema":{"shape":"SourceSchema"},
"InputParallelism":{
"shape":"InputParallelism",
"documentation":"<p>Describes the configured parallelism (number of in-application streams mapped to the streaming source).</p>"
},
"InputStartingPositionConfiguration":{
"shape":"InputStartingPositionConfiguration",
"documentation":"<p>Point at which the application is configured to read from the input stream.</p>"
}
},
"documentation":"<p>Describes the application input configuration. For more information, see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html\">Configuring Application Input</a>. </p>"
},
"InputDescriptions":{
"type":"list",
"member":{"shape":"InputDescription"}
},
"InputParallelism":{
"type":"structure",
"members":{
"Count":{
"shape":"InputParallelismCount",
"documentation":"<p>Number of in-application streams to create. For more information, see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html\">Limits</a>. </p>"
}
},
"documentation":"<p>Describes the number of in-application streams to create for a given streaming source. For information about parallellism, see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html\">Configuring Application Input</a>. </p>"
},
"InputParallelismCount":{
"type":"integer",
"max":10,
"min":1
},
"InputParallelismUpdate":{
"type":"structure",
"members":{
"CountUpdate":{
"shape":"InputParallelismCount",
"documentation":"<p>Number of in-application streams to create for the specified streaming source.</p>"
}
},
"documentation":"<p>Provides updates to the parallelism count.</p>"
},
"InputSchemaUpdate":{
"type":"structure",
"members":{
"RecordFormatUpdate":{
"shape":"RecordFormat",
"documentation":"<p>Specifies the format of the records on the streaming source.</p>"
},
"RecordEncodingUpdate":{
"shape":"RecordEncoding",
"documentation":"<p>Specifies the encoding of the records in the streaming source. For example, UTF-8.</p>"
},
"RecordColumnUpdates":{
"shape":"RecordColumns",
"documentation":"<p>A list of <code>RecordColumn</code> objects. Each object describes the mapping of the streaming source element to the corresponding column in the in-application stream. </p>"
}
},
"documentation":"<p> Describes updates for the application's input schema. </p>"
},
"InputStartingPosition":{
"type":"string",
"enum":[
"NOW",
"TRIM_HORIZON",
"LAST_STOPPED_POINT"
]
},
"InputStartingPositionConfiguration":{
"type":"structure",
"members":{
"InputStartingPosition":{
"shape":"InputStartingPosition",
"documentation":"<p>The starting position on the stream.</p> <ul> <li> <p> <code>LATEST</code> - Start reading just after the most recent record in the stream.</p> </li> <li> <p> <code>TRIM_HORIZON</code> - Start reading at the last untrimmed record in the stream, which is the oldest record available in the stream. This option is not available for an Amazon Kinesis Firehose delivery stream.</p> </li> <li> <p> <code>LAST_STOPPED_POINT</code> - Resume reading from where the application last stopped reading.</p> </li> </ul>"
}
},
"documentation":"<p>Describes the point at which the application reads from the streaming source.</p>"
},
"InputUpdate":{
"type":"structure",
"required":["InputId"],
"members":{
"InputId":{
"shape":"Id",
"documentation":"<p>Input ID of the application input to be updated.</p>"
},
"NamePrefixUpdate":{
"shape":"InAppStreamName",
"documentation":"<p>Name prefix for in-application stream(s) that Kinesis Analytics creates for the specific streaming source.</p>"
},
"KinesisStreamsInputUpdate":{
"shape":"KinesisStreamsInputUpdate",
"documentation":"<p>If a Amazon Kinesis stream is the streaming source to be updated, provides an updated stream ARN and IAM role ARN.</p>"
},
"KinesisFirehoseInputUpdate":{
"shape":"KinesisFirehoseInputUpdate",
"documentation":"<p>If an Amazon Kinesis Firehose delivery stream is the streaming source to be updated, provides an updated stream Amazon Resource Name (ARN) and IAM role ARN.</p>"
},
"InputSchemaUpdate":{
"shape":"InputSchemaUpdate",
"documentation":"<p>Describes the data format on the streaming source, and how record elements on the streaming source map to columns of the in-application stream that is created.</p>"
},
"InputParallelismUpdate":{
"shape":"InputParallelismUpdate",
"documentation":"<p>Describes the parallelism updates (the number in-application streams Kinesis Analytics creates for the specific streaming source).</p>"
}
},
"documentation":"<p>Describes updates to a specific input configuration (identified by the <code>InputId</code> of an application). </p>"
},
"InputUpdates":{
"type":"list",
"member":{"shape":"InputUpdate"}
},
"Inputs":{
"type":"list",
"member":{"shape":"Input"}
},
"InvalidApplicationConfigurationException":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"<p>test</p>"
}
},
"documentation":"<p>User-provided application configuration is not valid.</p>",
"exception":true
},
"InvalidArgumentException":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"<p/>"
}
},
"documentation":"<p>Specified input parameter value is invalid.</p>",
"exception":true
},
"JSONMappingParameters":{
"type":"structure",
"required":["RecordRowPath"],
"members":{
"RecordRowPath":{
"shape":"RecordRowPath",
"documentation":"<p>Path to the top-level parent that contains the records.</p> <p>For example, consider the following JSON record:</p> <p>In the <code>RecordRowPath</code>, <code>\"$\"</code> refers to the root and path <code>\"$.vehicle.Model\"</code> refers to the specific <code>\"Model\"</code> key in the JSON.</p>"
}
},
"documentation":"<p>Provides additional mapping information when JSON is the record format on the streaming source.</p>"
},
"KinesisFirehoseInput":{
"type":"structure",
"required":[
"ResourceARN",
"RoleARN"
],
"members":{
"ResourceARN":{
"shape":"ResourceARN",
"documentation":"<p>ARN of the input Firehose delivery stream.</p>"
},
"RoleARN":{
"shape":"RoleARN",
"documentation":"<p>ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to make sure the role has necessary permissions to access the stream.</p>"
}
},
"documentation":"<p> Identifies an Amazon Kinesis Firehose delivery stream as the streaming source. You provide the Firehose delivery stream's Amazon Resource Name (ARN) and an IAM role ARN that enables Amazon Kinesis Analytics to access the stream on your behalf.</p>"
},
"KinesisFirehoseInputDescription":{
"type":"structure",
"members":{
"ResourceARN":{
"shape":"ResourceARN",
"documentation":"<p>Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream.</p>"
},
"RoleARN":{
"shape":"RoleARN",
"documentation":"<p>ARN of the IAM role that Amazon Kinesis Analytics assumes to access the stream.</p>"
}
},
"documentation":"<p> Describes the Amazon Kinesis Firehose delivery stream that is configured as the streaming source in the application input configuration. </p>"
},
"KinesisFirehoseInputUpdate":{
"type":"structure",
"members":{
"ResourceARNUpdate":{
"shape":"ResourceARN",
"documentation":"<p>ARN of the input Amazon Kinesis Firehose delivery stream to read.</p>"
},
"RoleARNUpdate":{
"shape":"RoleARN",
"documentation":"<p>Amazon Resource Name (ARN) of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to grant necessary permissions to this role.</p>"
}
},
"documentation":"<p>When updating application input configuration, provides information about an Amazon Kinesis Firehose delivery stream as the streaming source.</p>"
},
"KinesisFirehoseOutput":{
"type":"structure",
"required":[
"ResourceARN",
"RoleARN"
],
"members":{
"ResourceARN":{
"shape":"ResourceARN",
"documentation":"<p>ARN of the destination Amazon Kinesis Firehose delivery stream to write to.</p>"
},
"RoleARN":{
"shape":"RoleARN",
"documentation":"<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>"
}
},
"documentation":"<p>When configuring application output, identifies an Amazon Kinesis Firehose delivery stream as the destination. You provide the stream Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to write to the stream on your behalf.</p>"
},
"KinesisFirehoseOutputDescription":{
"type":"structure",
"members":{
"ResourceARN":{
"shape":"ResourceARN",
"documentation":"<p>Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream.</p>"
},
"RoleARN":{
"shape":"RoleARN",
"documentation":"<p>ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream.</p>"
}
},
"documentation":"<p> For an application output, describes the Amazon Kinesis Firehose delivery stream configured as its destination. </p>"
},
"KinesisFirehoseOutputUpdate":{
"type":"structure",
"members":{