aws-sdk-qldb 1.0.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 +7 -0
- data/lib/aws-sdk-qldb.rb +47 -0
- data/lib/aws-sdk-qldb/client.rb +1013 -0
- data/lib/aws-sdk-qldb/client_api.rb +456 -0
- data/lib/aws-sdk-qldb/customizations.rb +0 -0
- data/lib/aws-sdk-qldb/errors.rb +160 -0
- data/lib/aws-sdk-qldb/resource.rb +23 -0
- data/lib/aws-sdk-qldb/types.rb +1149 -0
- metadata +88 -0
File without changes
|
@@ -0,0 +1,160 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws::QLDB
|
9
|
+
module Errors
|
10
|
+
|
11
|
+
extend Aws::Errors::DynamicErrors
|
12
|
+
|
13
|
+
class InvalidParameterException < ServiceError
|
14
|
+
|
15
|
+
# @param [Seahorse::Client::RequestContext] context
|
16
|
+
# @param [String] message
|
17
|
+
# @param [Aws::QLDB::Types::InvalidParameterException] data
|
18
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
19
|
+
super(context, message, data)
|
20
|
+
end
|
21
|
+
|
22
|
+
# @return [String]
|
23
|
+
def message
|
24
|
+
@message || @data[:message]
|
25
|
+
end
|
26
|
+
|
27
|
+
# @return [String]
|
28
|
+
def parameter_name
|
29
|
+
@data[:parameter_name]
|
30
|
+
end
|
31
|
+
|
32
|
+
end
|
33
|
+
|
34
|
+
class LimitExceededException < ServiceError
|
35
|
+
|
36
|
+
# @param [Seahorse::Client::RequestContext] context
|
37
|
+
# @param [String] message
|
38
|
+
# @param [Aws::QLDB::Types::LimitExceededException] data
|
39
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
40
|
+
super(context, message, data)
|
41
|
+
end
|
42
|
+
|
43
|
+
# @return [String]
|
44
|
+
def message
|
45
|
+
@message || @data[:message]
|
46
|
+
end
|
47
|
+
|
48
|
+
# @return [String]
|
49
|
+
def resource_type
|
50
|
+
@data[:resource_type]
|
51
|
+
end
|
52
|
+
|
53
|
+
end
|
54
|
+
|
55
|
+
class ResourceAlreadyExistsException < ServiceError
|
56
|
+
|
57
|
+
# @param [Seahorse::Client::RequestContext] context
|
58
|
+
# @param [String] message
|
59
|
+
# @param [Aws::QLDB::Types::ResourceAlreadyExistsException] data
|
60
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
61
|
+
super(context, message, data)
|
62
|
+
end
|
63
|
+
|
64
|
+
# @return [String]
|
65
|
+
def message
|
66
|
+
@message || @data[:message]
|
67
|
+
end
|
68
|
+
|
69
|
+
# @return [String]
|
70
|
+
def resource_type
|
71
|
+
@data[:resource_type]
|
72
|
+
end
|
73
|
+
|
74
|
+
# @return [String]
|
75
|
+
def resource_name
|
76
|
+
@data[:resource_name]
|
77
|
+
end
|
78
|
+
|
79
|
+
end
|
80
|
+
|
81
|
+
class ResourceInUseException < ServiceError
|
82
|
+
|
83
|
+
# @param [Seahorse::Client::RequestContext] context
|
84
|
+
# @param [String] message
|
85
|
+
# @param [Aws::QLDB::Types::ResourceInUseException] data
|
86
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
87
|
+
super(context, message, data)
|
88
|
+
end
|
89
|
+
|
90
|
+
# @return [String]
|
91
|
+
def message
|
92
|
+
@message || @data[:message]
|
93
|
+
end
|
94
|
+
|
95
|
+
# @return [String]
|
96
|
+
def resource_type
|
97
|
+
@data[:resource_type]
|
98
|
+
end
|
99
|
+
|
100
|
+
# @return [String]
|
101
|
+
def resource_name
|
102
|
+
@data[:resource_name]
|
103
|
+
end
|
104
|
+
|
105
|
+
end
|
106
|
+
|
107
|
+
class ResourceNotFoundException < ServiceError
|
108
|
+
|
109
|
+
# @param [Seahorse::Client::RequestContext] context
|
110
|
+
# @param [String] message
|
111
|
+
# @param [Aws::QLDB::Types::ResourceNotFoundException] data
|
112
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
113
|
+
super(context, message, data)
|
114
|
+
end
|
115
|
+
|
116
|
+
# @return [String]
|
117
|
+
def message
|
118
|
+
@message || @data[:message]
|
119
|
+
end
|
120
|
+
|
121
|
+
# @return [String]
|
122
|
+
def resource_type
|
123
|
+
@data[:resource_type]
|
124
|
+
end
|
125
|
+
|
126
|
+
# @return [String]
|
127
|
+
def resource_name
|
128
|
+
@data[:resource_name]
|
129
|
+
end
|
130
|
+
|
131
|
+
end
|
132
|
+
|
133
|
+
class ResourcePreconditionNotMetException < ServiceError
|
134
|
+
|
135
|
+
# @param [Seahorse::Client::RequestContext] context
|
136
|
+
# @param [String] message
|
137
|
+
# @param [Aws::QLDB::Types::ResourcePreconditionNotMetException] data
|
138
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
139
|
+
super(context, message, data)
|
140
|
+
end
|
141
|
+
|
142
|
+
# @return [String]
|
143
|
+
def message
|
144
|
+
@message || @data[:message]
|
145
|
+
end
|
146
|
+
|
147
|
+
# @return [String]
|
148
|
+
def resource_type
|
149
|
+
@data[:resource_type]
|
150
|
+
end
|
151
|
+
|
152
|
+
# @return [String]
|
153
|
+
def resource_name
|
154
|
+
@data[:resource_name]
|
155
|
+
end
|
156
|
+
|
157
|
+
end
|
158
|
+
|
159
|
+
end
|
160
|
+
end
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws::QLDB
|
9
|
+
class Resource
|
10
|
+
|
11
|
+
# @param options ({})
|
12
|
+
# @option options [Client] :client
|
13
|
+
def initialize(options = {})
|
14
|
+
@client = options[:client] || Client.new(options)
|
15
|
+
end
|
16
|
+
|
17
|
+
# @return [Client]
|
18
|
+
def client
|
19
|
+
@client
|
20
|
+
end
|
21
|
+
|
22
|
+
end
|
23
|
+
end
|
@@ -0,0 +1,1149 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws::QLDB
|
9
|
+
module Types
|
10
|
+
|
11
|
+
# @note When making an API call, you may pass CreateLedgerRequest
|
12
|
+
# data as a hash:
|
13
|
+
#
|
14
|
+
# {
|
15
|
+
# name: "LedgerName", # required
|
16
|
+
# tags: {
|
17
|
+
# "TagKey" => "TagValue",
|
18
|
+
# },
|
19
|
+
# permissions_mode: "ALLOW_ALL", # required, accepts ALLOW_ALL
|
20
|
+
# deletion_protection: false,
|
21
|
+
# }
|
22
|
+
#
|
23
|
+
# @!attribute [rw] name
|
24
|
+
# The name of the ledger that you want to create. The name must be
|
25
|
+
# unique among all of your ledgers in the current AWS Region.
|
26
|
+
# @return [String]
|
27
|
+
#
|
28
|
+
# @!attribute [rw] tags
|
29
|
+
# The key-value pairs to add as tags to the ledger that you want to
|
30
|
+
# create. Tag keys are case sensitive. Tag values are case sensitive
|
31
|
+
# and can be null.
|
32
|
+
# @return [Hash<String,String>]
|
33
|
+
#
|
34
|
+
# @!attribute [rw] permissions_mode
|
35
|
+
# The permissions mode to assign to the ledger that you want to
|
36
|
+
# create.
|
37
|
+
# @return [String]
|
38
|
+
#
|
39
|
+
# @!attribute [rw] deletion_protection
|
40
|
+
# The flag that prevents a ledger from being deleted by any user. If
|
41
|
+
# not provided on ledger creation, this feature is enabled (`true`) by
|
42
|
+
# default.
|
43
|
+
#
|
44
|
+
# If deletion protection is enabled, you must first disable it before
|
45
|
+
# you can delete the ledger using the QLDB API or the AWS Command Line
|
46
|
+
# Interface (AWS CLI). You can disable it by calling the
|
47
|
+
# `UpdateLedger` operation to set the flag to `false`. The QLDB
|
48
|
+
# console disables deletion protection for you when you use it to
|
49
|
+
# delete a ledger.
|
50
|
+
# @return [Boolean]
|
51
|
+
#
|
52
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/CreateLedgerRequest AWS API Documentation
|
53
|
+
#
|
54
|
+
class CreateLedgerRequest < Struct.new(
|
55
|
+
:name,
|
56
|
+
:tags,
|
57
|
+
:permissions_mode,
|
58
|
+
:deletion_protection)
|
59
|
+
include Aws::Structure
|
60
|
+
end
|
61
|
+
|
62
|
+
# @!attribute [rw] name
|
63
|
+
# The name of the ledger.
|
64
|
+
# @return [String]
|
65
|
+
#
|
66
|
+
# @!attribute [rw] arn
|
67
|
+
# The Amazon Resource Name (ARN) for the ledger.
|
68
|
+
# @return [String]
|
69
|
+
#
|
70
|
+
# @!attribute [rw] state
|
71
|
+
# The current status of the ledger.
|
72
|
+
# @return [String]
|
73
|
+
#
|
74
|
+
# @!attribute [rw] creation_date_time
|
75
|
+
# The date and time, in epoch time format, when the ledger was
|
76
|
+
# created. (Epoch time format is the number of seconds elapsed since
|
77
|
+
# 12:00:00 AM January 1, 1970 UTC.)
|
78
|
+
# @return [Time]
|
79
|
+
#
|
80
|
+
# @!attribute [rw] deletion_protection
|
81
|
+
# The flag that prevents a ledger from being deleted by any user. If
|
82
|
+
# not provided on ledger creation, this feature is enabled (`true`) by
|
83
|
+
# default.
|
84
|
+
#
|
85
|
+
# If deletion protection is enabled, you must first disable it before
|
86
|
+
# you can delete the ledger using the QLDB API or the AWS Command Line
|
87
|
+
# Interface (AWS CLI). You can disable it by calling the
|
88
|
+
# `UpdateLedger` operation to set the flag to `false`. The QLDB
|
89
|
+
# console disables deletion protection for you when you use it to
|
90
|
+
# delete a ledger.
|
91
|
+
# @return [Boolean]
|
92
|
+
#
|
93
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/CreateLedgerResponse AWS API Documentation
|
94
|
+
#
|
95
|
+
class CreateLedgerResponse < Struct.new(
|
96
|
+
:name,
|
97
|
+
:arn,
|
98
|
+
:state,
|
99
|
+
:creation_date_time,
|
100
|
+
:deletion_protection)
|
101
|
+
include Aws::Structure
|
102
|
+
end
|
103
|
+
|
104
|
+
# @note When making an API call, you may pass DeleteLedgerRequest
|
105
|
+
# data as a hash:
|
106
|
+
#
|
107
|
+
# {
|
108
|
+
# name: "LedgerName", # required
|
109
|
+
# }
|
110
|
+
#
|
111
|
+
# @!attribute [rw] name
|
112
|
+
# The name of the ledger that you want to delete.
|
113
|
+
# @return [String]
|
114
|
+
#
|
115
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/DeleteLedgerRequest AWS API Documentation
|
116
|
+
#
|
117
|
+
class DeleteLedgerRequest < Struct.new(
|
118
|
+
:name)
|
119
|
+
include Aws::Structure
|
120
|
+
end
|
121
|
+
|
122
|
+
# @note When making an API call, you may pass DescribeJournalS3ExportRequest
|
123
|
+
# data as a hash:
|
124
|
+
#
|
125
|
+
# {
|
126
|
+
# name: "LedgerName", # required
|
127
|
+
# export_id: "UniqueId", # required
|
128
|
+
# }
|
129
|
+
#
|
130
|
+
# @!attribute [rw] name
|
131
|
+
# The name of the ledger.
|
132
|
+
# @return [String]
|
133
|
+
#
|
134
|
+
# @!attribute [rw] export_id
|
135
|
+
# The unique ID of the journal export job that you want to describe.
|
136
|
+
# @return [String]
|
137
|
+
#
|
138
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/DescribeJournalS3ExportRequest AWS API Documentation
|
139
|
+
#
|
140
|
+
class DescribeJournalS3ExportRequest < Struct.new(
|
141
|
+
:name,
|
142
|
+
:export_id)
|
143
|
+
include Aws::Structure
|
144
|
+
end
|
145
|
+
|
146
|
+
# @!attribute [rw] export_description
|
147
|
+
# Information about the journal export job returned by a
|
148
|
+
# `DescribeJournalS3Export` request.
|
149
|
+
# @return [Types::JournalS3ExportDescription]
|
150
|
+
#
|
151
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/DescribeJournalS3ExportResponse AWS API Documentation
|
152
|
+
#
|
153
|
+
class DescribeJournalS3ExportResponse < Struct.new(
|
154
|
+
:export_description)
|
155
|
+
include Aws::Structure
|
156
|
+
end
|
157
|
+
|
158
|
+
# @note When making an API call, you may pass DescribeLedgerRequest
|
159
|
+
# data as a hash:
|
160
|
+
#
|
161
|
+
# {
|
162
|
+
# name: "LedgerName", # required
|
163
|
+
# }
|
164
|
+
#
|
165
|
+
# @!attribute [rw] name
|
166
|
+
# The name of the ledger that you want to describe.
|
167
|
+
# @return [String]
|
168
|
+
#
|
169
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/DescribeLedgerRequest AWS API Documentation
|
170
|
+
#
|
171
|
+
class DescribeLedgerRequest < Struct.new(
|
172
|
+
:name)
|
173
|
+
include Aws::Structure
|
174
|
+
end
|
175
|
+
|
176
|
+
# @!attribute [rw] name
|
177
|
+
# The name of the ledger.
|
178
|
+
# @return [String]
|
179
|
+
#
|
180
|
+
# @!attribute [rw] arn
|
181
|
+
# The Amazon Resource Name (ARN) for the ledger.
|
182
|
+
# @return [String]
|
183
|
+
#
|
184
|
+
# @!attribute [rw] state
|
185
|
+
# The current status of the ledger.
|
186
|
+
# @return [String]
|
187
|
+
#
|
188
|
+
# @!attribute [rw] creation_date_time
|
189
|
+
# The date and time, in epoch time format, when the ledger was
|
190
|
+
# created. (Epoch time format is the number of seconds elapsed since
|
191
|
+
# 12:00:00 AM January 1, 1970 UTC.)
|
192
|
+
# @return [Time]
|
193
|
+
#
|
194
|
+
# @!attribute [rw] deletion_protection
|
195
|
+
# The flag that prevents a ledger from being deleted by any user. If
|
196
|
+
# not provided on ledger creation, this feature is enabled (`true`) by
|
197
|
+
# default.
|
198
|
+
#
|
199
|
+
# If deletion protection is enabled, you must first disable it before
|
200
|
+
# you can delete the ledger using the QLDB API or the AWS Command Line
|
201
|
+
# Interface (AWS CLI). You can disable it by calling the
|
202
|
+
# `UpdateLedger` operation to set the flag to `false`. The QLDB
|
203
|
+
# console disables deletion protection for you when you use it to
|
204
|
+
# delete a ledger.
|
205
|
+
# @return [Boolean]
|
206
|
+
#
|
207
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/DescribeLedgerResponse AWS API Documentation
|
208
|
+
#
|
209
|
+
class DescribeLedgerResponse < Struct.new(
|
210
|
+
:name,
|
211
|
+
:arn,
|
212
|
+
:state,
|
213
|
+
:creation_date_time,
|
214
|
+
:deletion_protection)
|
215
|
+
include Aws::Structure
|
216
|
+
end
|
217
|
+
|
218
|
+
# @note When making an API call, you may pass ExportJournalToS3Request
|
219
|
+
# data as a hash:
|
220
|
+
#
|
221
|
+
# {
|
222
|
+
# name: "LedgerName", # required
|
223
|
+
# inclusive_start_time: Time.now, # required
|
224
|
+
# exclusive_end_time: Time.now, # required
|
225
|
+
# s3_export_configuration: { # required
|
226
|
+
# bucket: "S3Bucket", # required
|
227
|
+
# prefix: "S3Prefix", # required
|
228
|
+
# encryption_configuration: { # required
|
229
|
+
# object_encryption_type: "SSE_KMS", # required, accepts SSE_KMS, SSE_S3, NO_ENCRYPTION
|
230
|
+
# kms_key_arn: "Arn",
|
231
|
+
# },
|
232
|
+
# },
|
233
|
+
# role_arn: "Arn", # required
|
234
|
+
# }
|
235
|
+
#
|
236
|
+
# @!attribute [rw] name
|
237
|
+
# The name of the ledger.
|
238
|
+
# @return [String]
|
239
|
+
#
|
240
|
+
# @!attribute [rw] inclusive_start_time
|
241
|
+
# The inclusive start date and time for the range of journal contents
|
242
|
+
# that you want to export.
|
243
|
+
#
|
244
|
+
# The `InclusiveStartTime` must be in `ISO 8601` date and time format
|
245
|
+
# and in Universal Coordinated Time (UTC). For example:
|
246
|
+
# `2019-06-13T21:36:34Z`
|
247
|
+
#
|
248
|
+
# The `InclusiveStartTime` must be before `ExclusiveEndTime`.
|
249
|
+
#
|
250
|
+
# If you provide an `InclusiveStartTime` that is before the ledger's
|
251
|
+
# `CreationDateTime`, Amazon QLDB defaults it to the ledger's
|
252
|
+
# `CreationDateTime`.
|
253
|
+
# @return [Time]
|
254
|
+
#
|
255
|
+
# @!attribute [rw] exclusive_end_time
|
256
|
+
# The exclusive end date and time for the range of journal contents
|
257
|
+
# that you want to export.
|
258
|
+
#
|
259
|
+
# The `ExclusiveEndTime` must be in `ISO 8601` date and time format
|
260
|
+
# and in Universal Coordinated Time (UTC). For example:
|
261
|
+
# `2019-06-13T21:36:34Z`
|
262
|
+
#
|
263
|
+
# The `ExclusiveEndTime` must be less than or equal to the current UTC
|
264
|
+
# date and time.
|
265
|
+
# @return [Time]
|
266
|
+
#
|
267
|
+
# @!attribute [rw] s3_export_configuration
|
268
|
+
# The configuration settings of the Amazon S3 bucket destination for
|
269
|
+
# your export request.
|
270
|
+
# @return [Types::S3ExportConfiguration]
|
271
|
+
#
|
272
|
+
# @!attribute [rw] role_arn
|
273
|
+
# The Amazon Resource Name (ARN) of the IAM role that grants QLDB
|
274
|
+
# permissions for a journal export job to do the following:
|
275
|
+
#
|
276
|
+
# * Write objects into your Amazon Simple Storage Service (Amazon S3)
|
277
|
+
# bucket.
|
278
|
+
#
|
279
|
+
# * (Optional) Use your customer master key (CMK) in AWS Key
|
280
|
+
# Management Service (AWS KMS) for server-side encryption of your
|
281
|
+
# exported data.
|
282
|
+
# @return [String]
|
283
|
+
#
|
284
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/ExportJournalToS3Request AWS API Documentation
|
285
|
+
#
|
286
|
+
class ExportJournalToS3Request < Struct.new(
|
287
|
+
:name,
|
288
|
+
:inclusive_start_time,
|
289
|
+
:exclusive_end_time,
|
290
|
+
:s3_export_configuration,
|
291
|
+
:role_arn)
|
292
|
+
include Aws::Structure
|
293
|
+
end
|
294
|
+
|
295
|
+
# @!attribute [rw] export_id
|
296
|
+
# The unique ID that QLDB assigns to each journal export job.
|
297
|
+
#
|
298
|
+
# To describe your export request and check the status of the job, you
|
299
|
+
# can use `ExportId` to call `DescribeJournalS3Export`.
|
300
|
+
# @return [String]
|
301
|
+
#
|
302
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/ExportJournalToS3Response AWS API Documentation
|
303
|
+
#
|
304
|
+
class ExportJournalToS3Response < Struct.new(
|
305
|
+
:export_id)
|
306
|
+
include Aws::Structure
|
307
|
+
end
|
308
|
+
|
309
|
+
# @note When making an API call, you may pass GetBlockRequest
|
310
|
+
# data as a hash:
|
311
|
+
#
|
312
|
+
# {
|
313
|
+
# name: "LedgerName", # required
|
314
|
+
# block_address: { # required
|
315
|
+
# ion_text: "IonText",
|
316
|
+
# },
|
317
|
+
# digest_tip_address: {
|
318
|
+
# ion_text: "IonText",
|
319
|
+
# },
|
320
|
+
# }
|
321
|
+
#
|
322
|
+
# @!attribute [rw] name
|
323
|
+
# The name of the ledger.
|
324
|
+
# @return [String]
|
325
|
+
#
|
326
|
+
# @!attribute [rw] block_address
|
327
|
+
# The location of the block that you want to request. An address is an
|
328
|
+
# Amazon Ion structure that has two fields: `strandId` and
|
329
|
+
# `sequenceNo`.
|
330
|
+
#
|
331
|
+
# For example: `\{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14\}`
|
332
|
+
# @return [Types::ValueHolder]
|
333
|
+
#
|
334
|
+
# @!attribute [rw] digest_tip_address
|
335
|
+
# The latest block location covered by the digest for which to request
|
336
|
+
# a proof. An address is an Amazon Ion structure that has two fields:
|
337
|
+
# `strandId` and `sequenceNo`.
|
338
|
+
#
|
339
|
+
# For example: `\{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49\}`
|
340
|
+
# @return [Types::ValueHolder]
|
341
|
+
#
|
342
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/GetBlockRequest AWS API Documentation
|
343
|
+
#
|
344
|
+
class GetBlockRequest < Struct.new(
|
345
|
+
:name,
|
346
|
+
:block_address,
|
347
|
+
:digest_tip_address)
|
348
|
+
include Aws::Structure
|
349
|
+
end
|
350
|
+
|
351
|
+
# @!attribute [rw] block
|
352
|
+
# The block data object in Amazon Ion format.
|
353
|
+
# @return [Types::ValueHolder]
|
354
|
+
#
|
355
|
+
# @!attribute [rw] proof
|
356
|
+
# The proof object in Amazon Ion format returned by a `GetBlock`
|
357
|
+
# request. A proof contains the list of hash values required to
|
358
|
+
# recalculate the specified digest using a Merkle tree, starting with
|
359
|
+
# the specified block.
|
360
|
+
# @return [Types::ValueHolder]
|
361
|
+
#
|
362
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/GetBlockResponse AWS API Documentation
|
363
|
+
#
|
364
|
+
class GetBlockResponse < Struct.new(
|
365
|
+
:block,
|
366
|
+
:proof)
|
367
|
+
include Aws::Structure
|
368
|
+
end
|
369
|
+
|
370
|
+
# @note When making an API call, you may pass GetDigestRequest
|
371
|
+
# data as a hash:
|
372
|
+
#
|
373
|
+
# {
|
374
|
+
# name: "LedgerName", # required
|
375
|
+
# }
|
376
|
+
#
|
377
|
+
# @!attribute [rw] name
|
378
|
+
# The name of the ledger.
|
379
|
+
# @return [String]
|
380
|
+
#
|
381
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/GetDigestRequest AWS API Documentation
|
382
|
+
#
|
383
|
+
class GetDigestRequest < Struct.new(
|
384
|
+
:name)
|
385
|
+
include Aws::Structure
|
386
|
+
end
|
387
|
+
|
388
|
+
# @!attribute [rw] digest
|
389
|
+
# The 256-bit hash value representing the digest returned by a
|
390
|
+
# `GetDigest` request.
|
391
|
+
# @return [String]
|
392
|
+
#
|
393
|
+
# @!attribute [rw] digest_tip_address
|
394
|
+
# The latest block location covered by the digest that you requested.
|
395
|
+
# An address is an Amazon Ion structure that has two fields:
|
396
|
+
# `strandId` and `sequenceNo`.
|
397
|
+
# @return [Types::ValueHolder]
|
398
|
+
#
|
399
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/GetDigestResponse AWS API Documentation
|
400
|
+
#
|
401
|
+
class GetDigestResponse < Struct.new(
|
402
|
+
:digest,
|
403
|
+
:digest_tip_address)
|
404
|
+
include Aws::Structure
|
405
|
+
end
|
406
|
+
|
407
|
+
# @note When making an API call, you may pass GetRevisionRequest
|
408
|
+
# data as a hash:
|
409
|
+
#
|
410
|
+
# {
|
411
|
+
# name: "LedgerName", # required
|
412
|
+
# block_address: { # required
|
413
|
+
# ion_text: "IonText",
|
414
|
+
# },
|
415
|
+
# document_id: "UniqueId", # required
|
416
|
+
# digest_tip_address: {
|
417
|
+
# ion_text: "IonText",
|
418
|
+
# },
|
419
|
+
# }
|
420
|
+
#
|
421
|
+
# @!attribute [rw] name
|
422
|
+
# The name of the ledger.
|
423
|
+
# @return [String]
|
424
|
+
#
|
425
|
+
# @!attribute [rw] block_address
|
426
|
+
# The block location of the document revision to be verified. An
|
427
|
+
# address is an Amazon Ion structure that has two fields: `strandId`
|
428
|
+
# and `sequenceNo`.
|
429
|
+
#
|
430
|
+
# For example: `\{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14\}`
|
431
|
+
# @return [Types::ValueHolder]
|
432
|
+
#
|
433
|
+
# @!attribute [rw] document_id
|
434
|
+
# The unique ID of the document to be verified.
|
435
|
+
# @return [String]
|
436
|
+
#
|
437
|
+
# @!attribute [rw] digest_tip_address
|
438
|
+
# The latest block location covered by the digest for which to request
|
439
|
+
# a proof. An address is an Amazon Ion structure that has two fields:
|
440
|
+
# `strandId` and `sequenceNo`.
|
441
|
+
#
|
442
|
+
# For example: `\{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49\}`
|
443
|
+
# @return [Types::ValueHolder]
|
444
|
+
#
|
445
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/GetRevisionRequest AWS API Documentation
|
446
|
+
#
|
447
|
+
class GetRevisionRequest < Struct.new(
|
448
|
+
:name,
|
449
|
+
:block_address,
|
450
|
+
:document_id,
|
451
|
+
:digest_tip_address)
|
452
|
+
include Aws::Structure
|
453
|
+
end
|
454
|
+
|
455
|
+
# @!attribute [rw] proof
|
456
|
+
# The proof object in Amazon Ion format returned by a `GetRevision`
|
457
|
+
# request. A proof contains the list of hash values that are required
|
458
|
+
# to recalculate the specified digest using a Merkle tree, starting
|
459
|
+
# with the specified document revision.
|
460
|
+
# @return [Types::ValueHolder]
|
461
|
+
#
|
462
|
+
# @!attribute [rw] revision
|
463
|
+
# The document revision data object in Amazon Ion format.
|
464
|
+
# @return [Types::ValueHolder]
|
465
|
+
#
|
466
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/GetRevisionResponse AWS API Documentation
|
467
|
+
#
|
468
|
+
class GetRevisionResponse < Struct.new(
|
469
|
+
:proof,
|
470
|
+
:revision)
|
471
|
+
include Aws::Structure
|
472
|
+
end
|
473
|
+
|
474
|
+
# One or more parameters in the request aren't valid.
|
475
|
+
#
|
476
|
+
# @!attribute [rw] message
|
477
|
+
# @return [String]
|
478
|
+
#
|
479
|
+
# @!attribute [rw] parameter_name
|
480
|
+
# The name of the invalid parameter.
|
481
|
+
# @return [String]
|
482
|
+
#
|
483
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/InvalidParameterException AWS API Documentation
|
484
|
+
#
|
485
|
+
class InvalidParameterException < Struct.new(
|
486
|
+
:message,
|
487
|
+
:parameter_name)
|
488
|
+
include Aws::Structure
|
489
|
+
end
|
490
|
+
|
491
|
+
# The information about a journal export job, including the ledger name,
|
492
|
+
# export ID, when it was created, current status, and its start and end
|
493
|
+
# time export parameters.
|
494
|
+
#
|
495
|
+
# @!attribute [rw] ledger_name
|
496
|
+
# The name of the ledger.
|
497
|
+
# @return [String]
|
498
|
+
#
|
499
|
+
# @!attribute [rw] export_id
|
500
|
+
# The unique ID of the journal export job.
|
501
|
+
# @return [String]
|
502
|
+
#
|
503
|
+
# @!attribute [rw] export_creation_time
|
504
|
+
# The date and time, in epoch time format, when the export job was
|
505
|
+
# created. (Epoch time format is the number of seconds elapsed since
|
506
|
+
# 12:00:00 AM January 1, 1970 UTC.)
|
507
|
+
# @return [Time]
|
508
|
+
#
|
509
|
+
# @!attribute [rw] status
|
510
|
+
# The current state of the journal export job.
|
511
|
+
# @return [String]
|
512
|
+
#
|
513
|
+
# @!attribute [rw] inclusive_start_time
|
514
|
+
# The inclusive start date and time for the range of journal contents
|
515
|
+
# that are specified in the original export request.
|
516
|
+
# @return [Time]
|
517
|
+
#
|
518
|
+
# @!attribute [rw] exclusive_end_time
|
519
|
+
# The exclusive end date and time for the range of journal contents
|
520
|
+
# that are specified in the original export request.
|
521
|
+
# @return [Time]
|
522
|
+
#
|
523
|
+
# @!attribute [rw] s3_export_configuration
|
524
|
+
# The Amazon Simple Storage Service (Amazon S3) bucket location in
|
525
|
+
# which a journal export job writes the journal contents.
|
526
|
+
# @return [Types::S3ExportConfiguration]
|
527
|
+
#
|
528
|
+
# @!attribute [rw] role_arn
|
529
|
+
# The Amazon Resource Name (ARN) of the IAM role that grants QLDB
|
530
|
+
# permissions for a journal export job to do the following:
|
531
|
+
#
|
532
|
+
# * Write objects into your Amazon Simple Storage Service (Amazon S3)
|
533
|
+
# bucket.
|
534
|
+
#
|
535
|
+
# * (Optional) Use your customer master key (CMK) in AWS Key
|
536
|
+
# Management Service (AWS KMS) for server-side encryption of your
|
537
|
+
# exported data.
|
538
|
+
# @return [String]
|
539
|
+
#
|
540
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/JournalS3ExportDescription AWS API Documentation
|
541
|
+
#
|
542
|
+
class JournalS3ExportDescription < Struct.new(
|
543
|
+
:ledger_name,
|
544
|
+
:export_id,
|
545
|
+
:export_creation_time,
|
546
|
+
:status,
|
547
|
+
:inclusive_start_time,
|
548
|
+
:exclusive_end_time,
|
549
|
+
:s3_export_configuration,
|
550
|
+
:role_arn)
|
551
|
+
include Aws::Structure
|
552
|
+
end
|
553
|
+
|
554
|
+
# Information about a ledger, including its name, state, and when it was
|
555
|
+
# created.
|
556
|
+
#
|
557
|
+
# @!attribute [rw] name
|
558
|
+
# The name of the ledger.
|
559
|
+
# @return [String]
|
560
|
+
#
|
561
|
+
# @!attribute [rw] state
|
562
|
+
# The current status of the ledger.
|
563
|
+
# @return [String]
|
564
|
+
#
|
565
|
+
# @!attribute [rw] creation_date_time
|
566
|
+
# The date and time, in epoch time format, when the ledger was
|
567
|
+
# created. (Epoch time format is the number of seconds elapsed since
|
568
|
+
# 12:00:00 AM January 1, 1970 UTC.)
|
569
|
+
# @return [Time]
|
570
|
+
#
|
571
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/LedgerSummary AWS API Documentation
|
572
|
+
#
|
573
|
+
class LedgerSummary < Struct.new(
|
574
|
+
:name,
|
575
|
+
:state,
|
576
|
+
:creation_date_time)
|
577
|
+
include Aws::Structure
|
578
|
+
end
|
579
|
+
|
580
|
+
# You have reached the limit on the maximum number of resources allowed.
|
581
|
+
#
|
582
|
+
# @!attribute [rw] message
|
583
|
+
# @return [String]
|
584
|
+
#
|
585
|
+
# @!attribute [rw] resource_type
|
586
|
+
# The type of resource.
|
587
|
+
# @return [String]
|
588
|
+
#
|
589
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/LimitExceededException AWS API Documentation
|
590
|
+
#
|
591
|
+
class LimitExceededException < Struct.new(
|
592
|
+
:message,
|
593
|
+
:resource_type)
|
594
|
+
include Aws::Structure
|
595
|
+
end
|
596
|
+
|
597
|
+
# @note When making an API call, you may pass ListJournalS3ExportsForLedgerRequest
|
598
|
+
# data as a hash:
|
599
|
+
#
|
600
|
+
# {
|
601
|
+
# name: "LedgerName", # required
|
602
|
+
# max_results: 1,
|
603
|
+
# next_token: "NextToken",
|
604
|
+
# }
|
605
|
+
#
|
606
|
+
# @!attribute [rw] name
|
607
|
+
# The name of the ledger.
|
608
|
+
# @return [String]
|
609
|
+
#
|
610
|
+
# @!attribute [rw] max_results
|
611
|
+
# The maximum number of results to return in a single
|
612
|
+
# `ListJournalS3ExportsForLedger` request. (The actual number of
|
613
|
+
# results returned might be fewer.)
|
614
|
+
# @return [Integer]
|
615
|
+
#
|
616
|
+
# @!attribute [rw] next_token
|
617
|
+
# A pagination token, indicating that you want to retrieve the next
|
618
|
+
# page of results. If you received a value for `NextToken` in the
|
619
|
+
# response from a previous `ListJournalS3ExportsForLedger` call, then
|
620
|
+
# you should use that value as input here.
|
621
|
+
# @return [String]
|
622
|
+
#
|
623
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/ListJournalS3ExportsForLedgerRequest AWS API Documentation
|
624
|
+
#
|
625
|
+
class ListJournalS3ExportsForLedgerRequest < Struct.new(
|
626
|
+
:name,
|
627
|
+
:max_results,
|
628
|
+
:next_token)
|
629
|
+
include Aws::Structure
|
630
|
+
end
|
631
|
+
|
632
|
+
# @!attribute [rw] journal_s3_exports
|
633
|
+
# The array of journal export job descriptions that are associated
|
634
|
+
# with the specified ledger.
|
635
|
+
# @return [Array<Types::JournalS3ExportDescription>]
|
636
|
+
#
|
637
|
+
# @!attribute [rw] next_token
|
638
|
+
# * If `NextToken` is empty, then the last page of results has been
|
639
|
+
# processed and there are no more results to be retrieved.
|
640
|
+
#
|
641
|
+
# * If `NextToken` is *not* empty, then there are more results
|
642
|
+
# available. To retrieve the next page of results, use the value of
|
643
|
+
# `NextToken` in a subsequent `ListJournalS3ExportsForLedger` call.
|
644
|
+
# @return [String]
|
645
|
+
#
|
646
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/ListJournalS3ExportsForLedgerResponse AWS API Documentation
|
647
|
+
#
|
648
|
+
class ListJournalS3ExportsForLedgerResponse < Struct.new(
|
649
|
+
:journal_s3_exports,
|
650
|
+
:next_token)
|
651
|
+
include Aws::Structure
|
652
|
+
end
|
653
|
+
|
654
|
+
# @note When making an API call, you may pass ListJournalS3ExportsRequest
|
655
|
+
# data as a hash:
|
656
|
+
#
|
657
|
+
# {
|
658
|
+
# max_results: 1,
|
659
|
+
# next_token: "NextToken",
|
660
|
+
# }
|
661
|
+
#
|
662
|
+
# @!attribute [rw] max_results
|
663
|
+
# The maximum number of results to return in a single
|
664
|
+
# `ListJournalS3Exports` request. (The actual number of results
|
665
|
+
# returned might be fewer.)
|
666
|
+
# @return [Integer]
|
667
|
+
#
|
668
|
+
# @!attribute [rw] next_token
|
669
|
+
# A pagination token, indicating that you want to retrieve the next
|
670
|
+
# page of results. If you received a value for `NextToken` in the
|
671
|
+
# response from a previous `ListJournalS3Exports` call, then you
|
672
|
+
# should use that value as input here.
|
673
|
+
# @return [String]
|
674
|
+
#
|
675
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/ListJournalS3ExportsRequest AWS API Documentation
|
676
|
+
#
|
677
|
+
class ListJournalS3ExportsRequest < Struct.new(
|
678
|
+
:max_results,
|
679
|
+
:next_token)
|
680
|
+
include Aws::Structure
|
681
|
+
end
|
682
|
+
|
683
|
+
# @!attribute [rw] journal_s3_exports
|
684
|
+
# The array of journal export job descriptions for all ledgers that
|
685
|
+
# are associated with the current AWS account and Region.
|
686
|
+
# @return [Array<Types::JournalS3ExportDescription>]
|
687
|
+
#
|
688
|
+
# @!attribute [rw] next_token
|
689
|
+
# * If `NextToken` is empty, then the last page of results has been
|
690
|
+
# processed and there are no more results to be retrieved.
|
691
|
+
#
|
692
|
+
# * If `NextToken` is *not* empty, then there are more results
|
693
|
+
# available. To retrieve the next page of results, use the value of
|
694
|
+
# `NextToken` in a subsequent `ListJournalS3Exports` call.
|
695
|
+
# @return [String]
|
696
|
+
#
|
697
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/ListJournalS3ExportsResponse AWS API Documentation
|
698
|
+
#
|
699
|
+
class ListJournalS3ExportsResponse < Struct.new(
|
700
|
+
:journal_s3_exports,
|
701
|
+
:next_token)
|
702
|
+
include Aws::Structure
|
703
|
+
end
|
704
|
+
|
705
|
+
# @note When making an API call, you may pass ListLedgersRequest
|
706
|
+
# data as a hash:
|
707
|
+
#
|
708
|
+
# {
|
709
|
+
# max_results: 1,
|
710
|
+
# next_token: "NextToken",
|
711
|
+
# }
|
712
|
+
#
|
713
|
+
# @!attribute [rw] max_results
|
714
|
+
# The maximum number of results to return in a single `ListLedgers`
|
715
|
+
# request. (The actual number of results returned might be fewer.)
|
716
|
+
# @return [Integer]
|
717
|
+
#
|
718
|
+
# @!attribute [rw] next_token
|
719
|
+
# A pagination token, indicating that you want to retrieve the next
|
720
|
+
# page of results. If you received a value for `NextToken` in the
|
721
|
+
# response from a previous `ListLedgers` call, then you should use
|
722
|
+
# that value as input here.
|
723
|
+
# @return [String]
|
724
|
+
#
|
725
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/ListLedgersRequest AWS API Documentation
|
726
|
+
#
|
727
|
+
class ListLedgersRequest < Struct.new(
|
728
|
+
:max_results,
|
729
|
+
:next_token)
|
730
|
+
include Aws::Structure
|
731
|
+
end
|
732
|
+
|
733
|
+
# @!attribute [rw] ledgers
|
734
|
+
# The array of ledger summaries that are associated with the current
|
735
|
+
# AWS account and Region.
|
736
|
+
# @return [Array<Types::LedgerSummary>]
|
737
|
+
#
|
738
|
+
# @!attribute [rw] next_token
|
739
|
+
# A pagination token, indicating whether there are more results
|
740
|
+
# available:
|
741
|
+
#
|
742
|
+
# * If `NextToken` is empty, then the last page of results has been
|
743
|
+
# processed and there are no more results to be retrieved.
|
744
|
+
#
|
745
|
+
# * If `NextToken` is *not* empty, then there are more results
|
746
|
+
# available. To retrieve the next page of results, use the value of
|
747
|
+
# `NextToken` in a subsequent `ListLedgers` call.
|
748
|
+
# @return [String]
|
749
|
+
#
|
750
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/ListLedgersResponse AWS API Documentation
|
751
|
+
#
|
752
|
+
class ListLedgersResponse < Struct.new(
|
753
|
+
:ledgers,
|
754
|
+
:next_token)
|
755
|
+
include Aws::Structure
|
756
|
+
end
|
757
|
+
|
758
|
+
# @note When making an API call, you may pass ListTagsForResourceRequest
|
759
|
+
# data as a hash:
|
760
|
+
#
|
761
|
+
# {
|
762
|
+
# resource_arn: "Arn", # required
|
763
|
+
# }
|
764
|
+
#
|
765
|
+
# @!attribute [rw] resource_arn
|
766
|
+
# The Amazon Resource Name (ARN) for which you want to list the tags.
|
767
|
+
# For example:
|
768
|
+
#
|
769
|
+
# `arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger`
|
770
|
+
# @return [String]
|
771
|
+
#
|
772
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/ListTagsForResourceRequest AWS API Documentation
|
773
|
+
#
|
774
|
+
class ListTagsForResourceRequest < Struct.new(
|
775
|
+
:resource_arn)
|
776
|
+
include Aws::Structure
|
777
|
+
end
|
778
|
+
|
779
|
+
# @!attribute [rw] tags
|
780
|
+
# The tags that are currently associated with the specified Amazon
|
781
|
+
# QLDB resource.
|
782
|
+
# @return [Hash<String,String>]
|
783
|
+
#
|
784
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/ListTagsForResourceResponse AWS API Documentation
|
785
|
+
#
|
786
|
+
class ListTagsForResourceResponse < Struct.new(
|
787
|
+
:tags)
|
788
|
+
include Aws::Structure
|
789
|
+
end
|
790
|
+
|
791
|
+
# The specified resource already exists.
|
792
|
+
#
|
793
|
+
# @!attribute [rw] message
|
794
|
+
# @return [String]
|
795
|
+
#
|
796
|
+
# @!attribute [rw] resource_type
|
797
|
+
# The type of resource.
|
798
|
+
# @return [String]
|
799
|
+
#
|
800
|
+
# @!attribute [rw] resource_name
|
801
|
+
# The name of the resource.
|
802
|
+
# @return [String]
|
803
|
+
#
|
804
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/ResourceAlreadyExistsException AWS API Documentation
|
805
|
+
#
|
806
|
+
class ResourceAlreadyExistsException < Struct.new(
|
807
|
+
:message,
|
808
|
+
:resource_type,
|
809
|
+
:resource_name)
|
810
|
+
include Aws::Structure
|
811
|
+
end
|
812
|
+
|
813
|
+
# The specified resource can't be modified at this time.
|
814
|
+
#
|
815
|
+
# @!attribute [rw] message
|
816
|
+
# @return [String]
|
817
|
+
#
|
818
|
+
# @!attribute [rw] resource_type
|
819
|
+
# The type of resource.
|
820
|
+
# @return [String]
|
821
|
+
#
|
822
|
+
# @!attribute [rw] resource_name
|
823
|
+
# The name of the resource.
|
824
|
+
# @return [String]
|
825
|
+
#
|
826
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/ResourceInUseException AWS API Documentation
|
827
|
+
#
|
828
|
+
class ResourceInUseException < Struct.new(
|
829
|
+
:message,
|
830
|
+
:resource_type,
|
831
|
+
:resource_name)
|
832
|
+
include Aws::Structure
|
833
|
+
end
|
834
|
+
|
835
|
+
# The specified resource doesn't exist.
|
836
|
+
#
|
837
|
+
# @!attribute [rw] message
|
838
|
+
# @return [String]
|
839
|
+
#
|
840
|
+
# @!attribute [rw] resource_type
|
841
|
+
# The type of resource.
|
842
|
+
# @return [String]
|
843
|
+
#
|
844
|
+
# @!attribute [rw] resource_name
|
845
|
+
# The name of the resource.
|
846
|
+
# @return [String]
|
847
|
+
#
|
848
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/ResourceNotFoundException AWS API Documentation
|
849
|
+
#
|
850
|
+
class ResourceNotFoundException < Struct.new(
|
851
|
+
:message,
|
852
|
+
:resource_type,
|
853
|
+
:resource_name)
|
854
|
+
include Aws::Structure
|
855
|
+
end
|
856
|
+
|
857
|
+
# The operation failed because a condition wasn't satisfied in advance.
|
858
|
+
#
|
859
|
+
# @!attribute [rw] message
|
860
|
+
# @return [String]
|
861
|
+
#
|
862
|
+
# @!attribute [rw] resource_type
|
863
|
+
# The type of resource.
|
864
|
+
# @return [String]
|
865
|
+
#
|
866
|
+
# @!attribute [rw] resource_name
|
867
|
+
# The name of the resource.
|
868
|
+
# @return [String]
|
869
|
+
#
|
870
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/ResourcePreconditionNotMetException AWS API Documentation
|
871
|
+
#
|
872
|
+
class ResourcePreconditionNotMetException < Struct.new(
|
873
|
+
:message,
|
874
|
+
:resource_type,
|
875
|
+
:resource_name)
|
876
|
+
include Aws::Structure
|
877
|
+
end
|
878
|
+
|
879
|
+
# The encryption settings that are used by a journal export job to write
|
880
|
+
# data in an Amazon Simple Storage Service (Amazon S3) bucket.
|
881
|
+
#
|
882
|
+
# @note When making an API call, you may pass S3EncryptionConfiguration
|
883
|
+
# data as a hash:
|
884
|
+
#
|
885
|
+
# {
|
886
|
+
# object_encryption_type: "SSE_KMS", # required, accepts SSE_KMS, SSE_S3, NO_ENCRYPTION
|
887
|
+
# kms_key_arn: "Arn",
|
888
|
+
# }
|
889
|
+
#
|
890
|
+
# @!attribute [rw] object_encryption_type
|
891
|
+
# The Amazon S3 object encryption type.
|
892
|
+
#
|
893
|
+
# To learn more about server-side encryption options in Amazon S3, see
|
894
|
+
# [Protecting Data Using Server-Side Encryption][1] in the *Amazon S3
|
895
|
+
# Developer Guide*.
|
896
|
+
#
|
897
|
+
#
|
898
|
+
#
|
899
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html
|
900
|
+
# @return [String]
|
901
|
+
#
|
902
|
+
# @!attribute [rw] kms_key_arn
|
903
|
+
# The Amazon Resource Name (ARN) for a customer master key (CMK) in
|
904
|
+
# AWS Key Management Service (AWS KMS).
|
905
|
+
#
|
906
|
+
# You must provide a `KmsKeyArn` if you specify `SSE_KMS` as the
|
907
|
+
# `ObjectEncryptionType`.
|
908
|
+
#
|
909
|
+
# `KmsKeyArn` is not required if you specify `SSE_S3` as the
|
910
|
+
# `ObjectEncryptionType`.
|
911
|
+
# @return [String]
|
912
|
+
#
|
913
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/S3EncryptionConfiguration AWS API Documentation
|
914
|
+
#
|
915
|
+
class S3EncryptionConfiguration < Struct.new(
|
916
|
+
:object_encryption_type,
|
917
|
+
:kms_key_arn)
|
918
|
+
include Aws::Structure
|
919
|
+
end
|
920
|
+
|
921
|
+
# The Amazon Simple Storage Service (Amazon S3) bucket location in which
|
922
|
+
# a journal export job writes the journal contents.
|
923
|
+
#
|
924
|
+
# @note When making an API call, you may pass S3ExportConfiguration
|
925
|
+
# data as a hash:
|
926
|
+
#
|
927
|
+
# {
|
928
|
+
# bucket: "S3Bucket", # required
|
929
|
+
# prefix: "S3Prefix", # required
|
930
|
+
# encryption_configuration: { # required
|
931
|
+
# object_encryption_type: "SSE_KMS", # required, accepts SSE_KMS, SSE_S3, NO_ENCRYPTION
|
932
|
+
# kms_key_arn: "Arn",
|
933
|
+
# },
|
934
|
+
# }
|
935
|
+
#
|
936
|
+
# @!attribute [rw] bucket
|
937
|
+
# The Amazon S3 bucket name in which a journal export job writes the
|
938
|
+
# journal contents.
|
939
|
+
#
|
940
|
+
# The bucket name must comply with the Amazon S3 bucket naming
|
941
|
+
# conventions. For more information, see [Bucket Restrictions and
|
942
|
+
# Limitations][1] in the *Amazon S3 Developer Guide*.
|
943
|
+
#
|
944
|
+
#
|
945
|
+
#
|
946
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html
|
947
|
+
# @return [String]
|
948
|
+
#
|
949
|
+
# @!attribute [rw] prefix
|
950
|
+
# The prefix for the Amazon S3 bucket in which a journal export job
|
951
|
+
# writes the journal contents.
|
952
|
+
#
|
953
|
+
# The prefix must comply with Amazon S3 key naming rules and
|
954
|
+
# restrictions. For more information, see [Object Key and Metadata][1]
|
955
|
+
# in the *Amazon S3 Developer Guide*.
|
956
|
+
#
|
957
|
+
# The following are examples of valid `Prefix` values:
|
958
|
+
#
|
959
|
+
# * `JournalExports-ForMyLedger/Testing/`
|
960
|
+
#
|
961
|
+
# * `JournalExports`
|
962
|
+
#
|
963
|
+
# * `My:Tests/`
|
964
|
+
#
|
965
|
+
#
|
966
|
+
#
|
967
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html
|
968
|
+
# @return [String]
|
969
|
+
#
|
970
|
+
# @!attribute [rw] encryption_configuration
|
971
|
+
# The encryption settings that are used by a journal export job to
|
972
|
+
# write data in an Amazon S3 bucket.
|
973
|
+
# @return [Types::S3EncryptionConfiguration]
|
974
|
+
#
|
975
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/S3ExportConfiguration AWS API Documentation
|
976
|
+
#
|
977
|
+
class S3ExportConfiguration < Struct.new(
|
978
|
+
:bucket,
|
979
|
+
:prefix,
|
980
|
+
:encryption_configuration)
|
981
|
+
include Aws::Structure
|
982
|
+
end
|
983
|
+
|
984
|
+
# @note When making an API call, you may pass TagResourceRequest
|
985
|
+
# data as a hash:
|
986
|
+
#
|
987
|
+
# {
|
988
|
+
# resource_arn: "Arn", # required
|
989
|
+
# tags: { # required
|
990
|
+
# "TagKey" => "TagValue",
|
991
|
+
# },
|
992
|
+
# }
|
993
|
+
#
|
994
|
+
# @!attribute [rw] resource_arn
|
995
|
+
# The Amazon Resource Name (ARN) to which you want to add the tags.
|
996
|
+
# For example:
|
997
|
+
#
|
998
|
+
# `arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger`
|
999
|
+
# @return [String]
|
1000
|
+
#
|
1001
|
+
# @!attribute [rw] tags
|
1002
|
+
# The key-value pairs to add as tags to the specified QLDB resource.
|
1003
|
+
# Tag keys are case sensitive. If you specify a key that already
|
1004
|
+
# exists for the resource, your request fails and returns an error.
|
1005
|
+
# Tag values are case sensitive and can be null.
|
1006
|
+
# @return [Hash<String,String>]
|
1007
|
+
#
|
1008
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/TagResourceRequest AWS API Documentation
|
1009
|
+
#
|
1010
|
+
class TagResourceRequest < Struct.new(
|
1011
|
+
:resource_arn,
|
1012
|
+
:tags)
|
1013
|
+
include Aws::Structure
|
1014
|
+
end
|
1015
|
+
|
1016
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/TagResourceResponse AWS API Documentation
|
1017
|
+
#
|
1018
|
+
class TagResourceResponse < Aws::EmptyStructure; end
|
1019
|
+
|
1020
|
+
# @note When making an API call, you may pass UntagResourceRequest
|
1021
|
+
# data as a hash:
|
1022
|
+
#
|
1023
|
+
# {
|
1024
|
+
# resource_arn: "Arn", # required
|
1025
|
+
# tag_keys: ["TagKey"], # required
|
1026
|
+
# }
|
1027
|
+
#
|
1028
|
+
# @!attribute [rw] resource_arn
|
1029
|
+
# The Amazon Resource Name (ARN) from which you want to remove the
|
1030
|
+
# tags. For example:
|
1031
|
+
#
|
1032
|
+
# `arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger`
|
1033
|
+
# @return [String]
|
1034
|
+
#
|
1035
|
+
# @!attribute [rw] tag_keys
|
1036
|
+
# The list of tag keys that you want to remove.
|
1037
|
+
# @return [Array<String>]
|
1038
|
+
#
|
1039
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/UntagResourceRequest AWS API Documentation
|
1040
|
+
#
|
1041
|
+
class UntagResourceRequest < Struct.new(
|
1042
|
+
:resource_arn,
|
1043
|
+
:tag_keys)
|
1044
|
+
include Aws::Structure
|
1045
|
+
end
|
1046
|
+
|
1047
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/UntagResourceResponse AWS API Documentation
|
1048
|
+
#
|
1049
|
+
class UntagResourceResponse < Aws::EmptyStructure; end
|
1050
|
+
|
1051
|
+
# @note When making an API call, you may pass UpdateLedgerRequest
|
1052
|
+
# data as a hash:
|
1053
|
+
#
|
1054
|
+
# {
|
1055
|
+
# name: "LedgerName", # required
|
1056
|
+
# deletion_protection: false,
|
1057
|
+
# }
|
1058
|
+
#
|
1059
|
+
# @!attribute [rw] name
|
1060
|
+
# The name of the ledger.
|
1061
|
+
# @return [String]
|
1062
|
+
#
|
1063
|
+
# @!attribute [rw] deletion_protection
|
1064
|
+
# The flag that prevents a ledger from being deleted by any user. If
|
1065
|
+
# not provided on ledger creation, this feature is enabled (`true`) by
|
1066
|
+
# default.
|
1067
|
+
#
|
1068
|
+
# If deletion protection is enabled, you must first disable it before
|
1069
|
+
# you can delete the ledger using the QLDB API or the AWS Command Line
|
1070
|
+
# Interface (AWS CLI). You can disable it by calling the
|
1071
|
+
# `UpdateLedger` operation to set the flag to `false`. The QLDB
|
1072
|
+
# console disables deletion protection for you when you use it to
|
1073
|
+
# delete a ledger.
|
1074
|
+
# @return [Boolean]
|
1075
|
+
#
|
1076
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/UpdateLedgerRequest AWS API Documentation
|
1077
|
+
#
|
1078
|
+
class UpdateLedgerRequest < Struct.new(
|
1079
|
+
:name,
|
1080
|
+
:deletion_protection)
|
1081
|
+
include Aws::Structure
|
1082
|
+
end
|
1083
|
+
|
1084
|
+
# @!attribute [rw] name
|
1085
|
+
# The name of the ledger.
|
1086
|
+
# @return [String]
|
1087
|
+
#
|
1088
|
+
# @!attribute [rw] arn
|
1089
|
+
# The Amazon Resource Name (ARN) for the ledger.
|
1090
|
+
# @return [String]
|
1091
|
+
#
|
1092
|
+
# @!attribute [rw] state
|
1093
|
+
# The current status of the ledger.
|
1094
|
+
# @return [String]
|
1095
|
+
#
|
1096
|
+
# @!attribute [rw] creation_date_time
|
1097
|
+
# The date and time, in epoch time format, when the ledger was
|
1098
|
+
# created. (Epoch time format is the number of seconds elapsed since
|
1099
|
+
# 12:00:00 AM January 1, 1970 UTC.)
|
1100
|
+
# @return [Time]
|
1101
|
+
#
|
1102
|
+
# @!attribute [rw] deletion_protection
|
1103
|
+
# The flag that prevents a ledger from being deleted by any user. If
|
1104
|
+
# not provided on ledger creation, this feature is enabled (`true`) by
|
1105
|
+
# default.
|
1106
|
+
#
|
1107
|
+
# If deletion protection is enabled, you must first disable it before
|
1108
|
+
# you can delete the ledger using the QLDB API or the AWS Command Line
|
1109
|
+
# Interface (AWS CLI). You can disable it by calling the
|
1110
|
+
# `UpdateLedger` operation to set the flag to `false`. The QLDB
|
1111
|
+
# console disables deletion protection for you when you use it to
|
1112
|
+
# delete a ledger.
|
1113
|
+
# @return [Boolean]
|
1114
|
+
#
|
1115
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/UpdateLedgerResponse AWS API Documentation
|
1116
|
+
#
|
1117
|
+
class UpdateLedgerResponse < Struct.new(
|
1118
|
+
:name,
|
1119
|
+
:arn,
|
1120
|
+
:state,
|
1121
|
+
:creation_date_time,
|
1122
|
+
:deletion_protection)
|
1123
|
+
include Aws::Structure
|
1124
|
+
end
|
1125
|
+
|
1126
|
+
# A structure that can contain an Amazon Ion value in multiple encoding
|
1127
|
+
# formats.
|
1128
|
+
#
|
1129
|
+
# @note When making an API call, you may pass ValueHolder
|
1130
|
+
# data as a hash:
|
1131
|
+
#
|
1132
|
+
# {
|
1133
|
+
# ion_text: "IonText",
|
1134
|
+
# }
|
1135
|
+
#
|
1136
|
+
# @!attribute [rw] ion_text
|
1137
|
+
# An Amazon Ion plaintext value contained in a `ValueHolder`
|
1138
|
+
# structure.
|
1139
|
+
# @return [String]
|
1140
|
+
#
|
1141
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/ValueHolder AWS API Documentation
|
1142
|
+
#
|
1143
|
+
class ValueHolder < Struct.new(
|
1144
|
+
:ion_text)
|
1145
|
+
include Aws::Structure
|
1146
|
+
end
|
1147
|
+
|
1148
|
+
end
|
1149
|
+
end
|