aws-sdk-qldb 1.14.0 → 1.15.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-qldb.rb +1 -1
- data/lib/aws-sdk-qldb/client.rb +84 -49
- data/lib/aws-sdk-qldb/types.rb +84 -72
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: f160f78ebc39ab07b285e0b80e52bed4ac6bf17c9510d7040191cc084c1651ce
|
4
|
+
data.tar.gz: 6daaf1d0e593052301bf0cb66936a35a6536c7fd802c04b28de6b8a25162077c
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: fd3e4c31677c7c8d42e8e49cd11361f2cab0f506054c4b9fef19f29bfdef23f252593a754df1094bf445bd0c96b93f5c3eea5fcf20b535c6b0c16e882d5e8ded
|
7
|
+
data.tar.gz: ea2176d8645cecca765f0857710dbb53ebcf8c12fb11cb76b6e9226848a947ce3a9ebb01c44005044f2d11787b5e74c519287bfb7614a1b379ec7026bca3bb6a
|
data/CHANGELOG.md
CHANGED
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.15.0
|
data/lib/aws-sdk-qldb.rb
CHANGED
data/lib/aws-sdk-qldb/client.rb
CHANGED
@@ -338,7 +338,8 @@ module Aws::QLDB
|
|
338
338
|
# The name of the ledger.
|
339
339
|
#
|
340
340
|
# @option params [required, String] :stream_id
|
341
|
-
# The
|
341
|
+
# The UUID (represented in Base62-encoded text) of the QLDB journal
|
342
|
+
# stream to be canceled.
|
342
343
|
#
|
343
344
|
# @return [Types::CancelJournalKinesisStreamResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
344
345
|
#
|
@@ -364,7 +365,7 @@ module Aws::QLDB
|
|
364
365
|
req.send_request(options)
|
365
366
|
end
|
366
367
|
|
367
|
-
# Creates a new ledger in your AWS account.
|
368
|
+
# Creates a new ledger in your AWS account in the current Region.
|
368
369
|
#
|
369
370
|
# @option params [required, String] :name
|
370
371
|
# The name of the ledger that you want to create. The name must be
|
@@ -389,8 +390,8 @@ module Aws::QLDB
|
|
389
390
|
# * `ALLOW_ALL`\: A legacy permissions mode that enables access control
|
390
391
|
# with API-level granularity for ledgers.
|
391
392
|
#
|
392
|
-
# This mode allows users who have `SendCommand`
|
393
|
-
# ledger to run all PartiQL commands (hence, `ALLOW_ALL`) on any
|
393
|
+
# This mode allows users who have the `SendCommand` API permission for
|
394
|
+
# this ledger to run all PartiQL commands (hence, `ALLOW_ALL`) on any
|
394
395
|
# tables in the specified ledger. This mode disregards any table-level
|
395
396
|
# or command-level IAM permissions policies that you create for the
|
396
397
|
# ledger.
|
@@ -402,24 +403,28 @@ module Aws::QLDB
|
|
402
403
|
# By default, this mode denies all user requests to run any PartiQL
|
403
404
|
# commands on any tables in this ledger. To allow PartiQL commands to
|
404
405
|
# run, you must create IAM permissions policies for specific table
|
405
|
-
# resources and PartiQL actions, in addition to `SendCommand` API
|
406
|
-
#
|
406
|
+
# resources and PartiQL actions, in addition to the `SendCommand` API
|
407
|
+
# permission for the ledger. For information, see [Getting started
|
408
|
+
# with the standard permissions mode][1] in the *Amazon QLDB Developer
|
409
|
+
# Guide*.
|
407
410
|
#
|
408
411
|
# <note markdown="1"> We strongly recommend using the `STANDARD` permissions mode to
|
409
412
|
# maximize the security of your ledger data.
|
410
413
|
#
|
411
414
|
# </note>
|
412
415
|
#
|
416
|
+
#
|
417
|
+
#
|
418
|
+
# [1]: https://docs.aws.amazon.com/qldb/latest/developerguide/getting-started-standard-mode.html
|
419
|
+
#
|
413
420
|
# @option params [Boolean] :deletion_protection
|
414
421
|
# The flag that prevents a ledger from being deleted by any user. If not
|
415
422
|
# provided on ledger creation, this feature is enabled (`true`) by
|
416
423
|
# default.
|
417
424
|
#
|
418
425
|
# If deletion protection is enabled, you must first disable it before
|
419
|
-
# you can delete the ledger
|
420
|
-
#
|
421
|
-
# operation to set the flag to `false`. The QLDB console disables
|
422
|
-
# deletion protection for you when you use it to delete a ledger.
|
426
|
+
# you can delete the ledger. You can disable it by calling the
|
427
|
+
# `UpdateLedger` operation to set the flag to `false`.
|
423
428
|
#
|
424
429
|
# @return [Types::CreateLedgerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
425
430
|
#
|
@@ -462,10 +467,8 @@ module Aws::QLDB
|
|
462
467
|
# Deletes a ledger and all of its contents. This action is irreversible.
|
463
468
|
#
|
464
469
|
# If deletion protection is enabled, you must first disable it before
|
465
|
-
# you can delete the ledger
|
466
|
-
#
|
467
|
-
# operation to set the flag to `false`. The QLDB console disables
|
468
|
-
# deletion protection for you when you use it to delete a ledger.
|
470
|
+
# you can delete the ledger. You can disable it by calling the
|
471
|
+
# `UpdateLedger` operation to set the flag to `false`.
|
469
472
|
#
|
470
473
|
# @option params [required, String] :name
|
471
474
|
# The name of the ledger that you want to delete.
|
@@ -489,14 +492,23 @@ module Aws::QLDB
|
|
489
492
|
|
490
493
|
# Returns detailed information about a given Amazon QLDB journal stream.
|
491
494
|
# The output includes the Amazon Resource Name (ARN), stream name,
|
492
|
-
# current status, creation time, and the parameters of
|
495
|
+
# current status, creation time, and the parameters of the original
|
493
496
|
# stream creation request.
|
494
497
|
#
|
498
|
+
# This action does not return any expired journal streams. For more
|
499
|
+
# information, see [Expiration for terminal streams][1] in the *Amazon
|
500
|
+
# QLDB Developer Guide*.
|
501
|
+
#
|
502
|
+
#
|
503
|
+
#
|
504
|
+
# [1]: https://docs.aws.amazon.com/qldb/latest/developerguide/streams.create.html#streams.create.states.expiration
|
505
|
+
#
|
495
506
|
# @option params [required, String] :ledger_name
|
496
507
|
# The name of the ledger.
|
497
508
|
#
|
498
509
|
# @option params [required, String] :stream_id
|
499
|
-
# The
|
510
|
+
# The UUID (represented in Base62-encoded text) of the QLDB journal
|
511
|
+
# stream to describe.
|
500
512
|
#
|
501
513
|
# @return [Types::DescribeJournalKinesisStreamResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
502
514
|
#
|
@@ -534,11 +546,11 @@ module Aws::QLDB
|
|
534
546
|
end
|
535
547
|
|
536
548
|
# Returns information about a journal export job, including the ledger
|
537
|
-
# name, export ID,
|
538
|
-
#
|
549
|
+
# name, export ID, creation time, current status, and the parameters of
|
550
|
+
# the original export creation request.
|
539
551
|
#
|
540
552
|
# This action does not return any expired export jobs. For more
|
541
|
-
# information, see [Export
|
553
|
+
# information, see [Export job expiration][1] in the *Amazon QLDB
|
542
554
|
# Developer Guide*.
|
543
555
|
#
|
544
556
|
# If the export job with the given `ExportId` doesn't exist, then
|
@@ -555,7 +567,8 @@ module Aws::QLDB
|
|
555
567
|
# The name of the ledger.
|
556
568
|
#
|
557
569
|
# @option params [required, String] :export_id
|
558
|
-
# The
|
570
|
+
# The UUID (represented in Base62-encoded text) of the journal export
|
571
|
+
# job to describe.
|
559
572
|
#
|
560
573
|
# @return [Types::DescribeJournalS3ExportResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
561
574
|
#
|
@@ -648,12 +661,12 @@ module Aws::QLDB
|
|
648
661
|
# The name of the ledger.
|
649
662
|
#
|
650
663
|
# @option params [required, Time,DateTime,Date,Integer,String] :inclusive_start_time
|
651
|
-
# The inclusive start date and time for the range of journal contents
|
652
|
-
#
|
664
|
+
# The inclusive start date and time for the range of journal contents to
|
665
|
+
# export.
|
653
666
|
#
|
654
667
|
# The `InclusiveStartTime` must be in `ISO 8601` date and time format
|
655
668
|
# and in Universal Coordinated Time (UTC). For example:
|
656
|
-
# `2019-06-13T21:36:34Z
|
669
|
+
# `2019-06-13T21:36:34Z`.
|
657
670
|
#
|
658
671
|
# The `InclusiveStartTime` must be before `ExclusiveEndTime`.
|
659
672
|
#
|
@@ -662,12 +675,12 @@ module Aws::QLDB
|
|
662
675
|
# `CreationDateTime`.
|
663
676
|
#
|
664
677
|
# @option params [required, Time,DateTime,Date,Integer,String] :exclusive_end_time
|
665
|
-
# The exclusive end date and time for the range of journal contents
|
666
|
-
#
|
678
|
+
# The exclusive end date and time for the range of journal contents to
|
679
|
+
# export.
|
667
680
|
#
|
668
681
|
# The `ExclusiveEndTime` must be in `ISO 8601` date and time format and
|
669
682
|
# in Universal Coordinated Time (UTC). For example:
|
670
|
-
# `2019-06-13T21:36:34Z
|
683
|
+
# `2019-06-13T21:36:34Z`.
|
671
684
|
#
|
672
685
|
# The `ExclusiveEndTime` must be less than or equal to the current UTC
|
673
686
|
# date and time.
|
@@ -747,14 +760,14 @@ module Aws::QLDB
|
|
747
760
|
# The location of the block that you want to request. An address is an
|
748
761
|
# Amazon Ion structure that has two fields: `strandId` and `sequenceNo`.
|
749
762
|
#
|
750
|
-
# For example: `\{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14\}
|
763
|
+
# For example: `\{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14\}`.
|
751
764
|
#
|
752
765
|
# @option params [Types::ValueHolder] :digest_tip_address
|
753
766
|
# The latest block location covered by the digest for which to request a
|
754
767
|
# proof. An address is an Amazon Ion structure that has two fields:
|
755
768
|
# `strandId` and `sequenceNo`.
|
756
769
|
#
|
757
|
-
# For example: `\{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49\}
|
770
|
+
# For example: `\{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49\}`.
|
758
771
|
#
|
759
772
|
# @return [Types::GetBlockResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
760
773
|
#
|
@@ -831,17 +844,18 @@ module Aws::QLDB
|
|
831
844
|
# is an Amazon Ion structure that has two fields: `strandId` and
|
832
845
|
# `sequenceNo`.
|
833
846
|
#
|
834
|
-
# For example: `\{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14\}
|
847
|
+
# For example: `\{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14\}`.
|
835
848
|
#
|
836
849
|
# @option params [required, String] :document_id
|
837
|
-
# The
|
850
|
+
# The UUID (represented in Base62-encoded text) of the document to be
|
851
|
+
# verified.
|
838
852
|
#
|
839
853
|
# @option params [Types::ValueHolder] :digest_tip_address
|
840
854
|
# The latest block location covered by the digest for which to request a
|
841
855
|
# proof. An address is an Amazon Ion structure that has two fields:
|
842
856
|
# `strandId` and `sequenceNo`.
|
843
857
|
#
|
844
|
-
# For example: `\{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49\}
|
858
|
+
# For example: `\{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49\}`.
|
845
859
|
#
|
846
860
|
# @return [Types::GetRevisionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
847
861
|
#
|
@@ -879,10 +893,18 @@ module Aws::QLDB
|
|
879
893
|
# given ledger. The output of each stream descriptor includes the same
|
880
894
|
# details that are returned by `DescribeJournalKinesisStream`.
|
881
895
|
#
|
896
|
+
# This action does not return any expired journal streams. For more
|
897
|
+
# information, see [Expiration for terminal streams][1] in the *Amazon
|
898
|
+
# QLDB Developer Guide*.
|
899
|
+
#
|
882
900
|
# This action returns a maximum of `MaxResults` items. It is paginated
|
883
901
|
# so that you can retrieve all the items by calling
|
884
902
|
# `ListJournalKinesisStreamsForLedger` multiple times.
|
885
903
|
#
|
904
|
+
#
|
905
|
+
#
|
906
|
+
# [1]: https://docs.aws.amazon.com/qldb/latest/developerguide/streams.create.html#streams.create.states.expiration
|
907
|
+
#
|
886
908
|
# @option params [required, String] :ledger_name
|
887
909
|
# The name of the ledger.
|
888
910
|
#
|
@@ -946,7 +968,7 @@ module Aws::QLDB
|
|
946
968
|
# `ListJournalS3Exports` multiple times.
|
947
969
|
#
|
948
970
|
# This action does not return any expired export jobs. For more
|
949
|
-
# information, see [Export
|
971
|
+
# information, see [Export job expiration][1] in the *Amazon QLDB
|
950
972
|
# Developer Guide*.
|
951
973
|
#
|
952
974
|
#
|
@@ -1011,7 +1033,7 @@ module Aws::QLDB
|
|
1011
1033
|
# `ListJournalS3ExportsForLedger` multiple times.
|
1012
1034
|
#
|
1013
1035
|
# This action does not return any expired export jobs. For more
|
1014
|
-
# information, see [Export
|
1036
|
+
# information, see [Export job expiration][1] in the *Amazon QLDB
|
1015
1037
|
# Developer Guide*.
|
1016
1038
|
#
|
1017
1039
|
#
|
@@ -1123,8 +1145,8 @@ module Aws::QLDB
|
|
1123
1145
|
# Returns all tags for a specified Amazon QLDB resource.
|
1124
1146
|
#
|
1125
1147
|
# @option params [required, String] :resource_arn
|
1126
|
-
# The Amazon Resource Name (ARN) for which
|
1127
|
-
#
|
1148
|
+
# The Amazon Resource Name (ARN) for which to list the tags. For
|
1149
|
+
# example:
|
1128
1150
|
#
|
1129
1151
|
# `arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger`
|
1130
1152
|
#
|
@@ -1174,7 +1196,7 @@ module Aws::QLDB
|
|
1174
1196
|
# The inclusive start date and time from which to start streaming
|
1175
1197
|
# journal data. This parameter must be in `ISO 8601` date and time
|
1176
1198
|
# format and in Universal Coordinated Time (UTC). For example:
|
1177
|
-
# `2019-06-13T21:36:34Z
|
1199
|
+
# `2019-06-13T21:36:34Z`.
|
1178
1200
|
#
|
1179
1201
|
# The `InclusiveStartTime` cannot be in the future and must be before
|
1180
1202
|
# `ExclusiveEndTime`.
|
@@ -1190,7 +1212,7 @@ module Aws::QLDB
|
|
1190
1212
|
#
|
1191
1213
|
# The `ExclusiveEndTime` must be in `ISO 8601` date and time format and
|
1192
1214
|
# in Universal Coordinated Time (UTC). For example:
|
1193
|
-
# `2019-06-13T21:36:34Z
|
1215
|
+
# `2019-06-13T21:36:34Z`.
|
1194
1216
|
#
|
1195
1217
|
# @option params [required, Types::KinesisConfiguration] :kinesis_configuration
|
1196
1218
|
# The configuration settings of the Kinesis Data Streams destination for
|
@@ -1285,13 +1307,13 @@ module Aws::QLDB
|
|
1285
1307
|
# can specify up to 50 tag keys to remove.
|
1286
1308
|
#
|
1287
1309
|
# @option params [required, String] :resource_arn
|
1288
|
-
# The Amazon Resource Name (ARN) from which
|
1289
|
-
#
|
1310
|
+
# The Amazon Resource Name (ARN) from which to remove the tags. For
|
1311
|
+
# example:
|
1290
1312
|
#
|
1291
1313
|
# `arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger`
|
1292
1314
|
#
|
1293
1315
|
# @option params [required, Array<String>] :tag_keys
|
1294
|
-
# The list of tag keys
|
1316
|
+
# The list of tag keys to remove.
|
1295
1317
|
#
|
1296
1318
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1297
1319
|
#
|
@@ -1322,10 +1344,8 @@ module Aws::QLDB
|
|
1322
1344
|
# default.
|
1323
1345
|
#
|
1324
1346
|
# If deletion protection is enabled, you must first disable it before
|
1325
|
-
# you can delete the ledger
|
1326
|
-
#
|
1327
|
-
# operation to set the flag to `false`. The QLDB console disables
|
1328
|
-
# deletion protection for you when you use it to delete a ledger.
|
1347
|
+
# you can delete the ledger. You can disable it by calling the
|
1348
|
+
# `UpdateLedger` operation to set the flag to `false`.
|
1329
1349
|
#
|
1330
1350
|
# @return [Types::UpdateLedgerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1331
1351
|
#
|
@@ -1361,6 +1381,15 @@ module Aws::QLDB
|
|
1361
1381
|
|
1362
1382
|
# Updates the permissions mode of a ledger.
|
1363
1383
|
#
|
1384
|
+
# Before you switch to the `STANDARD` permissions mode, you must first
|
1385
|
+
# create all required IAM policies and table tags to avoid disruption to
|
1386
|
+
# your users. To learn more, see [Migrating to the standard permissions
|
1387
|
+
# mode][1] in the *Amazon QLDB Developer Guide*.
|
1388
|
+
#
|
1389
|
+
#
|
1390
|
+
#
|
1391
|
+
# [1]: https://docs.aws.amazon.com/qldb/latest/developerguide/ledger-management.basics.html#ledger-mgmt.basics.update-permissions.migrating
|
1392
|
+
#
|
1364
1393
|
# @option params [required, String] :name
|
1365
1394
|
# The name of the ledger.
|
1366
1395
|
#
|
@@ -1371,8 +1400,8 @@ module Aws::QLDB
|
|
1371
1400
|
# * `ALLOW_ALL`\: A legacy permissions mode that enables access control
|
1372
1401
|
# with API-level granularity for ledgers.
|
1373
1402
|
#
|
1374
|
-
# This mode allows users who have `SendCommand`
|
1375
|
-
# ledger to run all PartiQL commands (hence, `ALLOW_ALL`) on any
|
1403
|
+
# This mode allows users who have the `SendCommand` API permission for
|
1404
|
+
# this ledger to run all PartiQL commands (hence, `ALLOW_ALL`) on any
|
1376
1405
|
# tables in the specified ledger. This mode disregards any table-level
|
1377
1406
|
# or command-level IAM permissions policies that you create for the
|
1378
1407
|
# ledger.
|
@@ -1384,14 +1413,20 @@ module Aws::QLDB
|
|
1384
1413
|
# By default, this mode denies all user requests to run any PartiQL
|
1385
1414
|
# commands on any tables in this ledger. To allow PartiQL commands to
|
1386
1415
|
# run, you must create IAM permissions policies for specific table
|
1387
|
-
# resources and PartiQL actions, in addition to `SendCommand` API
|
1388
|
-
#
|
1416
|
+
# resources and PartiQL actions, in addition to the `SendCommand` API
|
1417
|
+
# permission for the ledger. For information, see [Getting started
|
1418
|
+
# with the standard permissions mode][1] in the *Amazon QLDB Developer
|
1419
|
+
# Guide*.
|
1389
1420
|
#
|
1390
1421
|
# <note markdown="1"> We strongly recommend using the `STANDARD` permissions mode to
|
1391
1422
|
# maximize the security of your ledger data.
|
1392
1423
|
#
|
1393
1424
|
# </note>
|
1394
1425
|
#
|
1426
|
+
#
|
1427
|
+
#
|
1428
|
+
# [1]: https://docs.aws.amazon.com/qldb/latest/developerguide/getting-started-standard-mode.html
|
1429
|
+
#
|
1395
1430
|
# @return [Types::UpdateLedgerPermissionsModeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1396
1431
|
#
|
1397
1432
|
# * {Types::UpdateLedgerPermissionsModeResponse#name #name} => String
|
@@ -1433,7 +1468,7 @@ module Aws::QLDB
|
|
1433
1468
|
params: params,
|
1434
1469
|
config: config)
|
1435
1470
|
context[:gem_name] = 'aws-sdk-qldb'
|
1436
|
-
context[:gem_version] = '1.
|
1471
|
+
context[:gem_version] = '1.15.0'
|
1437
1472
|
Seahorse::Client::Request.new(handlers, context)
|
1438
1473
|
end
|
1439
1474
|
|
data/lib/aws-sdk-qldb/types.rb
CHANGED
@@ -23,7 +23,8 @@ module Aws::QLDB
|
|
23
23
|
# @return [String]
|
24
24
|
#
|
25
25
|
# @!attribute [rw] stream_id
|
26
|
-
# The
|
26
|
+
# The UUID (represented in Base62-encoded text) of the QLDB journal
|
27
|
+
# stream to be canceled.
|
27
28
|
# @return [String]
|
28
29
|
#
|
29
30
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/CancelJournalKinesisStreamRequest AWS API Documentation
|
@@ -36,7 +37,7 @@ module Aws::QLDB
|
|
36
37
|
end
|
37
38
|
|
38
39
|
# @!attribute [rw] stream_id
|
39
|
-
# The
|
40
|
+
# The UUID (Base62-encoded text) of the canceled QLDB journal stream.
|
40
41
|
# @return [String]
|
41
42
|
#
|
42
43
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/CancelJournalKinesisStreamResponse AWS API Documentation
|
@@ -84,9 +85,9 @@ module Aws::QLDB
|
|
84
85
|
# * `ALLOW_ALL`\: A legacy permissions mode that enables access
|
85
86
|
# control with API-level granularity for ledgers.
|
86
87
|
#
|
87
|
-
# This mode allows users who have `SendCommand`
|
88
|
-
# ledger to run all PartiQL commands (hence, `ALLOW_ALL`)
|
89
|
-
# tables in the specified ledger. This mode disregards any
|
88
|
+
# This mode allows users who have the `SendCommand` API permission
|
89
|
+
# for this ledger to run all PartiQL commands (hence, `ALLOW_ALL`)
|
90
|
+
# on any tables in the specified ledger. This mode disregards any
|
90
91
|
# table-level or command-level IAM permissions policies that you
|
91
92
|
# create for the ledger.
|
92
93
|
#
|
@@ -97,13 +98,19 @@ module Aws::QLDB
|
|
97
98
|
# By default, this mode denies all user requests to run any PartiQL
|
98
99
|
# commands on any tables in this ledger. To allow PartiQL commands
|
99
100
|
# to run, you must create IAM permissions policies for specific
|
100
|
-
# table resources and PartiQL actions, in addition to
|
101
|
-
# API
|
101
|
+
# table resources and PartiQL actions, in addition to the
|
102
|
+
# `SendCommand` API permission for the ledger. For information, see
|
103
|
+
# [Getting started with the standard permissions mode][1] in the
|
104
|
+
# *Amazon QLDB Developer Guide*.
|
102
105
|
#
|
103
106
|
# <note markdown="1"> We strongly recommend using the `STANDARD` permissions mode to
|
104
107
|
# maximize the security of your ledger data.
|
105
108
|
#
|
106
109
|
# </note>
|
110
|
+
#
|
111
|
+
#
|
112
|
+
#
|
113
|
+
# [1]: https://docs.aws.amazon.com/qldb/latest/developerguide/getting-started-standard-mode.html
|
107
114
|
# @return [String]
|
108
115
|
#
|
109
116
|
# @!attribute [rw] deletion_protection
|
@@ -112,11 +119,8 @@ module Aws::QLDB
|
|
112
119
|
# default.
|
113
120
|
#
|
114
121
|
# If deletion protection is enabled, you must first disable it before
|
115
|
-
# you can delete the ledger
|
116
|
-
#
|
117
|
-
# `UpdateLedger` operation to set the flag to `false`. The QLDB
|
118
|
-
# console disables deletion protection for you when you use it to
|
119
|
-
# delete a ledger.
|
122
|
+
# you can delete the ledger. You can disable it by calling the
|
123
|
+
# `UpdateLedger` operation to set the flag to `false`.
|
120
124
|
# @return [Boolean]
|
121
125
|
#
|
122
126
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/CreateLedgerRequest AWS API Documentation
|
@@ -158,11 +162,8 @@ module Aws::QLDB
|
|
158
162
|
# default.
|
159
163
|
#
|
160
164
|
# If deletion protection is enabled, you must first disable it before
|
161
|
-
# you can delete the ledger
|
162
|
-
#
|
163
|
-
# `UpdateLedger` operation to set the flag to `false`. The QLDB
|
164
|
-
# console disables deletion protection for you when you use it to
|
165
|
-
# delete a ledger.
|
165
|
+
# you can delete the ledger. You can disable it by calling the
|
166
|
+
# `UpdateLedger` operation to set the flag to `false`.
|
166
167
|
# @return [Boolean]
|
167
168
|
#
|
168
169
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/CreateLedgerResponse AWS API Documentation
|
@@ -210,7 +211,8 @@ module Aws::QLDB
|
|
210
211
|
# @return [String]
|
211
212
|
#
|
212
213
|
# @!attribute [rw] stream_id
|
213
|
-
# The
|
214
|
+
# The UUID (represented in Base62-encoded text) of the QLDB journal
|
215
|
+
# stream to describe.
|
214
216
|
# @return [String]
|
215
217
|
#
|
216
218
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/DescribeJournalKinesisStreamRequest AWS API Documentation
|
@@ -248,7 +250,8 @@ module Aws::QLDB
|
|
248
250
|
# @return [String]
|
249
251
|
#
|
250
252
|
# @!attribute [rw] export_id
|
251
|
-
# The
|
253
|
+
# The UUID (represented in Base62-encoded text) of the journal export
|
254
|
+
# job to describe.
|
252
255
|
# @return [String]
|
253
256
|
#
|
254
257
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/DescribeJournalS3ExportRequest AWS API Documentation
|
@@ -320,11 +323,8 @@ module Aws::QLDB
|
|
320
323
|
# default.
|
321
324
|
#
|
322
325
|
# If deletion protection is enabled, you must first disable it before
|
323
|
-
# you can delete the ledger
|
324
|
-
#
|
325
|
-
# `UpdateLedger` operation to set the flag to `false`. The QLDB
|
326
|
-
# console disables deletion protection for you when you use it to
|
327
|
-
# delete a ledger.
|
326
|
+
# you can delete the ledger. You can disable it by calling the
|
327
|
+
# `UpdateLedger` operation to set the flag to `false`.
|
328
328
|
# @return [Boolean]
|
329
329
|
#
|
330
330
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/DescribeLedgerResponse AWS API Documentation
|
@@ -364,11 +364,11 @@ module Aws::QLDB
|
|
364
364
|
#
|
365
365
|
# @!attribute [rw] inclusive_start_time
|
366
366
|
# The inclusive start date and time for the range of journal contents
|
367
|
-
#
|
367
|
+
# to export.
|
368
368
|
#
|
369
369
|
# The `InclusiveStartTime` must be in `ISO 8601` date and time format
|
370
370
|
# and in Universal Coordinated Time (UTC). For example:
|
371
|
-
# `2019-06-13T21:36:34Z
|
371
|
+
# `2019-06-13T21:36:34Z`.
|
372
372
|
#
|
373
373
|
# The `InclusiveStartTime` must be before `ExclusiveEndTime`.
|
374
374
|
#
|
@@ -378,12 +378,12 @@ module Aws::QLDB
|
|
378
378
|
# @return [Time]
|
379
379
|
#
|
380
380
|
# @!attribute [rw] exclusive_end_time
|
381
|
-
# The exclusive end date and time for the range of journal contents
|
382
|
-
#
|
381
|
+
# The exclusive end date and time for the range of journal contents to
|
382
|
+
# export.
|
383
383
|
#
|
384
384
|
# The `ExclusiveEndTime` must be in `ISO 8601` date and time format
|
385
385
|
# and in Universal Coordinated Time (UTC). For example:
|
386
|
-
# `2019-06-13T21:36:34Z
|
386
|
+
# `2019-06-13T21:36:34Z`.
|
387
387
|
#
|
388
388
|
# The `ExclusiveEndTime` must be less than or equal to the current UTC
|
389
389
|
# date and time.
|
@@ -419,7 +419,8 @@ module Aws::QLDB
|
|
419
419
|
end
|
420
420
|
|
421
421
|
# @!attribute [rw] export_id
|
422
|
-
# The
|
422
|
+
# The UUID (represented in Base62-encoded text) that QLDB assigns to
|
423
|
+
# each journal export job.
|
423
424
|
#
|
424
425
|
# To describe your export request and check the status of the job, you
|
425
426
|
# can use `ExportId` to call `DescribeJournalS3Export`.
|
@@ -455,7 +456,7 @@ module Aws::QLDB
|
|
455
456
|
# Amazon Ion structure that has two fields: `strandId` and
|
456
457
|
# `sequenceNo`.
|
457
458
|
#
|
458
|
-
# For example: `\{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14\}
|
459
|
+
# For example: `\{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14\}`.
|
459
460
|
# @return [Types::ValueHolder]
|
460
461
|
#
|
461
462
|
# @!attribute [rw] digest_tip_address
|
@@ -463,7 +464,7 @@ module Aws::QLDB
|
|
463
464
|
# a proof. An address is an Amazon Ion structure that has two fields:
|
464
465
|
# `strandId` and `sequenceNo`.
|
465
466
|
#
|
466
|
-
# For example: `\{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49\}
|
467
|
+
# For example: `\{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49\}`.
|
467
468
|
# @return [Types::ValueHolder]
|
468
469
|
#
|
469
470
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/GetBlockRequest AWS API Documentation
|
@@ -558,11 +559,12 @@ module Aws::QLDB
|
|
558
559
|
# address is an Amazon Ion structure that has two fields: `strandId`
|
559
560
|
# and `sequenceNo`.
|
560
561
|
#
|
561
|
-
# For example: `\{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14\}
|
562
|
+
# For example: `\{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14\}`.
|
562
563
|
# @return [Types::ValueHolder]
|
563
564
|
#
|
564
565
|
# @!attribute [rw] document_id
|
565
|
-
# The
|
566
|
+
# The UUID (represented in Base62-encoded text) of the document to be
|
567
|
+
# verified.
|
566
568
|
# @return [String]
|
567
569
|
#
|
568
570
|
# @!attribute [rw] digest_tip_address
|
@@ -570,7 +572,7 @@ module Aws::QLDB
|
|
570
572
|
# a proof. An address is an Amazon Ion structure that has two fields:
|
571
573
|
# `strandId` and `sequenceNo`.
|
572
574
|
#
|
573
|
-
# For example: `\{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49\}
|
575
|
+
# For example: `\{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49\}`.
|
574
576
|
# @return [Types::ValueHolder]
|
575
577
|
#
|
576
578
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/GetRevisionRequest AWS API Documentation
|
@@ -622,9 +624,9 @@ module Aws::QLDB
|
|
622
624
|
include Aws::Structure
|
623
625
|
end
|
624
626
|
|
625
|
-
#
|
626
|
-
#
|
627
|
-
#
|
627
|
+
# Information about an Amazon QLDB journal stream, including the Amazon
|
628
|
+
# Resource Name (ARN), stream name, creation time, current status, and
|
629
|
+
# the parameters of the original stream creation request.
|
628
630
|
#
|
629
631
|
# @!attribute [rw] ledger_name
|
630
632
|
# The name of the ledger.
|
@@ -654,7 +656,8 @@ module Aws::QLDB
|
|
654
656
|
# @return [String]
|
655
657
|
#
|
656
658
|
# @!attribute [rw] stream_id
|
657
|
-
# The
|
659
|
+
# The UUID (represented in Base62-encoded text) of the QLDB journal
|
660
|
+
# stream.
|
658
661
|
# @return [String]
|
659
662
|
#
|
660
663
|
# @!attribute [rw] arn
|
@@ -667,7 +670,7 @@ module Aws::QLDB
|
|
667
670
|
#
|
668
671
|
# @!attribute [rw] kinesis_configuration
|
669
672
|
# The configuration settings of the Amazon Kinesis Data Streams
|
670
|
-
# destination for
|
673
|
+
# destination for a QLDB journal stream.
|
671
674
|
# @return [Types::KinesisConfiguration]
|
672
675
|
#
|
673
676
|
# @!attribute [rw] error_cause
|
@@ -698,16 +701,17 @@ module Aws::QLDB
|
|
698
701
|
include Aws::Structure
|
699
702
|
end
|
700
703
|
|
701
|
-
#
|
702
|
-
# export ID,
|
703
|
-
#
|
704
|
+
# Information about a journal export job, including the ledger name,
|
705
|
+
# export ID, creation time, current status, and the parameters of the
|
706
|
+
# original export creation request.
|
704
707
|
#
|
705
708
|
# @!attribute [rw] ledger_name
|
706
709
|
# The name of the ledger.
|
707
710
|
# @return [String]
|
708
711
|
#
|
709
712
|
# @!attribute [rw] export_id
|
710
|
-
# The
|
713
|
+
# The UUID (represented in Base62-encoded text) of the journal export
|
714
|
+
# job.
|
711
715
|
# @return [String]
|
712
716
|
#
|
713
717
|
# @!attribute [rw] export_creation_time
|
@@ -763,7 +767,7 @@ module Aws::QLDB
|
|
763
767
|
end
|
764
768
|
|
765
769
|
# The configuration settings of the Amazon Kinesis Data Streams
|
766
|
-
# destination for
|
770
|
+
# destination for an Amazon QLDB journal stream.
|
767
771
|
#
|
768
772
|
# @note When making an API call, you may pass KinesisConfiguration
|
769
773
|
# data as a hash:
|
@@ -774,17 +778,24 @@ module Aws::QLDB
|
|
774
778
|
# }
|
775
779
|
#
|
776
780
|
# @!attribute [rw] stream_arn
|
777
|
-
# The Amazon Resource Name (ARN) of the Kinesis
|
781
|
+
# The Amazon Resource Name (ARN) of the Kinesis Data Streams resource.
|
778
782
|
# @return [String]
|
779
783
|
#
|
780
784
|
# @!attribute [rw] aggregation_enabled
|
781
785
|
# Enables QLDB to publish multiple data records in a single Kinesis
|
782
|
-
# Data Streams record
|
783
|
-
#
|
786
|
+
# Data Streams record, increasing the number of records sent per API
|
787
|
+
# call.
|
788
|
+
#
|
789
|
+
# *This option is enabled by default.* Record aggregation has
|
790
|
+
# important implications for processing records and requires
|
791
|
+
# de-aggregation in your stream consumer. To learn more, see [KPL Key
|
792
|
+
# Concepts][1] and [Consumer De-aggregation][2] in the *Amazon Kinesis
|
793
|
+
# Data Streams Developer Guide*.
|
784
794
|
#
|
785
795
|
#
|
786
796
|
#
|
787
797
|
# [1]: https://docs.aws.amazon.com/streams/latest/dev/kinesis-kpl-concepts.html
|
798
|
+
# [2]: https://docs.aws.amazon.com/streams/latest/dev/kinesis-kpl-consumer-deaggregation.html
|
788
799
|
# @return [Boolean]
|
789
800
|
#
|
790
801
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/KinesisConfiguration AWS API Documentation
|
@@ -1075,8 +1086,8 @@ module Aws::QLDB
|
|
1075
1086
|
# }
|
1076
1087
|
#
|
1077
1088
|
# @!attribute [rw] resource_arn
|
1078
|
-
# The Amazon Resource Name (ARN) for which
|
1079
|
-
#
|
1089
|
+
# The Amazon Resource Name (ARN) for which to list the tags. For
|
1090
|
+
# example:
|
1080
1091
|
#
|
1081
1092
|
# `arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger`
|
1082
1093
|
# @return [String]
|
@@ -1219,7 +1230,7 @@ module Aws::QLDB
|
|
1219
1230
|
#
|
1220
1231
|
# @!attribute [rw] kms_key_arn
|
1221
1232
|
# The Amazon Resource Name (ARN) for a symmetric customer master key
|
1222
|
-
# (CMK) in AWS Key Management Service (AWS KMS). Amazon
|
1233
|
+
# (CMK) in AWS Key Management Service (AWS KMS). Amazon S3 does not
|
1223
1234
|
# support asymmetric CMKs.
|
1224
1235
|
#
|
1225
1236
|
# You must provide a `KmsKeyArn` if you specify `SSE_KMS` as the
|
@@ -1340,7 +1351,7 @@ module Aws::QLDB
|
|
1340
1351
|
# The inclusive start date and time from which to start streaming
|
1341
1352
|
# journal data. This parameter must be in `ISO 8601` date and time
|
1342
1353
|
# format and in Universal Coordinated Time (UTC). For example:
|
1343
|
-
# `2019-06-13T21:36:34Z
|
1354
|
+
# `2019-06-13T21:36:34Z`.
|
1344
1355
|
#
|
1345
1356
|
# The `InclusiveStartTime` cannot be in the future and must be before
|
1346
1357
|
# `ExclusiveEndTime`.
|
@@ -1357,7 +1368,7 @@ module Aws::QLDB
|
|
1357
1368
|
#
|
1358
1369
|
# The `ExclusiveEndTime` must be in `ISO 8601` date and time format
|
1359
1370
|
# and in Universal Coordinated Time (UTC). For example:
|
1360
|
-
# `2019-06-13T21:36:34Z
|
1371
|
+
# `2019-06-13T21:36:34Z`.
|
1361
1372
|
# @return [Time]
|
1362
1373
|
#
|
1363
1374
|
# @!attribute [rw] kinesis_configuration
|
@@ -1395,7 +1406,8 @@ module Aws::QLDB
|
|
1395
1406
|
end
|
1396
1407
|
|
1397
1408
|
# @!attribute [rw] stream_id
|
1398
|
-
# The
|
1409
|
+
# The UUID (represented in Base62-encoded text) that QLDB assigns to
|
1410
|
+
# each QLDB journal stream.
|
1399
1411
|
# @return [String]
|
1400
1412
|
#
|
1401
1413
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/StreamJournalToKinesisResponse AWS API Documentation
|
@@ -1452,14 +1464,14 @@ module Aws::QLDB
|
|
1452
1464
|
# }
|
1453
1465
|
#
|
1454
1466
|
# @!attribute [rw] resource_arn
|
1455
|
-
# The Amazon Resource Name (ARN) from which
|
1456
|
-
#
|
1467
|
+
# The Amazon Resource Name (ARN) from which to remove the tags. For
|
1468
|
+
# example:
|
1457
1469
|
#
|
1458
1470
|
# `arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger`
|
1459
1471
|
# @return [String]
|
1460
1472
|
#
|
1461
1473
|
# @!attribute [rw] tag_keys
|
1462
|
-
# The list of tag keys
|
1474
|
+
# The list of tag keys to remove.
|
1463
1475
|
# @return [Array<String>]
|
1464
1476
|
#
|
1465
1477
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/UntagResourceRequest AWS API Documentation
|
@@ -1494,9 +1506,9 @@ module Aws::QLDB
|
|
1494
1506
|
# * `ALLOW_ALL`\: A legacy permissions mode that enables access
|
1495
1507
|
# control with API-level granularity for ledgers.
|
1496
1508
|
#
|
1497
|
-
# This mode allows users who have `SendCommand`
|
1498
|
-
# ledger to run all PartiQL commands (hence, `ALLOW_ALL`)
|
1499
|
-
# tables in the specified ledger. This mode disregards any
|
1509
|
+
# This mode allows users who have the `SendCommand` API permission
|
1510
|
+
# for this ledger to run all PartiQL commands (hence, `ALLOW_ALL`)
|
1511
|
+
# on any tables in the specified ledger. This mode disregards any
|
1500
1512
|
# table-level or command-level IAM permissions policies that you
|
1501
1513
|
# create for the ledger.
|
1502
1514
|
#
|
@@ -1507,13 +1519,19 @@ module Aws::QLDB
|
|
1507
1519
|
# By default, this mode denies all user requests to run any PartiQL
|
1508
1520
|
# commands on any tables in this ledger. To allow PartiQL commands
|
1509
1521
|
# to run, you must create IAM permissions policies for specific
|
1510
|
-
# table resources and PartiQL actions, in addition to
|
1511
|
-
# API
|
1522
|
+
# table resources and PartiQL actions, in addition to the
|
1523
|
+
# `SendCommand` API permission for the ledger. For information, see
|
1524
|
+
# [Getting started with the standard permissions mode][1] in the
|
1525
|
+
# *Amazon QLDB Developer Guide*.
|
1512
1526
|
#
|
1513
1527
|
# <note markdown="1"> We strongly recommend using the `STANDARD` permissions mode to
|
1514
1528
|
# maximize the security of your ledger data.
|
1515
1529
|
#
|
1516
1530
|
# </note>
|
1531
|
+
#
|
1532
|
+
#
|
1533
|
+
#
|
1534
|
+
# [1]: https://docs.aws.amazon.com/qldb/latest/developerguide/getting-started-standard-mode.html
|
1517
1535
|
# @return [String]
|
1518
1536
|
#
|
1519
1537
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/UpdateLedgerPermissionsModeRequest AWS API Documentation
|
@@ -1565,11 +1583,8 @@ module Aws::QLDB
|
|
1565
1583
|
# default.
|
1566
1584
|
#
|
1567
1585
|
# If deletion protection is enabled, you must first disable it before
|
1568
|
-
# you can delete the ledger
|
1569
|
-
#
|
1570
|
-
# `UpdateLedger` operation to set the flag to `false`. The QLDB
|
1571
|
-
# console disables deletion protection for you when you use it to
|
1572
|
-
# delete a ledger.
|
1586
|
+
# you can delete the ledger. You can disable it by calling the
|
1587
|
+
# `UpdateLedger` operation to set the flag to `false`.
|
1573
1588
|
# @return [Boolean]
|
1574
1589
|
#
|
1575
1590
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/UpdateLedgerRequest AWS API Documentation
|
@@ -1605,11 +1620,8 @@ module Aws::QLDB
|
|
1605
1620
|
# default.
|
1606
1621
|
#
|
1607
1622
|
# If deletion protection is enabled, you must first disable it before
|
1608
|
-
# you can delete the ledger
|
1609
|
-
#
|
1610
|
-
# `UpdateLedger` operation to set the flag to `false`. The QLDB
|
1611
|
-
# console disables deletion protection for you when you use it to
|
1612
|
-
# delete a ledger.
|
1623
|
+
# you can delete the ledger. You can disable it by calling the
|
1624
|
+
# `UpdateLedger` operation to set the flag to `false`.
|
1613
1625
|
# @return [Boolean]
|
1614
1626
|
#
|
1615
1627
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/UpdateLedgerResponse AWS API Documentation
|
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.
|
4
|
+
version: 1.15.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: 2021-
|
11
|
+
date: 2021-06-04 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|