aws-sdk-kinesisanalytics 1.12.0 → 1.13.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 6d36af25b677e1392f14c4639f41bdb809842939
4
- data.tar.gz: 3105a59b5d82e99761737c2b9b59e5d359468a6a
3
+ metadata.gz: cd82be68b20da3506db2eec67601f5770809c80c
4
+ data.tar.gz: 81087b0c72784b633f571a79daa26bcab763f7f4
5
5
  SHA512:
6
- metadata.gz: c724202e82a52d20494fc073f8c41eb7baded2bbd7644883986d5d42b0b08b2d07420daaef8aca67df74244982e88970205997e0c831b4f3dbd267e12e7d8672
7
- data.tar.gz: 415d2226cf1762a5d678a73725e08feab72da13c9e38ee3f65350b8b5967a391303d2c84097967d0adc161fa86643afeb5356a696c2619133a0e9407db48726b
6
+ metadata.gz: b86e980ac79b8c047a055476649e1bb06d6d356a8e1781a975668b256ace69153c4006b0bff558361f3ed95976a02b44172722b264407b34d7c227fb9d9491c1
7
+ data.tar.gz: 37a40a533a7cf9621f0408f100403eec9cec5b88eab57bd72bd8175c2382f372056a5d37acab964a37bbb5933b54d7d1fe89aa2fb1bbe8b701e4c70f61b23276
@@ -42,6 +42,6 @@ require_relative 'aws-sdk-kinesisanalytics/customizations'
42
42
  # @service
43
43
  module Aws::KinesisAnalytics
44
44
 
45
- GEM_VERSION = '1.12.0'
45
+ GEM_VERSION = '1.13.0'
46
46
 
47
47
  end
@@ -209,12 +209,63 @@ module Aws::KinesisAnalytics
209
209
  # When `true`, request parameters are validated before
210
210
  # sending the request.
211
211
  #
212
+ # @option options [URI::HTTP,String] :http_proxy A proxy to send
213
+ # requests through. Formatted like 'http://proxy.com:123'.
214
+ #
215
+ # @option options [Float] :http_open_timeout (15) The number of
216
+ # seconds to wait when opening a HTTP session before rasing a
217
+ # `Timeout::Error`.
218
+ #
219
+ # @option options [Integer] :http_read_timeout (60) The default
220
+ # number of seconds to wait for response data. This value can
221
+ # safely be set
222
+ # per-request on the session yeidled by {#session_for}.
223
+ #
224
+ # @option options [Float] :http_idle_timeout (5) The number of
225
+ # seconds a connection is allowed to sit idble before it is
226
+ # considered stale. Stale connections are closed and removed
227
+ # from the pool before making a request.
228
+ #
229
+ # @option options [Float] :http_continue_timeout (1) The number of
230
+ # seconds to wait for a 100-continue response before sending the
231
+ # request body. This option has no effect unless the request has
232
+ # "Expect" header set to "100-continue". Defaults to `nil` which
233
+ # disables this behaviour. This value can safely be set per
234
+ # request on the session yeidled by {#session_for}.
235
+ #
236
+ # @option options [Boolean] :http_wire_trace (false) When `true`,
237
+ # HTTP debug output will be sent to the `:logger`.
238
+ #
239
+ # @option options [Boolean] :ssl_verify_peer (true) When `true`,
240
+ # SSL peer certificates are verified when establishing a
241
+ # connection.
242
+ #
243
+ # @option options [String] :ssl_ca_bundle Full path to the SSL
244
+ # certificate authority bundle file that should be used when
245
+ # verifying peer certificates. If you do not pass
246
+ # `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
247
+ # will be used if available.
248
+ #
249
+ # @option options [String] :ssl_ca_directory Full path of the
250
+ # directory that contains the unbundled SSL certificate
251
+ # authority files for verifying peer certificates. If you do
252
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
253
+ # system default will be used if available.
254
+ #
212
255
  def initialize(*args)
213
256
  super
214
257
  end
215
258
 
216
259
  # @!group API Operations
217
260
 
261
+ # <note markdown="1"> This documentation is for version 1 of the Amazon Kinesis Data
262
+ # Analytics API, which only supports SQL applications. Version 2 of the
263
+ # API supports SQL and Java applications. For more information about
264
+ # version 2, see [Amazon Kinesis Data Analytics API V2
265
+ # Documentation](/kinesisanalytics/latest/apiv2/Welcome.html).
266
+ #
267
+ # </note>
268
+ #
218
269
  # Adds a CloudWatch log stream to monitor application configuration
219
270
  # errors. For more information about using CloudWatch log streams with
220
271
  # Amazon Kinesis Analytics applications, see [Working with Amazon
@@ -222,7 +273,7 @@ module Aws::KinesisAnalytics
222
273
  #
223
274
  #
224
275
  #
225
- # [1]: http://docs.aws.amazon.com/kinesisanalytics/latest/dev/cloudwatch-logs.html
276
+ # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/cloudwatch-logs.html
226
277
  #
227
278
  # @option params [required, String] :application_name
228
279
  # The Kinesis Analytics application name.
@@ -258,24 +309,35 @@ module Aws::KinesisAnalytics
258
309
  req.send_request(options)
259
310
  end
260
311
 
312
+ # <note markdown="1"> This documentation is for version 1 of the Amazon Kinesis Data
313
+ # Analytics API, which only supports SQL applications. Version 2 of the
314
+ # API supports SQL and Java applications. For more information about
315
+ # version 2, see [Amazon Kinesis Data Analytics API V2
316
+ # Documentation](/kinesisanalytics/latest/apiv2/Welcome.html).
317
+ #
318
+ # </note>
319
+ #
261
320
  # Adds a streaming source to your Amazon Kinesis application. For
262
321
  # conceptual information, see [Configuring Application Input][1].
263
322
  #
264
323
  # You can add a streaming source either when you create an application
265
324
  # or you can use this operation to add a streaming source after you
266
- # create an application. For more information, see CreateApplication.
325
+ # create an application. For more information, see
326
+ # [CreateApplication][2].
267
327
  #
268
328
  # Any configuration update, including adding a streaming source using
269
329
  # this operation, results in a new version of the application. You can
270
- # use the DescribeApplication operation to find the current application
271
- # version.
330
+ # use the [DescribeApplication][3] operation to find the current
331
+ # application version.
272
332
  #
273
333
  # This operation requires permissions to perform the
274
334
  # `kinesisanalytics:AddApplicationInput` action.
275
335
  #
276
336
  #
277
337
  #
278
- # [1]: http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html
338
+ # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html
339
+ # [2]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_CreateApplication.html
340
+ # [3]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html
279
341
  #
280
342
  # @option params [required, String] :application_name
281
343
  # Name of your existing Amazon Kinesis Analytics application to which
@@ -283,11 +345,19 @@ module Aws::KinesisAnalytics
283
345
  #
284
346
  # @option params [required, Integer] :current_application_version_id
285
347
  # Current version of your Amazon Kinesis Analytics application. You can
286
- # use the DescribeApplication operation to find the current application
287
- # version.
348
+ # use the [DescribeApplication][1] operation to find the current
349
+ # application version.
350
+ #
351
+ #
352
+ #
353
+ # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html
288
354
  #
289
355
  # @option params [required, Types::Input] :input
290
- # The Input to add.
356
+ # The [Input][1] to add.
357
+ #
358
+ #
359
+ #
360
+ # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_Input.html
291
361
  #
292
362
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
293
363
  #
@@ -349,14 +419,23 @@ module Aws::KinesisAnalytics
349
419
  req.send_request(options)
350
420
  end
351
421
 
352
- # Adds an InputProcessingConfiguration to an application. An input
422
+ # <note markdown="1"> This documentation is for version 1 of the Amazon Kinesis Data
423
+ # Analytics API, which only supports SQL applications. Version 2 of the
424
+ # API supports SQL and Java applications. For more information about
425
+ # version 2, see [Amazon Kinesis Data Analytics API V2
426
+ # Documentation](/kinesisanalytics/latest/apiv2/Welcome.html).
427
+ #
428
+ # </note>
429
+ #
430
+ # Adds an [InputProcessingConfiguration][1] to an application. An input
353
431
  # processor preprocesses records on the input stream before the
354
432
  # application's SQL code executes. Currently, the only input processor
355
- # available is [AWS Lambda][1].
433
+ # available is [AWS Lambda][2].
356
434
  #
357
435
  #
358
436
  #
359
- # [1]: https://aws.amazon.com/documentation/lambda/
437
+ # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html
438
+ # [2]: https://docs.aws.amazon.com/lambda/
360
439
  #
361
440
  # @option params [required, String] :application_name
362
441
  # Name of the application to which you want to add the input processing
@@ -364,18 +443,30 @@ module Aws::KinesisAnalytics
364
443
  #
365
444
  # @option params [required, Integer] :current_application_version_id
366
445
  # Version of the application to which you want to add the input
367
- # processing configuration. You can use the DescribeApplication
446
+ # processing configuration. You can use the [DescribeApplication][1]
368
447
  # operation to get the current application version. If the version
369
448
  # specified is not the current version, the
370
449
  # `ConcurrentModificationException` is returned.
371
450
  #
451
+ #
452
+ #
453
+ # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html
454
+ #
372
455
  # @option params [required, String] :input_id
373
456
  # The ID of the input configuration to add the input processing
374
457
  # configuration to. You can get a list of the input IDs for an
375
- # application using the DescribeApplication operation.
458
+ # application using the [DescribeApplication][1] operation.
459
+ #
460
+ #
461
+ #
462
+ # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html
376
463
  #
377
464
  # @option params [required, Types::InputProcessingConfiguration] :input_processing_configuration
378
- # The InputProcessingConfiguration to add to the application.
465
+ # The [InputProcessingConfiguration][1] to add to the application.
466
+ #
467
+ #
468
+ #
469
+ # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html
379
470
  #
380
471
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
381
472
  #
@@ -402,6 +493,14 @@ module Aws::KinesisAnalytics
402
493
  req.send_request(options)
403
494
  end
404
495
 
496
+ # <note markdown="1"> This documentation is for version 1 of the Amazon Kinesis Data
497
+ # Analytics API, which only supports SQL applications. Version 2 of the
498
+ # API supports SQL and Java applications. For more information about
499
+ # version 2, see [Amazon Kinesis Data Analytics API V2
500
+ # Documentation](/kinesisanalytics/latest/apiv2/Welcome.html).
501
+ #
502
+ # </note>
503
+ #
405
504
  # Adds an external destination to your Amazon Kinesis Analytics
406
505
  # application.
407
506
  #
@@ -421,19 +520,20 @@ module Aws::KinesisAnalytics
421
520
  #
422
521
  # Any configuration update, including adding a streaming source using
423
522
  # this operation, results in a new version of the application. You can
424
- # use the DescribeApplication operation to find the current application
425
- # version.
523
+ # use the [DescribeApplication][2] operation to find the current
524
+ # application version.
426
525
  #
427
526
  # For the limits on the number of application inputs and outputs you can
428
- # configure, see [Limits][2].
527
+ # configure, see [Limits][3].
429
528
  #
430
529
  # This operation requires permissions to perform the
431
530
  # `kinesisanalytics:AddApplicationOutput` action.
432
531
  #
433
532
  #
434
533
  #
435
- # [1]: http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html
436
- # [2]: http://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html
534
+ # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html
535
+ # [2]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html
536
+ # [3]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html
437
537
  #
438
538
  # @option params [required, String] :application_name
439
539
  # Name of the application to which you want to add the output
@@ -441,9 +541,14 @@ module Aws::KinesisAnalytics
441
541
  #
442
542
  # @option params [required, Integer] :current_application_version_id
443
543
  # Version of the application to which you want to add the output
444
- # configuration. You can use the DescribeApplication operation to get
445
- # the current application version. If the version specified is not the
446
- # current version, the `ConcurrentModificationException` is returned.
544
+ # configuration. You can use the [DescribeApplication][1] operation to
545
+ # get the current application version. If the version specified is not
546
+ # the current version, the `ConcurrentModificationException` is
547
+ # returned.
548
+ #
549
+ #
550
+ #
551
+ # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html
447
552
  #
448
553
  # @option params [required, Types::Output] :output
449
554
  # An array of objects, each describing one output configuration. In the
@@ -488,6 +593,14 @@ module Aws::KinesisAnalytics
488
593
  req.send_request(options)
489
594
  end
490
595
 
596
+ # <note markdown="1"> This documentation is for version 1 of the Amazon Kinesis Data
597
+ # Analytics API, which only supports SQL applications. Version 2 of the
598
+ # API supports SQL and Java applications. For more information about
599
+ # version 2, see [Amazon Kinesis Data Analytics API V2
600
+ # Documentation](/kinesisanalytics/latest/apiv2/Welcome.html).
601
+ #
602
+ # </note>
603
+ #
491
604
  # Adds a reference data source to an existing application.
492
605
  #
493
606
  # Amazon Kinesis Analytics reads reference data (that is, an Amazon S3
@@ -506,18 +619,22 @@ module Aws::KinesisAnalytics
506
619
  #
507
620
  #
508
621
  #
509
- # [1]: http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html
510
- # [2]: http://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html
622
+ # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html
623
+ # [2]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html
511
624
  #
512
625
  # @option params [required, String] :application_name
513
626
  # Name of an existing application.
514
627
  #
515
628
  # @option params [required, Integer] :current_application_version_id
516
629
  # Version of the application for which you are adding the reference data
517
- # source. You can use the DescribeApplication operation to get the
630
+ # source. You can use the [DescribeApplication][1] operation to get the
518
631
  # current application version. If the version specified is not the
519
632
  # current version, the `ConcurrentModificationException` is returned.
520
633
  #
634
+ #
635
+ #
636
+ # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html
637
+ #
521
638
  # @option params [required, Types::ReferenceDataSource] :reference_data_source
522
639
  # The reference data source can be an object in your Amazon S3 bucket.
523
640
  # Amazon Kinesis Analytics reads the object and copies the data into the
@@ -575,6 +692,14 @@ module Aws::KinesisAnalytics
575
692
  req.send_request(options)
576
693
  end
577
694
 
695
+ # <note markdown="1"> This documentation is for version 1 of the Amazon Kinesis Data
696
+ # Analytics API, which only supports SQL applications. Version 2 of the
697
+ # API supports SQL and Java applications. For more information about
698
+ # version 2, see [Amazon Kinesis Data Analytics API V2
699
+ # Documentation](/kinesisanalytics/latest/apiv2/Welcome.html).
700
+ #
701
+ # </note>
702
+ #
578
703
  # Creates an Amazon Kinesis Analytics application. You can configure
579
704
  # each application with one streaming source as input, application code
580
705
  # to process the input, and up to three destinations where you want
@@ -606,8 +731,8 @@ module Aws::KinesisAnalytics
606
731
  #
607
732
  #
608
733
  #
609
- # [1]: http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works.html
610
- # [2]: http://docs.aws.amazon.com/kinesisanalytics/latest/dev/getting-started.html
734
+ # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works.html
735
+ # [2]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/getting-started.html
611
736
  #
612
737
  # @option params [required, String] :application_name
613
738
  # Name of your Amazon Kinesis Analytics application (for example,
@@ -662,7 +787,7 @@ module Aws::KinesisAnalytics
662
787
  #
663
788
  #
664
789
  #
665
- # [1]: http://docs.aws.amazon.com/kinesisanalytics/latest/dev/cloudwatch-logs.html
790
+ # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/cloudwatch-logs.html
666
791
  #
667
792
  # @option params [String] :application_code
668
793
  # One or more SQL statements that read input data, transform it, and
@@ -684,7 +809,19 @@ module Aws::KinesisAnalytics
684
809
  #
685
810
  #
686
811
  #
687
- # [1]: http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-app-code.html
812
+ # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-app-code.html
813
+ #
814
+ # @option params [Array<Types::Tag>] :tags
815
+ # A list of one or more tags to assign to the application. A tag is a
816
+ # key-value pair that identifies an application. Note that the maximum
817
+ # number of application tags includes system tags. The maximum number of
818
+ # user-defined application tags is 50. For more information, see [Using
819
+ # Cost Allocation Tags][1] in the *AWS Billing and Cost Management
820
+ # Guide*.
821
+ #
822
+ #
823
+ #
824
+ # [1]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html
688
825
  #
689
826
  # @return [Types::CreateApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
690
827
  #
@@ -766,6 +903,12 @@ module Aws::KinesisAnalytics
766
903
  # },
767
904
  # ],
768
905
  # application_code: "ApplicationCode",
906
+ # tags: [
907
+ # {
908
+ # key: "TagKey", # required
909
+ # value: "TagValue",
910
+ # },
911
+ # ],
769
912
  # })
770
913
  #
771
914
  # @example Response structure
@@ -783,6 +926,14 @@ module Aws::KinesisAnalytics
783
926
  req.send_request(options)
784
927
  end
785
928
 
929
+ # <note markdown="1"> This documentation is for version 1 of the Amazon Kinesis Data
930
+ # Analytics API, which only supports SQL applications. Version 2 of the
931
+ # API supports SQL and Java applications. For more information about
932
+ # version 2, see [Amazon Kinesis Data Analytics API V2
933
+ # Documentation](/kinesisanalytics/latest/apiv2/Welcome.html).
934
+ #
935
+ # </note>
936
+ #
786
937
  # Deletes the specified application. Amazon Kinesis Analytics halts
787
938
  # application execution and deletes the application, including any
788
939
  # application artifacts (such as in-application streams, reference
@@ -815,13 +966,21 @@ module Aws::KinesisAnalytics
815
966
  req.send_request(options)
816
967
  end
817
968
 
969
+ # <note markdown="1"> This documentation is for version 1 of the Amazon Kinesis Data
970
+ # Analytics API, which only supports SQL applications. Version 2 of the
971
+ # API supports SQL and Java applications. For more information about
972
+ # version 2, see [Amazon Kinesis Data Analytics API V2
973
+ # Documentation](/kinesisanalytics/latest/apiv2/Welcome.html).
974
+ #
975
+ # </note>
976
+ #
818
977
  # Deletes a CloudWatch log stream from an application. For more
819
978
  # information about using CloudWatch log streams with Amazon Kinesis
820
979
  # Analytics applications, see [Working with Amazon CloudWatch Logs][1].
821
980
  #
822
981
  #
823
982
  #
824
- # [1]: http://docs.aws.amazon.com/kinesisanalytics/latest/dev/cloudwatch-logs.html
983
+ # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/cloudwatch-logs.html
825
984
  #
826
985
  # @option params [required, String] :application_name
827
986
  # The Kinesis Analytics application name.
@@ -832,7 +991,11 @@ module Aws::KinesisAnalytics
832
991
  # @option params [required, String] :cloud_watch_logging_option_id
833
992
  # The `CloudWatchLoggingOptionId` of the CloudWatch logging option to
834
993
  # delete. You can get the `CloudWatchLoggingOptionId` by using the
835
- # DescribeApplication operation.
994
+ # [DescribeApplication][1] operation.
995
+ #
996
+ #
997
+ #
998
+ # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html
836
999
  #
837
1000
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
838
1001
  #
@@ -853,7 +1016,19 @@ module Aws::KinesisAnalytics
853
1016
  req.send_request(options)
854
1017
  end
855
1018
 
856
- # Deletes an InputProcessingConfiguration from an input.
1019
+ # <note markdown="1"> This documentation is for version 1 of the Amazon Kinesis Data
1020
+ # Analytics API, which only supports SQL applications. Version 2 of the
1021
+ # API supports SQL and Java applications. For more information about
1022
+ # version 2, see [Amazon Kinesis Data Analytics API V2
1023
+ # Documentation](/kinesisanalytics/latest/apiv2/Welcome.html).
1024
+ #
1025
+ # </note>
1026
+ #
1027
+ # Deletes an [InputProcessingConfiguration][1] from an input.
1028
+ #
1029
+ #
1030
+ #
1031
+ # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html
857
1032
  #
858
1033
  # @option params [required, String] :application_name
859
1034
  # The Kinesis Analytics application name.
@@ -864,7 +1039,11 @@ module Aws::KinesisAnalytics
864
1039
  # @option params [required, String] :input_id
865
1040
  # The ID of the input configuration from which to delete the input
866
1041
  # processing configuration. You can get a list of the input IDs for an
867
- # application by using the DescribeApplication operation.
1042
+ # application by using the [DescribeApplication][1] operation.
1043
+ #
1044
+ #
1045
+ #
1046
+ # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html
868
1047
  #
869
1048
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
870
1049
  #
@@ -885,6 +1064,14 @@ module Aws::KinesisAnalytics
885
1064
  req.send_request(options)
886
1065
  end
887
1066
 
1067
+ # <note markdown="1"> This documentation is for version 1 of the Amazon Kinesis Data
1068
+ # Analytics API, which only supports SQL applications. Version 2 of the
1069
+ # API supports SQL and Java applications. For more information about
1070
+ # version 2, see [Amazon Kinesis Data Analytics API V2
1071
+ # Documentation](/kinesisanalytics/latest/apiv2/Welcome.html).
1072
+ #
1073
+ # </note>
1074
+ #
888
1075
  # Deletes output destination configuration from your application
889
1076
  # configuration. Amazon Kinesis Analytics will no longer write data from
890
1077
  # the corresponding in-application stream to the external output
@@ -898,17 +1085,27 @@ module Aws::KinesisAnalytics
898
1085
  #
899
1086
  # @option params [required, Integer] :current_application_version_id
900
1087
  # Amazon Kinesis Analytics application version. You can use the
901
- # DescribeApplication operation to get the current application version.
902
- # If the version specified is not the current version, the
1088
+ # [DescribeApplication][1] operation to get the current application
1089
+ # version. If the version specified is not the current version, the
903
1090
  # `ConcurrentModificationException` is returned.
904
1091
  #
1092
+ #
1093
+ #
1094
+ # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html
1095
+ #
905
1096
  # @option params [required, String] :output_id
906
1097
  # The ID of the configuration to delete. Each output configuration that
907
1098
  # is added to the application, either when the application is created or
908
- # later using the AddApplicationOutput operation, has a unique ID. You
909
- # need to provide the ID to uniquely identify the output configuration
910
- # that you want to delete from the application configuration. You can
911
- # use the DescribeApplication operation to get the specific `OutputId`.
1099
+ # later using the [AddApplicationOutput][1] operation, has a unique ID.
1100
+ # You need to provide the ID to uniquely identify the output
1101
+ # configuration that you want to delete from the application
1102
+ # configuration. You can use the [DescribeApplication][2] operation to
1103
+ # get the specific `OutputId`.
1104
+ #
1105
+ #
1106
+ #
1107
+ # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_AddApplicationOutput.html
1108
+ # [2]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html
912
1109
  #
913
1110
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
914
1111
  #
@@ -929,30 +1126,51 @@ module Aws::KinesisAnalytics
929
1126
  req.send_request(options)
930
1127
  end
931
1128
 
1129
+ # <note markdown="1"> This documentation is for version 1 of the Amazon Kinesis Data
1130
+ # Analytics API, which only supports SQL applications. Version 2 of the
1131
+ # API supports SQL and Java applications. For more information about
1132
+ # version 2, see [Amazon Kinesis Data Analytics API V2
1133
+ # Documentation](/kinesisanalytics/latest/apiv2/Welcome.html).
1134
+ #
1135
+ # </note>
1136
+ #
932
1137
  # Deletes a reference data source configuration from the specified
933
1138
  # application configuration.
934
1139
  #
935
1140
  # If the application is running, Amazon Kinesis Analytics immediately
936
1141
  # removes the in-application table that you created using the
937
- # AddApplicationReferenceDataSource operation.
1142
+ # [AddApplicationReferenceDataSource][1] operation.
938
1143
  #
939
1144
  # This operation requires permissions to perform the
940
1145
  # `kinesisanalytics.DeleteApplicationReferenceDataSource` action.
941
1146
  #
1147
+ #
1148
+ #
1149
+ # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_AddApplicationReferenceDataSource.html
1150
+ #
942
1151
  # @option params [required, String] :application_name
943
1152
  # Name of an existing application.
944
1153
  #
945
1154
  # @option params [required, Integer] :current_application_version_id
946
- # Version of the application. You can use the DescribeApplication
1155
+ # Version of the application. You can use the [DescribeApplication][1]
947
1156
  # operation to get the current application version. If the version
948
1157
  # specified is not the current version, the
949
1158
  # `ConcurrentModificationException` is returned.
950
1159
  #
1160
+ #
1161
+ #
1162
+ # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html
1163
+ #
951
1164
  # @option params [required, String] :reference_id
952
1165
  # ID of the reference data source. When you add a reference data source
953
- # to your application using the AddApplicationReferenceDataSource,
1166
+ # to your application using the [AddApplicationReferenceDataSource][1],
954
1167
  # Amazon Kinesis Analytics assigns an ID. You can use the
955
- # DescribeApplication operation to get the reference ID.
1168
+ # [DescribeApplication][2] operation to get the reference ID.
1169
+ #
1170
+ #
1171
+ #
1172
+ # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_AddApplicationReferenceDataSource.html
1173
+ # [2]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html
956
1174
  #
957
1175
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
958
1176
  #
@@ -973,17 +1191,29 @@ module Aws::KinesisAnalytics
973
1191
  req.send_request(options)
974
1192
  end
975
1193
 
1194
+ # <note markdown="1"> This documentation is for version 1 of the Amazon Kinesis Data
1195
+ # Analytics API, which only supports SQL applications. Version 2 of the
1196
+ # API supports SQL and Java applications. For more information about
1197
+ # version 2, see [Amazon Kinesis Data Analytics API V2
1198
+ # Documentation](/kinesisanalytics/latest/apiv2/Welcome.html).
1199
+ #
1200
+ # </note>
1201
+ #
976
1202
  # Returns information about a specific Amazon Kinesis Analytics
977
1203
  # application.
978
1204
  #
979
1205
  # If you want to retrieve a list of all applications in your account,
980
- # use the ListApplications operation.
1206
+ # use the [ListApplications][1] operation.
981
1207
  #
982
1208
  # This operation requires permissions to perform the
983
1209
  # `kinesisanalytics:DescribeApplication` action. You can use
984
1210
  # `DescribeApplication` to get the current application versionId, which
985
1211
  # you need to call other operations such as `Update`.
986
1212
  #
1213
+ #
1214
+ #
1215
+ # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_ListApplications.html
1216
+ #
987
1217
  # @option params [required, String] :application_name
988
1218
  # Name of the application.
989
1219
  #
@@ -1068,6 +1298,14 @@ module Aws::KinesisAnalytics
1068
1298
  req.send_request(options)
1069
1299
  end
1070
1300
 
1301
+ # <note markdown="1"> This documentation is for version 1 of the Amazon Kinesis Data
1302
+ # Analytics API, which only supports SQL applications. Version 2 of the
1303
+ # API supports SQL and Java applications. For more information about
1304
+ # version 2, see [Amazon Kinesis Data Analytics API V2
1305
+ # Documentation](/kinesisanalytics/latest/apiv2/Welcome.html).
1306
+ #
1307
+ # </note>
1308
+ #
1071
1309
  # Infers a schema by evaluating sample records on the specified
1072
1310
  # streaming source (Amazon Kinesis stream or Amazon Kinesis Firehose
1073
1311
  # delivery stream) or S3 object. In the response, the operation returns
@@ -1085,7 +1323,7 @@ module Aws::KinesisAnalytics
1085
1323
  #
1086
1324
  #
1087
1325
  #
1088
- # [1]: http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html
1326
+ # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html
1089
1327
  #
1090
1328
  # @option params [String] :resource_arn
1091
1329
  # Amazon Resource Name (ARN) of the streaming source.
@@ -1103,9 +1341,13 @@ module Aws::KinesisAnalytics
1103
1341
  # object.
1104
1342
  #
1105
1343
  # @option params [Types::InputProcessingConfiguration] :input_processing_configuration
1106
- # The InputProcessingConfiguration to use to preprocess the records
1344
+ # The [InputProcessingConfiguration][1] to use to preprocess the records
1107
1345
  # before discovering the schema of the records.
1108
1346
  #
1347
+ #
1348
+ #
1349
+ # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html
1350
+ #
1109
1351
  # @return [Types::DiscoverInputSchemaResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1110
1352
  #
1111
1353
  # * {Types::DiscoverInputSchemaResponse#input_schema #input_schema} => Types::SourceSchema
@@ -1162,6 +1404,14 @@ module Aws::KinesisAnalytics
1162
1404
  req.send_request(options)
1163
1405
  end
1164
1406
 
1407
+ # <note markdown="1"> This documentation is for version 1 of the Amazon Kinesis Data
1408
+ # Analytics API, which only supports SQL applications. Version 2 of the
1409
+ # API supports SQL and Java applications. For more information about
1410
+ # version 2, see [Amazon Kinesis Data Analytics API V2
1411
+ # Documentation](/kinesisanalytics/latest/apiv2/Welcome.html).
1412
+ #
1413
+ # </note>
1414
+ #
1165
1415
  # Returns a list of Amazon Kinesis Analytics applications in your
1166
1416
  # account. For each application, the response includes the application
1167
1417
  # name, Amazon Resource Name (ARN), and status. If the response returns
@@ -1171,11 +1421,15 @@ module Aws::KinesisAnalytics
1171
1421
  # response.
1172
1422
  #
1173
1423
  # If you want detailed information about a specific application, use
1174
- # DescribeApplication.
1424
+ # [DescribeApplication][1].
1175
1425
  #
1176
1426
  # This operation requires permissions to perform the
1177
1427
  # `kinesisanalytics:ListApplications` action.
1178
1428
  #
1429
+ #
1430
+ #
1431
+ # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html
1432
+ #
1179
1433
  # @option params [Integer] :limit
1180
1434
  # Maximum number of applications to list.
1181
1435
  #
@@ -1215,6 +1469,44 @@ module Aws::KinesisAnalytics
1215
1469
  req.send_request(options)
1216
1470
  end
1217
1471
 
1472
+ # Retrieves the list of key-value tags assigned to the application.
1473
+ #
1474
+ # @option params [required, String] :resource_arn
1475
+ # The ARN of the application for which to retrieve tags.
1476
+ #
1477
+ # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1478
+ #
1479
+ # * {Types::ListTagsForResourceResponse#tags #tags} => Array&lt;Types::Tag&gt;
1480
+ #
1481
+ # @example Request syntax with placeholder values
1482
+ #
1483
+ # resp = client.list_tags_for_resource({
1484
+ # resource_arn: "KinesisAnalyticsARN", # required
1485
+ # })
1486
+ #
1487
+ # @example Response structure
1488
+ #
1489
+ # resp.tags #=> Array
1490
+ # resp.tags[0].key #=> String
1491
+ # resp.tags[0].value #=> String
1492
+ #
1493
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalytics-2015-08-14/ListTagsForResource AWS API Documentation
1494
+ #
1495
+ # @overload list_tags_for_resource(params = {})
1496
+ # @param [Hash] params ({})
1497
+ def list_tags_for_resource(params = {}, options = {})
1498
+ req = build_request(:list_tags_for_resource, params)
1499
+ req.send_request(options)
1500
+ end
1501
+
1502
+ # <note markdown="1"> This documentation is for version 1 of the Amazon Kinesis Data
1503
+ # Analytics API, which only supports SQL applications. Version 2 of the
1504
+ # API supports SQL and Java applications. For more information about
1505
+ # version 2, see [Amazon Kinesis Data Analytics API V2
1506
+ # Documentation](/kinesisanalytics/latest/apiv2/Welcome.html).
1507
+ #
1508
+ # </note>
1509
+ #
1218
1510
  # Starts the specified Amazon Kinesis Analytics application. After
1219
1511
  # creating an application, you must exclusively call this operation to
1220
1512
  # start your application.
@@ -1224,14 +1516,19 @@ module Aws::KinesisAnalytics
1224
1516
  #
1225
1517
  # The application status must be `READY` for you to start an
1226
1518
  # application. You can get the application status in the console or
1227
- # using the DescribeApplication operation.
1519
+ # using the [DescribeApplication][1] operation.
1228
1520
  #
1229
1521
  # After you start the application, you can stop the application from
1230
- # processing the input by calling the StopApplication operation.
1522
+ # processing the input by calling the [StopApplication][2] operation.
1231
1523
  #
1232
1524
  # This operation requires permissions to perform the
1233
1525
  # `kinesisanalytics:StartApplication` action.
1234
1526
  #
1527
+ #
1528
+ #
1529
+ # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html
1530
+ # [2]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_StopApplication.html
1531
+ #
1235
1532
  # @option params [required, String] :application_name
1236
1533
  # Name of the application.
1237
1534
  #
@@ -1266,16 +1563,28 @@ module Aws::KinesisAnalytics
1266
1563
  req.send_request(options)
1267
1564
  end
1268
1565
 
1566
+ # <note markdown="1"> This documentation is for version 1 of the Amazon Kinesis Data
1567
+ # Analytics API, which only supports SQL applications. Version 2 of the
1568
+ # API supports SQL and Java applications. For more information about
1569
+ # version 2, see [Amazon Kinesis Data Analytics API V2
1570
+ # Documentation](/kinesisanalytics/latest/apiv2/Welcome.html).
1571
+ #
1572
+ # </note>
1573
+ #
1269
1574
  # Stops the application from processing input data. You can stop an
1270
1575
  # application only if it is in the running state. You can use the
1271
- # DescribeApplication operation to find the application state. After the
1272
- # application is stopped, Amazon Kinesis Analytics stops reading data
1273
- # from the input, the application stops processing data, and there is no
1274
- # output written to the destination.
1576
+ # [DescribeApplication][1] operation to find the application state.
1577
+ # After the application is stopped, Amazon Kinesis Analytics stops
1578
+ # reading data from the input, the application stops processing data,
1579
+ # and there is no output written to the destination.
1275
1580
  #
1276
1581
  # This operation requires permissions to perform the
1277
1582
  # `kinesisanalytics:StopApplication` action.
1278
1583
  #
1584
+ #
1585
+ #
1586
+ # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html
1587
+ #
1279
1588
  # @option params [required, String] :application_name
1280
1589
  # Name of the running application to stop.
1281
1590
  #
@@ -1296,6 +1605,74 @@ module Aws::KinesisAnalytics
1296
1605
  req.send_request(options)
1297
1606
  end
1298
1607
 
1608
+ # Adds one or more key-value tags to a Kinesis Analytics application.
1609
+ # Note that the maximum number of application tags includes system tags.
1610
+ # The maximum number of user-defined application tags is 50.
1611
+ #
1612
+ # @option params [required, String] :resource_arn
1613
+ # The ARN of the application to assign the tags.
1614
+ #
1615
+ # @option params [required, Array<Types::Tag>] :tags
1616
+ # The key-value tags to assign to the application.
1617
+ #
1618
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1619
+ #
1620
+ # @example Request syntax with placeholder values
1621
+ #
1622
+ # resp = client.tag_resource({
1623
+ # resource_arn: "KinesisAnalyticsARN", # required
1624
+ # tags: [ # required
1625
+ # {
1626
+ # key: "TagKey", # required
1627
+ # value: "TagValue",
1628
+ # },
1629
+ # ],
1630
+ # })
1631
+ #
1632
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalytics-2015-08-14/TagResource AWS API Documentation
1633
+ #
1634
+ # @overload tag_resource(params = {})
1635
+ # @param [Hash] params ({})
1636
+ def tag_resource(params = {}, options = {})
1637
+ req = build_request(:tag_resource, params)
1638
+ req.send_request(options)
1639
+ end
1640
+
1641
+ # Removes one or more tags from a Kinesis Analytics application.
1642
+ #
1643
+ # @option params [required, String] :resource_arn
1644
+ # The ARN of the Kinesis Analytics application from which to remove the
1645
+ # tags.
1646
+ #
1647
+ # @option params [required, Array<String>] :tag_keys
1648
+ # A list of keys of tags to remove from the specified application.
1649
+ #
1650
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1651
+ #
1652
+ # @example Request syntax with placeholder values
1653
+ #
1654
+ # resp = client.untag_resource({
1655
+ # resource_arn: "KinesisAnalyticsARN", # required
1656
+ # tag_keys: ["TagKey"], # required
1657
+ # })
1658
+ #
1659
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kinesisanalytics-2015-08-14/UntagResource AWS API Documentation
1660
+ #
1661
+ # @overload untag_resource(params = {})
1662
+ # @param [Hash] params ({})
1663
+ def untag_resource(params = {}, options = {})
1664
+ req = build_request(:untag_resource, params)
1665
+ req.send_request(options)
1666
+ end
1667
+
1668
+ # <note markdown="1"> This documentation is for version 1 of the Amazon Kinesis Data
1669
+ # Analytics API, which only supports SQL applications. Version 2 of the
1670
+ # API supports SQL and Java applications. For more information about
1671
+ # version 2, see [Amazon Kinesis Data Analytics API V2
1672
+ # Documentation](/kinesisanalytics/latest/apiv2/Welcome.html).
1673
+ #
1674
+ # </note>
1675
+ #
1299
1676
  # Updates an existing Amazon Kinesis Analytics application. Using this
1300
1677
  # API, you can update application code, input configuration, and output
1301
1678
  # configuration.
@@ -1311,7 +1688,11 @@ module Aws::KinesisAnalytics
1311
1688
  #
1312
1689
  # @option params [required, Integer] :current_application_version_id
1313
1690
  # The current application version ID. You can use the
1314
- # DescribeApplication operation to get this value.
1691
+ # [DescribeApplication][1] operation to get this value.
1692
+ #
1693
+ #
1694
+ #
1695
+ # [1]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html
1315
1696
  #
1316
1697
  # @option params [required, Types::ApplicationUpdate] :application_update
1317
1698
  # Describes application updates.
@@ -1456,7 +1837,7 @@ module Aws::KinesisAnalytics
1456
1837
  params: params,
1457
1838
  config: config)
1458
1839
  context[:gem_name] = 'aws-sdk-kinesisanalytics'
1459
- context[:gem_version] = '1.12.0'
1840
+ context[:gem_version] = '1.13.0'
1460
1841
  Seahorse::Client::Request.new(handlers, context)
1461
1842
  end
1462
1843