aws-sdk-qldb 1.27.0 → 1.28.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: 806e1753ba4f85a010986de1bb7d00737a41c02880e11e35c58bb1511f289361
4
- data.tar.gz: 3442d0122819543b94325ce83d6c12314cc31d8c756491709f643621ec42265c
3
+ metadata.gz: 716b8b252d3712e62db9449e60267841abd7c0fa9f2099fa6fb46f135795bc64
4
+ data.tar.gz: 7055a7572ecd86e8a2e2851170df9b5f798a786fa93a400035a892a9a76ea223
5
5
  SHA512:
6
- metadata.gz: 1811a6020f8caabac6af743d2b46bb821803f88111550382a1da343521b00710398a6b7e007225048450b4b67f31ab1dd33df2f3dcc216251072722d9b31ec71
7
- data.tar.gz: dda6421fb94aac48eaf06906563d5781f4322ed9202e9c023d1a7981ba872032600fbc5bbd1240a4d3d61d1b8335a240e4847697815eb175364a3c8109770549
6
+ metadata.gz: 6d75732f5b5d4a28f711789f29dc048832678a82cbcb53bb12d4ae905d5b1cddee178c03c77553778528523e64980cf18209a1d65e4bd9df1559d9165273fb2c
7
+ data.tar.gz: 970469b879be4654575805d306424d95a46f7ff321d059cd44e3991a83301e73047ed692a26c461c644ed6565db63e78cae1a875c6a21e510aee55c9aecaa853
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.28.0 (2023-04-27)
5
+ ------------------
6
+
7
+ * Feature - Documentation updates for Amazon QLDB
8
+
4
9
  1.27.0 (2023-01-18)
5
10
  ------------------
6
11
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.27.0
1
+ 1.28.0
@@ -430,7 +430,7 @@ module Aws::QLDB
430
430
  # The permissions mode to assign to the ledger that you want to create.
431
431
  # This parameter can have one of the following values:
432
432
  #
433
- # * `ALLOW_ALL`\: A legacy permissions mode that enables access control
433
+ # * `ALLOW_ALL`: A legacy permissions mode that enables access control
434
434
  # with API-level granularity for ledgers.
435
435
  #
436
436
  # This mode allows users who have the `SendCommand` API permission for
@@ -439,7 +439,7 @@ module Aws::QLDB
439
439
  # or command-level IAM permissions policies that you create for the
440
440
  # ledger.
441
441
  #
442
- # * `STANDARD`\: (*Recommended*) A permissions mode that enables access
442
+ # * `STANDARD`: (*Recommended*) A permissions mode that enables access
443
443
  # control with finer granularity for ledgers, tables, and PartiQL
444
444
  # commands.
445
445
  #
@@ -461,13 +461,13 @@ module Aws::QLDB
461
461
  # [1]: https://docs.aws.amazon.com/qldb/latest/developerguide/getting-started-standard-mode.html
462
462
  #
463
463
  # @option params [Boolean] :deletion_protection
464
- # The flag that prevents a ledger from being deleted by any user. If not
465
- # provided on ledger creation, this feature is enabled (`true`) by
466
- # default.
464
+ # Specifies whether the ledger is protected from being deleted by any
465
+ # user. If not defined during ledger creation, this feature is enabled
466
+ # (`true`) by default.
467
467
  #
468
468
  # If deletion protection is enabled, you must first disable it before
469
469
  # you can delete the ledger. You can disable it by calling the
470
- # `UpdateLedger` operation to set the flag to `false`.
470
+ # `UpdateLedger` operation to set this parameter to `false`.
471
471
  #
472
472
  # @option params [String] :kms_key
473
473
  # The key in Key Management Service (KMS) to use for encryption of data
@@ -476,14 +476,14 @@ module Aws::QLDB
476
476
  #
477
477
  # Use one of the following options to specify this parameter:
478
478
  #
479
- # * `AWS_OWNED_KMS_KEY`\: Use an KMS key that is owned and managed by
479
+ # * `AWS_OWNED_KMS_KEY`: Use an KMS key that is owned and managed by
480
480
  # Amazon Web Services on your behalf.
481
481
  #
482
- # * **Undefined**\: By default, use an Amazon Web Services owned KMS
483
- # key.
482
+ # * **Undefined**: By default, use an Amazon Web Services owned KMS key.
484
483
  #
485
- # * **A valid symmetric customer managed KMS key**\: Use the specified
486
- # KMS key in your account that you create, own, and manage.
484
+ # * **A valid symmetric customer managed KMS key**: Use the specified
485
+ # symmetric encryption KMS key in your account that you create, own,
486
+ # and manage.
487
487
  #
488
488
  # Amazon QLDB does not support asymmetric keys. For more information,
489
489
  # see [Using symmetric and asymmetric keys][2] in the *Key Management
@@ -559,7 +559,7 @@ module Aws::QLDB
559
559
  #
560
560
  # If deletion protection is enabled, you must first disable it before
561
561
  # you can delete the ledger. You can disable it by calling the
562
- # `UpdateLedger` operation to set the flag to `false`.
562
+ # `UpdateLedger` operation to set this parameter to `false`.
563
563
  #
564
564
  # @option params [required, String] :name
565
565
  # The name of the ledger that you want to delete.
@@ -745,13 +745,6 @@ module Aws::QLDB
745
745
  # binary representation of Amazon Ion format, or in *JSON Lines* text
746
746
  # format.
747
747
  #
748
- # In JSON Lines format, each journal block in the exported data object
749
- # is a valid JSON object that is delimited by a newline. You can use
750
- # this format to easily integrate JSON exports with analytics tools such
751
- # as Glue and Amazon Athena because these services can parse
752
- # newline-delimited JSON automatically. For more information about the
753
- # format, see [JSON Lines][1].
754
- #
755
748
  # If the ledger with the given `Name` doesn't exist, then throws
756
749
  # `ResourceNotFoundException`.
757
750
  #
@@ -762,10 +755,6 @@ module Aws::QLDB
762
755
  # ledger. Beyond this limit, journal export requests throw
763
756
  # `LimitExceededException`.
764
757
  #
765
- #
766
- #
767
- # [1]: https://jsonlines.org/
768
- #
769
758
  # @option params [required, String] :name
770
759
  # The name of the ledger.
771
760
  #
@@ -802,8 +791,7 @@ module Aws::QLDB
802
791
  # The Amazon Resource Name (ARN) of the IAM role that grants QLDB
803
792
  # permissions for a journal export job to do the following:
804
793
  #
805
- # * Write objects into your Amazon Simple Storage Service (Amazon S3)
806
- # bucket.
794
+ # * Write objects into your Amazon S3 bucket.
807
795
  #
808
796
  # * (Optional) Use your customer managed key in Key Management Service
809
797
  # (KMS) for server-side encryption of your exported data.
@@ -813,8 +801,22 @@ module Aws::QLDB
813
801
  # resource. This is required for all journal export requests.
814
802
  #
815
803
  # @option params [String] :output_format
816
- # The output format of your exported journal data. If this parameter is
817
- # not specified, the exported data defaults to `ION_TEXT` format.
804
+ # The output format of your exported journal data. A journal export job
805
+ # can write the data objects in either the text or binary representation
806
+ # of [Amazon Ion][1] format, or in [JSON Lines][2] text format.
807
+ #
808
+ # Default: `ION_TEXT`
809
+ #
810
+ # In JSON Lines format, each journal block in an exported data object is
811
+ # a valid JSON object that is delimited by a newline. You can use this
812
+ # format to directly integrate JSON exports with analytics tools such as
813
+ # Amazon Athena and Glue because these services can parse
814
+ # newline-delimited JSON automatically.
815
+ #
816
+ #
817
+ #
818
+ # [1]: https://docs.aws.amazon.com/qldb/latest/developerguide/ion.html
819
+ # [2]: https://jsonlines.org/
818
820
  #
819
821
  # @return [Types::ExportJournalToS3Response] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
820
822
  #
@@ -1007,9 +1009,7 @@ module Aws::QLDB
1007
1009
  req.send_request(options)
1008
1010
  end
1009
1011
 
1010
- # Returns an array of all Amazon QLDB journal stream descriptors for a
1011
- # given ledger. The output of each stream descriptor includes the same
1012
- # details that are returned by `DescribeJournalKinesisStream`.
1012
+ # Returns all Amazon QLDB journal streams for a given ledger.
1013
1013
  #
1014
1014
  # This action does not return any expired journal streams. For more
1015
1015
  # information, see [Expiration for terminal streams][1] in the *Amazon
@@ -1078,9 +1078,8 @@ module Aws::QLDB
1078
1078
  req.send_request(options)
1079
1079
  end
1080
1080
 
1081
- # Returns an array of journal export job descriptions for all ledgers
1082
- # that are associated with the current Amazon Web Services account and
1083
- # Region.
1081
+ # Returns all journal export jobs for all ledgers that are associated
1082
+ # with the current Amazon Web Services account and Region.
1084
1083
  #
1085
1084
  # This action returns a maximum of `MaxResults` items, and is paginated
1086
1085
  # so that you can retrieve all the items by calling
@@ -1145,8 +1144,7 @@ module Aws::QLDB
1145
1144
  req.send_request(options)
1146
1145
  end
1147
1146
 
1148
- # Returns an array of journal export job descriptions for a specified
1149
- # ledger.
1147
+ # Returns all journal export jobs for a specified ledger.
1150
1148
  #
1151
1149
  # This action returns a maximum of `MaxResults` items, and is paginated
1152
1150
  # so that you can retrieve all the items by calling
@@ -1215,12 +1213,12 @@ module Aws::QLDB
1215
1213
  req.send_request(options)
1216
1214
  end
1217
1215
 
1218
- # Returns an array of ledger summaries that are associated with the
1219
- # current Amazon Web Services account and Region.
1216
+ # Returns all ledgers that are associated with the current Amazon Web
1217
+ # Services account and Region.
1220
1218
  #
1221
- # This action returns a maximum of 100 items and is paginated so that
1222
- # you can retrieve all the items by calling `ListLedgers` multiple
1223
- # times.
1219
+ # This action returns a maximum of `MaxResults` items and is paginated
1220
+ # so that you can retrieve all the items by calling `ListLedgers`
1221
+ # multiple times.
1224
1222
  #
1225
1223
  # @option params [Integer] :max_results
1226
1224
  # The maximum number of results to return in a single `ListLedgers`
@@ -1464,13 +1462,13 @@ module Aws::QLDB
1464
1462
  # The name of the ledger.
1465
1463
  #
1466
1464
  # @option params [Boolean] :deletion_protection
1467
- # The flag that prevents a ledger from being deleted by any user. If not
1468
- # provided on ledger creation, this feature is enabled (`true`) by
1469
- # default.
1465
+ # Specifies whether the ledger is protected from being deleted by any
1466
+ # user. If not defined during ledger creation, this feature is enabled
1467
+ # (`true`) by default.
1470
1468
  #
1471
1469
  # If deletion protection is enabled, you must first disable it before
1472
1470
  # you can delete the ledger. You can disable it by calling the
1473
- # `UpdateLedger` operation to set the flag to `false`.
1471
+ # `UpdateLedger` operation to set this parameter to `false`.
1474
1472
  #
1475
1473
  # @option params [String] :kms_key
1476
1474
  # The key in Key Management Service (KMS) to use for encryption of data
@@ -1479,13 +1477,14 @@ module Aws::QLDB
1479
1477
  #
1480
1478
  # Use one of the following options to specify this parameter:
1481
1479
  #
1482
- # * `AWS_OWNED_KMS_KEY`\: Use an KMS key that is owned and managed by
1480
+ # * `AWS_OWNED_KMS_KEY`: Use an KMS key that is owned and managed by
1483
1481
  # Amazon Web Services on your behalf.
1484
1482
  #
1485
- # * **Undefined**\: Make no changes to the KMS key of the ledger.
1483
+ # * **Undefined**: Make no changes to the KMS key of the ledger.
1486
1484
  #
1487
- # * **A valid symmetric customer managed KMS key**\: Use the specified
1488
- # KMS key in your account that you create, own, and manage.
1485
+ # * **A valid symmetric customer managed KMS key**: Use the specified
1486
+ # symmetric encryption KMS key in your account that you create, own,
1487
+ # and manage.
1489
1488
  #
1490
1489
  # Amazon QLDB does not support asymmetric keys. For more information,
1491
1490
  # see [Using symmetric and asymmetric keys][2] in the *Key Management
@@ -1571,7 +1570,7 @@ module Aws::QLDB
1571
1570
  # The permissions mode to assign to the ledger. This parameter can have
1572
1571
  # one of the following values:
1573
1572
  #
1574
- # * `ALLOW_ALL`\: A legacy permissions mode that enables access control
1573
+ # * `ALLOW_ALL`: A legacy permissions mode that enables access control
1575
1574
  # with API-level granularity for ledgers.
1576
1575
  #
1577
1576
  # This mode allows users who have the `SendCommand` API permission for
@@ -1580,7 +1579,7 @@ module Aws::QLDB
1580
1579
  # or command-level IAM permissions policies that you create for the
1581
1580
  # ledger.
1582
1581
  #
1583
- # * `STANDARD`\: (*Recommended*) A permissions mode that enables access
1582
+ # * `STANDARD`: (*Recommended*) A permissions mode that enables access
1584
1583
  # control with finer granularity for ledgers, tables, and PartiQL
1585
1584
  # commands.
1586
1585
  #
@@ -1642,7 +1641,7 @@ module Aws::QLDB
1642
1641
  params: params,
1643
1642
  config: config)
1644
1643
  context[:gem_name] = 'aws-sdk-qldb'
1645
- context[:gem_version] = '1.27.0'
1644
+ context[:gem_version] = '1.28.0'
1646
1645
  Seahorse::Client::Request.new(handlers, context)
1647
1646
  end
1648
1647
 
@@ -14,36 +14,39 @@ module Aws::QLDB
14
14
  use_dual_stack = parameters.use_dual_stack
15
15
  use_fips = parameters.use_fips
16
16
  endpoint = parameters.endpoint
17
- if (partition_result = Aws::Endpoints::Matchers.aws_partition(region))
18
- if Aws::Endpoints::Matchers.set?(endpoint) && (url = Aws::Endpoints::Matchers.parse_url(endpoint))
19
- if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true)
20
- raise ArgumentError, "Invalid Configuration: FIPS and custom endpoint are not supported"
21
- end
22
- if Aws::Endpoints::Matchers.boolean_equals?(use_dual_stack, true)
23
- raise ArgumentError, "Invalid Configuration: Dualstack and custom endpoint are not supported"
24
- end
25
- return Aws::Endpoints::Endpoint.new(url: endpoint, headers: {}, properties: {})
26
- end
27
- if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true) && Aws::Endpoints::Matchers.boolean_equals?(use_dual_stack, true)
28
- if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS")) && Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsDualStack"))
29
- return Aws::Endpoints::Endpoint.new(url: "https://qldb-fips.#{region}.#{partition_result['dualStackDnsSuffix']}", headers: {}, properties: {})
30
- end
31
- raise ArgumentError, "FIPS and DualStack are enabled, but this partition does not support one or both"
32
- end
17
+ if Aws::Endpoints::Matchers.set?(endpoint)
33
18
  if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true)
34
- if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS"))
35
- return Aws::Endpoints::Endpoint.new(url: "https://qldb-fips.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
36
- end
37
- raise ArgumentError, "FIPS is enabled but this partition does not support FIPS"
19
+ raise ArgumentError, "Invalid Configuration: FIPS and custom endpoint are not supported"
38
20
  end
39
21
  if Aws::Endpoints::Matchers.boolean_equals?(use_dual_stack, true)
40
- if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsDualStack"))
41
- return Aws::Endpoints::Endpoint.new(url: "https://qldb.#{region}.#{partition_result['dualStackDnsSuffix']}", headers: {}, properties: {})
22
+ raise ArgumentError, "Invalid Configuration: Dualstack and custom endpoint are not supported"
23
+ end
24
+ return Aws::Endpoints::Endpoint.new(url: endpoint, headers: {}, properties: {})
25
+ end
26
+ if Aws::Endpoints::Matchers.set?(region)
27
+ if (partition_result = Aws::Endpoints::Matchers.aws_partition(region))
28
+ if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true) && Aws::Endpoints::Matchers.boolean_equals?(use_dual_stack, true)
29
+ if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS")) && Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsDualStack"))
30
+ return Aws::Endpoints::Endpoint.new(url: "https://qldb-fips.#{region}.#{partition_result['dualStackDnsSuffix']}", headers: {}, properties: {})
31
+ end
32
+ raise ArgumentError, "FIPS and DualStack are enabled, but this partition does not support one or both"
33
+ end
34
+ if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true)
35
+ if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS"))
36
+ return Aws::Endpoints::Endpoint.new(url: "https://qldb-fips.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
37
+ end
38
+ raise ArgumentError, "FIPS is enabled but this partition does not support FIPS"
39
+ end
40
+ if Aws::Endpoints::Matchers.boolean_equals?(use_dual_stack, true)
41
+ if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsDualStack"))
42
+ return Aws::Endpoints::Endpoint.new(url: "https://qldb.#{region}.#{partition_result['dualStackDnsSuffix']}", headers: {}, properties: {})
43
+ end
44
+ raise ArgumentError, "DualStack is enabled but this partition does not support DualStack"
42
45
  end
43
- raise ArgumentError, "DualStack is enabled but this partition does not support DualStack"
46
+ return Aws::Endpoints::Endpoint.new(url: "https://qldb.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
44
47
  end
45
- return Aws::Endpoints::Endpoint.new(url: "https://qldb.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
46
48
  end
49
+ raise ArgumentError, "Invalid Configuration: Missing Region"
47
50
  raise ArgumentError, 'No endpoint could be resolved'
48
51
 
49
52
  end
@@ -63,8 +63,8 @@ module Aws::QLDB
63
63
  # The permissions mode to assign to the ledger that you want to
64
64
  # create. This parameter can have one of the following values:
65
65
  #
66
- # * `ALLOW_ALL`\: A legacy permissions mode that enables access
67
- # control with API-level granularity for ledgers.
66
+ # * `ALLOW_ALL`: A legacy permissions mode that enables access control
67
+ # with API-level granularity for ledgers.
68
68
  #
69
69
  # This mode allows users who have the `SendCommand` API permission
70
70
  # for this ledger to run all PartiQL commands (hence, `ALLOW_ALL`)
@@ -72,9 +72,9 @@ module Aws::QLDB
72
72
  # table-level or command-level IAM permissions policies that you
73
73
  # create for the ledger.
74
74
  #
75
- # * `STANDARD`\: (*Recommended*) A permissions mode that enables
76
- # access control with finer granularity for ledgers, tables, and
77
- # PartiQL commands.
75
+ # * `STANDARD`: (*Recommended*) A permissions mode that enables access
76
+ # control with finer granularity for ledgers, tables, and PartiQL
77
+ # commands.
78
78
  #
79
79
  # By default, this mode denies all user requests to run any PartiQL
80
80
  # commands on any tables in this ledger. To allow PartiQL commands
@@ -95,13 +95,13 @@ module Aws::QLDB
95
95
  # @return [String]
96
96
  #
97
97
  # @!attribute [rw] deletion_protection
98
- # The flag that prevents a ledger from being deleted by any user. If
99
- # not provided on ledger creation, this feature is enabled (`true`) by
100
- # default.
98
+ # Specifies whether the ledger is protected from being deleted by any
99
+ # user. If not defined during ledger creation, this feature is enabled
100
+ # (`true`) by default.
101
101
  #
102
102
  # If deletion protection is enabled, you must first disable it before
103
103
  # you can delete the ledger. You can disable it by calling the
104
- # `UpdateLedger` operation to set the flag to `false`.
104
+ # `UpdateLedger` operation to set this parameter to `false`.
105
105
  # @return [Boolean]
106
106
  #
107
107
  # @!attribute [rw] kms_key
@@ -111,14 +111,15 @@ module Aws::QLDB
111
111
  #
112
112
  # Use one of the following options to specify this parameter:
113
113
  #
114
- # * `AWS_OWNED_KMS_KEY`\: Use an KMS key that is owned and managed by
114
+ # * `AWS_OWNED_KMS_KEY`: Use an KMS key that is owned and managed by
115
115
  # Amazon Web Services on your behalf.
116
116
  #
117
- # * **Undefined**\: By default, use an Amazon Web Services owned KMS
117
+ # * **Undefined**: By default, use an Amazon Web Services owned KMS
118
118
  # key.
119
119
  #
120
- # * **A valid symmetric customer managed KMS key**\: Use the specified
121
- # KMS key in your account that you create, own, and manage.
120
+ # * **A valid symmetric customer managed KMS key**: Use the specified
121
+ # symmetric encryption KMS key in your account that you create, own,
122
+ # and manage.
122
123
  #
123
124
  # Amazon QLDB does not support asymmetric keys. For more
124
125
  # information, see [Using symmetric and asymmetric keys][2] in the
@@ -186,13 +187,13 @@ module Aws::QLDB
186
187
  # @return [String]
187
188
  #
188
189
  # @!attribute [rw] deletion_protection
189
- # The flag that prevents a ledger from being deleted by any user. If
190
- # not provided on ledger creation, this feature is enabled (`true`) by
191
- # default.
190
+ # Specifies whether the ledger is protected from being deleted by any
191
+ # user. If not defined during ledger creation, this feature is enabled
192
+ # (`true`) by default.
192
193
  #
193
194
  # If deletion protection is enabled, you must first disable it before
194
195
  # you can delete the ledger. You can disable it by calling the
195
- # `UpdateLedger` operation to set the flag to `false`.
196
+ # `UpdateLedger` operation to set this parameter to `false`.
196
197
  # @return [Boolean]
197
198
  #
198
199
  # @!attribute [rw] kms_key_arn
@@ -324,13 +325,13 @@ module Aws::QLDB
324
325
  # @return [String]
325
326
  #
326
327
  # @!attribute [rw] deletion_protection
327
- # The flag that prevents a ledger from being deleted by any user. If
328
- # not provided on ledger creation, this feature is enabled (`true`) by
329
- # default.
328
+ # Specifies whether the ledger is protected from being deleted by any
329
+ # user. If not defined during ledger creation, this feature is enabled
330
+ # (`true`) by default.
330
331
  #
331
332
  # If deletion protection is enabled, you must first disable it before
332
333
  # you can delete the ledger. You can disable it by calling the
333
- # `UpdateLedger` operation to set the flag to `false`.
334
+ # `UpdateLedger` operation to set this parameter to `false`.
334
335
  # @return [Boolean]
335
336
  #
336
337
  # @!attribute [rw] encryption_description
@@ -393,8 +394,7 @@ module Aws::QLDB
393
394
  # The Amazon Resource Name (ARN) of the IAM role that grants QLDB
394
395
  # permissions for a journal export job to do the following:
395
396
  #
396
- # * Write objects into your Amazon Simple Storage Service (Amazon S3)
397
- # bucket.
397
+ # * Write objects into your Amazon S3 bucket.
398
398
  #
399
399
  # * (Optional) Use your customer managed key in Key Management Service
400
400
  # (KMS) for server-side encryption of your exported data.
@@ -405,8 +405,23 @@ module Aws::QLDB
405
405
  # @return [String]
406
406
  #
407
407
  # @!attribute [rw] output_format
408
- # The output format of your exported journal data. If this parameter
409
- # is not specified, the exported data defaults to `ION_TEXT` format.
408
+ # The output format of your exported journal data. A journal export
409
+ # job can write the data objects in either the text or binary
410
+ # representation of [Amazon Ion][1] format, or in [JSON Lines][2] text
411
+ # format.
412
+ #
413
+ # Default: `ION_TEXT`
414
+ #
415
+ # In JSON Lines format, each journal block in an exported data object
416
+ # is a valid JSON object that is delimited by a newline. You can use
417
+ # this format to directly integrate JSON exports with analytics tools
418
+ # such as Amazon Athena and Glue because these services can parse
419
+ # newline-delimited JSON automatically.
420
+ #
421
+ #
422
+ #
423
+ # [1]: https://docs.aws.amazon.com/qldb/latest/developerguide/ion.html
424
+ # [2]: https://jsonlines.org/
410
425
  # @return [String]
411
426
  #
412
427
  # @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/ExportJournalToS3Request AWS API Documentation
@@ -752,11 +767,12 @@ module Aws::QLDB
752
767
  # Data Streams record, increasing the number of records sent per API
753
768
  # call.
754
769
  #
755
- # *This option is enabled by default.* Record aggregation has
756
- # important implications for processing records and requires
757
- # de-aggregation in your stream consumer. To learn more, see [KPL Key
758
- # Concepts][1] and [Consumer De-aggregation][2] in the *Amazon Kinesis
759
- # Data Streams Developer Guide*.
770
+ # Default: `True`
771
+ #
772
+ # Record aggregation has important implications for processing records
773
+ # and requires de-aggregation in your stream consumer. To learn more,
774
+ # see [KPL Key Concepts][1] and [Consumer De-aggregation][2] in the
775
+ # *Amazon Kinesis Data Streams Developer Guide*.
760
776
  #
761
777
  #
762
778
  #
@@ -796,9 +812,9 @@ module Aws::QLDB
796
812
  # The current state of encryption at rest for the ledger. This can be
797
813
  # one of the following values:
798
814
  #
799
- # * `ENABLED`\: Encryption is fully enabled using the specified key.
815
+ # * `ENABLED`: Encryption is fully enabled using the specified key.
800
816
  #
801
- # * `UPDATING`\: The ledger is actively processing the specified key
817
+ # * `UPDATING`: The ledger is actively processing the specified key
802
818
  # change.
803
819
  #
804
820
  # Key changes in QLDB are asynchronous. The ledger is fully
@@ -806,7 +822,7 @@ module Aws::QLDB
806
822
  # being processed. The amount of time it takes to update a key
807
823
  # varies depending on the ledger size.
808
824
  #
809
- # * `KMS_KEY_INACCESSIBLE`\: The specified customer managed KMS key is
825
+ # * `KMS_KEY_INACCESSIBLE`: The specified customer managed KMS key is
810
826
  # not accessible, and the ledger is impaired. Either the key was
811
827
  # disabled or deleted, or the grants on the key were revoked. When a
812
828
  # ledger is impaired, it is not accessible and does not accept any
@@ -912,8 +928,8 @@ module Aws::QLDB
912
928
  end
913
929
 
914
930
  # @!attribute [rw] streams
915
- # The array of QLDB journal stream descriptors that are associated
916
- # with the given ledger.
931
+ # The QLDB journal streams that are currently associated with the
932
+ # given ledger.
917
933
  # @return [Array<Types::JournalKinesisStreamDescription>]
918
934
  #
919
935
  # @!attribute [rw] next_token
@@ -962,8 +978,8 @@ module Aws::QLDB
962
978
  end
963
979
 
964
980
  # @!attribute [rw] journal_s3_exports
965
- # The array of journal export job descriptions that are associated
966
- # with the specified ledger.
981
+ # The journal export jobs that are currently associated with the
982
+ # specified ledger.
967
983
  # @return [Array<Types::JournalS3ExportDescription>]
968
984
  #
969
985
  # @!attribute [rw] next_token
@@ -1007,9 +1023,8 @@ module Aws::QLDB
1007
1023
  end
1008
1024
 
1009
1025
  # @!attribute [rw] journal_s3_exports
1010
- # The array of journal export job descriptions for all ledgers that
1011
- # are associated with the current Amazon Web Services account and
1012
- # Region.
1026
+ # The journal export jobs for all ledgers that are associated with the
1027
+ # current Amazon Web Services account and Region.
1013
1028
  # @return [Array<Types::JournalS3ExportDescription>]
1014
1029
  #
1015
1030
  # @!attribute [rw] next_token
@@ -1052,8 +1067,8 @@ module Aws::QLDB
1052
1067
  end
1053
1068
 
1054
1069
  # @!attribute [rw] ledgers
1055
- # The array of ledger summaries that are associated with the current
1056
- # Amazon Web Services account and Region.
1070
+ # The ledgers that are associated with the current Amazon Web Services
1071
+ # account and Region.
1057
1072
  # @return [Array<Types::LedgerSummary>]
1058
1073
  #
1059
1074
  # @!attribute [rw] next_token
@@ -1213,8 +1228,9 @@ module Aws::QLDB
1213
1228
  # @return [String]
1214
1229
  #
1215
1230
  # @!attribute [rw] kms_key_arn
1216
- # The Amazon Resource Name (ARN) of a symmetric key in Key Management
1217
- # Service (KMS). Amazon S3 does not support asymmetric KMS keys.
1231
+ # The Amazon Resource Name (ARN) of a symmetric encryption key in Key
1232
+ # Management Service (KMS). Amazon S3 does not support asymmetric KMS
1233
+ # keys.
1218
1234
  #
1219
1235
  # You must provide a `KmsKeyArn` if you specify `SSE_KMS` as the
1220
1236
  # `ObjectEncryptionType`.
@@ -1434,8 +1450,8 @@ module Aws::QLDB
1434
1450
  # The permissions mode to assign to the ledger. This parameter can
1435
1451
  # have one of the following values:
1436
1452
  #
1437
- # * `ALLOW_ALL`\: A legacy permissions mode that enables access
1438
- # control with API-level granularity for ledgers.
1453
+ # * `ALLOW_ALL`: A legacy permissions mode that enables access control
1454
+ # with API-level granularity for ledgers.
1439
1455
  #
1440
1456
  # This mode allows users who have the `SendCommand` API permission
1441
1457
  # for this ledger to run all PartiQL commands (hence, `ALLOW_ALL`)
@@ -1443,9 +1459,9 @@ module Aws::QLDB
1443
1459
  # table-level or command-level IAM permissions policies that you
1444
1460
  # create for the ledger.
1445
1461
  #
1446
- # * `STANDARD`\: (*Recommended*) A permissions mode that enables
1447
- # access control with finer granularity for ledgers, tables, and
1448
- # PartiQL commands.
1462
+ # * `STANDARD`: (*Recommended*) A permissions mode that enables access
1463
+ # control with finer granularity for ledgers, tables, and PartiQL
1464
+ # commands.
1449
1465
  #
1450
1466
  # By default, this mode denies all user requests to run any PartiQL
1451
1467
  # commands on any tables in this ledger. To allow PartiQL commands
@@ -1501,13 +1517,13 @@ module Aws::QLDB
1501
1517
  # @return [String]
1502
1518
  #
1503
1519
  # @!attribute [rw] deletion_protection
1504
- # The flag that prevents a ledger from being deleted by any user. If
1505
- # not provided on ledger creation, this feature is enabled (`true`) by
1506
- # default.
1520
+ # Specifies whether the ledger is protected from being deleted by any
1521
+ # user. If not defined during ledger creation, this feature is enabled
1522
+ # (`true`) by default.
1507
1523
  #
1508
1524
  # If deletion protection is enabled, you must first disable it before
1509
1525
  # you can delete the ledger. You can disable it by calling the
1510
- # `UpdateLedger` operation to set the flag to `false`.
1526
+ # `UpdateLedger` operation to set this parameter to `false`.
1511
1527
  # @return [Boolean]
1512
1528
  #
1513
1529
  # @!attribute [rw] kms_key
@@ -1517,13 +1533,14 @@ module Aws::QLDB
1517
1533
  #
1518
1534
  # Use one of the following options to specify this parameter:
1519
1535
  #
1520
- # * `AWS_OWNED_KMS_KEY`\: Use an KMS key that is owned and managed by
1536
+ # * `AWS_OWNED_KMS_KEY`: Use an KMS key that is owned and managed by
1521
1537
  # Amazon Web Services on your behalf.
1522
1538
  #
1523
- # * **Undefined**\: Make no changes to the KMS key of the ledger.
1539
+ # * **Undefined**: Make no changes to the KMS key of the ledger.
1524
1540
  #
1525
- # * **A valid symmetric customer managed KMS key**\: Use the specified
1526
- # KMS key in your account that you create, own, and manage.
1541
+ # * **A valid symmetric customer managed KMS key**: Use the specified
1542
+ # symmetric encryption KMS key in your account that you create, own,
1543
+ # and manage.
1527
1544
  #
1528
1545
  # Amazon QLDB does not support asymmetric keys. For more
1529
1546
  # information, see [Using symmetric and asymmetric keys][2] in the
@@ -1585,13 +1602,13 @@ module Aws::QLDB
1585
1602
  # @return [Time]
1586
1603
  #
1587
1604
  # @!attribute [rw] deletion_protection
1588
- # The flag that prevents a ledger from being deleted by any user. If
1589
- # not provided on ledger creation, this feature is enabled (`true`) by
1590
- # default.
1605
+ # Specifies whether the ledger is protected from being deleted by any
1606
+ # user. If not defined during ledger creation, this feature is enabled
1607
+ # (`true`) by default.
1591
1608
  #
1592
1609
  # If deletion protection is enabled, you must first disable it before
1593
1610
  # you can delete the ledger. You can disable it by calling the
1594
- # `UpdateLedger` operation to set the flag to `false`.
1611
+ # `UpdateLedger` operation to set this parameter to `false`.
1595
1612
  # @return [Boolean]
1596
1613
  #
1597
1614
  # @!attribute [rw] encryption_description
data/lib/aws-sdk-qldb.rb CHANGED
@@ -52,6 +52,6 @@ require_relative 'aws-sdk-qldb/customizations'
52
52
  # @!group service
53
53
  module Aws::QLDB
54
54
 
55
- GEM_VERSION = '1.27.0'
55
+ GEM_VERSION = '1.28.0'
56
56
 
57
57
  end
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.27.0
4
+ version: 1.28.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: 2023-01-18 00:00:00.000000000 Z
11
+ date: 2023-04-27 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core