aws-sdk-qldb 1.10.0 → 1.15.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +88 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-qldb.rb +2 -2
- data/lib/aws-sdk-qldb/client.rb +168 -43
- data/lib/aws-sdk-qldb/client_api.rb +24 -1
- data/lib/aws-sdk-qldb/errors.rb +1 -1
- data/lib/aws-sdk-qldb/resource.rb +1 -1
- data/lib/aws-sdk-qldb/types.rb +183 -65
- metadata +11 -9
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -90,6 +90,8 @@ module Aws::QLDB
|
|
90
90
|
UniqueId = Shapes::StringShape.new(name: 'UniqueId')
|
91
91
|
UntagResourceRequest = Shapes::StructureShape.new(name: 'UntagResourceRequest')
|
92
92
|
UntagResourceResponse = Shapes::StructureShape.new(name: 'UntagResourceResponse')
|
93
|
+
UpdateLedgerPermissionsModeRequest = Shapes::StructureShape.new(name: 'UpdateLedgerPermissionsModeRequest')
|
94
|
+
UpdateLedgerPermissionsModeResponse = Shapes::StructureShape.new(name: 'UpdateLedgerPermissionsModeResponse')
|
93
95
|
UpdateLedgerRequest = Shapes::StructureShape.new(name: 'UpdateLedgerRequest')
|
94
96
|
UpdateLedgerResponse = Shapes::StructureShape.new(name: 'UpdateLedgerResponse')
|
95
97
|
ValueHolder = Shapes::StructureShape.new(name: 'ValueHolder')
|
@@ -111,6 +113,7 @@ module Aws::QLDB
|
|
111
113
|
CreateLedgerResponse.add_member(:arn, Shapes::ShapeRef.new(shape: Arn, location_name: "Arn"))
|
112
114
|
CreateLedgerResponse.add_member(:state, Shapes::ShapeRef.new(shape: LedgerState, location_name: "State"))
|
113
115
|
CreateLedgerResponse.add_member(:creation_date_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "CreationDateTime"))
|
116
|
+
CreateLedgerResponse.add_member(:permissions_mode, Shapes::ShapeRef.new(shape: PermissionsMode, location_name: "PermissionsMode"))
|
114
117
|
CreateLedgerResponse.add_member(:deletion_protection, Shapes::ShapeRef.new(shape: DeletionProtection, location_name: "DeletionProtection"))
|
115
118
|
CreateLedgerResponse.struct_class = Types::CreateLedgerResponse
|
116
119
|
|
@@ -138,6 +141,7 @@ module Aws::QLDB
|
|
138
141
|
DescribeLedgerResponse.add_member(:arn, Shapes::ShapeRef.new(shape: Arn, location_name: "Arn"))
|
139
142
|
DescribeLedgerResponse.add_member(:state, Shapes::ShapeRef.new(shape: LedgerState, location_name: "State"))
|
140
143
|
DescribeLedgerResponse.add_member(:creation_date_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "CreationDateTime"))
|
144
|
+
DescribeLedgerResponse.add_member(:permissions_mode, Shapes::ShapeRef.new(shape: PermissionsMode, location_name: "PermissionsMode"))
|
141
145
|
DescribeLedgerResponse.add_member(:deletion_protection, Shapes::ShapeRef.new(shape: DeletionProtection, location_name: "DeletionProtection"))
|
142
146
|
DescribeLedgerResponse.struct_class = Types::DescribeLedgerResponse
|
143
147
|
|
@@ -321,6 +325,15 @@ module Aws::QLDB
|
|
321
325
|
|
322
326
|
UntagResourceResponse.struct_class = Types::UntagResourceResponse
|
323
327
|
|
328
|
+
UpdateLedgerPermissionsModeRequest.add_member(:name, Shapes::ShapeRef.new(shape: LedgerName, required: true, location: "uri", location_name: "name"))
|
329
|
+
UpdateLedgerPermissionsModeRequest.add_member(:permissions_mode, Shapes::ShapeRef.new(shape: PermissionsMode, required: true, location_name: "PermissionsMode"))
|
330
|
+
UpdateLedgerPermissionsModeRequest.struct_class = Types::UpdateLedgerPermissionsModeRequest
|
331
|
+
|
332
|
+
UpdateLedgerPermissionsModeResponse.add_member(:name, Shapes::ShapeRef.new(shape: LedgerName, location_name: "Name"))
|
333
|
+
UpdateLedgerPermissionsModeResponse.add_member(:arn, Shapes::ShapeRef.new(shape: Arn, location_name: "Arn"))
|
334
|
+
UpdateLedgerPermissionsModeResponse.add_member(:permissions_mode, Shapes::ShapeRef.new(shape: PermissionsMode, location_name: "PermissionsMode"))
|
335
|
+
UpdateLedgerPermissionsModeResponse.struct_class = Types::UpdateLedgerPermissionsModeResponse
|
336
|
+
|
324
337
|
UpdateLedgerRequest.add_member(:name, Shapes::ShapeRef.new(shape: LedgerName, required: true, location: "uri", location_name: "name"))
|
325
338
|
UpdateLedgerRequest.add_member(:deletion_protection, Shapes::ShapeRef.new(shape: DeletionProtection, location_name: "DeletionProtection"))
|
326
339
|
UpdateLedgerRequest.struct_class = Types::UpdateLedgerRequest
|
@@ -571,6 +584,16 @@ module Aws::QLDB
|
|
571
584
|
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
|
572
585
|
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
573
586
|
end)
|
587
|
+
|
588
|
+
api.add_operation(:update_ledger_permissions_mode, Seahorse::Model::Operation.new.tap do |o|
|
589
|
+
o.name = "UpdateLedgerPermissionsMode"
|
590
|
+
o.http_method = "PATCH"
|
591
|
+
o.http_request_uri = "/ledgers/{name}/permissions-mode"
|
592
|
+
o.input = Shapes::ShapeRef.new(shape: UpdateLedgerPermissionsModeRequest)
|
593
|
+
o.output = Shapes::ShapeRef.new(shape: UpdateLedgerPermissionsModeResponse)
|
594
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
|
595
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
596
|
+
end)
|
574
597
|
end
|
575
598
|
|
576
599
|
end
|
data/lib/aws-sdk-qldb/errors.rb
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
data/lib/aws-sdk-qldb/types.rb
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -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
|
@@ -55,7 +56,7 @@ module Aws::QLDB
|
|
55
56
|
# tags: {
|
56
57
|
# "TagKey" => "TagValue",
|
57
58
|
# },
|
58
|
-
# permissions_mode: "ALLOW_ALL", # required, accepts ALLOW_ALL
|
59
|
+
# permissions_mode: "ALLOW_ALL", # required, accepts ALLOW_ALL, STANDARD
|
59
60
|
# deletion_protection: false,
|
60
61
|
# }
|
61
62
|
#
|
@@ -79,7 +80,37 @@ module Aws::QLDB
|
|
79
80
|
#
|
80
81
|
# @!attribute [rw] permissions_mode
|
81
82
|
# The permissions mode to assign to the ledger that you want to
|
82
|
-
# create.
|
83
|
+
# create. This parameter can have one of the following values:
|
84
|
+
#
|
85
|
+
# * `ALLOW_ALL`\: A legacy permissions mode that enables access
|
86
|
+
# control with API-level granularity for ledgers.
|
87
|
+
#
|
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
|
91
|
+
# table-level or command-level IAM permissions policies that you
|
92
|
+
# create for the ledger.
|
93
|
+
#
|
94
|
+
# * `STANDARD`\: (*Recommended*) A permissions mode that enables
|
95
|
+
# access control with finer granularity for ledgers, tables, and
|
96
|
+
# PartiQL commands.
|
97
|
+
#
|
98
|
+
# By default, this mode denies all user requests to run any PartiQL
|
99
|
+
# commands on any tables in this ledger. To allow PartiQL commands
|
100
|
+
# to run, you must create IAM permissions policies for specific
|
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*.
|
105
|
+
#
|
106
|
+
# <note markdown="1"> We strongly recommend using the `STANDARD` permissions mode to
|
107
|
+
# maximize the security of your ledger data.
|
108
|
+
#
|
109
|
+
# </note>
|
110
|
+
#
|
111
|
+
#
|
112
|
+
#
|
113
|
+
# [1]: https://docs.aws.amazon.com/qldb/latest/developerguide/getting-started-standard-mode.html
|
83
114
|
# @return [String]
|
84
115
|
#
|
85
116
|
# @!attribute [rw] deletion_protection
|
@@ -88,11 +119,8 @@ module Aws::QLDB
|
|
88
119
|
# default.
|
89
120
|
#
|
90
121
|
# If deletion protection is enabled, you must first disable it before
|
91
|
-
# you can delete the ledger
|
92
|
-
#
|
93
|
-
# `UpdateLedger` operation to set the flag to `false`. The QLDB
|
94
|
-
# console disables deletion protection for you when you use it to
|
95
|
-
# 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`.
|
96
124
|
# @return [Boolean]
|
97
125
|
#
|
98
126
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/CreateLedgerRequest AWS API Documentation
|
@@ -124,17 +152,18 @@ module Aws::QLDB
|
|
124
152
|
# 12:00:00 AM January 1, 1970 UTC.)
|
125
153
|
# @return [Time]
|
126
154
|
#
|
155
|
+
# @!attribute [rw] permissions_mode
|
156
|
+
# The permissions mode of the ledger that you created.
|
157
|
+
# @return [String]
|
158
|
+
#
|
127
159
|
# @!attribute [rw] deletion_protection
|
128
160
|
# The flag that prevents a ledger from being deleted by any user. If
|
129
161
|
# not provided on ledger creation, this feature is enabled (`true`) by
|
130
162
|
# default.
|
131
163
|
#
|
132
164
|
# If deletion protection is enabled, you must first disable it before
|
133
|
-
# you can delete the ledger
|
134
|
-
#
|
135
|
-
# `UpdateLedger` operation to set the flag to `false`. The QLDB
|
136
|
-
# console disables deletion protection for you when you use it to
|
137
|
-
# 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`.
|
138
167
|
# @return [Boolean]
|
139
168
|
#
|
140
169
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/CreateLedgerResponse AWS API Documentation
|
@@ -144,6 +173,7 @@ module Aws::QLDB
|
|
144
173
|
:arn,
|
145
174
|
:state,
|
146
175
|
:creation_date_time,
|
176
|
+
:permissions_mode,
|
147
177
|
:deletion_protection)
|
148
178
|
SENSITIVE = []
|
149
179
|
include Aws::Structure
|
@@ -181,7 +211,8 @@ module Aws::QLDB
|
|
181
211
|
# @return [String]
|
182
212
|
#
|
183
213
|
# @!attribute [rw] stream_id
|
184
|
-
# The
|
214
|
+
# The UUID (represented in Base62-encoded text) of the QLDB journal
|
215
|
+
# stream to describe.
|
185
216
|
# @return [String]
|
186
217
|
#
|
187
218
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/DescribeJournalKinesisStreamRequest AWS API Documentation
|
@@ -219,7 +250,8 @@ module Aws::QLDB
|
|
219
250
|
# @return [String]
|
220
251
|
#
|
221
252
|
# @!attribute [rw] export_id
|
222
|
-
# The
|
253
|
+
# The UUID (represented in Base62-encoded text) of the journal export
|
254
|
+
# job to describe.
|
223
255
|
# @return [String]
|
224
256
|
#
|
225
257
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/DescribeJournalS3ExportRequest AWS API Documentation
|
@@ -281,17 +313,18 @@ module Aws::QLDB
|
|
281
313
|
# 12:00:00 AM January 1, 1970 UTC.)
|
282
314
|
# @return [Time]
|
283
315
|
#
|
316
|
+
# @!attribute [rw] permissions_mode
|
317
|
+
# The permissions mode of the ledger.
|
318
|
+
# @return [String]
|
319
|
+
#
|
284
320
|
# @!attribute [rw] deletion_protection
|
285
321
|
# The flag that prevents a ledger from being deleted by any user. If
|
286
322
|
# not provided on ledger creation, this feature is enabled (`true`) by
|
287
323
|
# default.
|
288
324
|
#
|
289
325
|
# If deletion protection is enabled, you must first disable it before
|
290
|
-
# you can delete the ledger
|
291
|
-
#
|
292
|
-
# `UpdateLedger` operation to set the flag to `false`. The QLDB
|
293
|
-
# console disables deletion protection for you when you use it to
|
294
|
-
# 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`.
|
295
328
|
# @return [Boolean]
|
296
329
|
#
|
297
330
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/DescribeLedgerResponse AWS API Documentation
|
@@ -301,6 +334,7 @@ module Aws::QLDB
|
|
301
334
|
:arn,
|
302
335
|
:state,
|
303
336
|
:creation_date_time,
|
337
|
+
:permissions_mode,
|
304
338
|
:deletion_protection)
|
305
339
|
SENSITIVE = []
|
306
340
|
include Aws::Structure
|
@@ -330,11 +364,11 @@ module Aws::QLDB
|
|
330
364
|
#
|
331
365
|
# @!attribute [rw] inclusive_start_time
|
332
366
|
# The inclusive start date and time for the range of journal contents
|
333
|
-
#
|
367
|
+
# to export.
|
334
368
|
#
|
335
369
|
# The `InclusiveStartTime` must be in `ISO 8601` date and time format
|
336
370
|
# and in Universal Coordinated Time (UTC). For example:
|
337
|
-
# `2019-06-13T21:36:34Z
|
371
|
+
# `2019-06-13T21:36:34Z`.
|
338
372
|
#
|
339
373
|
# The `InclusiveStartTime` must be before `ExclusiveEndTime`.
|
340
374
|
#
|
@@ -344,12 +378,12 @@ module Aws::QLDB
|
|
344
378
|
# @return [Time]
|
345
379
|
#
|
346
380
|
# @!attribute [rw] exclusive_end_time
|
347
|
-
# The exclusive end date and time for the range of journal contents
|
348
|
-
#
|
381
|
+
# The exclusive end date and time for the range of journal contents to
|
382
|
+
# export.
|
349
383
|
#
|
350
384
|
# The `ExclusiveEndTime` must be in `ISO 8601` date and time format
|
351
385
|
# and in Universal Coordinated Time (UTC). For example:
|
352
|
-
# `2019-06-13T21:36:34Z
|
386
|
+
# `2019-06-13T21:36:34Z`.
|
353
387
|
#
|
354
388
|
# The `ExclusiveEndTime` must be less than or equal to the current UTC
|
355
389
|
# date and time.
|
@@ -385,7 +419,8 @@ module Aws::QLDB
|
|
385
419
|
end
|
386
420
|
|
387
421
|
# @!attribute [rw] export_id
|
388
|
-
# The
|
422
|
+
# The UUID (represented in Base62-encoded text) that QLDB assigns to
|
423
|
+
# each journal export job.
|
389
424
|
#
|
390
425
|
# To describe your export request and check the status of the job, you
|
391
426
|
# can use `ExportId` to call `DescribeJournalS3Export`.
|
@@ -421,7 +456,7 @@ module Aws::QLDB
|
|
421
456
|
# Amazon Ion structure that has two fields: `strandId` and
|
422
457
|
# `sequenceNo`.
|
423
458
|
#
|
424
|
-
# For example: `\{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14\}
|
459
|
+
# For example: `\{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14\}`.
|
425
460
|
# @return [Types::ValueHolder]
|
426
461
|
#
|
427
462
|
# @!attribute [rw] digest_tip_address
|
@@ -429,7 +464,7 @@ module Aws::QLDB
|
|
429
464
|
# a proof. An address is an Amazon Ion structure that has two fields:
|
430
465
|
# `strandId` and `sequenceNo`.
|
431
466
|
#
|
432
|
-
# For example: `\{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49\}
|
467
|
+
# For example: `\{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49\}`.
|
433
468
|
# @return [Types::ValueHolder]
|
434
469
|
#
|
435
470
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/GetBlockRequest AWS API Documentation
|
@@ -524,11 +559,12 @@ module Aws::QLDB
|
|
524
559
|
# address is an Amazon Ion structure that has two fields: `strandId`
|
525
560
|
# and `sequenceNo`.
|
526
561
|
#
|
527
|
-
# For example: `\{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14\}
|
562
|
+
# For example: `\{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14\}`.
|
528
563
|
# @return [Types::ValueHolder]
|
529
564
|
#
|
530
565
|
# @!attribute [rw] document_id
|
531
|
-
# The
|
566
|
+
# The UUID (represented in Base62-encoded text) of the document to be
|
567
|
+
# verified.
|
532
568
|
# @return [String]
|
533
569
|
#
|
534
570
|
# @!attribute [rw] digest_tip_address
|
@@ -536,7 +572,7 @@ module Aws::QLDB
|
|
536
572
|
# a proof. An address is an Amazon Ion structure that has two fields:
|
537
573
|
# `strandId` and `sequenceNo`.
|
538
574
|
#
|
539
|
-
# For example: `\{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49\}
|
575
|
+
# For example: `\{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49\}`.
|
540
576
|
# @return [Types::ValueHolder]
|
541
577
|
#
|
542
578
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/GetRevisionRequest AWS API Documentation
|
@@ -588,9 +624,9 @@ module Aws::QLDB
|
|
588
624
|
include Aws::Structure
|
589
625
|
end
|
590
626
|
|
591
|
-
#
|
592
|
-
#
|
593
|
-
#
|
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.
|
594
630
|
#
|
595
631
|
# @!attribute [rw] ledger_name
|
596
632
|
# The name of the ledger.
|
@@ -620,7 +656,8 @@ module Aws::QLDB
|
|
620
656
|
# @return [String]
|
621
657
|
#
|
622
658
|
# @!attribute [rw] stream_id
|
623
|
-
# The
|
659
|
+
# The UUID (represented in Base62-encoded text) of the QLDB journal
|
660
|
+
# stream.
|
624
661
|
# @return [String]
|
625
662
|
#
|
626
663
|
# @!attribute [rw] arn
|
@@ -633,7 +670,7 @@ module Aws::QLDB
|
|
633
670
|
#
|
634
671
|
# @!attribute [rw] kinesis_configuration
|
635
672
|
# The configuration settings of the Amazon Kinesis Data Streams
|
636
|
-
# destination for
|
673
|
+
# destination for a QLDB journal stream.
|
637
674
|
# @return [Types::KinesisConfiguration]
|
638
675
|
#
|
639
676
|
# @!attribute [rw] error_cause
|
@@ -664,16 +701,17 @@ module Aws::QLDB
|
|
664
701
|
include Aws::Structure
|
665
702
|
end
|
666
703
|
|
667
|
-
#
|
668
|
-
# export ID,
|
669
|
-
#
|
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.
|
670
707
|
#
|
671
708
|
# @!attribute [rw] ledger_name
|
672
709
|
# The name of the ledger.
|
673
710
|
# @return [String]
|
674
711
|
#
|
675
712
|
# @!attribute [rw] export_id
|
676
|
-
# The
|
713
|
+
# The UUID (represented in Base62-encoded text) of the journal export
|
714
|
+
# job.
|
677
715
|
# @return [String]
|
678
716
|
#
|
679
717
|
# @!attribute [rw] export_creation_time
|
@@ -729,7 +767,7 @@ module Aws::QLDB
|
|
729
767
|
end
|
730
768
|
|
731
769
|
# The configuration settings of the Amazon Kinesis Data Streams
|
732
|
-
# destination for
|
770
|
+
# destination for an Amazon QLDB journal stream.
|
733
771
|
#
|
734
772
|
# @note When making an API call, you may pass KinesisConfiguration
|
735
773
|
# data as a hash:
|
@@ -740,17 +778,24 @@ module Aws::QLDB
|
|
740
778
|
# }
|
741
779
|
#
|
742
780
|
# @!attribute [rw] stream_arn
|
743
|
-
# The Amazon Resource Name (ARN) of the Kinesis
|
781
|
+
# The Amazon Resource Name (ARN) of the Kinesis Data Streams resource.
|
744
782
|
# @return [String]
|
745
783
|
#
|
746
784
|
# @!attribute [rw] aggregation_enabled
|
747
785
|
# Enables QLDB to publish multiple data records in a single Kinesis
|
748
|
-
# Data Streams record
|
749
|
-
#
|
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*.
|
750
794
|
#
|
751
795
|
#
|
752
796
|
#
|
753
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
|
754
799
|
# @return [Boolean]
|
755
800
|
#
|
756
801
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/KinesisConfiguration AWS API Documentation
|
@@ -1041,8 +1086,8 @@ module Aws::QLDB
|
|
1041
1086
|
# }
|
1042
1087
|
#
|
1043
1088
|
# @!attribute [rw] resource_arn
|
1044
|
-
# The Amazon Resource Name (ARN) for which
|
1045
|
-
#
|
1089
|
+
# The Amazon Resource Name (ARN) for which to list the tags. For
|
1090
|
+
# example:
|
1046
1091
|
#
|
1047
1092
|
# `arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger`
|
1048
1093
|
# @return [String]
|
@@ -1185,7 +1230,7 @@ module Aws::QLDB
|
|
1185
1230
|
#
|
1186
1231
|
# @!attribute [rw] kms_key_arn
|
1187
1232
|
# The Amazon Resource Name (ARN) for a symmetric customer master key
|
1188
|
-
# (CMK) in AWS Key Management Service (AWS KMS). Amazon
|
1233
|
+
# (CMK) in AWS Key Management Service (AWS KMS). Amazon S3 does not
|
1189
1234
|
# support asymmetric CMKs.
|
1190
1235
|
#
|
1191
1236
|
# You must provide a `KmsKeyArn` if you specify `SSE_KMS` as the
|
@@ -1306,7 +1351,7 @@ module Aws::QLDB
|
|
1306
1351
|
# The inclusive start date and time from which to start streaming
|
1307
1352
|
# journal data. This parameter must be in `ISO 8601` date and time
|
1308
1353
|
# format and in Universal Coordinated Time (UTC). For example:
|
1309
|
-
# `2019-06-13T21:36:34Z
|
1354
|
+
# `2019-06-13T21:36:34Z`.
|
1310
1355
|
#
|
1311
1356
|
# The `InclusiveStartTime` cannot be in the future and must be before
|
1312
1357
|
# `ExclusiveEndTime`.
|
@@ -1323,7 +1368,7 @@ module Aws::QLDB
|
|
1323
1368
|
#
|
1324
1369
|
# The `ExclusiveEndTime` must be in `ISO 8601` date and time format
|
1325
1370
|
# and in Universal Coordinated Time (UTC). For example:
|
1326
|
-
# `2019-06-13T21:36:34Z
|
1371
|
+
# `2019-06-13T21:36:34Z`.
|
1327
1372
|
# @return [Time]
|
1328
1373
|
#
|
1329
1374
|
# @!attribute [rw] kinesis_configuration
|
@@ -1361,7 +1406,8 @@ module Aws::QLDB
|
|
1361
1406
|
end
|
1362
1407
|
|
1363
1408
|
# @!attribute [rw] stream_id
|
1364
|
-
# The
|
1409
|
+
# The UUID (represented in Base62-encoded text) that QLDB assigns to
|
1410
|
+
# each QLDB journal stream.
|
1365
1411
|
# @return [String]
|
1366
1412
|
#
|
1367
1413
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/StreamJournalToKinesisResponse AWS API Documentation
|
@@ -1418,14 +1464,14 @@ module Aws::QLDB
|
|
1418
1464
|
# }
|
1419
1465
|
#
|
1420
1466
|
# @!attribute [rw] resource_arn
|
1421
|
-
# The Amazon Resource Name (ARN) from which
|
1422
|
-
#
|
1467
|
+
# The Amazon Resource Name (ARN) from which to remove the tags. For
|
1468
|
+
# example:
|
1423
1469
|
#
|
1424
1470
|
# `arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger`
|
1425
1471
|
# @return [String]
|
1426
1472
|
#
|
1427
1473
|
# @!attribute [rw] tag_keys
|
1428
|
-
# The list of tag keys
|
1474
|
+
# The list of tag keys to remove.
|
1429
1475
|
# @return [Array<String>]
|
1430
1476
|
#
|
1431
1477
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/UntagResourceRequest AWS API Documentation
|
@@ -1441,6 +1487,84 @@ module Aws::QLDB
|
|
1441
1487
|
#
|
1442
1488
|
class UntagResourceResponse < Aws::EmptyStructure; end
|
1443
1489
|
|
1490
|
+
# @note When making an API call, you may pass UpdateLedgerPermissionsModeRequest
|
1491
|
+
# data as a hash:
|
1492
|
+
#
|
1493
|
+
# {
|
1494
|
+
# name: "LedgerName", # required
|
1495
|
+
# permissions_mode: "ALLOW_ALL", # required, accepts ALLOW_ALL, STANDARD
|
1496
|
+
# }
|
1497
|
+
#
|
1498
|
+
# @!attribute [rw] name
|
1499
|
+
# The name of the ledger.
|
1500
|
+
# @return [String]
|
1501
|
+
#
|
1502
|
+
# @!attribute [rw] permissions_mode
|
1503
|
+
# The permissions mode to assign to the ledger. This parameter can
|
1504
|
+
# have one of the following values:
|
1505
|
+
#
|
1506
|
+
# * `ALLOW_ALL`\: A legacy permissions mode that enables access
|
1507
|
+
# control with API-level granularity for ledgers.
|
1508
|
+
#
|
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
|
1512
|
+
# table-level or command-level IAM permissions policies that you
|
1513
|
+
# create for the ledger.
|
1514
|
+
#
|
1515
|
+
# * `STANDARD`\: (*Recommended*) A permissions mode that enables
|
1516
|
+
# access control with finer granularity for ledgers, tables, and
|
1517
|
+
# PartiQL commands.
|
1518
|
+
#
|
1519
|
+
# By default, this mode denies all user requests to run any PartiQL
|
1520
|
+
# commands on any tables in this ledger. To allow PartiQL commands
|
1521
|
+
# to run, you must create IAM permissions policies for specific
|
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*.
|
1526
|
+
#
|
1527
|
+
# <note markdown="1"> We strongly recommend using the `STANDARD` permissions mode to
|
1528
|
+
# maximize the security of your ledger data.
|
1529
|
+
#
|
1530
|
+
# </note>
|
1531
|
+
#
|
1532
|
+
#
|
1533
|
+
#
|
1534
|
+
# [1]: https://docs.aws.amazon.com/qldb/latest/developerguide/getting-started-standard-mode.html
|
1535
|
+
# @return [String]
|
1536
|
+
#
|
1537
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/UpdateLedgerPermissionsModeRequest AWS API Documentation
|
1538
|
+
#
|
1539
|
+
class UpdateLedgerPermissionsModeRequest < Struct.new(
|
1540
|
+
:name,
|
1541
|
+
:permissions_mode)
|
1542
|
+
SENSITIVE = []
|
1543
|
+
include Aws::Structure
|
1544
|
+
end
|
1545
|
+
|
1546
|
+
# @!attribute [rw] name
|
1547
|
+
# The name of the ledger.
|
1548
|
+
# @return [String]
|
1549
|
+
#
|
1550
|
+
# @!attribute [rw] arn
|
1551
|
+
# The Amazon Resource Name (ARN) for the ledger.
|
1552
|
+
# @return [String]
|
1553
|
+
#
|
1554
|
+
# @!attribute [rw] permissions_mode
|
1555
|
+
# The current permissions mode of the ledger.
|
1556
|
+
# @return [String]
|
1557
|
+
#
|
1558
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/UpdateLedgerPermissionsModeResponse AWS API Documentation
|
1559
|
+
#
|
1560
|
+
class UpdateLedgerPermissionsModeResponse < Struct.new(
|
1561
|
+
:name,
|
1562
|
+
:arn,
|
1563
|
+
:permissions_mode)
|
1564
|
+
SENSITIVE = []
|
1565
|
+
include Aws::Structure
|
1566
|
+
end
|
1567
|
+
|
1444
1568
|
# @note When making an API call, you may pass UpdateLedgerRequest
|
1445
1569
|
# data as a hash:
|
1446
1570
|
#
|
@@ -1459,11 +1583,8 @@ module Aws::QLDB
|
|
1459
1583
|
# default.
|
1460
1584
|
#
|
1461
1585
|
# If deletion protection is enabled, you must first disable it before
|
1462
|
-
# you can delete the ledger
|
1463
|
-
#
|
1464
|
-
# `UpdateLedger` operation to set the flag to `false`. The QLDB
|
1465
|
-
# console disables deletion protection for you when you use it to
|
1466
|
-
# 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`.
|
1467
1588
|
# @return [Boolean]
|
1468
1589
|
#
|
1469
1590
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/UpdateLedgerRequest AWS API Documentation
|
@@ -1499,11 +1620,8 @@ module Aws::QLDB
|
|
1499
1620
|
# default.
|
1500
1621
|
#
|
1501
1622
|
# If deletion protection is enabled, you must first disable it before
|
1502
|
-
# you can delete the ledger
|
1503
|
-
#
|
1504
|
-
# `UpdateLedger` operation to set the flag to `false`. The QLDB
|
1505
|
-
# console disables deletion protection for you when you use it to
|
1506
|
-
# 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`.
|
1507
1625
|
# @return [Boolean]
|
1508
1626
|
#
|
1509
1627
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/UpdateLedgerResponse AWS API Documentation
|