aws-sdk-qldb 1.2.0 → 1.7.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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: f51d5e9b7d9e87379c1ae99c70e89d5f54778f25
4
- data.tar.gz: 4f395747d4e74cd1b20b5272d299f22b6de2a27c
2
+ SHA256:
3
+ metadata.gz: f17965f8b4cccc22f7bd7ce6dc2aef740ea43859d05e9e44e698ea80309b00ae
4
+ data.tar.gz: dbc97caafac91ee1c64577259ceef841f286b3123ace0ae72434d462dafa8540
5
5
  SHA512:
6
- metadata.gz: e1a93d011cca5165337010b54d1c1b21f1e9b5957550367b44a66ed393b3cab8853a22c3f1c37e49f5164781b4bf772082410d7239b78859790b06f38ca19d0a
7
- data.tar.gz: 6cca08f7a7b61743f1da1744fea1512200e30ab4613696f4fb7ca607d4c0e3fe2978d14bf5f7ebe629fc22a7e8d1f074be3583918dfbc944171a270dc776b81d
6
+ metadata.gz: dc0cf3372e26b7e7da6e5d1c7a053dcd1c7e3a6ae02cf95ff319f5c2622860b295bcd35abf6ed815a6354b43320de65cccbceb51f1dc83b8f0bbcf9f6e60acbf
7
+ data.tar.gz: cc525489eec649006f1e8f664ea283f6745ef9f2102de061bbfe7924a46d50a8c7363a25e3373c1237809535ae265c5e03a88ff29f920e0017cb436bffeec9c9
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -25,7 +27,7 @@ require_relative 'aws-sdk-qldb/customizations'
25
27
  # structure.
26
28
  #
27
29
  # qldb = Aws::QLDB::Client.new
28
- # resp = qldb.create_ledger(params)
30
+ # resp = qldb.cancel_journal_kinesis_stream(params)
29
31
  #
30
32
  # See {Client} for more information.
31
33
  #
@@ -45,6 +47,6 @@ require_relative 'aws-sdk-qldb/customizations'
45
47
  # @service
46
48
  module Aws::QLDB
47
49
 
48
- GEM_VERSION = '1.2.0'
50
+ GEM_VERSION = '1.7.0'
49
51
 
50
52
  end
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -24,6 +26,7 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
24
26
  require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
25
27
  require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
26
28
  require 'aws-sdk-core/plugins/transfer_encoding.rb'
29
+ require 'aws-sdk-core/plugins/http_checksum.rb'
27
30
  require 'aws-sdk-core/plugins/signature_v4.rb'
28
31
  require 'aws-sdk-core/plugins/protocols/rest_json.rb'
29
32
 
@@ -32,11 +35,11 @@ Aws::Plugins::GlobalConfiguration.add_identifier(:qldb)
32
35
  module Aws::QLDB
33
36
  # An API client for QLDB. To construct a client, you need to configure a `:region` and `:credentials`.
34
37
  #
35
- # client = Aws::QLDB::Client.new(
36
- # region: region_name,
37
- # credentials: credentials,
38
- # # ...
39
- # )
38
+ # client = Aws::QLDB::Client.new(
39
+ # region: region_name,
40
+ # credentials: credentials,
41
+ # # ...
42
+ # )
40
43
  #
41
44
  # For details on configuring region and credentials see
42
45
  # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
@@ -69,6 +72,7 @@ module Aws::QLDB
69
72
  add_plugin(Aws::Plugins::ClientMetricsPlugin)
70
73
  add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
71
74
  add_plugin(Aws::Plugins::TransferEncoding)
75
+ add_plugin(Aws::Plugins::HttpChecksum)
72
76
  add_plugin(Aws::Plugins::SignatureV4)
73
77
  add_plugin(Aws::Plugins::Protocols::RestJson)
74
78
 
@@ -105,7 +109,7 @@ module Aws::QLDB
105
109
  # @option options [required, String] :region
106
110
  # The AWS region to connect to. The configured `:region` is
107
111
  # used to determine the service `:endpoint`. When not passed,
108
- # a default `:region` is search for in the following locations:
112
+ # a default `:region` is searched for in the following locations:
109
113
  #
110
114
  # * `Aws.config[:region]`
111
115
  # * `ENV['AWS_REGION']`
@@ -161,7 +165,7 @@ module Aws::QLDB
161
165
  # @option options [String] :endpoint
162
166
  # The client endpoint is normally constructed from the `:region`
163
167
  # option. You should only configure an `:endpoint` when connecting
164
- # to test endpoints. This should be avalid HTTP(S) URI.
168
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
165
169
  #
166
170
  # @option options [Integer] :endpoint_cache_max_entries (1000)
167
171
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -176,7 +180,7 @@ module Aws::QLDB
176
180
  # requests fetching endpoints information. Defaults to 60 sec.
177
181
  #
178
182
  # @option options [Boolean] :endpoint_discovery (false)
179
- # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
183
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
180
184
  #
181
185
  # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
182
186
  # The log formatter.
@@ -229,15 +233,19 @@ module Aws::QLDB
229
233
  #
230
234
  # @option options [String] :retry_mode ("legacy")
231
235
  # Specifies which retry algorithm to use. Values are:
232
- # * `legacy` - The pre-existing retry behavior. This is default value if
233
- # no retry mode is provided.
234
- # * `standard` - A standardized set of retry rules across the AWS SDKs.
235
- # This includes support for retry quotas, which limit the number of
236
- # unsuccessful retries a client can make.
237
- # * `adaptive` - An experimental retry mode that includes all the
238
- # functionality of `standard` mode along with automatic client side
239
- # throttling. This is a provisional mode that may change behavior
240
- # in the future.
236
+ #
237
+ # * `legacy` - The pre-existing retry behavior. This is default value if
238
+ # no retry mode is provided.
239
+ #
240
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
241
+ # This includes support for retry quotas, which limit the number of
242
+ # unsuccessful retries a client can make.
243
+ #
244
+ # * `adaptive` - An experimental retry mode that includes all the
245
+ # functionality of `standard` mode along with automatic client side
246
+ # throttling. This is a provisional mode that may change behavior
247
+ # in the future.
248
+ #
241
249
  #
242
250
  # @option options [String] :secret_access_key
243
251
  #
@@ -265,8 +273,7 @@ module Aws::QLDB
265
273
  #
266
274
  # @option options [Integer] :http_read_timeout (60) The default
267
275
  # number of seconds to wait for response data. This value can
268
- # safely be set
269
- # per-request on the session yielded by {#session_for}.
276
+ # safely be set per-request on the session.
270
277
  #
271
278
  # @option options [Float] :http_idle_timeout (5) The number of
272
279
  # seconds a connection is allowed to sit idle before it is
@@ -278,7 +285,7 @@ module Aws::QLDB
278
285
  # request body. This option has no effect unless the request has
279
286
  # "Expect" header set to "100-continue". Defaults to `nil` which
280
287
  # disables this behaviour. This value can safely be set per
281
- # request on the session yielded by {#session_for}.
288
+ # request on the session.
282
289
  #
283
290
  # @option options [Boolean] :http_wire_trace (false) When `true`,
284
291
  # HTTP debug output will be sent to the `:logger`.
@@ -305,12 +312,56 @@ module Aws::QLDB
305
312
 
306
313
  # @!group API Operations
307
314
 
315
+ # Ends a given Amazon QLDB journal stream. Before a stream can be
316
+ # canceled, its current status must be `ACTIVE`.
317
+ #
318
+ # You can't restart a stream after you cancel it. Canceled QLDB stream
319
+ # resources are subject to a 7-day retention period, so they are
320
+ # automatically deleted after this limit expires.
321
+ #
322
+ # @option params [required, String] :ledger_name
323
+ # The name of the ledger.
324
+ #
325
+ # @option params [required, String] :stream_id
326
+ # The unique ID that QLDB assigns to each QLDB journal stream.
327
+ #
328
+ # @return [Types::CancelJournalKinesisStreamResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
329
+ #
330
+ # * {Types::CancelJournalKinesisStreamResponse#stream_id #stream_id} => String
331
+ #
332
+ # @example Request syntax with placeholder values
333
+ #
334
+ # resp = client.cancel_journal_kinesis_stream({
335
+ # ledger_name: "LedgerName", # required
336
+ # stream_id: "UniqueId", # required
337
+ # })
338
+ #
339
+ # @example Response structure
340
+ #
341
+ # resp.stream_id #=> String
342
+ #
343
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/CancelJournalKinesisStream AWS API Documentation
344
+ #
345
+ # @overload cancel_journal_kinesis_stream(params = {})
346
+ # @param [Hash] params ({})
347
+ def cancel_journal_kinesis_stream(params = {}, options = {})
348
+ req = build_request(:cancel_journal_kinesis_stream, params)
349
+ req.send_request(options)
350
+ end
351
+
308
352
  # Creates a new ledger in your AWS account.
309
353
  #
310
354
  # @option params [required, String] :name
311
355
  # The name of the ledger that you want to create. The name must be
312
356
  # unique among all of your ledgers in the current AWS Region.
313
357
  #
358
+ # Naming constraints for ledger names are defined in [Quotas in Amazon
359
+ # QLDB][1] in the *Amazon QLDB Developer Guide*.
360
+ #
361
+ #
362
+ #
363
+ # [1]: https://docs.aws.amazon.com/qldb/latest/developerguide/limits.html#limits.naming
364
+ #
314
365
  # @option params [Hash<String,String>] :tags
315
366
  # The key-value pairs to add as tags to the ledger that you want to
316
367
  # create. Tag keys are case sensitive. Tag values are case sensitive and
@@ -394,16 +445,70 @@ module Aws::QLDB
394
445
  req.send_request(options)
395
446
  end
396
447
 
448
+ # Returns detailed information about a given Amazon QLDB journal stream.
449
+ # The output includes the Amazon Resource Name (ARN), stream name,
450
+ # current status, creation time, and the parameters of your original
451
+ # stream creation request.
452
+ #
453
+ # @option params [required, String] :ledger_name
454
+ # The name of the ledger.
455
+ #
456
+ # @option params [required, String] :stream_id
457
+ # The unique ID that QLDB assigns to each QLDB journal stream.
458
+ #
459
+ # @return [Types::DescribeJournalKinesisStreamResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
460
+ #
461
+ # * {Types::DescribeJournalKinesisStreamResponse#stream #stream} => Types::JournalKinesisStreamDescription
462
+ #
463
+ # @example Request syntax with placeholder values
464
+ #
465
+ # resp = client.describe_journal_kinesis_stream({
466
+ # ledger_name: "LedgerName", # required
467
+ # stream_id: "UniqueId", # required
468
+ # })
469
+ #
470
+ # @example Response structure
471
+ #
472
+ # resp.stream.ledger_name #=> String
473
+ # resp.stream.creation_time #=> Time
474
+ # resp.stream.inclusive_start_time #=> Time
475
+ # resp.stream.exclusive_end_time #=> Time
476
+ # resp.stream.role_arn #=> String
477
+ # resp.stream.stream_id #=> String
478
+ # resp.stream.arn #=> String
479
+ # resp.stream.status #=> String, one of "ACTIVE", "COMPLETED", "CANCELED", "FAILED", "IMPAIRED"
480
+ # resp.stream.kinesis_configuration.stream_arn #=> String
481
+ # resp.stream.kinesis_configuration.aggregation_enabled #=> Boolean
482
+ # resp.stream.error_cause #=> String, one of "KINESIS_STREAM_NOT_FOUND", "IAM_PERMISSION_REVOKED"
483
+ # resp.stream.stream_name #=> String
484
+ #
485
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/DescribeJournalKinesisStream AWS API Documentation
486
+ #
487
+ # @overload describe_journal_kinesis_stream(params = {})
488
+ # @param [Hash] params ({})
489
+ def describe_journal_kinesis_stream(params = {}, options = {})
490
+ req = build_request(:describe_journal_kinesis_stream, params)
491
+ req.send_request(options)
492
+ end
493
+
397
494
  # Returns information about a journal export job, including the ledger
398
495
  # name, export ID, when it was created, current status, and its start
399
496
  # and end time export parameters.
400
497
  #
498
+ # This action does not return any expired export jobs. For more
499
+ # information, see [Export Job Expiration][1] in the *Amazon QLDB
500
+ # Developer Guide*.
501
+ #
401
502
  # If the export job with the given `ExportId` doesn't exist, then
402
503
  # throws `ResourceNotFoundException`.
403
504
  #
404
505
  # If the ledger with the given `Name` doesn't exist, then throws
405
506
  # `ResourceNotFoundException`.
406
507
  #
508
+ #
509
+ #
510
+ # [1]: https://docs.aws.amazon.com/qldb/latest/developerguide/export-journal.request.html#export-journal.request.expiration
511
+ #
407
512
  # @option params [required, String] :name
408
513
  # The name of the ledger.
409
514
  #
@@ -571,10 +676,13 @@ module Aws::QLDB
571
676
  req.send_request(options)
572
677
  end
573
678
 
574
- # Returns a journal block object at a specified address in a ledger.
575
- # Also returns a proof of the specified block for verification if
679
+ # Returns a block object at a specified address in a journal. Also
680
+ # returns a proof of the specified block for verification if
576
681
  # `DigestTipAddress` is provided.
577
682
  #
683
+ # For information about the data contents in a block, see [Journal
684
+ # contents][1] in the *Amazon QLDB Developer Guide*.
685
+ #
578
686
  # If the specified ledger doesn't exist or is in `DELETING` status,
579
687
  # then throws `ResourceNotFoundException`.
580
688
  #
@@ -584,6 +692,10 @@ module Aws::QLDB
584
692
  # If no block exists with the specified address, then throws
585
693
  # `InvalidParameterException`.
586
694
  #
695
+ #
696
+ #
697
+ # [1]: https://docs.aws.amazon.com/qldb/latest/developerguide/journal-contents.html
698
+ #
587
699
  # @option params [required, String] :name
588
700
  # The name of the ledger.
589
701
  #
@@ -719,6 +831,69 @@ module Aws::QLDB
719
831
  req.send_request(options)
720
832
  end
721
833
 
834
+ # Returns an array of all Amazon QLDB journal stream descriptors for a
835
+ # given ledger. The output of each stream descriptor includes the same
836
+ # details that are returned by `DescribeJournalKinesisStream`.
837
+ #
838
+ # This action returns a maximum of `MaxResults` items. It is paginated
839
+ # so that you can retrieve all the items by calling
840
+ # `ListJournalKinesisStreamsForLedger` multiple times.
841
+ #
842
+ # @option params [required, String] :ledger_name
843
+ # The name of the ledger.
844
+ #
845
+ # @option params [Integer] :max_results
846
+ # The maximum number of results to return in a single
847
+ # `ListJournalKinesisStreamsForLedger` request. (The actual number of
848
+ # results returned might be fewer.)
849
+ #
850
+ # @option params [String] :next_token
851
+ # A pagination token, indicating that you want to retrieve the next page
852
+ # of results. If you received a value for `NextToken` in the response
853
+ # from a previous `ListJournalKinesisStreamsForLedger` call, you should
854
+ # use that value as input here.
855
+ #
856
+ # @return [Types::ListJournalKinesisStreamsForLedgerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
857
+ #
858
+ # * {Types::ListJournalKinesisStreamsForLedgerResponse#streams #streams} => Array&lt;Types::JournalKinesisStreamDescription&gt;
859
+ # * {Types::ListJournalKinesisStreamsForLedgerResponse#next_token #next_token} => String
860
+ #
861
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
862
+ #
863
+ # @example Request syntax with placeholder values
864
+ #
865
+ # resp = client.list_journal_kinesis_streams_for_ledger({
866
+ # ledger_name: "LedgerName", # required
867
+ # max_results: 1,
868
+ # next_token: "NextToken",
869
+ # })
870
+ #
871
+ # @example Response structure
872
+ #
873
+ # resp.streams #=> Array
874
+ # resp.streams[0].ledger_name #=> String
875
+ # resp.streams[0].creation_time #=> Time
876
+ # resp.streams[0].inclusive_start_time #=> Time
877
+ # resp.streams[0].exclusive_end_time #=> Time
878
+ # resp.streams[0].role_arn #=> String
879
+ # resp.streams[0].stream_id #=> String
880
+ # resp.streams[0].arn #=> String
881
+ # resp.streams[0].status #=> String, one of "ACTIVE", "COMPLETED", "CANCELED", "FAILED", "IMPAIRED"
882
+ # resp.streams[0].kinesis_configuration.stream_arn #=> String
883
+ # resp.streams[0].kinesis_configuration.aggregation_enabled #=> Boolean
884
+ # resp.streams[0].error_cause #=> String, one of "KINESIS_STREAM_NOT_FOUND", "IAM_PERMISSION_REVOKED"
885
+ # resp.streams[0].stream_name #=> String
886
+ # resp.next_token #=> String
887
+ #
888
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/ListJournalKinesisStreamsForLedger AWS API Documentation
889
+ #
890
+ # @overload list_journal_kinesis_streams_for_ledger(params = {})
891
+ # @param [Hash] params ({})
892
+ def list_journal_kinesis_streams_for_ledger(params = {}, options = {})
893
+ req = build_request(:list_journal_kinesis_streams_for_ledger, params)
894
+ req.send_request(options)
895
+ end
896
+
722
897
  # Returns an array of journal export job descriptions for all ledgers
723
898
  # that are associated with the current AWS account and Region.
724
899
  #
@@ -726,6 +901,14 @@ module Aws::QLDB
726
901
  # so that you can retrieve all the items by calling
727
902
  # `ListJournalS3Exports` multiple times.
728
903
  #
904
+ # This action does not return any expired export jobs. For more
905
+ # information, see [Export Job Expiration][1] in the *Amazon QLDB
906
+ # Developer Guide*.
907
+ #
908
+ #
909
+ #
910
+ # [1]: https://docs.aws.amazon.com/qldb/latest/developerguide/export-journal.request.html#export-journal.request.expiration
911
+ #
729
912
  # @option params [Integer] :max_results
730
913
  # The maximum number of results to return in a single
731
914
  # `ListJournalS3Exports` request. (The actual number of results returned
@@ -742,6 +925,8 @@ module Aws::QLDB
742
925
  # * {Types::ListJournalS3ExportsResponse#journal_s3_exports #journal_s3_exports} => Array&lt;Types::JournalS3ExportDescription&gt;
743
926
  # * {Types::ListJournalS3ExportsResponse#next_token #next_token} => String
744
927
  #
928
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
929
+ #
745
930
  # @example Request syntax with placeholder values
746
931
  #
747
932
  # resp = client.list_journal_s3_exports({
@@ -781,6 +966,14 @@ module Aws::QLDB
781
966
  # so that you can retrieve all the items by calling
782
967
  # `ListJournalS3ExportsForLedger` multiple times.
783
968
  #
969
+ # This action does not return any expired export jobs. For more
970
+ # information, see [Export Job Expiration][1] in the *Amazon QLDB
971
+ # Developer Guide*.
972
+ #
973
+ #
974
+ #
975
+ # [1]: https://docs.aws.amazon.com/qldb/latest/developerguide/export-journal.request.html#export-journal.request.expiration
976
+ #
784
977
  # @option params [required, String] :name
785
978
  # The name of the ledger.
786
979
  #
@@ -800,6 +993,8 @@ module Aws::QLDB
800
993
  # * {Types::ListJournalS3ExportsForLedgerResponse#journal_s3_exports #journal_s3_exports} => Array&lt;Types::JournalS3ExportDescription&gt;
801
994
  # * {Types::ListJournalS3ExportsForLedgerResponse#next_token #next_token} => String
802
995
  #
996
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
997
+ #
803
998
  # @example Request syntax with placeholder values
804
999
  #
805
1000
  # resp = client.list_journal_s3_exports_for_ledger({
@@ -855,6 +1050,8 @@ module Aws::QLDB
855
1050
  # * {Types::ListLedgersResponse#ledgers #ledgers} => Array&lt;Types::LedgerSummary&gt;
856
1051
  # * {Types::ListLedgersResponse#next_token #next_token} => String
857
1052
  #
1053
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1054
+ #
858
1055
  # @example Request syntax with placeholder values
859
1056
  #
860
1057
  # resp = client.list_ledgers({
@@ -911,6 +1108,98 @@ module Aws::QLDB
911
1108
  req.send_request(options)
912
1109
  end
913
1110
 
1111
+ # Creates a journal stream for a given Amazon QLDB ledger. The stream
1112
+ # captures every document revision that is committed to the ledger's
1113
+ # journal and delivers the data to a specified Amazon Kinesis Data
1114
+ # Streams resource.
1115
+ #
1116
+ # @option params [required, String] :ledger_name
1117
+ # The name of the ledger.
1118
+ #
1119
+ # @option params [required, String] :role_arn
1120
+ # The Amazon Resource Name (ARN) of the IAM role that grants QLDB
1121
+ # permissions for a journal stream to write data records to a Kinesis
1122
+ # Data Streams resource.
1123
+ #
1124
+ # @option params [Hash<String,String>] :tags
1125
+ # The key-value pairs to add as tags to the stream that you want to
1126
+ # create. Tag keys are case sensitive. Tag values are case sensitive and
1127
+ # can be null.
1128
+ #
1129
+ # @option params [required, Time,DateTime,Date,Integer,String] :inclusive_start_time
1130
+ # The inclusive start date and time from which to start streaming
1131
+ # journal data. This parameter must be in `ISO 8601` date and time
1132
+ # format and in Universal Coordinated Time (UTC). For example:
1133
+ # `2019-06-13T21:36:34Z`
1134
+ #
1135
+ # The `InclusiveStartTime` cannot be in the future and must be before
1136
+ # `ExclusiveEndTime`.
1137
+ #
1138
+ # If you provide an `InclusiveStartTime` that is before the ledger's
1139
+ # `CreationDateTime`, QLDB effectively defaults it to the ledger's
1140
+ # `CreationDateTime`.
1141
+ #
1142
+ # @option params [Time,DateTime,Date,Integer,String] :exclusive_end_time
1143
+ # The exclusive date and time that specifies when the stream ends. If
1144
+ # you don't define this parameter, the stream runs indefinitely until
1145
+ # you cancel it.
1146
+ #
1147
+ # The `ExclusiveEndTime` must be in `ISO 8601` date and time format and
1148
+ # in Universal Coordinated Time (UTC). For example:
1149
+ # `2019-06-13T21:36:34Z`
1150
+ #
1151
+ # @option params [required, Types::KinesisConfiguration] :kinesis_configuration
1152
+ # The configuration settings of the Kinesis Data Streams destination for
1153
+ # your stream request.
1154
+ #
1155
+ # @option params [required, String] :stream_name
1156
+ # The name that you want to assign to the QLDB journal stream.
1157
+ # User-defined names can help identify and indicate the purpose of a
1158
+ # stream.
1159
+ #
1160
+ # Your stream name must be unique among other *active* streams for a
1161
+ # given ledger. Stream names have the same naming constraints as ledger
1162
+ # names, as defined in [Quotas in Amazon QLDB][1] in the *Amazon QLDB
1163
+ # Developer Guide*.
1164
+ #
1165
+ #
1166
+ #
1167
+ # [1]: https://docs.aws.amazon.com/qldb/latest/developerguide/limits.html#limits.naming
1168
+ #
1169
+ # @return [Types::StreamJournalToKinesisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1170
+ #
1171
+ # * {Types::StreamJournalToKinesisResponse#stream_id #stream_id} => String
1172
+ #
1173
+ # @example Request syntax with placeholder values
1174
+ #
1175
+ # resp = client.stream_journal_to_kinesis({
1176
+ # ledger_name: "LedgerName", # required
1177
+ # role_arn: "Arn", # required
1178
+ # tags: {
1179
+ # "TagKey" => "TagValue",
1180
+ # },
1181
+ # inclusive_start_time: Time.now, # required
1182
+ # exclusive_end_time: Time.now,
1183
+ # kinesis_configuration: { # required
1184
+ # stream_arn: "Arn", # required
1185
+ # aggregation_enabled: false,
1186
+ # },
1187
+ # stream_name: "StreamName", # required
1188
+ # })
1189
+ #
1190
+ # @example Response structure
1191
+ #
1192
+ # resp.stream_id #=> String
1193
+ #
1194
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/StreamJournalToKinesis AWS API Documentation
1195
+ #
1196
+ # @overload stream_journal_to_kinesis(params = {})
1197
+ # @param [Hash] params ({})
1198
+ def stream_journal_to_kinesis(params = {}, options = {})
1199
+ req = build_request(:stream_journal_to_kinesis, params)
1200
+ req.send_request(options)
1201
+ end
1202
+
914
1203
  # Adds one or more tags to a specified Amazon QLDB resource.
915
1204
  #
916
1205
  # A resource can have up to 50 tags. If you try to create more than 50
@@ -1039,7 +1328,7 @@ module Aws::QLDB
1039
1328
  params: params,
1040
1329
  config: config)
1041
1330
  context[:gem_name] = 'aws-sdk-qldb'
1042
- context[:gem_version] = '1.2.0'
1331
+ context[:gem_version] = '1.7.0'
1043
1332
  Seahorse::Client::Request.new(handlers, context)
1044
1333
  end
1045
1334
 
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -12,15 +14,21 @@ module Aws::QLDB
12
14
  include Seahorse::Model
13
15
 
14
16
  Arn = Shapes::StringShape.new(name: 'Arn')
17
+ Boolean = Shapes::BooleanShape.new(name: 'Boolean')
18
+ CancelJournalKinesisStreamRequest = Shapes::StructureShape.new(name: 'CancelJournalKinesisStreamRequest')
19
+ CancelJournalKinesisStreamResponse = Shapes::StructureShape.new(name: 'CancelJournalKinesisStreamResponse')
15
20
  CreateLedgerRequest = Shapes::StructureShape.new(name: 'CreateLedgerRequest')
16
21
  CreateLedgerResponse = Shapes::StructureShape.new(name: 'CreateLedgerResponse')
17
22
  DeleteLedgerRequest = Shapes::StructureShape.new(name: 'DeleteLedgerRequest')
18
23
  DeletionProtection = Shapes::BooleanShape.new(name: 'DeletionProtection')
24
+ DescribeJournalKinesisStreamRequest = Shapes::StructureShape.new(name: 'DescribeJournalKinesisStreamRequest')
25
+ DescribeJournalKinesisStreamResponse = Shapes::StructureShape.new(name: 'DescribeJournalKinesisStreamResponse')
19
26
  DescribeJournalS3ExportRequest = Shapes::StructureShape.new(name: 'DescribeJournalS3ExportRequest')
20
27
  DescribeJournalS3ExportResponse = Shapes::StructureShape.new(name: 'DescribeJournalS3ExportResponse')
21
28
  DescribeLedgerRequest = Shapes::StructureShape.new(name: 'DescribeLedgerRequest')
22
29
  DescribeLedgerResponse = Shapes::StructureShape.new(name: 'DescribeLedgerResponse')
23
30
  Digest = Shapes::BlobShape.new(name: 'Digest')
31
+ ErrorCause = Shapes::StringShape.new(name: 'ErrorCause')
24
32
  ErrorMessage = Shapes::StringShape.new(name: 'ErrorMessage')
25
33
  ExportJournalToS3Request = Shapes::StructureShape.new(name: 'ExportJournalToS3Request')
26
34
  ExportJournalToS3Response = Shapes::StructureShape.new(name: 'ExportJournalToS3Response')
@@ -33,13 +41,18 @@ module Aws::QLDB
33
41
  GetRevisionResponse = Shapes::StructureShape.new(name: 'GetRevisionResponse')
34
42
  InvalidParameterException = Shapes::StructureShape.new(name: 'InvalidParameterException')
35
43
  IonText = Shapes::StringShape.new(name: 'IonText')
44
+ JournalKinesisStreamDescription = Shapes::StructureShape.new(name: 'JournalKinesisStreamDescription')
45
+ JournalKinesisStreamDescriptionList = Shapes::ListShape.new(name: 'JournalKinesisStreamDescriptionList')
36
46
  JournalS3ExportDescription = Shapes::StructureShape.new(name: 'JournalS3ExportDescription')
37
47
  JournalS3ExportList = Shapes::ListShape.new(name: 'JournalS3ExportList')
48
+ KinesisConfiguration = Shapes::StructureShape.new(name: 'KinesisConfiguration')
38
49
  LedgerList = Shapes::ListShape.new(name: 'LedgerList')
39
50
  LedgerName = Shapes::StringShape.new(name: 'LedgerName')
40
51
  LedgerState = Shapes::StringShape.new(name: 'LedgerState')
41
52
  LedgerSummary = Shapes::StructureShape.new(name: 'LedgerSummary')
42
53
  LimitExceededException = Shapes::StructureShape.new(name: 'LimitExceededException')
54
+ ListJournalKinesisStreamsForLedgerRequest = Shapes::StructureShape.new(name: 'ListJournalKinesisStreamsForLedgerRequest')
55
+ ListJournalKinesisStreamsForLedgerResponse = Shapes::StructureShape.new(name: 'ListJournalKinesisStreamsForLedgerResponse')
43
56
  ListJournalS3ExportsForLedgerRequest = Shapes::StructureShape.new(name: 'ListJournalS3ExportsForLedgerRequest')
44
57
  ListJournalS3ExportsForLedgerResponse = Shapes::StructureShape.new(name: 'ListJournalS3ExportsForLedgerResponse')
45
58
  ListJournalS3ExportsRequest = Shapes::StructureShape.new(name: 'ListJournalS3ExportsRequest')
@@ -63,6 +76,10 @@ module Aws::QLDB
63
76
  S3ExportConfiguration = Shapes::StructureShape.new(name: 'S3ExportConfiguration')
64
77
  S3ObjectEncryptionType = Shapes::StringShape.new(name: 'S3ObjectEncryptionType')
65
78
  S3Prefix = Shapes::StringShape.new(name: 'S3Prefix')
79
+ StreamJournalToKinesisRequest = Shapes::StructureShape.new(name: 'StreamJournalToKinesisRequest')
80
+ StreamJournalToKinesisResponse = Shapes::StructureShape.new(name: 'StreamJournalToKinesisResponse')
81
+ StreamName = Shapes::StringShape.new(name: 'StreamName')
82
+ StreamStatus = Shapes::StringShape.new(name: 'StreamStatus')
66
83
  TagKey = Shapes::StringShape.new(name: 'TagKey')
67
84
  TagKeyList = Shapes::ListShape.new(name: 'TagKeyList')
68
85
  TagResourceRequest = Shapes::StructureShape.new(name: 'TagResourceRequest')
@@ -77,6 +94,13 @@ module Aws::QLDB
77
94
  UpdateLedgerResponse = Shapes::StructureShape.new(name: 'UpdateLedgerResponse')
78
95
  ValueHolder = Shapes::StructureShape.new(name: 'ValueHolder')
79
96
 
97
+ CancelJournalKinesisStreamRequest.add_member(:ledger_name, Shapes::ShapeRef.new(shape: LedgerName, required: true, location: "uri", location_name: "name"))
98
+ CancelJournalKinesisStreamRequest.add_member(:stream_id, Shapes::ShapeRef.new(shape: UniqueId, required: true, location: "uri", location_name: "streamId"))
99
+ CancelJournalKinesisStreamRequest.struct_class = Types::CancelJournalKinesisStreamRequest
100
+
101
+ CancelJournalKinesisStreamResponse.add_member(:stream_id, Shapes::ShapeRef.new(shape: UniqueId, location_name: "StreamId"))
102
+ CancelJournalKinesisStreamResponse.struct_class = Types::CancelJournalKinesisStreamResponse
103
+
80
104
  CreateLedgerRequest.add_member(:name, Shapes::ShapeRef.new(shape: LedgerName, required: true, location_name: "Name"))
81
105
  CreateLedgerRequest.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "Tags"))
82
106
  CreateLedgerRequest.add_member(:permissions_mode, Shapes::ShapeRef.new(shape: PermissionsMode, required: true, location_name: "PermissionsMode"))
@@ -93,6 +117,13 @@ module Aws::QLDB
93
117
  DeleteLedgerRequest.add_member(:name, Shapes::ShapeRef.new(shape: LedgerName, required: true, location: "uri", location_name: "name"))
94
118
  DeleteLedgerRequest.struct_class = Types::DeleteLedgerRequest
95
119
 
120
+ DescribeJournalKinesisStreamRequest.add_member(:ledger_name, Shapes::ShapeRef.new(shape: LedgerName, required: true, location: "uri", location_name: "name"))
121
+ DescribeJournalKinesisStreamRequest.add_member(:stream_id, Shapes::ShapeRef.new(shape: UniqueId, required: true, location: "uri", location_name: "streamId"))
122
+ DescribeJournalKinesisStreamRequest.struct_class = Types::DescribeJournalKinesisStreamRequest
123
+
124
+ DescribeJournalKinesisStreamResponse.add_member(:stream, Shapes::ShapeRef.new(shape: JournalKinesisStreamDescription, location_name: "Stream"))
125
+ DescribeJournalKinesisStreamResponse.struct_class = Types::DescribeJournalKinesisStreamResponse
126
+
96
127
  DescribeJournalS3ExportRequest.add_member(:name, Shapes::ShapeRef.new(shape: LedgerName, required: true, location: "uri", location_name: "name"))
97
128
  DescribeJournalS3ExportRequest.add_member(:export_id, Shapes::ShapeRef.new(shape: UniqueId, required: true, location: "uri", location_name: "exportId"))
98
129
  DescribeJournalS3ExportRequest.struct_class = Types::DescribeJournalS3ExportRequest
@@ -150,6 +181,21 @@ module Aws::QLDB
150
181
  InvalidParameterException.add_member(:parameter_name, Shapes::ShapeRef.new(shape: ParameterName, location_name: "ParameterName"))
151
182
  InvalidParameterException.struct_class = Types::InvalidParameterException
152
183
 
184
+ JournalKinesisStreamDescription.add_member(:ledger_name, Shapes::ShapeRef.new(shape: LedgerName, required: true, location_name: "LedgerName"))
185
+ JournalKinesisStreamDescription.add_member(:creation_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "CreationTime"))
186
+ JournalKinesisStreamDescription.add_member(:inclusive_start_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "InclusiveStartTime"))
187
+ JournalKinesisStreamDescription.add_member(:exclusive_end_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "ExclusiveEndTime"))
188
+ JournalKinesisStreamDescription.add_member(:role_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "RoleArn"))
189
+ JournalKinesisStreamDescription.add_member(:stream_id, Shapes::ShapeRef.new(shape: UniqueId, required: true, location_name: "StreamId"))
190
+ JournalKinesisStreamDescription.add_member(:arn, Shapes::ShapeRef.new(shape: Arn, location_name: "Arn"))
191
+ JournalKinesisStreamDescription.add_member(:status, Shapes::ShapeRef.new(shape: StreamStatus, required: true, location_name: "Status"))
192
+ JournalKinesisStreamDescription.add_member(:kinesis_configuration, Shapes::ShapeRef.new(shape: KinesisConfiguration, required: true, location_name: "KinesisConfiguration"))
193
+ JournalKinesisStreamDescription.add_member(:error_cause, Shapes::ShapeRef.new(shape: ErrorCause, location_name: "ErrorCause"))
194
+ JournalKinesisStreamDescription.add_member(:stream_name, Shapes::ShapeRef.new(shape: StreamName, required: true, location_name: "StreamName"))
195
+ JournalKinesisStreamDescription.struct_class = Types::JournalKinesisStreamDescription
196
+
197
+ JournalKinesisStreamDescriptionList.member = Shapes::ShapeRef.new(shape: JournalKinesisStreamDescription)
198
+
153
199
  JournalS3ExportDescription.add_member(:ledger_name, Shapes::ShapeRef.new(shape: LedgerName, required: true, location_name: "LedgerName"))
154
200
  JournalS3ExportDescription.add_member(:export_id, Shapes::ShapeRef.new(shape: UniqueId, required: true, location_name: "ExportId"))
155
201
  JournalS3ExportDescription.add_member(:export_creation_time, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "ExportCreationTime"))
@@ -162,6 +208,10 @@ module Aws::QLDB
162
208
 
163
209
  JournalS3ExportList.member = Shapes::ShapeRef.new(shape: JournalS3ExportDescription)
164
210
 
211
+ KinesisConfiguration.add_member(:stream_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "StreamArn"))
212
+ KinesisConfiguration.add_member(:aggregation_enabled, Shapes::ShapeRef.new(shape: Boolean, location_name: "AggregationEnabled"))
213
+ KinesisConfiguration.struct_class = Types::KinesisConfiguration
214
+
165
215
  LedgerList.member = Shapes::ShapeRef.new(shape: LedgerSummary)
166
216
 
167
217
  LedgerSummary.add_member(:name, Shapes::ShapeRef.new(shape: LedgerName, location_name: "Name"))
@@ -173,6 +223,15 @@ module Aws::QLDB
173
223
  LimitExceededException.add_member(:resource_type, Shapes::ShapeRef.new(shape: ResourceType, location_name: "ResourceType"))
174
224
  LimitExceededException.struct_class = Types::LimitExceededException
175
225
 
226
+ ListJournalKinesisStreamsForLedgerRequest.add_member(:ledger_name, Shapes::ShapeRef.new(shape: LedgerName, required: true, location: "uri", location_name: "name"))
227
+ ListJournalKinesisStreamsForLedgerRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location: "querystring", location_name: "max_results"))
228
+ ListJournalKinesisStreamsForLedgerRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "next_token"))
229
+ ListJournalKinesisStreamsForLedgerRequest.struct_class = Types::ListJournalKinesisStreamsForLedgerRequest
230
+
231
+ ListJournalKinesisStreamsForLedgerResponse.add_member(:streams, Shapes::ShapeRef.new(shape: JournalKinesisStreamDescriptionList, location_name: "Streams"))
232
+ ListJournalKinesisStreamsForLedgerResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
233
+ ListJournalKinesisStreamsForLedgerResponse.struct_class = Types::ListJournalKinesisStreamsForLedgerResponse
234
+
176
235
  ListJournalS3ExportsForLedgerRequest.add_member(:name, Shapes::ShapeRef.new(shape: LedgerName, required: true, location: "uri", location_name: "name"))
177
236
  ListJournalS3ExportsForLedgerRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location: "querystring", location_name: "max_results"))
178
237
  ListJournalS3ExportsForLedgerRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "next_token"))
@@ -233,6 +292,18 @@ module Aws::QLDB
233
292
  S3ExportConfiguration.add_member(:encryption_configuration, Shapes::ShapeRef.new(shape: S3EncryptionConfiguration, required: true, location_name: "EncryptionConfiguration"))
234
293
  S3ExportConfiguration.struct_class = Types::S3ExportConfiguration
235
294
 
295
+ StreamJournalToKinesisRequest.add_member(:ledger_name, Shapes::ShapeRef.new(shape: LedgerName, required: true, location: "uri", location_name: "name"))
296
+ StreamJournalToKinesisRequest.add_member(:role_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "RoleArn"))
297
+ StreamJournalToKinesisRequest.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "Tags"))
298
+ StreamJournalToKinesisRequest.add_member(:inclusive_start_time, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "InclusiveStartTime"))
299
+ StreamJournalToKinesisRequest.add_member(:exclusive_end_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "ExclusiveEndTime"))
300
+ StreamJournalToKinesisRequest.add_member(:kinesis_configuration, Shapes::ShapeRef.new(shape: KinesisConfiguration, required: true, location_name: "KinesisConfiguration"))
301
+ StreamJournalToKinesisRequest.add_member(:stream_name, Shapes::ShapeRef.new(shape: StreamName, required: true, location_name: "StreamName"))
302
+ StreamJournalToKinesisRequest.struct_class = Types::StreamJournalToKinesisRequest
303
+
304
+ StreamJournalToKinesisResponse.add_member(:stream_id, Shapes::ShapeRef.new(shape: UniqueId, location_name: "StreamId"))
305
+ StreamJournalToKinesisResponse.struct_class = Types::StreamJournalToKinesisResponse
306
+
236
307
  TagKeyList.member = Shapes::ShapeRef.new(shape: TagKey)
237
308
 
238
309
  TagResourceRequest.add_member(:resource_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location: "uri", location_name: "resourceArn"))
@@ -283,6 +354,17 @@ module Aws::QLDB
283
354
  "uid" => "qldb-2019-01-02",
284
355
  }
285
356
 
357
+ api.add_operation(:cancel_journal_kinesis_stream, Seahorse::Model::Operation.new.tap do |o|
358
+ o.name = "CancelJournalKinesisStream"
359
+ o.http_method = "DELETE"
360
+ o.http_request_uri = "/ledgers/{name}/journal-kinesis-streams/{streamId}"
361
+ o.input = Shapes::ShapeRef.new(shape: CancelJournalKinesisStreamRequest)
362
+ o.output = Shapes::ShapeRef.new(shape: CancelJournalKinesisStreamResponse)
363
+ o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
364
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
365
+ o.errors << Shapes::ShapeRef.new(shape: ResourcePreconditionNotMetException)
366
+ end)
367
+
286
368
  api.add_operation(:create_ledger, Seahorse::Model::Operation.new.tap do |o|
287
369
  o.name = "CreateLedger"
288
370
  o.http_method = "POST"
@@ -307,6 +389,17 @@ module Aws::QLDB
307
389
  o.errors << Shapes::ShapeRef.new(shape: ResourcePreconditionNotMetException)
308
390
  end)
309
391
 
392
+ api.add_operation(:describe_journal_kinesis_stream, Seahorse::Model::Operation.new.tap do |o|
393
+ o.name = "DescribeJournalKinesisStream"
394
+ o.http_method = "GET"
395
+ o.http_request_uri = "/ledgers/{name}/journal-kinesis-streams/{streamId}"
396
+ o.input = Shapes::ShapeRef.new(shape: DescribeJournalKinesisStreamRequest)
397
+ o.output = Shapes::ShapeRef.new(shape: DescribeJournalKinesisStreamResponse)
398
+ o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
399
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
400
+ o.errors << Shapes::ShapeRef.new(shape: ResourcePreconditionNotMetException)
401
+ end)
402
+
310
403
  api.add_operation(:describe_journal_s3_export, Seahorse::Model::Operation.new.tap do |o|
311
404
  o.name = "DescribeJournalS3Export"
312
405
  o.http_method = "GET"
@@ -369,6 +462,23 @@ module Aws::QLDB
369
462
  o.errors << Shapes::ShapeRef.new(shape: ResourcePreconditionNotMetException)
370
463
  end)
371
464
 
465
+ api.add_operation(:list_journal_kinesis_streams_for_ledger, Seahorse::Model::Operation.new.tap do |o|
466
+ o.name = "ListJournalKinesisStreamsForLedger"
467
+ o.http_method = "GET"
468
+ o.http_request_uri = "/ledgers/{name}/journal-kinesis-streams"
469
+ o.input = Shapes::ShapeRef.new(shape: ListJournalKinesisStreamsForLedgerRequest)
470
+ o.output = Shapes::ShapeRef.new(shape: ListJournalKinesisStreamsForLedgerResponse)
471
+ o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
472
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
473
+ o.errors << Shapes::ShapeRef.new(shape: ResourcePreconditionNotMetException)
474
+ o[:pager] = Aws::Pager.new(
475
+ limit_key: "max_results",
476
+ tokens: {
477
+ "next_token" => "next_token"
478
+ }
479
+ )
480
+ end)
481
+
372
482
  api.add_operation(:list_journal_s3_exports, Seahorse::Model::Operation.new.tap do |o|
373
483
  o.name = "ListJournalS3Exports"
374
484
  o.http_method = "GET"
@@ -421,6 +531,17 @@ module Aws::QLDB
421
531
  o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
422
532
  end)
423
533
 
534
+ api.add_operation(:stream_journal_to_kinesis, Seahorse::Model::Operation.new.tap do |o|
535
+ o.name = "StreamJournalToKinesis"
536
+ o.http_method = "POST"
537
+ o.http_request_uri = "/ledgers/{name}/journal-kinesis-streams"
538
+ o.input = Shapes::ShapeRef.new(shape: StreamJournalToKinesisRequest)
539
+ o.output = Shapes::ShapeRef.new(shape: StreamJournalToKinesisResponse)
540
+ o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
541
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
542
+ o.errors << Shapes::ShapeRef.new(shape: ResourcePreconditionNotMetException)
543
+ end)
544
+
424
545
  api.add_operation(:tag_resource, Seahorse::Model::Operation.new.tap do |o|
425
546
  o.name = "TagResource"
426
547
  o.http_method = "POST"
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -6,13 +8,7 @@
6
8
  # WARNING ABOUT GENERATED CODE
7
9
 
8
10
  module Aws::QLDB
9
- # This class provides a resource oriented interface for QLDB.
10
- # To create a resource object:
11
- # resource = Aws::QLDB::Resource.new(region: 'us-west-2')
12
- # You can supply a client object with custom configuration that will be used for all resource operations.
13
- # If you do not pass +:client+, a default client will be constructed.
14
- # client = Aws::QLDB::Client.new(region: 'us-west-2')
15
- # resource = Aws::QLDB::Resource.new(client: client)
11
+
16
12
  class Resource
17
13
 
18
14
  # @param options ({})
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -8,6 +10,41 @@
8
10
  module Aws::QLDB
9
11
  module Types
10
12
 
13
+ # @note When making an API call, you may pass CancelJournalKinesisStreamRequest
14
+ # data as a hash:
15
+ #
16
+ # {
17
+ # ledger_name: "LedgerName", # required
18
+ # stream_id: "UniqueId", # required
19
+ # }
20
+ #
21
+ # @!attribute [rw] ledger_name
22
+ # The name of the ledger.
23
+ # @return [String]
24
+ #
25
+ # @!attribute [rw] stream_id
26
+ # The unique ID that QLDB assigns to each QLDB journal stream.
27
+ # @return [String]
28
+ #
29
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/CancelJournalKinesisStreamRequest AWS API Documentation
30
+ #
31
+ class CancelJournalKinesisStreamRequest < Struct.new(
32
+ :ledger_name,
33
+ :stream_id)
34
+ include Aws::Structure
35
+ end
36
+
37
+ # @!attribute [rw] stream_id
38
+ # The unique ID that QLDB assigns to each QLDB journal stream.
39
+ # @return [String]
40
+ #
41
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/CancelJournalKinesisStreamResponse AWS API Documentation
42
+ #
43
+ class CancelJournalKinesisStreamResponse < Struct.new(
44
+ :stream_id)
45
+ include Aws::Structure
46
+ end
47
+
11
48
  # @note When making an API call, you may pass CreateLedgerRequest
12
49
  # data as a hash:
13
50
  #
@@ -23,6 +60,13 @@ module Aws::QLDB
23
60
  # @!attribute [rw] name
24
61
  # The name of the ledger that you want to create. The name must be
25
62
  # unique among all of your ledgers in the current AWS Region.
63
+ #
64
+ # Naming constraints for ledger names are defined in [Quotas in Amazon
65
+ # QLDB][1] in the *Amazon QLDB Developer Guide*.
66
+ #
67
+ #
68
+ #
69
+ # [1]: https://docs.aws.amazon.com/qldb/latest/developerguide/limits.html#limits.naming
26
70
  # @return [String]
27
71
  #
28
72
  # @!attribute [rw] tags
@@ -119,6 +163,42 @@ module Aws::QLDB
119
163
  include Aws::Structure
120
164
  end
121
165
 
166
+ # @note When making an API call, you may pass DescribeJournalKinesisStreamRequest
167
+ # data as a hash:
168
+ #
169
+ # {
170
+ # ledger_name: "LedgerName", # required
171
+ # stream_id: "UniqueId", # required
172
+ # }
173
+ #
174
+ # @!attribute [rw] ledger_name
175
+ # The name of the ledger.
176
+ # @return [String]
177
+ #
178
+ # @!attribute [rw] stream_id
179
+ # The unique ID that QLDB assigns to each QLDB journal stream.
180
+ # @return [String]
181
+ #
182
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/DescribeJournalKinesisStreamRequest AWS API Documentation
183
+ #
184
+ class DescribeJournalKinesisStreamRequest < Struct.new(
185
+ :ledger_name,
186
+ :stream_id)
187
+ include Aws::Structure
188
+ end
189
+
190
+ # @!attribute [rw] stream
191
+ # Information about the QLDB journal stream returned by a
192
+ # `DescribeJournalS3Export` request.
193
+ # @return [Types::JournalKinesisStreamDescription]
194
+ #
195
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/DescribeJournalKinesisStreamResponse AWS API Documentation
196
+ #
197
+ class DescribeJournalKinesisStreamResponse < Struct.new(
198
+ :stream)
199
+ include Aws::Structure
200
+ end
201
+
122
202
  # @note When making an API call, you may pass DescribeJournalS3ExportRequest
123
203
  # data as a hash:
124
204
  #
@@ -488,6 +568,81 @@ module Aws::QLDB
488
568
  include Aws::Structure
489
569
  end
490
570
 
571
+ # The information about an Amazon QLDB journal stream, including the
572
+ # Amazon Resource Name (ARN), stream name, creation time, current
573
+ # status, and the parameters of your original stream creation request.
574
+ #
575
+ # @!attribute [rw] ledger_name
576
+ # The name of the ledger.
577
+ # @return [String]
578
+ #
579
+ # @!attribute [rw] creation_time
580
+ # The date and time, in epoch time format, when the QLDB journal
581
+ # stream was created. (Epoch time format is the number of seconds
582
+ # elapsed since 12:00:00 AM January 1, 1970 UTC.)
583
+ # @return [Time]
584
+ #
585
+ # @!attribute [rw] inclusive_start_time
586
+ # The inclusive start date and time from which to start streaming
587
+ # journal data.
588
+ # @return [Time]
589
+ #
590
+ # @!attribute [rw] exclusive_end_time
591
+ # The exclusive date and time that specifies when the stream ends. If
592
+ # this parameter is blank, the stream runs indefinitely until you
593
+ # cancel it.
594
+ # @return [Time]
595
+ #
596
+ # @!attribute [rw] role_arn
597
+ # The Amazon Resource Name (ARN) of the IAM role that grants QLDB
598
+ # permissions for a journal stream to write data records to a Kinesis
599
+ # Data Streams resource.
600
+ # @return [String]
601
+ #
602
+ # @!attribute [rw] stream_id
603
+ # The unique ID that QLDB assigns to each QLDB journal stream.
604
+ # @return [String]
605
+ #
606
+ # @!attribute [rw] arn
607
+ # The Amazon Resource Name (ARN) of the QLDB journal stream.
608
+ # @return [String]
609
+ #
610
+ # @!attribute [rw] status
611
+ # The current state of the QLDB journal stream.
612
+ # @return [String]
613
+ #
614
+ # @!attribute [rw] kinesis_configuration
615
+ # The configuration settings of the Amazon Kinesis Data Streams
616
+ # destination for your QLDB journal stream.
617
+ # @return [Types::KinesisConfiguration]
618
+ #
619
+ # @!attribute [rw] error_cause
620
+ # The error message that describes the reason that a stream has a
621
+ # status of `IMPAIRED` or `FAILED`. This is not applicable to streams
622
+ # that have other status values.
623
+ # @return [String]
624
+ #
625
+ # @!attribute [rw] stream_name
626
+ # The user-defined name of the QLDB journal stream.
627
+ # @return [String]
628
+ #
629
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/JournalKinesisStreamDescription AWS API Documentation
630
+ #
631
+ class JournalKinesisStreamDescription < Struct.new(
632
+ :ledger_name,
633
+ :creation_time,
634
+ :inclusive_start_time,
635
+ :exclusive_end_time,
636
+ :role_arn,
637
+ :stream_id,
638
+ :arn,
639
+ :status,
640
+ :kinesis_configuration,
641
+ :error_cause,
642
+ :stream_name)
643
+ include Aws::Structure
644
+ end
645
+
491
646
  # The information about a journal export job, including the ledger name,
492
647
  # export ID, when it was created, current status, and its start and end
493
648
  # time export parameters.
@@ -551,6 +706,39 @@ module Aws::QLDB
551
706
  include Aws::Structure
552
707
  end
553
708
 
709
+ # The configuration settings of the Amazon Kinesis Data Streams
710
+ # destination for your Amazon QLDB journal stream.
711
+ #
712
+ # @note When making an API call, you may pass KinesisConfiguration
713
+ # data as a hash:
714
+ #
715
+ # {
716
+ # stream_arn: "Arn", # required
717
+ # aggregation_enabled: false,
718
+ # }
719
+ #
720
+ # @!attribute [rw] stream_arn
721
+ # The Amazon Resource Name (ARN) of the Kinesis data stream resource.
722
+ # @return [String]
723
+ #
724
+ # @!attribute [rw] aggregation_enabled
725
+ # Enables QLDB to publish multiple data records in a single Kinesis
726
+ # Data Streams record. To learn more, see [KPL Key Concepts][1] in the
727
+ # *Amazon Kinesis Data Streams Developer Guide*.
728
+ #
729
+ #
730
+ #
731
+ # [1]: https://docs.aws.amazon.com/streams/latest/dev/kinesis-kpl-concepts.html
732
+ # @return [Boolean]
733
+ #
734
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/KinesisConfiguration AWS API Documentation
735
+ #
736
+ class KinesisConfiguration < Struct.new(
737
+ :stream_arn,
738
+ :aggregation_enabled)
739
+ include Aws::Structure
740
+ end
741
+
554
742
  # Information about a ledger, including its name, state, and when it was
555
743
  # created.
556
744
  #
@@ -594,6 +782,63 @@ module Aws::QLDB
594
782
  include Aws::Structure
595
783
  end
596
784
 
785
+ # @note When making an API call, you may pass ListJournalKinesisStreamsForLedgerRequest
786
+ # data as a hash:
787
+ #
788
+ # {
789
+ # ledger_name: "LedgerName", # required
790
+ # max_results: 1,
791
+ # next_token: "NextToken",
792
+ # }
793
+ #
794
+ # @!attribute [rw] ledger_name
795
+ # The name of the ledger.
796
+ # @return [String]
797
+ #
798
+ # @!attribute [rw] max_results
799
+ # The maximum number of results to return in a single
800
+ # `ListJournalKinesisStreamsForLedger` request. (The actual number of
801
+ # results returned might be fewer.)
802
+ # @return [Integer]
803
+ #
804
+ # @!attribute [rw] next_token
805
+ # A pagination token, indicating that you want to retrieve the next
806
+ # page of results. If you received a value for `NextToken` in the
807
+ # response from a previous `ListJournalKinesisStreamsForLedger` call,
808
+ # you should use that value as input here.
809
+ # @return [String]
810
+ #
811
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/ListJournalKinesisStreamsForLedgerRequest AWS API Documentation
812
+ #
813
+ class ListJournalKinesisStreamsForLedgerRequest < Struct.new(
814
+ :ledger_name,
815
+ :max_results,
816
+ :next_token)
817
+ include Aws::Structure
818
+ end
819
+
820
+ # @!attribute [rw] streams
821
+ # The array of QLDB journal stream descriptors that are associated
822
+ # with the given ledger.
823
+ # @return [Array<Types::JournalKinesisStreamDescription>]
824
+ #
825
+ # @!attribute [rw] next_token
826
+ # * If `NextToken` is empty, the last page of results has been
827
+ # processed and there are no more results to be retrieved.
828
+ #
829
+ # * If `NextToken` is *not* empty, more results are available. To
830
+ # retrieve the next page of results, use the value of `NextToken` in
831
+ # a subsequent `ListJournalKinesisStreamsForLedger` call.
832
+ # @return [String]
833
+ #
834
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/ListJournalKinesisStreamsForLedgerResponse AWS API Documentation
835
+ #
836
+ class ListJournalKinesisStreamsForLedgerResponse < Struct.new(
837
+ :streams,
838
+ :next_token)
839
+ include Aws::Structure
840
+ end
841
+
597
842
  # @note When making an API call, you may pass ListJournalS3ExportsForLedgerRequest
598
843
  # data as a hash:
599
844
  #
@@ -900,8 +1145,9 @@ module Aws::QLDB
900
1145
  # @return [String]
901
1146
  #
902
1147
  # @!attribute [rw] kms_key_arn
903
- # The Amazon Resource Name (ARN) for a customer master key (CMK) in
904
- # AWS Key Management Service (AWS KMS).
1148
+ # The Amazon Resource Name (ARN) for a symmetric customer master key
1149
+ # (CMK) in AWS Key Management Service (AWS KMS). Amazon QLDB does not
1150
+ # support asymmetric CMKs.
905
1151
  #
906
1152
  # You must provide a `KmsKeyArn` if you specify `SSE_KMS` as the
907
1153
  # `ObjectEncryptionType`.
@@ -981,6 +1227,108 @@ module Aws::QLDB
981
1227
  include Aws::Structure
982
1228
  end
983
1229
 
1230
+ # @note When making an API call, you may pass StreamJournalToKinesisRequest
1231
+ # data as a hash:
1232
+ #
1233
+ # {
1234
+ # ledger_name: "LedgerName", # required
1235
+ # role_arn: "Arn", # required
1236
+ # tags: {
1237
+ # "TagKey" => "TagValue",
1238
+ # },
1239
+ # inclusive_start_time: Time.now, # required
1240
+ # exclusive_end_time: Time.now,
1241
+ # kinesis_configuration: { # required
1242
+ # stream_arn: "Arn", # required
1243
+ # aggregation_enabled: false,
1244
+ # },
1245
+ # stream_name: "StreamName", # required
1246
+ # }
1247
+ #
1248
+ # @!attribute [rw] ledger_name
1249
+ # The name of the ledger.
1250
+ # @return [String]
1251
+ #
1252
+ # @!attribute [rw] role_arn
1253
+ # The Amazon Resource Name (ARN) of the IAM role that grants QLDB
1254
+ # permissions for a journal stream to write data records to a Kinesis
1255
+ # Data Streams resource.
1256
+ # @return [String]
1257
+ #
1258
+ # @!attribute [rw] tags
1259
+ # The key-value pairs to add as tags to the stream that you want to
1260
+ # create. Tag keys are case sensitive. Tag values are case sensitive
1261
+ # and can be null.
1262
+ # @return [Hash<String,String>]
1263
+ #
1264
+ # @!attribute [rw] inclusive_start_time
1265
+ # The inclusive start date and time from which to start streaming
1266
+ # journal data. This parameter must be in `ISO 8601` date and time
1267
+ # format and in Universal Coordinated Time (UTC). For example:
1268
+ # `2019-06-13T21:36:34Z`
1269
+ #
1270
+ # The `InclusiveStartTime` cannot be in the future and must be before
1271
+ # `ExclusiveEndTime`.
1272
+ #
1273
+ # If you provide an `InclusiveStartTime` that is before the ledger's
1274
+ # `CreationDateTime`, QLDB effectively defaults it to the ledger's
1275
+ # `CreationDateTime`.
1276
+ # @return [Time]
1277
+ #
1278
+ # @!attribute [rw] exclusive_end_time
1279
+ # The exclusive date and time that specifies when the stream ends. If
1280
+ # you don't define this parameter, the stream runs indefinitely until
1281
+ # you cancel it.
1282
+ #
1283
+ # The `ExclusiveEndTime` must be in `ISO 8601` date and time format
1284
+ # and in Universal Coordinated Time (UTC). For example:
1285
+ # `2019-06-13T21:36:34Z`
1286
+ # @return [Time]
1287
+ #
1288
+ # @!attribute [rw] kinesis_configuration
1289
+ # The configuration settings of the Kinesis Data Streams destination
1290
+ # for your stream request.
1291
+ # @return [Types::KinesisConfiguration]
1292
+ #
1293
+ # @!attribute [rw] stream_name
1294
+ # The name that you want to assign to the QLDB journal stream.
1295
+ # User-defined names can help identify and indicate the purpose of a
1296
+ # stream.
1297
+ #
1298
+ # Your stream name must be unique among other *active* streams for a
1299
+ # given ledger. Stream names have the same naming constraints as
1300
+ # ledger names, as defined in [Quotas in Amazon QLDB][1] in the
1301
+ # *Amazon QLDB Developer Guide*.
1302
+ #
1303
+ #
1304
+ #
1305
+ # [1]: https://docs.aws.amazon.com/qldb/latest/developerguide/limits.html#limits.naming
1306
+ # @return [String]
1307
+ #
1308
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/StreamJournalToKinesisRequest AWS API Documentation
1309
+ #
1310
+ class StreamJournalToKinesisRequest < Struct.new(
1311
+ :ledger_name,
1312
+ :role_arn,
1313
+ :tags,
1314
+ :inclusive_start_time,
1315
+ :exclusive_end_time,
1316
+ :kinesis_configuration,
1317
+ :stream_name)
1318
+ include Aws::Structure
1319
+ end
1320
+
1321
+ # @!attribute [rw] stream_id
1322
+ # The unique ID that QLDB assigns to each QLDB journal stream.
1323
+ # @return [String]
1324
+ #
1325
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/StreamJournalToKinesisResponse AWS API Documentation
1326
+ #
1327
+ class StreamJournalToKinesisResponse < Struct.new(
1328
+ :stream_id)
1329
+ include Aws::Structure
1330
+ end
1331
+
984
1332
  # @note When making an API call, you may pass TagResourceRequest
985
1333
  # data as a hash:
986
1334
  #
@@ -1123,8 +1471,7 @@ module Aws::QLDB
1123
1471
  include Aws::Structure
1124
1472
  end
1125
1473
 
1126
- # A structure that can contain an Amazon Ion value in multiple encoding
1127
- # formats.
1474
+ # A structure that can contain a value in multiple encoding formats.
1128
1475
  #
1129
1476
  # @note When making an API call, you may pass ValueHolder
1130
1477
  # data as a hash:
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-qldb
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.2.0
4
+ version: 1.7.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-03-09 00:00:00.000000000 Z
11
+ date: 2020-06-16 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
19
19
  version: '3'
20
20
  - - ">="
21
21
  - !ruby/object:Gem::Version
22
- version: 3.71.0
22
+ version: 3.99.0
23
23
  type: :runtime
24
24
  prerelease: false
25
25
  version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
29
29
  version: '3'
30
30
  - - ">="
31
31
  - !ruby/object:Gem::Version
32
- version: 3.71.0
32
+ version: 3.99.0
33
33
  - !ruby/object:Gem::Dependency
34
34
  name: aws-sigv4
35
35
  requirement: !ruby/object:Gem::Requirement
@@ -81,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
81
81
  version: '0'
82
82
  requirements: []
83
83
  rubyforge_project:
84
- rubygems_version: 2.5.2.3
84
+ rubygems_version: 2.7.6.2
85
85
  signing_key:
86
86
  specification_version: 4
87
87
  summary: AWS SDK for Ruby - QLDB