aws-sdk-qldb 1.14.0 → 1.18.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: b855a08fcf61fe9ab43c75c07bdf8d94e7a0def11d2f33d61608bbab93d099ee
4
- data.tar.gz: d3352328214a2cd14a07b6243d7e36322517ad47aa804a81c39056729ff9e119
3
+ metadata.gz: ae34f01e72fbae85f8988ed6f378fb7a9c1cdb640e6f8a27cc38f514965db40c
4
+ data.tar.gz: 5d4da458dae894ff0384f7681ab8141bffc50a21e70fa44998df6661a41a43db
5
5
  SHA512:
6
- metadata.gz: 25e3d4a5839cf6d3aa07f2658746e77d5d61020fc68c3882355d4a7e70844fd1f5c9d50bb1d9b6fd031113434d3b666fefdfec6443c459914db49a195599c5a5
7
- data.tar.gz: fc783f746b0f652e372b76da4e26bc3a787d76f2a5728b76995af0627bf877a32e12e1eacb5629de0b30883dabec81a3576c6ff00c2825ff332c6216c88febe2
6
+ metadata.gz: 5ed1ce6c975ed9e11f705a68fe427cad6629d4df4a78c220cbc02bd1bf1fa43f7ebbf5adf6783596bacba01d749bfd80463063b70c4b12be828928d83b6f970d
7
+ data.tar.gz: ce6bee2f028877841f902c70048975538f2105e34ff4216a50ff297ab747f28ca8587d19d958edf869bc9f5fa05ae2ec4f2df0cf02e190f861301cff759be944
data/CHANGELOG.md CHANGED
@@ -1,6 +1,26 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.18.0 (2021-07-30)
5
+ ------------------
6
+
7
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
8
+
9
+ 1.17.0 (2021-07-28)
10
+ ------------------
11
+
12
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
13
+
14
+ 1.16.0 (2021-07-22)
15
+ ------------------
16
+
17
+ * Feature - Amazon QLDB now supports ledgers encrypted with customer managed KMS keys. Changes in CreateLedger, UpdateLedger and DescribeLedger APIs to support the changes.
18
+
19
+ 1.15.0 (2021-06-04)
20
+ ------------------
21
+
22
+ * Feature - Documentation updates for Amazon QLDB
23
+
4
24
  1.14.0 (2021-05-26)
5
25
  ------------------
6
26
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.14.0
1
+ 1.18.0
data/lib/aws-sdk-qldb.rb CHANGED
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-qldb/customizations'
48
48
  # @!group service
49
49
  module Aws::QLDB
50
50
 
51
- GEM_VERSION = '1.14.0'
51
+ GEM_VERSION = '1.18.0'
52
52
 
53
53
  end
@@ -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 unique ID that QLDB assigns to each QLDB journal stream.
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,11 +365,11 @@ 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 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
371
- # unique among all of your ledgers in the current AWS Region.
372
+ # unique among all of the ledgers in your account in the current Region.
372
373
  #
373
374
  # Naming constraints for ledger names are defined in [Quotas in Amazon
374
375
  # QLDB][1] in the *Amazon QLDB Developer Guide*.
@@ -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` permissions for this
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,73 @@ 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
- # permissions for the ledger.
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 using the QLDB API or the AWS Command Line
420
- # Interface (AWS CLI). You can disable it by calling the `UpdateLedger`
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`.
428
+ #
429
+ # @option params [String] :kms_key
430
+ # The key in Key Management Service (KMS) to use for encryption of data
431
+ # at rest in the ledger. For more information, see [Encryption at
432
+ # rest][1] in the *Amazon QLDB Developer Guide*.
433
+ #
434
+ # Use one of the following options to specify this parameter:
435
+ #
436
+ # * `AWS_OWNED_KMS_KEY`\: Use an KMS key that is owned and managed by
437
+ # Amazon Web Services on your behalf.
438
+ #
439
+ # * **Undefined**\: By default, use an Amazon Web Services owned KMS
440
+ # key.
441
+ #
442
+ # * **A valid symmetric customer managed KMS key**\: Use the specified
443
+ # KMS key in your account that you create, own, and manage.
444
+ #
445
+ # Amazon QLDB does not support asymmetric keys. For more information,
446
+ # see [Using symmetric and asymmetric keys][2] in the *Key Management
447
+ # Service Developer Guide*.
448
+ #
449
+ # To specify a customer managed KMS key, you can use its key ID, Amazon
450
+ # Resource Name (ARN), alias name, or alias ARN. When using an alias
451
+ # name, prefix it with `"alias/"`. To specify a key in a different
452
+ # account, you must use the key ARN or alias ARN.
453
+ #
454
+ # For example:
455
+ #
456
+ # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
457
+ #
458
+ # * Key ARN:
459
+ # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
460
+ #
461
+ # * Alias name: `alias/ExampleAlias`
462
+ #
463
+ # * Alias ARN: `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias`
464
+ #
465
+ # For more information, see [Key identifiers (KeyId)][3] in the *Key
466
+ # Management Service Developer Guide*.
467
+ #
468
+ #
469
+ #
470
+ # [1]: https://docs.aws.amazon.com/qldb/latest/developerguide/encryption-at-rest.html
471
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html
472
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id
423
473
  #
424
474
  # @return [Types::CreateLedgerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
425
475
  #
@@ -429,6 +479,7 @@ module Aws::QLDB
429
479
  # * {Types::CreateLedgerResponse#creation_date_time #creation_date_time} => Time
430
480
  # * {Types::CreateLedgerResponse#permissions_mode #permissions_mode} => String
431
481
  # * {Types::CreateLedgerResponse#deletion_protection #deletion_protection} => Boolean
482
+ # * {Types::CreateLedgerResponse#kms_key_arn #kms_key_arn} => String
432
483
  #
433
484
  # @example Request syntax with placeholder values
434
485
  #
@@ -439,6 +490,7 @@ module Aws::QLDB
439
490
  # },
440
491
  # permissions_mode: "ALLOW_ALL", # required, accepts ALLOW_ALL, STANDARD
441
492
  # deletion_protection: false,
493
+ # kms_key: "KmsKey",
442
494
  # })
443
495
  #
444
496
  # @example Response structure
@@ -449,6 +501,7 @@ module Aws::QLDB
449
501
  # resp.creation_date_time #=> Time
450
502
  # resp.permissions_mode #=> String, one of "ALLOW_ALL", "STANDARD"
451
503
  # resp.deletion_protection #=> Boolean
504
+ # resp.kms_key_arn #=> String
452
505
  #
453
506
  # @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/CreateLedger AWS API Documentation
454
507
  #
@@ -462,10 +515,8 @@ module Aws::QLDB
462
515
  # Deletes a ledger and all of its contents. This action is irreversible.
463
516
  #
464
517
  # If deletion protection is enabled, you must first disable it before
465
- # you can delete the ledger using the QLDB API or the AWS Command Line
466
- # Interface (AWS CLI). You can disable it by calling the `UpdateLedger`
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.
518
+ # you can delete the ledger. You can disable it by calling the
519
+ # `UpdateLedger` operation to set the flag to `false`.
469
520
  #
470
521
  # @option params [required, String] :name
471
522
  # The name of the ledger that you want to delete.
@@ -489,14 +540,23 @@ module Aws::QLDB
489
540
 
490
541
  # Returns detailed information about a given Amazon QLDB journal stream.
491
542
  # The output includes the Amazon Resource Name (ARN), stream name,
492
- # current status, creation time, and the parameters of your original
543
+ # current status, creation time, and the parameters of the original
493
544
  # stream creation request.
494
545
  #
546
+ # This action does not return any expired journal streams. For more
547
+ # information, see [Expiration for terminal streams][1] in the *Amazon
548
+ # QLDB Developer Guide*.
549
+ #
550
+ #
551
+ #
552
+ # [1]: https://docs.aws.amazon.com/qldb/latest/developerguide/streams.create.html#streams.create.states.expiration
553
+ #
495
554
  # @option params [required, String] :ledger_name
496
555
  # The name of the ledger.
497
556
  #
498
557
  # @option params [required, String] :stream_id
499
- # The unique ID that QLDB assigns to each QLDB journal stream.
558
+ # The UUID (represented in Base62-encoded text) of the QLDB journal
559
+ # stream to describe.
500
560
  #
501
561
  # @return [Types::DescribeJournalKinesisStreamResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
502
562
  #
@@ -534,11 +594,11 @@ module Aws::QLDB
534
594
  end
535
595
 
536
596
  # Returns information about a journal export job, including the ledger
537
- # name, export ID, when it was created, current status, and its start
538
- # and end time export parameters.
597
+ # name, export ID, creation time, current status, and the parameters of
598
+ # the original export creation request.
539
599
  #
540
600
  # This action does not return any expired export jobs. For more
541
- # information, see [Export Job Expiration][1] in the *Amazon QLDB
601
+ # information, see [Export job expiration][1] in the *Amazon QLDB
542
602
  # Developer Guide*.
543
603
  #
544
604
  # If the export job with the given `ExportId` doesn't exist, then
@@ -555,7 +615,8 @@ module Aws::QLDB
555
615
  # The name of the ledger.
556
616
  #
557
617
  # @option params [required, String] :export_id
558
- # The unique ID of the journal export job that you want to describe.
618
+ # The UUID (represented in Base62-encoded text) of the journal export
619
+ # job to describe.
559
620
  #
560
621
  # @return [Types::DescribeJournalS3ExportResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
561
622
  #
@@ -591,8 +652,8 @@ module Aws::QLDB
591
652
  req.send_request(options)
592
653
  end
593
654
 
594
- # Returns information about a ledger, including its state and when it
595
- # was created.
655
+ # Returns information about a ledger, including its state, permissions
656
+ # mode, encryption at rest settings, and when it was created.
596
657
  #
597
658
  # @option params [required, String] :name
598
659
  # The name of the ledger that you want to describe.
@@ -605,6 +666,7 @@ module Aws::QLDB
605
666
  # * {Types::DescribeLedgerResponse#creation_date_time #creation_date_time} => Time
606
667
  # * {Types::DescribeLedgerResponse#permissions_mode #permissions_mode} => String
607
668
  # * {Types::DescribeLedgerResponse#deletion_protection #deletion_protection} => Boolean
669
+ # * {Types::DescribeLedgerResponse#encryption_description #encryption_description} => Types::LedgerEncryptionDescription
608
670
  #
609
671
  # @example Request syntax with placeholder values
610
672
  #
@@ -620,6 +682,9 @@ module Aws::QLDB
620
682
  # resp.creation_date_time #=> Time
621
683
  # resp.permissions_mode #=> String, one of "ALLOW_ALL", "STANDARD"
622
684
  # resp.deletion_protection #=> Boolean
685
+ # resp.encryption_description.kms_key_arn #=> String
686
+ # resp.encryption_description.encryption_status #=> String, one of "ENABLED", "UPDATING", "KMS_KEY_INACCESSIBLE"
687
+ # resp.encryption_description.inaccessible_kms_key_date_time #=> Time
623
688
  #
624
689
  # @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/DescribeLedger AWS API Documentation
625
690
  #
@@ -648,12 +713,12 @@ module Aws::QLDB
648
713
  # The name of the ledger.
649
714
  #
650
715
  # @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
- # that you want to export.
716
+ # The inclusive start date and time for the range of journal contents to
717
+ # export.
653
718
  #
654
719
  # The `InclusiveStartTime` must be in `ISO 8601` date and time format
655
720
  # and in Universal Coordinated Time (UTC). For example:
656
- # `2019-06-13T21:36:34Z`
721
+ # `2019-06-13T21:36:34Z`.
657
722
  #
658
723
  # The `InclusiveStartTime` must be before `ExclusiveEndTime`.
659
724
  #
@@ -662,12 +727,12 @@ module Aws::QLDB
662
727
  # `CreationDateTime`.
663
728
  #
664
729
  # @option params [required, Time,DateTime,Date,Integer,String] :exclusive_end_time
665
- # The exclusive end date and time for the range of journal contents that
666
- # you want to export.
730
+ # The exclusive end date and time for the range of journal contents to
731
+ # export.
667
732
  #
668
733
  # The `ExclusiveEndTime` must be in `ISO 8601` date and time format and
669
734
  # in Universal Coordinated Time (UTC). For example:
670
- # `2019-06-13T21:36:34Z`
735
+ # `2019-06-13T21:36:34Z`.
671
736
  #
672
737
  # The `ExclusiveEndTime` must be less than or equal to the current UTC
673
738
  # date and time.
@@ -683,8 +748,8 @@ module Aws::QLDB
683
748
  # * Write objects into your Amazon Simple Storage Service (Amazon S3)
684
749
  # bucket.
685
750
  #
686
- # * (Optional) Use your customer master key (CMK) in AWS Key Management
687
- # Service (AWS KMS) for server-side encryption of your exported data.
751
+ # * (Optional) Use your customer master key (CMK) in Key Management
752
+ # Service (KMS) for server-side encryption of your exported data.
688
753
  #
689
754
  # @return [Types::ExportJournalToS3Response] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
690
755
  #
@@ -747,14 +812,14 @@ module Aws::QLDB
747
812
  # The location of the block that you want to request. An address is an
748
813
  # Amazon Ion structure that has two fields: `strandId` and `sequenceNo`.
749
814
  #
750
- # For example: `\{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14\}`
815
+ # For example: `\{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14\}`.
751
816
  #
752
817
  # @option params [Types::ValueHolder] :digest_tip_address
753
818
  # The latest block location covered by the digest for which to request a
754
819
  # proof. An address is an Amazon Ion structure that has two fields:
755
820
  # `strandId` and `sequenceNo`.
756
821
  #
757
- # For example: `\{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49\}`
822
+ # For example: `\{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49\}`.
758
823
  #
759
824
  # @return [Types::GetBlockResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
760
825
  #
@@ -831,17 +896,18 @@ module Aws::QLDB
831
896
  # is an Amazon Ion structure that has two fields: `strandId` and
832
897
  # `sequenceNo`.
833
898
  #
834
- # For example: `\{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14\}`
899
+ # For example: `\{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14\}`.
835
900
  #
836
901
  # @option params [required, String] :document_id
837
- # The unique ID of the document to be verified.
902
+ # The UUID (represented in Base62-encoded text) of the document to be
903
+ # verified.
838
904
  #
839
905
  # @option params [Types::ValueHolder] :digest_tip_address
840
906
  # The latest block location covered by the digest for which to request a
841
907
  # proof. An address is an Amazon Ion structure that has two fields:
842
908
  # `strandId` and `sequenceNo`.
843
909
  #
844
- # For example: `\{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49\}`
910
+ # For example: `\{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49\}`.
845
911
  #
846
912
  # @return [Types::GetRevisionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
847
913
  #
@@ -879,10 +945,18 @@ module Aws::QLDB
879
945
  # given ledger. The output of each stream descriptor includes the same
880
946
  # details that are returned by `DescribeJournalKinesisStream`.
881
947
  #
948
+ # This action does not return any expired journal streams. For more
949
+ # information, see [Expiration for terminal streams][1] in the *Amazon
950
+ # QLDB Developer Guide*.
951
+ #
882
952
  # This action returns a maximum of `MaxResults` items. It is paginated
883
953
  # so that you can retrieve all the items by calling
884
954
  # `ListJournalKinesisStreamsForLedger` multiple times.
885
955
  #
956
+ #
957
+ #
958
+ # [1]: https://docs.aws.amazon.com/qldb/latest/developerguide/streams.create.html#streams.create.states.expiration
959
+ #
886
960
  # @option params [required, String] :ledger_name
887
961
  # The name of the ledger.
888
962
  #
@@ -939,14 +1013,14 @@ module Aws::QLDB
939
1013
  end
940
1014
 
941
1015
  # Returns an array of journal export job descriptions for all ledgers
942
- # that are associated with the current AWS account and Region.
1016
+ # that are associated with the current account and Region.
943
1017
  #
944
1018
  # This action returns a maximum of `MaxResults` items, and is paginated
945
1019
  # so that you can retrieve all the items by calling
946
1020
  # `ListJournalS3Exports` multiple times.
947
1021
  #
948
1022
  # This action does not return any expired export jobs. For more
949
- # information, see [Export Job Expiration][1] in the *Amazon QLDB
1023
+ # information, see [Export job expiration][1] in the *Amazon QLDB
950
1024
  # Developer Guide*.
951
1025
  #
952
1026
  #
@@ -1011,7 +1085,7 @@ module Aws::QLDB
1011
1085
  # `ListJournalS3ExportsForLedger` multiple times.
1012
1086
  #
1013
1087
  # This action does not return any expired export jobs. For more
1014
- # information, see [Export Job Expiration][1] in the *Amazon QLDB
1088
+ # information, see [Export job expiration][1] in the *Amazon QLDB
1015
1089
  # Developer Guide*.
1016
1090
  #
1017
1091
  #
@@ -1073,7 +1147,7 @@ module Aws::QLDB
1073
1147
  end
1074
1148
 
1075
1149
  # Returns an array of ledger summaries that are associated with the
1076
- # current AWS account and Region.
1150
+ # current account and Region.
1077
1151
  #
1078
1152
  # This action returns a maximum of 100 items and is paginated so that
1079
1153
  # you can retrieve all the items by calling `ListLedgers` multiple
@@ -1123,8 +1197,8 @@ module Aws::QLDB
1123
1197
  # Returns all tags for a specified Amazon QLDB resource.
1124
1198
  #
1125
1199
  # @option params [required, String] :resource_arn
1126
- # The Amazon Resource Name (ARN) for which you want to list the tags.
1127
- # For example:
1200
+ # The Amazon Resource Name (ARN) for which to list the tags. For
1201
+ # example:
1128
1202
  #
1129
1203
  # `arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger`
1130
1204
  #
@@ -1174,7 +1248,7 @@ module Aws::QLDB
1174
1248
  # The inclusive start date and time from which to start streaming
1175
1249
  # journal data. This parameter must be in `ISO 8601` date and time
1176
1250
  # format and in Universal Coordinated Time (UTC). For example:
1177
- # `2019-06-13T21:36:34Z`
1251
+ # `2019-06-13T21:36:34Z`.
1178
1252
  #
1179
1253
  # The `InclusiveStartTime` cannot be in the future and must be before
1180
1254
  # `ExclusiveEndTime`.
@@ -1190,7 +1264,7 @@ module Aws::QLDB
1190
1264
  #
1191
1265
  # The `ExclusiveEndTime` must be in `ISO 8601` date and time format and
1192
1266
  # in Universal Coordinated Time (UTC). For example:
1193
- # `2019-06-13T21:36:34Z`
1267
+ # `2019-06-13T21:36:34Z`.
1194
1268
  #
1195
1269
  # @option params [required, Types::KinesisConfiguration] :kinesis_configuration
1196
1270
  # The configuration settings of the Kinesis Data Streams destination for
@@ -1285,13 +1359,13 @@ module Aws::QLDB
1285
1359
  # can specify up to 50 tag keys to remove.
1286
1360
  #
1287
1361
  # @option params [required, String] :resource_arn
1288
- # The Amazon Resource Name (ARN) from which you want to remove the tags.
1289
- # For example:
1362
+ # The Amazon Resource Name (ARN) from which to remove the tags. For
1363
+ # example:
1290
1364
  #
1291
1365
  # `arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger`
1292
1366
  #
1293
1367
  # @option params [required, Array<String>] :tag_keys
1294
- # The list of tag keys that you want to remove.
1368
+ # The list of tag keys to remove.
1295
1369
  #
1296
1370
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1297
1371
  #
@@ -1322,10 +1396,52 @@ module Aws::QLDB
1322
1396
  # default.
1323
1397
  #
1324
1398
  # If deletion protection is enabled, you must first disable it before
1325
- # you can delete the ledger using the QLDB API or the AWS Command Line
1326
- # Interface (AWS CLI). You can disable it by calling the `UpdateLedger`
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.
1399
+ # you can delete the ledger. You can disable it by calling the
1400
+ # `UpdateLedger` operation to set the flag to `false`.
1401
+ #
1402
+ # @option params [String] :kms_key
1403
+ # The key in Key Management Service (KMS) to use for encryption of data
1404
+ # at rest in the ledger. For more information, see [Encryption at
1405
+ # rest][1] in the *Amazon QLDB Developer Guide*.
1406
+ #
1407
+ # Use one of the following options to specify this parameter:
1408
+ #
1409
+ # * `AWS_OWNED_KMS_KEY`\: Use an KMS key that is owned and managed by
1410
+ # Amazon Web Services on your behalf.
1411
+ #
1412
+ # * **Undefined**\: Make no changes to the KMS key of the ledger.
1413
+ #
1414
+ # * **A valid symmetric customer managed KMS key**\: Use the specified
1415
+ # KMS key in your account that you create, own, and manage.
1416
+ #
1417
+ # Amazon QLDB does not support asymmetric keys. For more information,
1418
+ # see [Using symmetric and asymmetric keys][2] in the *Key Management
1419
+ # Service Developer Guide*.
1420
+ #
1421
+ # To specify a customer managed KMS key, you can use its key ID, Amazon
1422
+ # Resource Name (ARN), alias name, or alias ARN. When using an alias
1423
+ # name, prefix it with `"alias/"`. To specify a key in a different
1424
+ # account, you must use the key ARN or alias ARN.
1425
+ #
1426
+ # For example:
1427
+ #
1428
+ # * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
1429
+ #
1430
+ # * Key ARN:
1431
+ # `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
1432
+ #
1433
+ # * Alias name: `alias/ExampleAlias`
1434
+ #
1435
+ # * Alias ARN: `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias`
1436
+ #
1437
+ # For more information, see [Key identifiers (KeyId)][3] in the *Key
1438
+ # Management Service Developer Guide*.
1439
+ #
1440
+ #
1441
+ #
1442
+ # [1]: https://docs.aws.amazon.com/qldb/latest/developerguide/encryption-at-rest.html
1443
+ # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html
1444
+ # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id
1329
1445
  #
1330
1446
  # @return [Types::UpdateLedgerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1331
1447
  #
@@ -1334,12 +1450,14 @@ module Aws::QLDB
1334
1450
  # * {Types::UpdateLedgerResponse#state #state} => String
1335
1451
  # * {Types::UpdateLedgerResponse#creation_date_time #creation_date_time} => Time
1336
1452
  # * {Types::UpdateLedgerResponse#deletion_protection #deletion_protection} => Boolean
1453
+ # * {Types::UpdateLedgerResponse#encryption_description #encryption_description} => Types::LedgerEncryptionDescription
1337
1454
  #
1338
1455
  # @example Request syntax with placeholder values
1339
1456
  #
1340
1457
  # resp = client.update_ledger({
1341
1458
  # name: "LedgerName", # required
1342
1459
  # deletion_protection: false,
1460
+ # kms_key: "KmsKey",
1343
1461
  # })
1344
1462
  #
1345
1463
  # @example Response structure
@@ -1349,6 +1467,9 @@ module Aws::QLDB
1349
1467
  # resp.state #=> String, one of "CREATING", "ACTIVE", "DELETING", "DELETED"
1350
1468
  # resp.creation_date_time #=> Time
1351
1469
  # resp.deletion_protection #=> Boolean
1470
+ # resp.encryption_description.kms_key_arn #=> String
1471
+ # resp.encryption_description.encryption_status #=> String, one of "ENABLED", "UPDATING", "KMS_KEY_INACCESSIBLE"
1472
+ # resp.encryption_description.inaccessible_kms_key_date_time #=> Time
1352
1473
  #
1353
1474
  # @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/UpdateLedger AWS API Documentation
1354
1475
  #
@@ -1361,6 +1482,15 @@ module Aws::QLDB
1361
1482
 
1362
1483
  # Updates the permissions mode of a ledger.
1363
1484
  #
1485
+ # Before you switch to the `STANDARD` permissions mode, you must first
1486
+ # create all required IAM policies and table tags to avoid disruption to
1487
+ # your users. To learn more, see [Migrating to the standard permissions
1488
+ # mode][1] in the *Amazon QLDB Developer Guide*.
1489
+ #
1490
+ #
1491
+ #
1492
+ # [1]: https://docs.aws.amazon.com/qldb/latest/developerguide/ledger-management.basics.html#ledger-mgmt.basics.update-permissions.migrating
1493
+ #
1364
1494
  # @option params [required, String] :name
1365
1495
  # The name of the ledger.
1366
1496
  #
@@ -1371,8 +1501,8 @@ module Aws::QLDB
1371
1501
  # * `ALLOW_ALL`\: A legacy permissions mode that enables access control
1372
1502
  # with API-level granularity for ledgers.
1373
1503
  #
1374
- # This mode allows users who have `SendCommand` permissions for this
1375
- # ledger to run all PartiQL commands (hence, `ALLOW_ALL`) on any
1504
+ # This mode allows users who have the `SendCommand` API permission for
1505
+ # this ledger to run all PartiQL commands (hence, `ALLOW_ALL`) on any
1376
1506
  # tables in the specified ledger. This mode disregards any table-level
1377
1507
  # or command-level IAM permissions policies that you create for the
1378
1508
  # ledger.
@@ -1384,14 +1514,20 @@ module Aws::QLDB
1384
1514
  # By default, this mode denies all user requests to run any PartiQL
1385
1515
  # commands on any tables in this ledger. To allow PartiQL commands to
1386
1516
  # run, you must create IAM permissions policies for specific table
1387
- # resources and PartiQL actions, in addition to `SendCommand` API
1388
- # permissions for the ledger.
1517
+ # resources and PartiQL actions, in addition to the `SendCommand` API
1518
+ # permission for the ledger. For information, see [Getting started
1519
+ # with the standard permissions mode][1] in the *Amazon QLDB Developer
1520
+ # Guide*.
1389
1521
  #
1390
1522
  # <note markdown="1"> We strongly recommend using the `STANDARD` permissions mode to
1391
1523
  # maximize the security of your ledger data.
1392
1524
  #
1393
1525
  # </note>
1394
1526
  #
1527
+ #
1528
+ #
1529
+ # [1]: https://docs.aws.amazon.com/qldb/latest/developerguide/getting-started-standard-mode.html
1530
+ #
1395
1531
  # @return [Types::UpdateLedgerPermissionsModeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1396
1532
  #
1397
1533
  # * {Types::UpdateLedgerPermissionsModeResponse#name #name} => String
@@ -1433,7 +1569,7 @@ module Aws::QLDB
1433
1569
  params: params,
1434
1570
  config: config)
1435
1571
  context[:gem_name] = 'aws-sdk-qldb'
1436
- context[:gem_version] = '1.14.0'
1572
+ context[:gem_version] = '1.18.0'
1437
1573
  Seahorse::Client::Request.new(handlers, context)
1438
1574
  end
1439
1575