aws-sdk-qldb 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- 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
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 461e049d211c13ead1d6ad8ff903300dccd46e1a
|
4
|
+
data.tar.gz: 3ee92d1e0afcaf23e2f826f81ebfb46a48159979
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 7d71e962fd98ec2a85fdd51713116f5fb73dea238f654931807f0185be358b46187f9d1e55c28778c9bc80037dd4257ebe9019af8840f1653cea255d0c477094
|
7
|
+
data.tar.gz: d96bc902e2452d910fba1958894adf5d5d4f84394f23def404dad64e7ee1974f0bf73723e0f0f4759e3261826a3a2ff49e539bd2fe236092d96cc89019d90b46
|
data/lib/aws-sdk-qldb.rb
ADDED
@@ -0,0 +1,47 @@
|
|
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
|
+
require 'aws-sdk-core'
|
9
|
+
require 'aws-sigv4'
|
10
|
+
|
11
|
+
require_relative 'aws-sdk-qldb/types'
|
12
|
+
require_relative 'aws-sdk-qldb/client_api'
|
13
|
+
require_relative 'aws-sdk-qldb/client'
|
14
|
+
require_relative 'aws-sdk-qldb/errors'
|
15
|
+
require_relative 'aws-sdk-qldb/resource'
|
16
|
+
require_relative 'aws-sdk-qldb/customizations'
|
17
|
+
|
18
|
+
# This module provides support for Amazon QLDB. This module is available in the
|
19
|
+
# `aws-sdk-qldb` gem.
|
20
|
+
#
|
21
|
+
# # Client
|
22
|
+
#
|
23
|
+
# The {Client} class provides one method for each API operation. Operation
|
24
|
+
# methods each accept a hash of request parameters and return a response
|
25
|
+
# structure.
|
26
|
+
#
|
27
|
+
# See {Client} for more information.
|
28
|
+
#
|
29
|
+
# # Errors
|
30
|
+
#
|
31
|
+
# Errors returned from Amazon QLDB all
|
32
|
+
# extend {Errors::ServiceError}.
|
33
|
+
#
|
34
|
+
# begin
|
35
|
+
# # do stuff
|
36
|
+
# rescue Aws::QLDB::Errors::ServiceError
|
37
|
+
# # rescues all service API errors
|
38
|
+
# end
|
39
|
+
#
|
40
|
+
# See {Errors} for more information.
|
41
|
+
#
|
42
|
+
# @service
|
43
|
+
module Aws::QLDB
|
44
|
+
|
45
|
+
GEM_VERSION = '1.0.0'
|
46
|
+
|
47
|
+
end
|
@@ -0,0 +1,1013 @@
|
|
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
|
+
require 'seahorse/client/plugins/content_length.rb'
|
9
|
+
require 'aws-sdk-core/plugins/credentials_configuration.rb'
|
10
|
+
require 'aws-sdk-core/plugins/logging.rb'
|
11
|
+
require 'aws-sdk-core/plugins/param_converter.rb'
|
12
|
+
require 'aws-sdk-core/plugins/param_validator.rb'
|
13
|
+
require 'aws-sdk-core/plugins/user_agent.rb'
|
14
|
+
require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
|
15
|
+
require 'aws-sdk-core/plugins/retry_errors.rb'
|
16
|
+
require 'aws-sdk-core/plugins/global_configuration.rb'
|
17
|
+
require 'aws-sdk-core/plugins/regional_endpoint.rb'
|
18
|
+
require 'aws-sdk-core/plugins/endpoint_discovery.rb'
|
19
|
+
require 'aws-sdk-core/plugins/endpoint_pattern.rb'
|
20
|
+
require 'aws-sdk-core/plugins/response_paging.rb'
|
21
|
+
require 'aws-sdk-core/plugins/stub_responses.rb'
|
22
|
+
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
23
|
+
require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
24
|
+
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
25
|
+
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
26
|
+
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
27
|
+
require 'aws-sdk-core/plugins/signature_v4.rb'
|
28
|
+
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
29
|
+
|
30
|
+
Aws::Plugins::GlobalConfiguration.add_identifier(:qldb)
|
31
|
+
|
32
|
+
module Aws::QLDB
|
33
|
+
class Client < Seahorse::Client::Base
|
34
|
+
|
35
|
+
include Aws::ClientStubs
|
36
|
+
|
37
|
+
@identifier = :qldb
|
38
|
+
|
39
|
+
set_api(ClientApi::API)
|
40
|
+
|
41
|
+
add_plugin(Seahorse::Client::Plugins::ContentLength)
|
42
|
+
add_plugin(Aws::Plugins::CredentialsConfiguration)
|
43
|
+
add_plugin(Aws::Plugins::Logging)
|
44
|
+
add_plugin(Aws::Plugins::ParamConverter)
|
45
|
+
add_plugin(Aws::Plugins::ParamValidator)
|
46
|
+
add_plugin(Aws::Plugins::UserAgent)
|
47
|
+
add_plugin(Aws::Plugins::HelpfulSocketErrors)
|
48
|
+
add_plugin(Aws::Plugins::RetryErrors)
|
49
|
+
add_plugin(Aws::Plugins::GlobalConfiguration)
|
50
|
+
add_plugin(Aws::Plugins::RegionalEndpoint)
|
51
|
+
add_plugin(Aws::Plugins::EndpointDiscovery)
|
52
|
+
add_plugin(Aws::Plugins::EndpointPattern)
|
53
|
+
add_plugin(Aws::Plugins::ResponsePaging)
|
54
|
+
add_plugin(Aws::Plugins::StubResponses)
|
55
|
+
add_plugin(Aws::Plugins::IdempotencyToken)
|
56
|
+
add_plugin(Aws::Plugins::JsonvalueConverter)
|
57
|
+
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
58
|
+
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
59
|
+
add_plugin(Aws::Plugins::TransferEncoding)
|
60
|
+
add_plugin(Aws::Plugins::SignatureV4)
|
61
|
+
add_plugin(Aws::Plugins::Protocols::RestJson)
|
62
|
+
|
63
|
+
# @overload initialize(options)
|
64
|
+
# @param [Hash] options
|
65
|
+
# @option options [required, Aws::CredentialProvider] :credentials
|
66
|
+
# Your AWS credentials. This can be an instance of any one of the
|
67
|
+
# following classes:
|
68
|
+
#
|
69
|
+
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
70
|
+
# credentials.
|
71
|
+
#
|
72
|
+
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
73
|
+
# from an EC2 IMDS on an EC2 instance.
|
74
|
+
#
|
75
|
+
# * `Aws::SharedCredentials` - Used for loading credentials from a
|
76
|
+
# shared file, such as `~/.aws/config`.
|
77
|
+
#
|
78
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
79
|
+
#
|
80
|
+
# When `:credentials` are not configured directly, the following
|
81
|
+
# locations will be searched for credentials:
|
82
|
+
#
|
83
|
+
# * `Aws.config[:credentials]`
|
84
|
+
# * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
|
85
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
86
|
+
# * `~/.aws/credentials`
|
87
|
+
# * `~/.aws/config`
|
88
|
+
# * EC2 IMDS instance profile - When used by default, the timeouts are
|
89
|
+
# very aggressive. Construct and pass an instance of
|
90
|
+
# `Aws::InstanceProfileCredentails` to enable retries and extended
|
91
|
+
# timeouts.
|
92
|
+
#
|
93
|
+
# @option options [required, String] :region
|
94
|
+
# The AWS region to connect to. The configured `:region` is
|
95
|
+
# used to determine the service `:endpoint`. When not passed,
|
96
|
+
# a default `:region` is search for in the following locations:
|
97
|
+
#
|
98
|
+
# * `Aws.config[:region]`
|
99
|
+
# * `ENV['AWS_REGION']`
|
100
|
+
# * `ENV['AMAZON_REGION']`
|
101
|
+
# * `ENV['AWS_DEFAULT_REGION']`
|
102
|
+
# * `~/.aws/credentials`
|
103
|
+
# * `~/.aws/config`
|
104
|
+
#
|
105
|
+
# @option options [String] :access_key_id
|
106
|
+
#
|
107
|
+
# @option options [Boolean] :active_endpoint_cache (false)
|
108
|
+
# When set to `true`, a thread polling for endpoints will be running in
|
109
|
+
# the background every 60 secs (default). Defaults to `false`.
|
110
|
+
#
|
111
|
+
# @option options [Boolean] :client_side_monitoring (false)
|
112
|
+
# When `true`, client-side metrics will be collected for all API requests from
|
113
|
+
# this client.
|
114
|
+
#
|
115
|
+
# @option options [String] :client_side_monitoring_client_id ("")
|
116
|
+
# Allows you to provide an identifier for this client which will be attached to
|
117
|
+
# all generated client side metrics. Defaults to an empty string.
|
118
|
+
#
|
119
|
+
# @option options [String] :client_side_monitoring_host ("127.0.0.1")
|
120
|
+
# Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
|
121
|
+
# side monitoring agent is running on, where client metrics will be published via UDP.
|
122
|
+
#
|
123
|
+
# @option options [Integer] :client_side_monitoring_port (31000)
|
124
|
+
# Required for publishing client metrics. The port that the client side monitoring
|
125
|
+
# agent is running on, where client metrics will be published via UDP.
|
126
|
+
#
|
127
|
+
# @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
|
128
|
+
# Allows you to provide a custom client-side monitoring publisher class. By default,
|
129
|
+
# will use the Client Side Monitoring Agent Publisher.
|
130
|
+
#
|
131
|
+
# @option options [Boolean] :convert_params (true)
|
132
|
+
# When `true`, an attempt is made to coerce request parameters into
|
133
|
+
# the required types.
|
134
|
+
#
|
135
|
+
# @option options [Boolean] :disable_host_prefix_injection (false)
|
136
|
+
# Set to true to disable SDK automatically adding host prefix
|
137
|
+
# to default service endpoint when available.
|
138
|
+
#
|
139
|
+
# @option options [String] :endpoint
|
140
|
+
# The client endpoint is normally constructed from the `:region`
|
141
|
+
# option. You should only configure an `:endpoint` when connecting
|
142
|
+
# to test endpoints. This should be avalid HTTP(S) URI.
|
143
|
+
#
|
144
|
+
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
145
|
+
# Used for the maximum size limit of the LRU cache storing endpoints data
|
146
|
+
# for endpoint discovery enabled operations. Defaults to 1000.
|
147
|
+
#
|
148
|
+
# @option options [Integer] :endpoint_cache_max_threads (10)
|
149
|
+
# Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
|
150
|
+
#
|
151
|
+
# @option options [Integer] :endpoint_cache_poll_interval (60)
|
152
|
+
# When :endpoint_discovery and :active_endpoint_cache is enabled,
|
153
|
+
# Use this option to config the time interval in seconds for making
|
154
|
+
# requests fetching endpoints information. Defaults to 60 sec.
|
155
|
+
#
|
156
|
+
# @option options [Boolean] :endpoint_discovery (false)
|
157
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
|
158
|
+
#
|
159
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
160
|
+
# The log formatter.
|
161
|
+
#
|
162
|
+
# @option options [Symbol] :log_level (:info)
|
163
|
+
# The log level to send messages to the `:logger` at.
|
164
|
+
#
|
165
|
+
# @option options [Logger] :logger
|
166
|
+
# The Logger instance to send log messages to. If this option
|
167
|
+
# is not set, logging will be disabled.
|
168
|
+
#
|
169
|
+
# @option options [String] :profile ("default")
|
170
|
+
# Used when loading credentials from the shared credentials file
|
171
|
+
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
172
|
+
#
|
173
|
+
# @option options [Float] :retry_base_delay (0.3)
|
174
|
+
# The base delay in seconds used by the default backoff function.
|
175
|
+
#
|
176
|
+
# @option options [Symbol] :retry_jitter (:none)
|
177
|
+
# A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
|
178
|
+
#
|
179
|
+
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
180
|
+
#
|
181
|
+
# @option options [Integer] :retry_limit (3)
|
182
|
+
# The maximum number of times to retry failed requests. Only
|
183
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
184
|
+
# are retried. Generally, these are throttling errors, data
|
185
|
+
# checksum errors, networking errors, timeout errors and auth
|
186
|
+
# errors from expired credentials.
|
187
|
+
#
|
188
|
+
# @option options [Integer] :retry_max_delay (0)
|
189
|
+
# The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
|
190
|
+
#
|
191
|
+
# @option options [String] :secret_access_key
|
192
|
+
#
|
193
|
+
# @option options [String] :session_token
|
194
|
+
#
|
195
|
+
# @option options [Boolean] :stub_responses (false)
|
196
|
+
# Causes the client to return stubbed responses. By default
|
197
|
+
# fake responses are generated and returned. You can specify
|
198
|
+
# the response data to return or errors to raise by calling
|
199
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
200
|
+
#
|
201
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
202
|
+
# requests are made, and retries are disabled.
|
203
|
+
#
|
204
|
+
# @option options [Boolean] :validate_params (true)
|
205
|
+
# When `true`, request parameters are validated before
|
206
|
+
# sending the request.
|
207
|
+
#
|
208
|
+
# @option options [URI::HTTP,String] :http_proxy A proxy to send
|
209
|
+
# requests through. Formatted like 'http://proxy.com:123'.
|
210
|
+
#
|
211
|
+
# @option options [Float] :http_open_timeout (15) The number of
|
212
|
+
# seconds to wait when opening a HTTP session before rasing a
|
213
|
+
# `Timeout::Error`.
|
214
|
+
#
|
215
|
+
# @option options [Integer] :http_read_timeout (60) The default
|
216
|
+
# number of seconds to wait for response data. This value can
|
217
|
+
# safely be set
|
218
|
+
# per-request on the session yeidled by {#session_for}.
|
219
|
+
#
|
220
|
+
# @option options [Float] :http_idle_timeout (5) The number of
|
221
|
+
# seconds a connection is allowed to sit idble before it is
|
222
|
+
# considered stale. Stale connections are closed and removed
|
223
|
+
# from the pool before making a request.
|
224
|
+
#
|
225
|
+
# @option options [Float] :http_continue_timeout (1) The number of
|
226
|
+
# seconds to wait for a 100-continue response before sending the
|
227
|
+
# request body. This option has no effect unless the request has
|
228
|
+
# "Expect" header set to "100-continue". Defaults to `nil` which
|
229
|
+
# disables this behaviour. This value can safely be set per
|
230
|
+
# request on the session yeidled by {#session_for}.
|
231
|
+
#
|
232
|
+
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
233
|
+
# HTTP debug output will be sent to the `:logger`.
|
234
|
+
#
|
235
|
+
# @option options [Boolean] :ssl_verify_peer (true) When `true`,
|
236
|
+
# SSL peer certificates are verified when establishing a
|
237
|
+
# connection.
|
238
|
+
#
|
239
|
+
# @option options [String] :ssl_ca_bundle Full path to the SSL
|
240
|
+
# certificate authority bundle file that should be used when
|
241
|
+
# verifying peer certificates. If you do not pass
|
242
|
+
# `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
|
243
|
+
# will be used if available.
|
244
|
+
#
|
245
|
+
# @option options [String] :ssl_ca_directory Full path of the
|
246
|
+
# directory that contains the unbundled SSL certificate
|
247
|
+
# authority files for verifying peer certificates. If you do
|
248
|
+
# not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
|
249
|
+
# system default will be used if available.
|
250
|
+
#
|
251
|
+
def initialize(*args)
|
252
|
+
super
|
253
|
+
end
|
254
|
+
|
255
|
+
# @!group API Operations
|
256
|
+
|
257
|
+
# Creates a new ledger in your AWS account.
|
258
|
+
#
|
259
|
+
# @option params [required, String] :name
|
260
|
+
# The name of the ledger that you want to create. The name must be
|
261
|
+
# unique among all of your ledgers in the current AWS Region.
|
262
|
+
#
|
263
|
+
# @option params [Hash<String,String>] :tags
|
264
|
+
# The key-value pairs to add as tags to the ledger that you want to
|
265
|
+
# create. Tag keys are case sensitive. Tag values are case sensitive and
|
266
|
+
# can be null.
|
267
|
+
#
|
268
|
+
# @option params [required, String] :permissions_mode
|
269
|
+
# The permissions mode to assign to the ledger that you want to create.
|
270
|
+
#
|
271
|
+
# @option params [Boolean] :deletion_protection
|
272
|
+
# The flag that prevents a ledger from being deleted by any user. If not
|
273
|
+
# provided on ledger creation, this feature is enabled (`true`) by
|
274
|
+
# default.
|
275
|
+
#
|
276
|
+
# If deletion protection is enabled, you must first disable it before
|
277
|
+
# you can delete the ledger using the QLDB API or the AWS Command Line
|
278
|
+
# Interface (AWS CLI). You can disable it by calling the `UpdateLedger`
|
279
|
+
# operation to set the flag to `false`. The QLDB console disables
|
280
|
+
# deletion protection for you when you use it to delete a ledger.
|
281
|
+
#
|
282
|
+
# @return [Types::CreateLedgerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
283
|
+
#
|
284
|
+
# * {Types::CreateLedgerResponse#name #name} => String
|
285
|
+
# * {Types::CreateLedgerResponse#arn #arn} => String
|
286
|
+
# * {Types::CreateLedgerResponse#state #state} => String
|
287
|
+
# * {Types::CreateLedgerResponse#creation_date_time #creation_date_time} => Time
|
288
|
+
# * {Types::CreateLedgerResponse#deletion_protection #deletion_protection} => Boolean
|
289
|
+
#
|
290
|
+
# @example Request syntax with placeholder values
|
291
|
+
#
|
292
|
+
# resp = client.create_ledger({
|
293
|
+
# name: "LedgerName", # required
|
294
|
+
# tags: {
|
295
|
+
# "TagKey" => "TagValue",
|
296
|
+
# },
|
297
|
+
# permissions_mode: "ALLOW_ALL", # required, accepts ALLOW_ALL
|
298
|
+
# deletion_protection: false,
|
299
|
+
# })
|
300
|
+
#
|
301
|
+
# @example Response structure
|
302
|
+
#
|
303
|
+
# resp.name #=> String
|
304
|
+
# resp.arn #=> String
|
305
|
+
# resp.state #=> String, one of "CREATING", "ACTIVE", "DELETING", "DELETED"
|
306
|
+
# resp.creation_date_time #=> Time
|
307
|
+
# resp.deletion_protection #=> Boolean
|
308
|
+
#
|
309
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/CreateLedger AWS API Documentation
|
310
|
+
#
|
311
|
+
# @overload create_ledger(params = {})
|
312
|
+
# @param [Hash] params ({})
|
313
|
+
def create_ledger(params = {}, options = {})
|
314
|
+
req = build_request(:create_ledger, params)
|
315
|
+
req.send_request(options)
|
316
|
+
end
|
317
|
+
|
318
|
+
# Deletes a ledger and all of its contents. This action is irreversible.
|
319
|
+
#
|
320
|
+
# If deletion protection is enabled, you must first disable it before
|
321
|
+
# you can delete the ledger using the QLDB API or the AWS Command Line
|
322
|
+
# Interface (AWS CLI). You can disable it by calling the `UpdateLedger`
|
323
|
+
# operation to set the flag to `false`. The QLDB console disables
|
324
|
+
# deletion protection for you when you use it to delete a ledger.
|
325
|
+
#
|
326
|
+
# @option params [required, String] :name
|
327
|
+
# The name of the ledger that you want to delete.
|
328
|
+
#
|
329
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
330
|
+
#
|
331
|
+
# @example Request syntax with placeholder values
|
332
|
+
#
|
333
|
+
# resp = client.delete_ledger({
|
334
|
+
# name: "LedgerName", # required
|
335
|
+
# })
|
336
|
+
#
|
337
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/DeleteLedger AWS API Documentation
|
338
|
+
#
|
339
|
+
# @overload delete_ledger(params = {})
|
340
|
+
# @param [Hash] params ({})
|
341
|
+
def delete_ledger(params = {}, options = {})
|
342
|
+
req = build_request(:delete_ledger, params)
|
343
|
+
req.send_request(options)
|
344
|
+
end
|
345
|
+
|
346
|
+
# Returns information about a journal export job, including the ledger
|
347
|
+
# name, export ID, when it was created, current status, and its start
|
348
|
+
# and end time export parameters.
|
349
|
+
#
|
350
|
+
# If the export job with the given `ExportId` doesn't exist, then
|
351
|
+
# throws `ResourceNotFoundException`.
|
352
|
+
#
|
353
|
+
# If the ledger with the given `Name` doesn't exist, then throws
|
354
|
+
# `ResourceNotFoundException`.
|
355
|
+
#
|
356
|
+
# @option params [required, String] :name
|
357
|
+
# The name of the ledger.
|
358
|
+
#
|
359
|
+
# @option params [required, String] :export_id
|
360
|
+
# The unique ID of the journal export job that you want to describe.
|
361
|
+
#
|
362
|
+
# @return [Types::DescribeJournalS3ExportResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
363
|
+
#
|
364
|
+
# * {Types::DescribeJournalS3ExportResponse#export_description #export_description} => Types::JournalS3ExportDescription
|
365
|
+
#
|
366
|
+
# @example Request syntax with placeholder values
|
367
|
+
#
|
368
|
+
# resp = client.describe_journal_s3_export({
|
369
|
+
# name: "LedgerName", # required
|
370
|
+
# export_id: "UniqueId", # required
|
371
|
+
# })
|
372
|
+
#
|
373
|
+
# @example Response structure
|
374
|
+
#
|
375
|
+
# resp.export_description.ledger_name #=> String
|
376
|
+
# resp.export_description.export_id #=> String
|
377
|
+
# resp.export_description.export_creation_time #=> Time
|
378
|
+
# resp.export_description.status #=> String, one of "IN_PROGRESS", "COMPLETED", "CANCELLED"
|
379
|
+
# resp.export_description.inclusive_start_time #=> Time
|
380
|
+
# resp.export_description.exclusive_end_time #=> Time
|
381
|
+
# resp.export_description.s3_export_configuration.bucket #=> String
|
382
|
+
# resp.export_description.s3_export_configuration.prefix #=> String
|
383
|
+
# resp.export_description.s3_export_configuration.encryption_configuration.object_encryption_type #=> String, one of "SSE_KMS", "SSE_S3", "NO_ENCRYPTION"
|
384
|
+
# resp.export_description.s3_export_configuration.encryption_configuration.kms_key_arn #=> String
|
385
|
+
# resp.export_description.role_arn #=> String
|
386
|
+
#
|
387
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/DescribeJournalS3Export AWS API Documentation
|
388
|
+
#
|
389
|
+
# @overload describe_journal_s3_export(params = {})
|
390
|
+
# @param [Hash] params ({})
|
391
|
+
def describe_journal_s3_export(params = {}, options = {})
|
392
|
+
req = build_request(:describe_journal_s3_export, params)
|
393
|
+
req.send_request(options)
|
394
|
+
end
|
395
|
+
|
396
|
+
# Returns information about a ledger, including its state and when it
|
397
|
+
# was created.
|
398
|
+
#
|
399
|
+
# @option params [required, String] :name
|
400
|
+
# The name of the ledger that you want to describe.
|
401
|
+
#
|
402
|
+
# @return [Types::DescribeLedgerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
403
|
+
#
|
404
|
+
# * {Types::DescribeLedgerResponse#name #name} => String
|
405
|
+
# * {Types::DescribeLedgerResponse#arn #arn} => String
|
406
|
+
# * {Types::DescribeLedgerResponse#state #state} => String
|
407
|
+
# * {Types::DescribeLedgerResponse#creation_date_time #creation_date_time} => Time
|
408
|
+
# * {Types::DescribeLedgerResponse#deletion_protection #deletion_protection} => Boolean
|
409
|
+
#
|
410
|
+
# @example Request syntax with placeholder values
|
411
|
+
#
|
412
|
+
# resp = client.describe_ledger({
|
413
|
+
# name: "LedgerName", # required
|
414
|
+
# })
|
415
|
+
#
|
416
|
+
# @example Response structure
|
417
|
+
#
|
418
|
+
# resp.name #=> String
|
419
|
+
# resp.arn #=> String
|
420
|
+
# resp.state #=> String, one of "CREATING", "ACTIVE", "DELETING", "DELETED"
|
421
|
+
# resp.creation_date_time #=> Time
|
422
|
+
# resp.deletion_protection #=> Boolean
|
423
|
+
#
|
424
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/DescribeLedger AWS API Documentation
|
425
|
+
#
|
426
|
+
# @overload describe_ledger(params = {})
|
427
|
+
# @param [Hash] params ({})
|
428
|
+
def describe_ledger(params = {}, options = {})
|
429
|
+
req = build_request(:describe_ledger, params)
|
430
|
+
req.send_request(options)
|
431
|
+
end
|
432
|
+
|
433
|
+
# Exports journal contents within a date and time range from a ledger
|
434
|
+
# into a specified Amazon Simple Storage Service (Amazon S3) bucket. The
|
435
|
+
# data is written as files in Amazon Ion format.
|
436
|
+
#
|
437
|
+
# If the ledger with the given `Name` doesn't exist, then throws
|
438
|
+
# `ResourceNotFoundException`.
|
439
|
+
#
|
440
|
+
# If the ledger with the given `Name` is in `CREATING` status, then
|
441
|
+
# throws `ResourcePreconditionNotMetException`.
|
442
|
+
#
|
443
|
+
# You can initiate up to two concurrent journal export requests for each
|
444
|
+
# ledger. Beyond this limit, journal export requests throw
|
445
|
+
# `LimitExceededException`.
|
446
|
+
#
|
447
|
+
# @option params [required, String] :name
|
448
|
+
# The name of the ledger.
|
449
|
+
#
|
450
|
+
# @option params [required, Time,DateTime,Date,Integer,String] :inclusive_start_time
|
451
|
+
# The inclusive start date and time for the range of journal contents
|
452
|
+
# that you want to export.
|
453
|
+
#
|
454
|
+
# The `InclusiveStartTime` must be in `ISO 8601` date and time format
|
455
|
+
# and in Universal Coordinated Time (UTC). For example:
|
456
|
+
# `2019-06-13T21:36:34Z`
|
457
|
+
#
|
458
|
+
# The `InclusiveStartTime` must be before `ExclusiveEndTime`.
|
459
|
+
#
|
460
|
+
# If you provide an `InclusiveStartTime` that is before the ledger's
|
461
|
+
# `CreationDateTime`, Amazon QLDB defaults it to the ledger's
|
462
|
+
# `CreationDateTime`.
|
463
|
+
#
|
464
|
+
# @option params [required, Time,DateTime,Date,Integer,String] :exclusive_end_time
|
465
|
+
# The exclusive end date and time for the range of journal contents that
|
466
|
+
# you want to export.
|
467
|
+
#
|
468
|
+
# The `ExclusiveEndTime` must be in `ISO 8601` date and time format and
|
469
|
+
# in Universal Coordinated Time (UTC). For example:
|
470
|
+
# `2019-06-13T21:36:34Z`
|
471
|
+
#
|
472
|
+
# The `ExclusiveEndTime` must be less than or equal to the current UTC
|
473
|
+
# date and time.
|
474
|
+
#
|
475
|
+
# @option params [required, Types::S3ExportConfiguration] :s3_export_configuration
|
476
|
+
# The configuration settings of the Amazon S3 bucket destination for
|
477
|
+
# your export request.
|
478
|
+
#
|
479
|
+
# @option params [required, String] :role_arn
|
480
|
+
# The Amazon Resource Name (ARN) of the IAM role that grants QLDB
|
481
|
+
# permissions for a journal export job to do the following:
|
482
|
+
#
|
483
|
+
# * Write objects into your Amazon Simple Storage Service (Amazon S3)
|
484
|
+
# bucket.
|
485
|
+
#
|
486
|
+
# * (Optional) Use your customer master key (CMK) in AWS Key Management
|
487
|
+
# Service (AWS KMS) for server-side encryption of your exported data.
|
488
|
+
#
|
489
|
+
# @return [Types::ExportJournalToS3Response] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
490
|
+
#
|
491
|
+
# * {Types::ExportJournalToS3Response#export_id #export_id} => String
|
492
|
+
#
|
493
|
+
# @example Request syntax with placeholder values
|
494
|
+
#
|
495
|
+
# resp = client.export_journal_to_s3({
|
496
|
+
# name: "LedgerName", # required
|
497
|
+
# inclusive_start_time: Time.now, # required
|
498
|
+
# exclusive_end_time: Time.now, # required
|
499
|
+
# s3_export_configuration: { # required
|
500
|
+
# bucket: "S3Bucket", # required
|
501
|
+
# prefix: "S3Prefix", # required
|
502
|
+
# encryption_configuration: { # required
|
503
|
+
# object_encryption_type: "SSE_KMS", # required, accepts SSE_KMS, SSE_S3, NO_ENCRYPTION
|
504
|
+
# kms_key_arn: "Arn",
|
505
|
+
# },
|
506
|
+
# },
|
507
|
+
# role_arn: "Arn", # required
|
508
|
+
# })
|
509
|
+
#
|
510
|
+
# @example Response structure
|
511
|
+
#
|
512
|
+
# resp.export_id #=> String
|
513
|
+
#
|
514
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/ExportJournalToS3 AWS API Documentation
|
515
|
+
#
|
516
|
+
# @overload export_journal_to_s3(params = {})
|
517
|
+
# @param [Hash] params ({})
|
518
|
+
def export_journal_to_s3(params = {}, options = {})
|
519
|
+
req = build_request(:export_journal_to_s3, params)
|
520
|
+
req.send_request(options)
|
521
|
+
end
|
522
|
+
|
523
|
+
# Returns a journal block object at a specified address in a ledger.
|
524
|
+
# Also returns a proof of the specified block for verification if
|
525
|
+
# `DigestTipAddress` is provided.
|
526
|
+
#
|
527
|
+
# If the specified ledger doesn't exist or is in `DELETING` status,
|
528
|
+
# then throws `ResourceNotFoundException`.
|
529
|
+
#
|
530
|
+
# If the specified ledger is in `CREATING` status, then throws
|
531
|
+
# `ResourcePreconditionNotMetException`.
|
532
|
+
#
|
533
|
+
# If no block exists with the specified address, then throws
|
534
|
+
# `InvalidParameterException`.
|
535
|
+
#
|
536
|
+
# @option params [required, String] :name
|
537
|
+
# The name of the ledger.
|
538
|
+
#
|
539
|
+
# @option params [required, Types::ValueHolder] :block_address
|
540
|
+
# The location of the block that you want to request. An address is an
|
541
|
+
# Amazon Ion structure that has two fields: `strandId` and `sequenceNo`.
|
542
|
+
#
|
543
|
+
# For example: `\{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14\}`
|
544
|
+
#
|
545
|
+
# @option params [Types::ValueHolder] :digest_tip_address
|
546
|
+
# The latest block location covered by the digest for which to request a
|
547
|
+
# proof. An address is an Amazon Ion structure that has two fields:
|
548
|
+
# `strandId` and `sequenceNo`.
|
549
|
+
#
|
550
|
+
# For example: `\{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49\}`
|
551
|
+
#
|
552
|
+
# @return [Types::GetBlockResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
553
|
+
#
|
554
|
+
# * {Types::GetBlockResponse#block #block} => Types::ValueHolder
|
555
|
+
# * {Types::GetBlockResponse#proof #proof} => Types::ValueHolder
|
556
|
+
#
|
557
|
+
# @example Request syntax with placeholder values
|
558
|
+
#
|
559
|
+
# resp = client.get_block({
|
560
|
+
# name: "LedgerName", # required
|
561
|
+
# block_address: { # required
|
562
|
+
# ion_text: "IonText",
|
563
|
+
# },
|
564
|
+
# digest_tip_address: {
|
565
|
+
# ion_text: "IonText",
|
566
|
+
# },
|
567
|
+
# })
|
568
|
+
#
|
569
|
+
# @example Response structure
|
570
|
+
#
|
571
|
+
# resp.block.ion_text #=> String
|
572
|
+
# resp.proof.ion_text #=> String
|
573
|
+
#
|
574
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/GetBlock AWS API Documentation
|
575
|
+
#
|
576
|
+
# @overload get_block(params = {})
|
577
|
+
# @param [Hash] params ({})
|
578
|
+
def get_block(params = {}, options = {})
|
579
|
+
req = build_request(:get_block, params)
|
580
|
+
req.send_request(options)
|
581
|
+
end
|
582
|
+
|
583
|
+
# Returns the digest of a ledger at the latest committed block in the
|
584
|
+
# journal. The response includes a 256-bit hash value and a block
|
585
|
+
# address.
|
586
|
+
#
|
587
|
+
# @option params [required, String] :name
|
588
|
+
# The name of the ledger.
|
589
|
+
#
|
590
|
+
# @return [Types::GetDigestResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
591
|
+
#
|
592
|
+
# * {Types::GetDigestResponse#digest #digest} => String
|
593
|
+
# * {Types::GetDigestResponse#digest_tip_address #digest_tip_address} => Types::ValueHolder
|
594
|
+
#
|
595
|
+
# @example Request syntax with placeholder values
|
596
|
+
#
|
597
|
+
# resp = client.get_digest({
|
598
|
+
# name: "LedgerName", # required
|
599
|
+
# })
|
600
|
+
#
|
601
|
+
# @example Response structure
|
602
|
+
#
|
603
|
+
# resp.digest #=> String
|
604
|
+
# resp.digest_tip_address.ion_text #=> String
|
605
|
+
#
|
606
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/GetDigest AWS API Documentation
|
607
|
+
#
|
608
|
+
# @overload get_digest(params = {})
|
609
|
+
# @param [Hash] params ({})
|
610
|
+
def get_digest(params = {}, options = {})
|
611
|
+
req = build_request(:get_digest, params)
|
612
|
+
req.send_request(options)
|
613
|
+
end
|
614
|
+
|
615
|
+
# Returns a revision data object for a specified document ID and block
|
616
|
+
# address. Also returns a proof of the specified revision for
|
617
|
+
# verification if `DigestTipAddress` is provided.
|
618
|
+
#
|
619
|
+
# @option params [required, String] :name
|
620
|
+
# The name of the ledger.
|
621
|
+
#
|
622
|
+
# @option params [required, Types::ValueHolder] :block_address
|
623
|
+
# The block location of the document revision to be verified. An address
|
624
|
+
# is an Amazon Ion structure that has two fields: `strandId` and
|
625
|
+
# `sequenceNo`.
|
626
|
+
#
|
627
|
+
# For example: `\{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14\}`
|
628
|
+
#
|
629
|
+
# @option params [required, String] :document_id
|
630
|
+
# The unique ID of the document to be verified.
|
631
|
+
#
|
632
|
+
# @option params [Types::ValueHolder] :digest_tip_address
|
633
|
+
# The latest block location covered by the digest for which to request a
|
634
|
+
# proof. An address is an Amazon Ion structure that has two fields:
|
635
|
+
# `strandId` and `sequenceNo`.
|
636
|
+
#
|
637
|
+
# For example: `\{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49\}`
|
638
|
+
#
|
639
|
+
# @return [Types::GetRevisionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
640
|
+
#
|
641
|
+
# * {Types::GetRevisionResponse#proof #proof} => Types::ValueHolder
|
642
|
+
# * {Types::GetRevisionResponse#revision #revision} => Types::ValueHolder
|
643
|
+
#
|
644
|
+
# @example Request syntax with placeholder values
|
645
|
+
#
|
646
|
+
# resp = client.get_revision({
|
647
|
+
# name: "LedgerName", # required
|
648
|
+
# block_address: { # required
|
649
|
+
# ion_text: "IonText",
|
650
|
+
# },
|
651
|
+
# document_id: "UniqueId", # required
|
652
|
+
# digest_tip_address: {
|
653
|
+
# ion_text: "IonText",
|
654
|
+
# },
|
655
|
+
# })
|
656
|
+
#
|
657
|
+
# @example Response structure
|
658
|
+
#
|
659
|
+
# resp.proof.ion_text #=> String
|
660
|
+
# resp.revision.ion_text #=> String
|
661
|
+
#
|
662
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/GetRevision AWS API Documentation
|
663
|
+
#
|
664
|
+
# @overload get_revision(params = {})
|
665
|
+
# @param [Hash] params ({})
|
666
|
+
def get_revision(params = {}, options = {})
|
667
|
+
req = build_request(:get_revision, params)
|
668
|
+
req.send_request(options)
|
669
|
+
end
|
670
|
+
|
671
|
+
# Returns an array of journal export job descriptions for all ledgers
|
672
|
+
# that are associated with the current AWS account and Region.
|
673
|
+
#
|
674
|
+
# This action returns a maximum of `MaxResults` items, and is paginated
|
675
|
+
# so that you can retrieve all the items by calling
|
676
|
+
# `ListJournalS3Exports` multiple times.
|
677
|
+
#
|
678
|
+
# @option params [Integer] :max_results
|
679
|
+
# The maximum number of results to return in a single
|
680
|
+
# `ListJournalS3Exports` request. (The actual number of results returned
|
681
|
+
# might be fewer.)
|
682
|
+
#
|
683
|
+
# @option params [String] :next_token
|
684
|
+
# A pagination token, indicating that you want to retrieve the next page
|
685
|
+
# of results. If you received a value for `NextToken` in the response
|
686
|
+
# from a previous `ListJournalS3Exports` call, then you should use that
|
687
|
+
# value as input here.
|
688
|
+
#
|
689
|
+
# @return [Types::ListJournalS3ExportsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
690
|
+
#
|
691
|
+
# * {Types::ListJournalS3ExportsResponse#journal_s3_exports #journal_s3_exports} => Array<Types::JournalS3ExportDescription>
|
692
|
+
# * {Types::ListJournalS3ExportsResponse#next_token #next_token} => String
|
693
|
+
#
|
694
|
+
# @example Request syntax with placeholder values
|
695
|
+
#
|
696
|
+
# resp = client.list_journal_s3_exports({
|
697
|
+
# max_results: 1,
|
698
|
+
# next_token: "NextToken",
|
699
|
+
# })
|
700
|
+
#
|
701
|
+
# @example Response structure
|
702
|
+
#
|
703
|
+
# resp.journal_s3_exports #=> Array
|
704
|
+
# resp.journal_s3_exports[0].ledger_name #=> String
|
705
|
+
# resp.journal_s3_exports[0].export_id #=> String
|
706
|
+
# resp.journal_s3_exports[0].export_creation_time #=> Time
|
707
|
+
# resp.journal_s3_exports[0].status #=> String, one of "IN_PROGRESS", "COMPLETED", "CANCELLED"
|
708
|
+
# resp.journal_s3_exports[0].inclusive_start_time #=> Time
|
709
|
+
# resp.journal_s3_exports[0].exclusive_end_time #=> Time
|
710
|
+
# resp.journal_s3_exports[0].s3_export_configuration.bucket #=> String
|
711
|
+
# resp.journal_s3_exports[0].s3_export_configuration.prefix #=> String
|
712
|
+
# resp.journal_s3_exports[0].s3_export_configuration.encryption_configuration.object_encryption_type #=> String, one of "SSE_KMS", "SSE_S3", "NO_ENCRYPTION"
|
713
|
+
# resp.journal_s3_exports[0].s3_export_configuration.encryption_configuration.kms_key_arn #=> String
|
714
|
+
# resp.journal_s3_exports[0].role_arn #=> String
|
715
|
+
# resp.next_token #=> String
|
716
|
+
#
|
717
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/ListJournalS3Exports AWS API Documentation
|
718
|
+
#
|
719
|
+
# @overload list_journal_s3_exports(params = {})
|
720
|
+
# @param [Hash] params ({})
|
721
|
+
def list_journal_s3_exports(params = {}, options = {})
|
722
|
+
req = build_request(:list_journal_s3_exports, params)
|
723
|
+
req.send_request(options)
|
724
|
+
end
|
725
|
+
|
726
|
+
# Returns an array of journal export job descriptions for a specified
|
727
|
+
# ledger.
|
728
|
+
#
|
729
|
+
# This action returns a maximum of `MaxResults` items, and is paginated
|
730
|
+
# so that you can retrieve all the items by calling
|
731
|
+
# `ListJournalS3ExportsForLedger` multiple times.
|
732
|
+
#
|
733
|
+
# @option params [required, String] :name
|
734
|
+
# The name of the ledger.
|
735
|
+
#
|
736
|
+
# @option params [Integer] :max_results
|
737
|
+
# The maximum number of results to return in a single
|
738
|
+
# `ListJournalS3ExportsForLedger` request. (The actual number of results
|
739
|
+
# returned might be fewer.)
|
740
|
+
#
|
741
|
+
# @option params [String] :next_token
|
742
|
+
# A pagination token, indicating that you want to retrieve the next page
|
743
|
+
# of results. If you received a value for `NextToken` in the response
|
744
|
+
# from a previous `ListJournalS3ExportsForLedger` call, then you should
|
745
|
+
# use that value as input here.
|
746
|
+
#
|
747
|
+
# @return [Types::ListJournalS3ExportsForLedgerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
748
|
+
#
|
749
|
+
# * {Types::ListJournalS3ExportsForLedgerResponse#journal_s3_exports #journal_s3_exports} => Array<Types::JournalS3ExportDescription>
|
750
|
+
# * {Types::ListJournalS3ExportsForLedgerResponse#next_token #next_token} => String
|
751
|
+
#
|
752
|
+
# @example Request syntax with placeholder values
|
753
|
+
#
|
754
|
+
# resp = client.list_journal_s3_exports_for_ledger({
|
755
|
+
# name: "LedgerName", # required
|
756
|
+
# max_results: 1,
|
757
|
+
# next_token: "NextToken",
|
758
|
+
# })
|
759
|
+
#
|
760
|
+
# @example Response structure
|
761
|
+
#
|
762
|
+
# resp.journal_s3_exports #=> Array
|
763
|
+
# resp.journal_s3_exports[0].ledger_name #=> String
|
764
|
+
# resp.journal_s3_exports[0].export_id #=> String
|
765
|
+
# resp.journal_s3_exports[0].export_creation_time #=> Time
|
766
|
+
# resp.journal_s3_exports[0].status #=> String, one of "IN_PROGRESS", "COMPLETED", "CANCELLED"
|
767
|
+
# resp.journal_s3_exports[0].inclusive_start_time #=> Time
|
768
|
+
# resp.journal_s3_exports[0].exclusive_end_time #=> Time
|
769
|
+
# resp.journal_s3_exports[0].s3_export_configuration.bucket #=> String
|
770
|
+
# resp.journal_s3_exports[0].s3_export_configuration.prefix #=> String
|
771
|
+
# resp.journal_s3_exports[0].s3_export_configuration.encryption_configuration.object_encryption_type #=> String, one of "SSE_KMS", "SSE_S3", "NO_ENCRYPTION"
|
772
|
+
# resp.journal_s3_exports[0].s3_export_configuration.encryption_configuration.kms_key_arn #=> String
|
773
|
+
# resp.journal_s3_exports[0].role_arn #=> String
|
774
|
+
# resp.next_token #=> String
|
775
|
+
#
|
776
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/ListJournalS3ExportsForLedger AWS API Documentation
|
777
|
+
#
|
778
|
+
# @overload list_journal_s3_exports_for_ledger(params = {})
|
779
|
+
# @param [Hash] params ({})
|
780
|
+
def list_journal_s3_exports_for_ledger(params = {}, options = {})
|
781
|
+
req = build_request(:list_journal_s3_exports_for_ledger, params)
|
782
|
+
req.send_request(options)
|
783
|
+
end
|
784
|
+
|
785
|
+
# Returns an array of ledger summaries that are associated with the
|
786
|
+
# current AWS account and Region.
|
787
|
+
#
|
788
|
+
# This action returns a maximum of 100 items and is paginated so that
|
789
|
+
# you can retrieve all the items by calling `ListLedgers` multiple
|
790
|
+
# times.
|
791
|
+
#
|
792
|
+
# @option params [Integer] :max_results
|
793
|
+
# The maximum number of results to return in a single `ListLedgers`
|
794
|
+
# request. (The actual number of results returned might be fewer.)
|
795
|
+
#
|
796
|
+
# @option params [String] :next_token
|
797
|
+
# A pagination token, indicating that you want to retrieve the next page
|
798
|
+
# of results. If you received a value for `NextToken` in the response
|
799
|
+
# from a previous `ListLedgers` call, then you should use that value as
|
800
|
+
# input here.
|
801
|
+
#
|
802
|
+
# @return [Types::ListLedgersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
803
|
+
#
|
804
|
+
# * {Types::ListLedgersResponse#ledgers #ledgers} => Array<Types::LedgerSummary>
|
805
|
+
# * {Types::ListLedgersResponse#next_token #next_token} => String
|
806
|
+
#
|
807
|
+
# @example Request syntax with placeholder values
|
808
|
+
#
|
809
|
+
# resp = client.list_ledgers({
|
810
|
+
# max_results: 1,
|
811
|
+
# next_token: "NextToken",
|
812
|
+
# })
|
813
|
+
#
|
814
|
+
# @example Response structure
|
815
|
+
#
|
816
|
+
# resp.ledgers #=> Array
|
817
|
+
# resp.ledgers[0].name #=> String
|
818
|
+
# resp.ledgers[0].state #=> String, one of "CREATING", "ACTIVE", "DELETING", "DELETED"
|
819
|
+
# resp.ledgers[0].creation_date_time #=> Time
|
820
|
+
# resp.next_token #=> String
|
821
|
+
#
|
822
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/ListLedgers AWS API Documentation
|
823
|
+
#
|
824
|
+
# @overload list_ledgers(params = {})
|
825
|
+
# @param [Hash] params ({})
|
826
|
+
def list_ledgers(params = {}, options = {})
|
827
|
+
req = build_request(:list_ledgers, params)
|
828
|
+
req.send_request(options)
|
829
|
+
end
|
830
|
+
|
831
|
+
# Returns all tags for a specified Amazon QLDB resource.
|
832
|
+
#
|
833
|
+
# @option params [required, String] :resource_arn
|
834
|
+
# The Amazon Resource Name (ARN) for which you want to list the tags.
|
835
|
+
# For example:
|
836
|
+
#
|
837
|
+
# `arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger`
|
838
|
+
#
|
839
|
+
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
840
|
+
#
|
841
|
+
# * {Types::ListTagsForResourceResponse#tags #tags} => Hash<String,String>
|
842
|
+
#
|
843
|
+
# @example Request syntax with placeholder values
|
844
|
+
#
|
845
|
+
# resp = client.list_tags_for_resource({
|
846
|
+
# resource_arn: "Arn", # required
|
847
|
+
# })
|
848
|
+
#
|
849
|
+
# @example Response structure
|
850
|
+
#
|
851
|
+
# resp.tags #=> Hash
|
852
|
+
# resp.tags["TagKey"] #=> String
|
853
|
+
#
|
854
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/ListTagsForResource AWS API Documentation
|
855
|
+
#
|
856
|
+
# @overload list_tags_for_resource(params = {})
|
857
|
+
# @param [Hash] params ({})
|
858
|
+
def list_tags_for_resource(params = {}, options = {})
|
859
|
+
req = build_request(:list_tags_for_resource, params)
|
860
|
+
req.send_request(options)
|
861
|
+
end
|
862
|
+
|
863
|
+
# Adds one or more tags to a specified Amazon QLDB resource.
|
864
|
+
#
|
865
|
+
# A resource can have up to 50 tags. If you try to create more than 50
|
866
|
+
# tags for a resource, your request fails and returns an error.
|
867
|
+
#
|
868
|
+
# @option params [required, String] :resource_arn
|
869
|
+
# The Amazon Resource Name (ARN) to which you want to add the tags. For
|
870
|
+
# example:
|
871
|
+
#
|
872
|
+
# `arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger`
|
873
|
+
#
|
874
|
+
# @option params [required, Hash<String,String>] :tags
|
875
|
+
# The key-value pairs to add as tags to the specified QLDB resource. Tag
|
876
|
+
# keys are case sensitive. If you specify a key that already exists for
|
877
|
+
# the resource, your request fails and returns an error. Tag values are
|
878
|
+
# case sensitive and can be null.
|
879
|
+
#
|
880
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
881
|
+
#
|
882
|
+
# @example Request syntax with placeholder values
|
883
|
+
#
|
884
|
+
# resp = client.tag_resource({
|
885
|
+
# resource_arn: "Arn", # required
|
886
|
+
# tags: { # required
|
887
|
+
# "TagKey" => "TagValue",
|
888
|
+
# },
|
889
|
+
# })
|
890
|
+
#
|
891
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/TagResource AWS API Documentation
|
892
|
+
#
|
893
|
+
# @overload tag_resource(params = {})
|
894
|
+
# @param [Hash] params ({})
|
895
|
+
def tag_resource(params = {}, options = {})
|
896
|
+
req = build_request(:tag_resource, params)
|
897
|
+
req.send_request(options)
|
898
|
+
end
|
899
|
+
|
900
|
+
# Removes one or more tags from a specified Amazon QLDB resource. You
|
901
|
+
# can specify up to 50 tag keys to remove.
|
902
|
+
#
|
903
|
+
# @option params [required, String] :resource_arn
|
904
|
+
# The Amazon Resource Name (ARN) from which you want to remove the tags.
|
905
|
+
# For example:
|
906
|
+
#
|
907
|
+
# `arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger`
|
908
|
+
#
|
909
|
+
# @option params [required, Array<String>] :tag_keys
|
910
|
+
# The list of tag keys that you want to remove.
|
911
|
+
#
|
912
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
913
|
+
#
|
914
|
+
# @example Request syntax with placeholder values
|
915
|
+
#
|
916
|
+
# resp = client.untag_resource({
|
917
|
+
# resource_arn: "Arn", # required
|
918
|
+
# tag_keys: ["TagKey"], # required
|
919
|
+
# })
|
920
|
+
#
|
921
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/UntagResource AWS API Documentation
|
922
|
+
#
|
923
|
+
# @overload untag_resource(params = {})
|
924
|
+
# @param [Hash] params ({})
|
925
|
+
def untag_resource(params = {}, options = {})
|
926
|
+
req = build_request(:untag_resource, params)
|
927
|
+
req.send_request(options)
|
928
|
+
end
|
929
|
+
|
930
|
+
# Updates properties on a ledger.
|
931
|
+
#
|
932
|
+
# @option params [required, String] :name
|
933
|
+
# The name of the ledger.
|
934
|
+
#
|
935
|
+
# @option params [Boolean] :deletion_protection
|
936
|
+
# The flag that prevents a ledger from being deleted by any user. If not
|
937
|
+
# provided on ledger creation, this feature is enabled (`true`) by
|
938
|
+
# default.
|
939
|
+
#
|
940
|
+
# If deletion protection is enabled, you must first disable it before
|
941
|
+
# you can delete the ledger using the QLDB API or the AWS Command Line
|
942
|
+
# Interface (AWS CLI). You can disable it by calling the `UpdateLedger`
|
943
|
+
# operation to set the flag to `false`. The QLDB console disables
|
944
|
+
# deletion protection for you when you use it to delete a ledger.
|
945
|
+
#
|
946
|
+
# @return [Types::UpdateLedgerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
947
|
+
#
|
948
|
+
# * {Types::UpdateLedgerResponse#name #name} => String
|
949
|
+
# * {Types::UpdateLedgerResponse#arn #arn} => String
|
950
|
+
# * {Types::UpdateLedgerResponse#state #state} => String
|
951
|
+
# * {Types::UpdateLedgerResponse#creation_date_time #creation_date_time} => Time
|
952
|
+
# * {Types::UpdateLedgerResponse#deletion_protection #deletion_protection} => Boolean
|
953
|
+
#
|
954
|
+
# @example Request syntax with placeholder values
|
955
|
+
#
|
956
|
+
# resp = client.update_ledger({
|
957
|
+
# name: "LedgerName", # required
|
958
|
+
# deletion_protection: false,
|
959
|
+
# })
|
960
|
+
#
|
961
|
+
# @example Response structure
|
962
|
+
#
|
963
|
+
# resp.name #=> String
|
964
|
+
# resp.arn #=> String
|
965
|
+
# resp.state #=> String, one of "CREATING", "ACTIVE", "DELETING", "DELETED"
|
966
|
+
# resp.creation_date_time #=> Time
|
967
|
+
# resp.deletion_protection #=> Boolean
|
968
|
+
#
|
969
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02/UpdateLedger AWS API Documentation
|
970
|
+
#
|
971
|
+
# @overload update_ledger(params = {})
|
972
|
+
# @param [Hash] params ({})
|
973
|
+
def update_ledger(params = {}, options = {})
|
974
|
+
req = build_request(:update_ledger, params)
|
975
|
+
req.send_request(options)
|
976
|
+
end
|
977
|
+
|
978
|
+
# @!endgroup
|
979
|
+
|
980
|
+
# @param params ({})
|
981
|
+
# @api private
|
982
|
+
def build_request(operation_name, params = {})
|
983
|
+
handlers = @handlers.for(operation_name)
|
984
|
+
context = Seahorse::Client::RequestContext.new(
|
985
|
+
operation_name: operation_name,
|
986
|
+
operation: config.api.operation(operation_name),
|
987
|
+
client: self,
|
988
|
+
params: params,
|
989
|
+
config: config)
|
990
|
+
context[:gem_name] = 'aws-sdk-qldb'
|
991
|
+
context[:gem_version] = '1.0.0'
|
992
|
+
Seahorse::Client::Request.new(handlers, context)
|
993
|
+
end
|
994
|
+
|
995
|
+
# @api private
|
996
|
+
# @deprecated
|
997
|
+
def waiter_names
|
998
|
+
[]
|
999
|
+
end
|
1000
|
+
|
1001
|
+
class << self
|
1002
|
+
|
1003
|
+
# @api private
|
1004
|
+
attr_reader :identifier
|
1005
|
+
|
1006
|
+
# @api private
|
1007
|
+
def errors_module
|
1008
|
+
Errors
|
1009
|
+
end
|
1010
|
+
|
1011
|
+
end
|
1012
|
+
end
|
1013
|
+
end
|