aws-sdk-schemas 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-schemas.rb +48 -0
- data/lib/aws-sdk-schemas/client.rb +1466 -0
- data/lib/aws-sdk-schemas/client_api.rb +1050 -0
- data/lib/aws-sdk-schemas/customizations.rb +0 -0
- data/lib/aws-sdk-schemas/errors.rb +203 -0
- data/lib/aws-sdk-schemas/resource.rb +23 -0
- data/lib/aws-sdk-schemas/types.rb +2013 -0
- data/lib/aws-sdk-schemas/waiters.rb +69 -0
- metadata +89 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 3a288eaf0a79827ce1bf54111184bb37fe371279
|
4
|
+
data.tar.gz: 43c170aa0a7b48bda4027ed06aae9189c00f8567
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: e483129e50f0b0ce8456aebcf3f5dbd4b781a3f5ae03d85582ec664c27e7ac9515cd021b39f260fa6bb65e5df01ae221f7e91487768c468d57fb5e199f5a5541
|
7
|
+
data.tar.gz: 912beaff4064dba27593dda45f367fbe613c32951cce8ebb74f82156e0510c3b520ed53d0ffc960ccce05d1afe44a377cfcd25e3b5ac56cac0e88bec750cd005
|
@@ -0,0 +1,48 @@
|
|
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-schemas/types'
|
12
|
+
require_relative 'aws-sdk-schemas/client_api'
|
13
|
+
require_relative 'aws-sdk-schemas/client'
|
14
|
+
require_relative 'aws-sdk-schemas/errors'
|
15
|
+
require_relative 'aws-sdk-schemas/waiters'
|
16
|
+
require_relative 'aws-sdk-schemas/resource'
|
17
|
+
require_relative 'aws-sdk-schemas/customizations'
|
18
|
+
|
19
|
+
# This module provides support for Schemas. This module is available in the
|
20
|
+
# `aws-sdk-schemas` gem.
|
21
|
+
#
|
22
|
+
# # Client
|
23
|
+
#
|
24
|
+
# The {Client} class provides one method for each API operation. Operation
|
25
|
+
# methods each accept a hash of request parameters and return a response
|
26
|
+
# structure.
|
27
|
+
#
|
28
|
+
# See {Client} for more information.
|
29
|
+
#
|
30
|
+
# # Errors
|
31
|
+
#
|
32
|
+
# Errors returned from Schemas all
|
33
|
+
# extend {Errors::ServiceError}.
|
34
|
+
#
|
35
|
+
# begin
|
36
|
+
# # do stuff
|
37
|
+
# rescue Aws::Schemas::Errors::ServiceError
|
38
|
+
# # rescues all service API errors
|
39
|
+
# end
|
40
|
+
#
|
41
|
+
# See {Errors} for more information.
|
42
|
+
#
|
43
|
+
# @service
|
44
|
+
module Aws::Schemas
|
45
|
+
|
46
|
+
GEM_VERSION = '1.0.0'
|
47
|
+
|
48
|
+
end
|
@@ -0,0 +1,1466 @@
|
|
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(:schemas)
|
31
|
+
|
32
|
+
module Aws::Schemas
|
33
|
+
class Client < Seahorse::Client::Base
|
34
|
+
|
35
|
+
include Aws::ClientStubs
|
36
|
+
|
37
|
+
@identifier = :schemas
|
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 discoverer.
|
258
|
+
#
|
259
|
+
# @option params [String] :description
|
260
|
+
#
|
261
|
+
# @option params [required, String] :source_arn
|
262
|
+
#
|
263
|
+
# @option params [Hash<String,String>] :tags
|
264
|
+
# Key-value pairs associated with a resource.
|
265
|
+
#
|
266
|
+
# @return [Types::CreateDiscovererResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
267
|
+
#
|
268
|
+
# * {Types::CreateDiscovererResponse#description #description} => String
|
269
|
+
# * {Types::CreateDiscovererResponse#discoverer_arn #discoverer_arn} => String
|
270
|
+
# * {Types::CreateDiscovererResponse#discoverer_id #discoverer_id} => String
|
271
|
+
# * {Types::CreateDiscovererResponse#source_arn #source_arn} => String
|
272
|
+
# * {Types::CreateDiscovererResponse#state #state} => String
|
273
|
+
# * {Types::CreateDiscovererResponse#tags #tags} => Hash<String,String>
|
274
|
+
#
|
275
|
+
# @example Request syntax with placeholder values
|
276
|
+
#
|
277
|
+
# resp = client.create_discoverer({
|
278
|
+
# description: "__stringMin0Max256",
|
279
|
+
# source_arn: "__stringMin20Max1600", # required
|
280
|
+
# tags: {
|
281
|
+
# "__string" => "__string",
|
282
|
+
# },
|
283
|
+
# })
|
284
|
+
#
|
285
|
+
# @example Response structure
|
286
|
+
#
|
287
|
+
# resp.description #=> String
|
288
|
+
# resp.discoverer_arn #=> String
|
289
|
+
# resp.discoverer_id #=> String
|
290
|
+
# resp.source_arn #=> String
|
291
|
+
# resp.state #=> String, one of "STARTED", "STOPPED"
|
292
|
+
# resp.tags #=> Hash
|
293
|
+
# resp.tags["__string"] #=> String
|
294
|
+
#
|
295
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/schemas-2019-12-02/CreateDiscoverer AWS API Documentation
|
296
|
+
#
|
297
|
+
# @overload create_discoverer(params = {})
|
298
|
+
# @param [Hash] params ({})
|
299
|
+
def create_discoverer(params = {}, options = {})
|
300
|
+
req = build_request(:create_discoverer, params)
|
301
|
+
req.send_request(options)
|
302
|
+
end
|
303
|
+
|
304
|
+
# Creates a registry.
|
305
|
+
#
|
306
|
+
# @option params [String] :description
|
307
|
+
#
|
308
|
+
# @option params [required, String] :registry_name
|
309
|
+
#
|
310
|
+
# @option params [Hash<String,String>] :tags
|
311
|
+
# Key-value pairs associated with a resource.
|
312
|
+
#
|
313
|
+
# @return [Types::CreateRegistryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
314
|
+
#
|
315
|
+
# * {Types::CreateRegistryResponse#description #description} => String
|
316
|
+
# * {Types::CreateRegistryResponse#registry_arn #registry_arn} => String
|
317
|
+
# * {Types::CreateRegistryResponse#registry_name #registry_name} => String
|
318
|
+
# * {Types::CreateRegistryResponse#tags #tags} => Hash<String,String>
|
319
|
+
#
|
320
|
+
# @example Request syntax with placeholder values
|
321
|
+
#
|
322
|
+
# resp = client.create_registry({
|
323
|
+
# description: "__stringMin0Max256",
|
324
|
+
# registry_name: "__string", # required
|
325
|
+
# tags: {
|
326
|
+
# "__string" => "__string",
|
327
|
+
# },
|
328
|
+
# })
|
329
|
+
#
|
330
|
+
# @example Response structure
|
331
|
+
#
|
332
|
+
# resp.description #=> String
|
333
|
+
# resp.registry_arn #=> String
|
334
|
+
# resp.registry_name #=> String
|
335
|
+
# resp.tags #=> Hash
|
336
|
+
# resp.tags["__string"] #=> String
|
337
|
+
#
|
338
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/schemas-2019-12-02/CreateRegistry AWS API Documentation
|
339
|
+
#
|
340
|
+
# @overload create_registry(params = {})
|
341
|
+
# @param [Hash] params ({})
|
342
|
+
def create_registry(params = {}, options = {})
|
343
|
+
req = build_request(:create_registry, params)
|
344
|
+
req.send_request(options)
|
345
|
+
end
|
346
|
+
|
347
|
+
# Creates a schema definition.
|
348
|
+
#
|
349
|
+
# @option params [required, String] :content
|
350
|
+
#
|
351
|
+
# @option params [String] :description
|
352
|
+
#
|
353
|
+
# @option params [required, String] :registry_name
|
354
|
+
#
|
355
|
+
# @option params [required, String] :schema_name
|
356
|
+
#
|
357
|
+
# @option params [Hash<String,String>] :tags
|
358
|
+
# Key-value pairs associated with a resource.
|
359
|
+
#
|
360
|
+
# @option params [required, String] :type
|
361
|
+
#
|
362
|
+
# @return [Types::CreateSchemaResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
363
|
+
#
|
364
|
+
# * {Types::CreateSchemaResponse#description #description} => String
|
365
|
+
# * {Types::CreateSchemaResponse#last_modified #last_modified} => Time
|
366
|
+
# * {Types::CreateSchemaResponse#schema_arn #schema_arn} => String
|
367
|
+
# * {Types::CreateSchemaResponse#schema_name #schema_name} => String
|
368
|
+
# * {Types::CreateSchemaResponse#schema_version #schema_version} => String
|
369
|
+
# * {Types::CreateSchemaResponse#tags #tags} => Hash<String,String>
|
370
|
+
# * {Types::CreateSchemaResponse#type #type} => String
|
371
|
+
# * {Types::CreateSchemaResponse#version_created_date #version_created_date} => Time
|
372
|
+
#
|
373
|
+
# @example Request syntax with placeholder values
|
374
|
+
#
|
375
|
+
# resp = client.create_schema({
|
376
|
+
# content: "__stringMin1Max100000", # required
|
377
|
+
# description: "__stringMin0Max256",
|
378
|
+
# registry_name: "__string", # required
|
379
|
+
# schema_name: "__string", # required
|
380
|
+
# tags: {
|
381
|
+
# "__string" => "__string",
|
382
|
+
# },
|
383
|
+
# type: "OpenApi3", # required, accepts OpenApi3
|
384
|
+
# })
|
385
|
+
#
|
386
|
+
# @example Response structure
|
387
|
+
#
|
388
|
+
# resp.description #=> String
|
389
|
+
# resp.last_modified #=> Time
|
390
|
+
# resp.schema_arn #=> String
|
391
|
+
# resp.schema_name #=> String
|
392
|
+
# resp.schema_version #=> String
|
393
|
+
# resp.tags #=> Hash
|
394
|
+
# resp.tags["__string"] #=> String
|
395
|
+
# resp.type #=> String
|
396
|
+
# resp.version_created_date #=> Time
|
397
|
+
#
|
398
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/schemas-2019-12-02/CreateSchema AWS API Documentation
|
399
|
+
#
|
400
|
+
# @overload create_schema(params = {})
|
401
|
+
# @param [Hash] params ({})
|
402
|
+
def create_schema(params = {}, options = {})
|
403
|
+
req = build_request(:create_schema, params)
|
404
|
+
req.send_request(options)
|
405
|
+
end
|
406
|
+
|
407
|
+
# Deletes a discoverer.
|
408
|
+
#
|
409
|
+
# @option params [required, String] :discoverer_id
|
410
|
+
#
|
411
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
412
|
+
#
|
413
|
+
# @example Request syntax with placeholder values
|
414
|
+
#
|
415
|
+
# resp = client.delete_discoverer({
|
416
|
+
# discoverer_id: "__string", # required
|
417
|
+
# })
|
418
|
+
#
|
419
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/schemas-2019-12-02/DeleteDiscoverer AWS API Documentation
|
420
|
+
#
|
421
|
+
# @overload delete_discoverer(params = {})
|
422
|
+
# @param [Hash] params ({})
|
423
|
+
def delete_discoverer(params = {}, options = {})
|
424
|
+
req = build_request(:delete_discoverer, params)
|
425
|
+
req.send_request(options)
|
426
|
+
end
|
427
|
+
|
428
|
+
# Deletes a Registry.
|
429
|
+
#
|
430
|
+
# @option params [required, String] :registry_name
|
431
|
+
#
|
432
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
433
|
+
#
|
434
|
+
# @example Request syntax with placeholder values
|
435
|
+
#
|
436
|
+
# resp = client.delete_registry({
|
437
|
+
# registry_name: "__string", # required
|
438
|
+
# })
|
439
|
+
#
|
440
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/schemas-2019-12-02/DeleteRegistry AWS API Documentation
|
441
|
+
#
|
442
|
+
# @overload delete_registry(params = {})
|
443
|
+
# @param [Hash] params ({})
|
444
|
+
def delete_registry(params = {}, options = {})
|
445
|
+
req = build_request(:delete_registry, params)
|
446
|
+
req.send_request(options)
|
447
|
+
end
|
448
|
+
|
449
|
+
# Delete a schema definition.
|
450
|
+
#
|
451
|
+
# @option params [required, String] :registry_name
|
452
|
+
#
|
453
|
+
# @option params [required, String] :schema_name
|
454
|
+
#
|
455
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
456
|
+
#
|
457
|
+
# @example Request syntax with placeholder values
|
458
|
+
#
|
459
|
+
# resp = client.delete_schema({
|
460
|
+
# registry_name: "__string", # required
|
461
|
+
# schema_name: "__string", # required
|
462
|
+
# })
|
463
|
+
#
|
464
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/schemas-2019-12-02/DeleteSchema AWS API Documentation
|
465
|
+
#
|
466
|
+
# @overload delete_schema(params = {})
|
467
|
+
# @param [Hash] params ({})
|
468
|
+
def delete_schema(params = {}, options = {})
|
469
|
+
req = build_request(:delete_schema, params)
|
470
|
+
req.send_request(options)
|
471
|
+
end
|
472
|
+
|
473
|
+
# Delete the schema version definition
|
474
|
+
#
|
475
|
+
# @option params [required, String] :registry_name
|
476
|
+
#
|
477
|
+
# @option params [required, String] :schema_name
|
478
|
+
#
|
479
|
+
# @option params [required, String] :schema_version
|
480
|
+
#
|
481
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
482
|
+
#
|
483
|
+
# @example Request syntax with placeholder values
|
484
|
+
#
|
485
|
+
# resp = client.delete_schema_version({
|
486
|
+
# registry_name: "__string", # required
|
487
|
+
# schema_name: "__string", # required
|
488
|
+
# schema_version: "__string", # required
|
489
|
+
# })
|
490
|
+
#
|
491
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/schemas-2019-12-02/DeleteSchemaVersion AWS API Documentation
|
492
|
+
#
|
493
|
+
# @overload delete_schema_version(params = {})
|
494
|
+
# @param [Hash] params ({})
|
495
|
+
def delete_schema_version(params = {}, options = {})
|
496
|
+
req = build_request(:delete_schema_version, params)
|
497
|
+
req.send_request(options)
|
498
|
+
end
|
499
|
+
|
500
|
+
# Describe the code binding URI.
|
501
|
+
#
|
502
|
+
# @option params [required, String] :language
|
503
|
+
#
|
504
|
+
# @option params [required, String] :registry_name
|
505
|
+
#
|
506
|
+
# @option params [required, String] :schema_name
|
507
|
+
#
|
508
|
+
# @option params [String] :schema_version
|
509
|
+
#
|
510
|
+
# @return [Types::DescribeCodeBindingResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
511
|
+
#
|
512
|
+
# * {Types::DescribeCodeBindingResponse#creation_date #creation_date} => Time
|
513
|
+
# * {Types::DescribeCodeBindingResponse#last_modified #last_modified} => Time
|
514
|
+
# * {Types::DescribeCodeBindingResponse#schema_version #schema_version} => String
|
515
|
+
# * {Types::DescribeCodeBindingResponse#status #status} => String
|
516
|
+
#
|
517
|
+
# @example Request syntax with placeholder values
|
518
|
+
#
|
519
|
+
# resp = client.describe_code_binding({
|
520
|
+
# language: "__string", # required
|
521
|
+
# registry_name: "__string", # required
|
522
|
+
# schema_name: "__string", # required
|
523
|
+
# schema_version: "__string",
|
524
|
+
# })
|
525
|
+
#
|
526
|
+
# @example Response structure
|
527
|
+
#
|
528
|
+
# resp.creation_date #=> Time
|
529
|
+
# resp.last_modified #=> Time
|
530
|
+
# resp.schema_version #=> String
|
531
|
+
# resp.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "CREATE_FAILED"
|
532
|
+
#
|
533
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/schemas-2019-12-02/DescribeCodeBinding AWS API Documentation
|
534
|
+
#
|
535
|
+
# @overload describe_code_binding(params = {})
|
536
|
+
# @param [Hash] params ({})
|
537
|
+
def describe_code_binding(params = {}, options = {})
|
538
|
+
req = build_request(:describe_code_binding, params)
|
539
|
+
req.send_request(options)
|
540
|
+
end
|
541
|
+
|
542
|
+
# Describes the discoverer.
|
543
|
+
#
|
544
|
+
# @option params [required, String] :discoverer_id
|
545
|
+
#
|
546
|
+
# @return [Types::DescribeDiscovererResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
547
|
+
#
|
548
|
+
# * {Types::DescribeDiscovererResponse#description #description} => String
|
549
|
+
# * {Types::DescribeDiscovererResponse#discoverer_arn #discoverer_arn} => String
|
550
|
+
# * {Types::DescribeDiscovererResponse#discoverer_id #discoverer_id} => String
|
551
|
+
# * {Types::DescribeDiscovererResponse#source_arn #source_arn} => String
|
552
|
+
# * {Types::DescribeDiscovererResponse#state #state} => String
|
553
|
+
# * {Types::DescribeDiscovererResponse#tags #tags} => Hash<String,String>
|
554
|
+
#
|
555
|
+
# @example Request syntax with placeholder values
|
556
|
+
#
|
557
|
+
# resp = client.describe_discoverer({
|
558
|
+
# discoverer_id: "__string", # required
|
559
|
+
# })
|
560
|
+
#
|
561
|
+
# @example Response structure
|
562
|
+
#
|
563
|
+
# resp.description #=> String
|
564
|
+
# resp.discoverer_arn #=> String
|
565
|
+
# resp.discoverer_id #=> String
|
566
|
+
# resp.source_arn #=> String
|
567
|
+
# resp.state #=> String, one of "STARTED", "STOPPED"
|
568
|
+
# resp.tags #=> Hash
|
569
|
+
# resp.tags["__string"] #=> String
|
570
|
+
#
|
571
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/schemas-2019-12-02/DescribeDiscoverer AWS API Documentation
|
572
|
+
#
|
573
|
+
# @overload describe_discoverer(params = {})
|
574
|
+
# @param [Hash] params ({})
|
575
|
+
def describe_discoverer(params = {}, options = {})
|
576
|
+
req = build_request(:describe_discoverer, params)
|
577
|
+
req.send_request(options)
|
578
|
+
end
|
579
|
+
|
580
|
+
# Describes the registry.
|
581
|
+
#
|
582
|
+
# @option params [required, String] :registry_name
|
583
|
+
#
|
584
|
+
# @return [Types::DescribeRegistryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
585
|
+
#
|
586
|
+
# * {Types::DescribeRegistryResponse#description #description} => String
|
587
|
+
# * {Types::DescribeRegistryResponse#registry_arn #registry_arn} => String
|
588
|
+
# * {Types::DescribeRegistryResponse#registry_name #registry_name} => String
|
589
|
+
# * {Types::DescribeRegistryResponse#tags #tags} => Hash<String,String>
|
590
|
+
#
|
591
|
+
# @example Request syntax with placeholder values
|
592
|
+
#
|
593
|
+
# resp = client.describe_registry({
|
594
|
+
# registry_name: "__string", # required
|
595
|
+
# })
|
596
|
+
#
|
597
|
+
# @example Response structure
|
598
|
+
#
|
599
|
+
# resp.description #=> String
|
600
|
+
# resp.registry_arn #=> String
|
601
|
+
# resp.registry_name #=> String
|
602
|
+
# resp.tags #=> Hash
|
603
|
+
# resp.tags["__string"] #=> String
|
604
|
+
#
|
605
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/schemas-2019-12-02/DescribeRegistry AWS API Documentation
|
606
|
+
#
|
607
|
+
# @overload describe_registry(params = {})
|
608
|
+
# @param [Hash] params ({})
|
609
|
+
def describe_registry(params = {}, options = {})
|
610
|
+
req = build_request(:describe_registry, params)
|
611
|
+
req.send_request(options)
|
612
|
+
end
|
613
|
+
|
614
|
+
# Retrieve the schema definition.
|
615
|
+
#
|
616
|
+
# @option params [required, String] :registry_name
|
617
|
+
#
|
618
|
+
# @option params [required, String] :schema_name
|
619
|
+
#
|
620
|
+
# @option params [String] :schema_version
|
621
|
+
#
|
622
|
+
# @return [Types::DescribeSchemaResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
623
|
+
#
|
624
|
+
# * {Types::DescribeSchemaResponse#content #content} => String
|
625
|
+
# * {Types::DescribeSchemaResponse#description #description} => String
|
626
|
+
# * {Types::DescribeSchemaResponse#last_modified #last_modified} => Time
|
627
|
+
# * {Types::DescribeSchemaResponse#schema_arn #schema_arn} => String
|
628
|
+
# * {Types::DescribeSchemaResponse#schema_name #schema_name} => String
|
629
|
+
# * {Types::DescribeSchemaResponse#schema_version #schema_version} => String
|
630
|
+
# * {Types::DescribeSchemaResponse#tags #tags} => Hash<String,String>
|
631
|
+
# * {Types::DescribeSchemaResponse#type #type} => String
|
632
|
+
# * {Types::DescribeSchemaResponse#version_created_date #version_created_date} => Time
|
633
|
+
#
|
634
|
+
# @example Request syntax with placeholder values
|
635
|
+
#
|
636
|
+
# resp = client.describe_schema({
|
637
|
+
# registry_name: "__string", # required
|
638
|
+
# schema_name: "__string", # required
|
639
|
+
# schema_version: "__string",
|
640
|
+
# })
|
641
|
+
#
|
642
|
+
# @example Response structure
|
643
|
+
#
|
644
|
+
# resp.content #=> String
|
645
|
+
# resp.description #=> String
|
646
|
+
# resp.last_modified #=> Time
|
647
|
+
# resp.schema_arn #=> String
|
648
|
+
# resp.schema_name #=> String
|
649
|
+
# resp.schema_version #=> String
|
650
|
+
# resp.tags #=> Hash
|
651
|
+
# resp.tags["__string"] #=> String
|
652
|
+
# resp.type #=> String
|
653
|
+
# resp.version_created_date #=> Time
|
654
|
+
#
|
655
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/schemas-2019-12-02/DescribeSchema AWS API Documentation
|
656
|
+
#
|
657
|
+
# @overload describe_schema(params = {})
|
658
|
+
# @param [Hash] params ({})
|
659
|
+
def describe_schema(params = {}, options = {})
|
660
|
+
req = build_request(:describe_schema, params)
|
661
|
+
req.send_request(options)
|
662
|
+
end
|
663
|
+
|
664
|
+
# Get the code binding source URI.
|
665
|
+
#
|
666
|
+
# @option params [required, String] :language
|
667
|
+
#
|
668
|
+
# @option params [required, String] :registry_name
|
669
|
+
#
|
670
|
+
# @option params [required, String] :schema_name
|
671
|
+
#
|
672
|
+
# @option params [String] :schema_version
|
673
|
+
#
|
674
|
+
# @return [Types::GetCodeBindingSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
675
|
+
#
|
676
|
+
# * {Types::GetCodeBindingSourceResponse#body #body} => IO
|
677
|
+
#
|
678
|
+
# @example Request syntax with placeholder values
|
679
|
+
#
|
680
|
+
# resp = client.get_code_binding_source({
|
681
|
+
# language: "__string", # required
|
682
|
+
# registry_name: "__string", # required
|
683
|
+
# schema_name: "__string", # required
|
684
|
+
# schema_version: "__string",
|
685
|
+
# })
|
686
|
+
#
|
687
|
+
# @example Response structure
|
688
|
+
#
|
689
|
+
# resp.body #=> IO
|
690
|
+
#
|
691
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/schemas-2019-12-02/GetCodeBindingSource AWS API Documentation
|
692
|
+
#
|
693
|
+
# @overload get_code_binding_source(params = {})
|
694
|
+
# @param [Hash] params ({})
|
695
|
+
def get_code_binding_source(params = {}, options = {}, &block)
|
696
|
+
req = build_request(:get_code_binding_source, params)
|
697
|
+
req.send_request(options, &block)
|
698
|
+
end
|
699
|
+
|
700
|
+
# Get the discovered schema that was generated based on sampled events.
|
701
|
+
#
|
702
|
+
# @option params [required, Array<String>] :events
|
703
|
+
#
|
704
|
+
# @option params [required, String] :type
|
705
|
+
#
|
706
|
+
# @return [Types::GetDiscoveredSchemaResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
707
|
+
#
|
708
|
+
# * {Types::GetDiscoveredSchemaResponse#content #content} => String
|
709
|
+
#
|
710
|
+
# @example Request syntax with placeholder values
|
711
|
+
#
|
712
|
+
# resp = client.get_discovered_schema({
|
713
|
+
# events: ["GetDiscoveredSchemaVersionItemInput"], # required
|
714
|
+
# type: "OpenApi3", # required, accepts OpenApi3
|
715
|
+
# })
|
716
|
+
#
|
717
|
+
# @example Response structure
|
718
|
+
#
|
719
|
+
# resp.content #=> String
|
720
|
+
#
|
721
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/schemas-2019-12-02/GetDiscoveredSchema AWS API Documentation
|
722
|
+
#
|
723
|
+
# @overload get_discovered_schema(params = {})
|
724
|
+
# @param [Hash] params ({})
|
725
|
+
def get_discovered_schema(params = {}, options = {})
|
726
|
+
req = build_request(:get_discovered_schema, params)
|
727
|
+
req.send_request(options)
|
728
|
+
end
|
729
|
+
|
730
|
+
# List the discoverers.
|
731
|
+
#
|
732
|
+
# @option params [String] :discoverer_id_prefix
|
733
|
+
#
|
734
|
+
# @option params [Integer] :limit
|
735
|
+
#
|
736
|
+
# @option params [String] :next_token
|
737
|
+
#
|
738
|
+
# @option params [String] :source_arn_prefix
|
739
|
+
#
|
740
|
+
# @return [Types::ListDiscoverersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
741
|
+
#
|
742
|
+
# * {Types::ListDiscoverersResponse#discoverers #discoverers} => Array<Types::DiscovererSummary>
|
743
|
+
# * {Types::ListDiscoverersResponse#next_token #next_token} => String
|
744
|
+
#
|
745
|
+
# @example Request syntax with placeholder values
|
746
|
+
#
|
747
|
+
# resp = client.list_discoverers({
|
748
|
+
# discoverer_id_prefix: "__string",
|
749
|
+
# limit: 1,
|
750
|
+
# next_token: "__string",
|
751
|
+
# source_arn_prefix: "__string",
|
752
|
+
# })
|
753
|
+
#
|
754
|
+
# @example Response structure
|
755
|
+
#
|
756
|
+
# resp.discoverers #=> Array
|
757
|
+
# resp.discoverers[0].discoverer_arn #=> String
|
758
|
+
# resp.discoverers[0].discoverer_id #=> String
|
759
|
+
# resp.discoverers[0].source_arn #=> String
|
760
|
+
# resp.discoverers[0].state #=> String, one of "STARTED", "STOPPED"
|
761
|
+
# resp.discoverers[0].tags #=> Hash
|
762
|
+
# resp.discoverers[0].tags["__string"] #=> String
|
763
|
+
# resp.next_token #=> String
|
764
|
+
#
|
765
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/schemas-2019-12-02/ListDiscoverers AWS API Documentation
|
766
|
+
#
|
767
|
+
# @overload list_discoverers(params = {})
|
768
|
+
# @param [Hash] params ({})
|
769
|
+
def list_discoverers(params = {}, options = {})
|
770
|
+
req = build_request(:list_discoverers, params)
|
771
|
+
req.send_request(options)
|
772
|
+
end
|
773
|
+
|
774
|
+
# List the registries.
|
775
|
+
#
|
776
|
+
# @option params [Integer] :limit
|
777
|
+
#
|
778
|
+
# @option params [String] :next_token
|
779
|
+
#
|
780
|
+
# @option params [String] :registry_name_prefix
|
781
|
+
#
|
782
|
+
# @option params [String] :scope
|
783
|
+
#
|
784
|
+
# @return [Types::ListRegistriesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
785
|
+
#
|
786
|
+
# * {Types::ListRegistriesResponse#next_token #next_token} => String
|
787
|
+
# * {Types::ListRegistriesResponse#registries #registries} => Array<Types::RegistrySummary>
|
788
|
+
#
|
789
|
+
# @example Request syntax with placeholder values
|
790
|
+
#
|
791
|
+
# resp = client.list_registries({
|
792
|
+
# limit: 1,
|
793
|
+
# next_token: "__string",
|
794
|
+
# registry_name_prefix: "__string",
|
795
|
+
# scope: "__string",
|
796
|
+
# })
|
797
|
+
#
|
798
|
+
# @example Response structure
|
799
|
+
#
|
800
|
+
# resp.next_token #=> String
|
801
|
+
# resp.registries #=> Array
|
802
|
+
# resp.registries[0].registry_arn #=> String
|
803
|
+
# resp.registries[0].registry_name #=> String
|
804
|
+
# resp.registries[0].tags #=> Hash
|
805
|
+
# resp.registries[0].tags["__string"] #=> String
|
806
|
+
#
|
807
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/schemas-2019-12-02/ListRegistries AWS API Documentation
|
808
|
+
#
|
809
|
+
# @overload list_registries(params = {})
|
810
|
+
# @param [Hash] params ({})
|
811
|
+
def list_registries(params = {}, options = {})
|
812
|
+
req = build_request(:list_registries, params)
|
813
|
+
req.send_request(options)
|
814
|
+
end
|
815
|
+
|
816
|
+
# Provides a list of the schema versions and related information.
|
817
|
+
#
|
818
|
+
# @option params [Integer] :limit
|
819
|
+
#
|
820
|
+
# @option params [String] :next_token
|
821
|
+
#
|
822
|
+
# @option params [required, String] :registry_name
|
823
|
+
#
|
824
|
+
# @option params [required, String] :schema_name
|
825
|
+
#
|
826
|
+
# @return [Types::ListSchemaVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
827
|
+
#
|
828
|
+
# * {Types::ListSchemaVersionsResponse#next_token #next_token} => String
|
829
|
+
# * {Types::ListSchemaVersionsResponse#schema_versions #schema_versions} => Array<Types::SchemaVersionSummary>
|
830
|
+
#
|
831
|
+
# @example Request syntax with placeholder values
|
832
|
+
#
|
833
|
+
# resp = client.list_schema_versions({
|
834
|
+
# limit: 1,
|
835
|
+
# next_token: "__string",
|
836
|
+
# registry_name: "__string", # required
|
837
|
+
# schema_name: "__string", # required
|
838
|
+
# })
|
839
|
+
#
|
840
|
+
# @example Response structure
|
841
|
+
#
|
842
|
+
# resp.next_token #=> String
|
843
|
+
# resp.schema_versions #=> Array
|
844
|
+
# resp.schema_versions[0].schema_arn #=> String
|
845
|
+
# resp.schema_versions[0].schema_name #=> String
|
846
|
+
# resp.schema_versions[0].schema_version #=> String
|
847
|
+
#
|
848
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/schemas-2019-12-02/ListSchemaVersions AWS API Documentation
|
849
|
+
#
|
850
|
+
# @overload list_schema_versions(params = {})
|
851
|
+
# @param [Hash] params ({})
|
852
|
+
def list_schema_versions(params = {}, options = {})
|
853
|
+
req = build_request(:list_schema_versions, params)
|
854
|
+
req.send_request(options)
|
855
|
+
end
|
856
|
+
|
857
|
+
# List the schemas.
|
858
|
+
#
|
859
|
+
# @option params [Integer] :limit
|
860
|
+
#
|
861
|
+
# @option params [String] :next_token
|
862
|
+
#
|
863
|
+
# @option params [required, String] :registry_name
|
864
|
+
#
|
865
|
+
# @option params [String] :schema_name_prefix
|
866
|
+
#
|
867
|
+
# @return [Types::ListSchemasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
868
|
+
#
|
869
|
+
# * {Types::ListSchemasResponse#next_token #next_token} => String
|
870
|
+
# * {Types::ListSchemasResponse#schemas #schemas} => Array<Types::SchemaSummary>
|
871
|
+
#
|
872
|
+
# @example Request syntax with placeholder values
|
873
|
+
#
|
874
|
+
# resp = client.list_schemas({
|
875
|
+
# limit: 1,
|
876
|
+
# next_token: "__string",
|
877
|
+
# registry_name: "__string", # required
|
878
|
+
# schema_name_prefix: "__string",
|
879
|
+
# })
|
880
|
+
#
|
881
|
+
# @example Response structure
|
882
|
+
#
|
883
|
+
# resp.next_token #=> String
|
884
|
+
# resp.schemas #=> Array
|
885
|
+
# resp.schemas[0].last_modified #=> Time
|
886
|
+
# resp.schemas[0].schema_arn #=> String
|
887
|
+
# resp.schemas[0].schema_name #=> String
|
888
|
+
# resp.schemas[0].tags #=> Hash
|
889
|
+
# resp.schemas[0].tags["__string"] #=> String
|
890
|
+
# resp.schemas[0].version_count #=> Integer
|
891
|
+
#
|
892
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/schemas-2019-12-02/ListSchemas AWS API Documentation
|
893
|
+
#
|
894
|
+
# @overload list_schemas(params = {})
|
895
|
+
# @param [Hash] params ({})
|
896
|
+
def list_schemas(params = {}, options = {})
|
897
|
+
req = build_request(:list_schemas, params)
|
898
|
+
req.send_request(options)
|
899
|
+
end
|
900
|
+
|
901
|
+
# Get tags for resource.
|
902
|
+
#
|
903
|
+
# @option params [required, String] :resource_arn
|
904
|
+
#
|
905
|
+
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
906
|
+
#
|
907
|
+
# * {Types::ListTagsForResourceResponse#tags #tags} => Hash<String,String>
|
908
|
+
#
|
909
|
+
# @example Request syntax with placeholder values
|
910
|
+
#
|
911
|
+
# resp = client.list_tags_for_resource({
|
912
|
+
# resource_arn: "__string", # required
|
913
|
+
# })
|
914
|
+
#
|
915
|
+
# @example Response structure
|
916
|
+
#
|
917
|
+
# resp.tags #=> Hash
|
918
|
+
# resp.tags["__string"] #=> String
|
919
|
+
#
|
920
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/schemas-2019-12-02/ListTagsForResource AWS API Documentation
|
921
|
+
#
|
922
|
+
# @overload list_tags_for_resource(params = {})
|
923
|
+
# @param [Hash] params ({})
|
924
|
+
def list_tags_for_resource(params = {}, options = {})
|
925
|
+
req = build_request(:list_tags_for_resource, params)
|
926
|
+
req.send_request(options)
|
927
|
+
end
|
928
|
+
|
929
|
+
# @option params [required, String] :role_arn
|
930
|
+
#
|
931
|
+
# @option params [required, Integer] :timeout
|
932
|
+
#
|
933
|
+
# @return [Types::LockServiceLinkedRoleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
934
|
+
#
|
935
|
+
# * {Types::LockServiceLinkedRoleResponse#can_be_deleted #can_be_deleted} => Boolean
|
936
|
+
# * {Types::LockServiceLinkedRoleResponse#reason_of_failure #reason_of_failure} => String
|
937
|
+
# * {Types::LockServiceLinkedRoleResponse#related_resources #related_resources} => Array<Types::DiscovererSummary>
|
938
|
+
#
|
939
|
+
# @example Request syntax with placeholder values
|
940
|
+
#
|
941
|
+
# resp = client.lock_service_linked_role({
|
942
|
+
# role_arn: "__stringMin1Max1600", # required
|
943
|
+
# timeout: 1, # required
|
944
|
+
# })
|
945
|
+
#
|
946
|
+
# @example Response structure
|
947
|
+
#
|
948
|
+
# resp.can_be_deleted #=> Boolean
|
949
|
+
# resp.reason_of_failure #=> String
|
950
|
+
# resp.related_resources #=> Array
|
951
|
+
# resp.related_resources[0].discoverer_arn #=> String
|
952
|
+
# resp.related_resources[0].discoverer_id #=> String
|
953
|
+
# resp.related_resources[0].source_arn #=> String
|
954
|
+
# resp.related_resources[0].state #=> String, one of "STARTED", "STOPPED"
|
955
|
+
# resp.related_resources[0].tags #=> Hash
|
956
|
+
# resp.related_resources[0].tags["__string"] #=> String
|
957
|
+
#
|
958
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/schemas-2019-12-02/LockServiceLinkedRole AWS API Documentation
|
959
|
+
#
|
960
|
+
# @overload lock_service_linked_role(params = {})
|
961
|
+
# @param [Hash] params ({})
|
962
|
+
def lock_service_linked_role(params = {}, options = {})
|
963
|
+
req = build_request(:lock_service_linked_role, params)
|
964
|
+
req.send_request(options)
|
965
|
+
end
|
966
|
+
|
967
|
+
# Put code binding URI
|
968
|
+
#
|
969
|
+
# @option params [required, String] :language
|
970
|
+
#
|
971
|
+
# @option params [required, String] :registry_name
|
972
|
+
#
|
973
|
+
# @option params [required, String] :schema_name
|
974
|
+
#
|
975
|
+
# @option params [String] :schema_version
|
976
|
+
#
|
977
|
+
# @return [Types::PutCodeBindingResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
978
|
+
#
|
979
|
+
# * {Types::PutCodeBindingResponse#creation_date #creation_date} => Time
|
980
|
+
# * {Types::PutCodeBindingResponse#last_modified #last_modified} => Time
|
981
|
+
# * {Types::PutCodeBindingResponse#schema_version #schema_version} => String
|
982
|
+
# * {Types::PutCodeBindingResponse#status #status} => String
|
983
|
+
#
|
984
|
+
# @example Request syntax with placeholder values
|
985
|
+
#
|
986
|
+
# resp = client.put_code_binding({
|
987
|
+
# language: "__string", # required
|
988
|
+
# registry_name: "__string", # required
|
989
|
+
# schema_name: "__string", # required
|
990
|
+
# schema_version: "__string",
|
991
|
+
# })
|
992
|
+
#
|
993
|
+
# @example Response structure
|
994
|
+
#
|
995
|
+
# resp.creation_date #=> Time
|
996
|
+
# resp.last_modified #=> Time
|
997
|
+
# resp.schema_version #=> String
|
998
|
+
# resp.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "CREATE_FAILED"
|
999
|
+
#
|
1000
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/schemas-2019-12-02/PutCodeBinding AWS API Documentation
|
1001
|
+
#
|
1002
|
+
# @overload put_code_binding(params = {})
|
1003
|
+
# @param [Hash] params ({})
|
1004
|
+
def put_code_binding(params = {}, options = {})
|
1005
|
+
req = build_request(:put_code_binding, params)
|
1006
|
+
req.send_request(options)
|
1007
|
+
end
|
1008
|
+
|
1009
|
+
# Search the schemas
|
1010
|
+
#
|
1011
|
+
# @option params [required, String] :keywords
|
1012
|
+
#
|
1013
|
+
# @option params [Integer] :limit
|
1014
|
+
#
|
1015
|
+
# @option params [String] :next_token
|
1016
|
+
#
|
1017
|
+
# @option params [required, String] :registry_name
|
1018
|
+
#
|
1019
|
+
# @return [Types::SearchSchemasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1020
|
+
#
|
1021
|
+
# * {Types::SearchSchemasResponse#next_token #next_token} => String
|
1022
|
+
# * {Types::SearchSchemasResponse#schemas #schemas} => Array<Types::SearchSchemaSummary>
|
1023
|
+
#
|
1024
|
+
# @example Request syntax with placeholder values
|
1025
|
+
#
|
1026
|
+
# resp = client.search_schemas({
|
1027
|
+
# keywords: "__string", # required
|
1028
|
+
# limit: 1,
|
1029
|
+
# next_token: "__string",
|
1030
|
+
# registry_name: "__string", # required
|
1031
|
+
# })
|
1032
|
+
#
|
1033
|
+
# @example Response structure
|
1034
|
+
#
|
1035
|
+
# resp.next_token #=> String
|
1036
|
+
# resp.schemas #=> Array
|
1037
|
+
# resp.schemas[0].registry_name #=> String
|
1038
|
+
# resp.schemas[0].schema_arn #=> String
|
1039
|
+
# resp.schemas[0].schema_name #=> String
|
1040
|
+
# resp.schemas[0].schema_versions #=> Array
|
1041
|
+
# resp.schemas[0].schema_versions[0].created_date #=> Time
|
1042
|
+
# resp.schemas[0].schema_versions[0].schema_version #=> String
|
1043
|
+
#
|
1044
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/schemas-2019-12-02/SearchSchemas AWS API Documentation
|
1045
|
+
#
|
1046
|
+
# @overload search_schemas(params = {})
|
1047
|
+
# @param [Hash] params ({})
|
1048
|
+
def search_schemas(params = {}, options = {})
|
1049
|
+
req = build_request(:search_schemas, params)
|
1050
|
+
req.send_request(options)
|
1051
|
+
end
|
1052
|
+
|
1053
|
+
# Starts the discoverer
|
1054
|
+
#
|
1055
|
+
# @option params [required, String] :discoverer_id
|
1056
|
+
#
|
1057
|
+
# @return [Types::StartDiscovererResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1058
|
+
#
|
1059
|
+
# * {Types::StartDiscovererResponse#discoverer_id #discoverer_id} => String
|
1060
|
+
# * {Types::StartDiscovererResponse#state #state} => String
|
1061
|
+
#
|
1062
|
+
# @example Request syntax with placeholder values
|
1063
|
+
#
|
1064
|
+
# resp = client.start_discoverer({
|
1065
|
+
# discoverer_id: "__string", # required
|
1066
|
+
# })
|
1067
|
+
#
|
1068
|
+
# @example Response structure
|
1069
|
+
#
|
1070
|
+
# resp.discoverer_id #=> String
|
1071
|
+
# resp.state #=> String, one of "STARTED", "STOPPED"
|
1072
|
+
#
|
1073
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/schemas-2019-12-02/StartDiscoverer AWS API Documentation
|
1074
|
+
#
|
1075
|
+
# @overload start_discoverer(params = {})
|
1076
|
+
# @param [Hash] params ({})
|
1077
|
+
def start_discoverer(params = {}, options = {})
|
1078
|
+
req = build_request(:start_discoverer, params)
|
1079
|
+
req.send_request(options)
|
1080
|
+
end
|
1081
|
+
|
1082
|
+
# Stops the discoverer
|
1083
|
+
#
|
1084
|
+
# @option params [required, String] :discoverer_id
|
1085
|
+
#
|
1086
|
+
# @return [Types::StopDiscovererResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1087
|
+
#
|
1088
|
+
# * {Types::StopDiscovererResponse#discoverer_id #discoverer_id} => String
|
1089
|
+
# * {Types::StopDiscovererResponse#state #state} => String
|
1090
|
+
#
|
1091
|
+
# @example Request syntax with placeholder values
|
1092
|
+
#
|
1093
|
+
# resp = client.stop_discoverer({
|
1094
|
+
# discoverer_id: "__string", # required
|
1095
|
+
# })
|
1096
|
+
#
|
1097
|
+
# @example Response structure
|
1098
|
+
#
|
1099
|
+
# resp.discoverer_id #=> String
|
1100
|
+
# resp.state #=> String, one of "STARTED", "STOPPED"
|
1101
|
+
#
|
1102
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/schemas-2019-12-02/StopDiscoverer AWS API Documentation
|
1103
|
+
#
|
1104
|
+
# @overload stop_discoverer(params = {})
|
1105
|
+
# @param [Hash] params ({})
|
1106
|
+
def stop_discoverer(params = {}, options = {})
|
1107
|
+
req = build_request(:stop_discoverer, params)
|
1108
|
+
req.send_request(options)
|
1109
|
+
end
|
1110
|
+
|
1111
|
+
# Add tags to a resource.
|
1112
|
+
#
|
1113
|
+
# @option params [required, String] :resource_arn
|
1114
|
+
#
|
1115
|
+
# @option params [required, Hash<String,String>] :tags
|
1116
|
+
# Key-value pairs associated with a resource.
|
1117
|
+
#
|
1118
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1119
|
+
#
|
1120
|
+
# @example Request syntax with placeholder values
|
1121
|
+
#
|
1122
|
+
# resp = client.tag_resource({
|
1123
|
+
# resource_arn: "__string", # required
|
1124
|
+
# tags: { # required
|
1125
|
+
# "__string" => "__string",
|
1126
|
+
# },
|
1127
|
+
# })
|
1128
|
+
#
|
1129
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/schemas-2019-12-02/TagResource AWS API Documentation
|
1130
|
+
#
|
1131
|
+
# @overload tag_resource(params = {})
|
1132
|
+
# @param [Hash] params ({})
|
1133
|
+
def tag_resource(params = {}, options = {})
|
1134
|
+
req = build_request(:tag_resource, params)
|
1135
|
+
req.send_request(options)
|
1136
|
+
end
|
1137
|
+
|
1138
|
+
# @option params [required, String] :role_arn
|
1139
|
+
#
|
1140
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1141
|
+
#
|
1142
|
+
# @example Request syntax with placeholder values
|
1143
|
+
#
|
1144
|
+
# resp = client.unlock_service_linked_role({
|
1145
|
+
# role_arn: "__stringMin1Max1600", # required
|
1146
|
+
# })
|
1147
|
+
#
|
1148
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/schemas-2019-12-02/UnlockServiceLinkedRole AWS API Documentation
|
1149
|
+
#
|
1150
|
+
# @overload unlock_service_linked_role(params = {})
|
1151
|
+
# @param [Hash] params ({})
|
1152
|
+
def unlock_service_linked_role(params = {}, options = {})
|
1153
|
+
req = build_request(:unlock_service_linked_role, params)
|
1154
|
+
req.send_request(options)
|
1155
|
+
end
|
1156
|
+
|
1157
|
+
# Removes tags from a resource.
|
1158
|
+
#
|
1159
|
+
# @option params [required, String] :resource_arn
|
1160
|
+
#
|
1161
|
+
# @option params [required, Array<String>] :tag_keys
|
1162
|
+
#
|
1163
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1164
|
+
#
|
1165
|
+
# @example Request syntax with placeholder values
|
1166
|
+
#
|
1167
|
+
# resp = client.untag_resource({
|
1168
|
+
# resource_arn: "__string", # required
|
1169
|
+
# tag_keys: ["__string"], # required
|
1170
|
+
# })
|
1171
|
+
#
|
1172
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/schemas-2019-12-02/UntagResource AWS API Documentation
|
1173
|
+
#
|
1174
|
+
# @overload untag_resource(params = {})
|
1175
|
+
# @param [Hash] params ({})
|
1176
|
+
def untag_resource(params = {}, options = {})
|
1177
|
+
req = build_request(:untag_resource, params)
|
1178
|
+
req.send_request(options)
|
1179
|
+
end
|
1180
|
+
|
1181
|
+
# Updates the discoverer
|
1182
|
+
#
|
1183
|
+
# @option params [String] :description
|
1184
|
+
#
|
1185
|
+
# @option params [required, String] :discoverer_id
|
1186
|
+
#
|
1187
|
+
# @return [Types::UpdateDiscovererResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1188
|
+
#
|
1189
|
+
# * {Types::UpdateDiscovererResponse#description #description} => String
|
1190
|
+
# * {Types::UpdateDiscovererResponse#discoverer_arn #discoverer_arn} => String
|
1191
|
+
# * {Types::UpdateDiscovererResponse#discoverer_id #discoverer_id} => String
|
1192
|
+
# * {Types::UpdateDiscovererResponse#source_arn #source_arn} => String
|
1193
|
+
# * {Types::UpdateDiscovererResponse#state #state} => String
|
1194
|
+
# * {Types::UpdateDiscovererResponse#tags #tags} => Hash<String,String>
|
1195
|
+
#
|
1196
|
+
# @example Request syntax with placeholder values
|
1197
|
+
#
|
1198
|
+
# resp = client.update_discoverer({
|
1199
|
+
# description: "__stringMin0Max256",
|
1200
|
+
# discoverer_id: "__string", # required
|
1201
|
+
# })
|
1202
|
+
#
|
1203
|
+
# @example Response structure
|
1204
|
+
#
|
1205
|
+
# resp.description #=> String
|
1206
|
+
# resp.discoverer_arn #=> String
|
1207
|
+
# resp.discoverer_id #=> String
|
1208
|
+
# resp.source_arn #=> String
|
1209
|
+
# resp.state #=> String, one of "STARTED", "STOPPED"
|
1210
|
+
# resp.tags #=> Hash
|
1211
|
+
# resp.tags["__string"] #=> String
|
1212
|
+
#
|
1213
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/schemas-2019-12-02/UpdateDiscoverer AWS API Documentation
|
1214
|
+
#
|
1215
|
+
# @overload update_discoverer(params = {})
|
1216
|
+
# @param [Hash] params ({})
|
1217
|
+
def update_discoverer(params = {}, options = {})
|
1218
|
+
req = build_request(:update_discoverer, params)
|
1219
|
+
req.send_request(options)
|
1220
|
+
end
|
1221
|
+
|
1222
|
+
# Updates a registry.
|
1223
|
+
#
|
1224
|
+
# @option params [String] :description
|
1225
|
+
#
|
1226
|
+
# @option params [required, String] :registry_name
|
1227
|
+
#
|
1228
|
+
# @return [Types::UpdateRegistryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1229
|
+
#
|
1230
|
+
# * {Types::UpdateRegistryResponse#description #description} => String
|
1231
|
+
# * {Types::UpdateRegistryResponse#registry_arn #registry_arn} => String
|
1232
|
+
# * {Types::UpdateRegistryResponse#registry_name #registry_name} => String
|
1233
|
+
# * {Types::UpdateRegistryResponse#tags #tags} => Hash<String,String>
|
1234
|
+
#
|
1235
|
+
# @example Request syntax with placeholder values
|
1236
|
+
#
|
1237
|
+
# resp = client.update_registry({
|
1238
|
+
# description: "__stringMin0Max256",
|
1239
|
+
# registry_name: "__string", # required
|
1240
|
+
# })
|
1241
|
+
#
|
1242
|
+
# @example Response structure
|
1243
|
+
#
|
1244
|
+
# resp.description #=> String
|
1245
|
+
# resp.registry_arn #=> String
|
1246
|
+
# resp.registry_name #=> String
|
1247
|
+
# resp.tags #=> Hash
|
1248
|
+
# resp.tags["__string"] #=> String
|
1249
|
+
#
|
1250
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/schemas-2019-12-02/UpdateRegistry AWS API Documentation
|
1251
|
+
#
|
1252
|
+
# @overload update_registry(params = {})
|
1253
|
+
# @param [Hash] params ({})
|
1254
|
+
def update_registry(params = {}, options = {})
|
1255
|
+
req = build_request(:update_registry, params)
|
1256
|
+
req.send_request(options)
|
1257
|
+
end
|
1258
|
+
|
1259
|
+
# Updates the schema definition
|
1260
|
+
#
|
1261
|
+
# @option params [String] :client_token_id
|
1262
|
+
# **A suitable default value is auto-generated.** You should normally
|
1263
|
+
# not need to pass this option.**
|
1264
|
+
#
|
1265
|
+
# @option params [String] :content
|
1266
|
+
#
|
1267
|
+
# @option params [String] :description
|
1268
|
+
#
|
1269
|
+
# @option params [required, String] :registry_name
|
1270
|
+
#
|
1271
|
+
# @option params [required, String] :schema_name
|
1272
|
+
#
|
1273
|
+
# @option params [String] :type
|
1274
|
+
#
|
1275
|
+
# @return [Types::UpdateSchemaResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1276
|
+
#
|
1277
|
+
# * {Types::UpdateSchemaResponse#description #description} => String
|
1278
|
+
# * {Types::UpdateSchemaResponse#last_modified #last_modified} => Time
|
1279
|
+
# * {Types::UpdateSchemaResponse#schema_arn #schema_arn} => String
|
1280
|
+
# * {Types::UpdateSchemaResponse#schema_name #schema_name} => String
|
1281
|
+
# * {Types::UpdateSchemaResponse#schema_version #schema_version} => String
|
1282
|
+
# * {Types::UpdateSchemaResponse#tags #tags} => Hash<String,String>
|
1283
|
+
# * {Types::UpdateSchemaResponse#type #type} => String
|
1284
|
+
# * {Types::UpdateSchemaResponse#version_created_date #version_created_date} => Time
|
1285
|
+
#
|
1286
|
+
# @example Request syntax with placeholder values
|
1287
|
+
#
|
1288
|
+
# resp = client.update_schema({
|
1289
|
+
# client_token_id: "__stringMin0Max36",
|
1290
|
+
# content: "__stringMin1Max100000",
|
1291
|
+
# description: "__stringMin0Max256",
|
1292
|
+
# registry_name: "__string", # required
|
1293
|
+
# schema_name: "__string", # required
|
1294
|
+
# type: "OpenApi3", # accepts OpenApi3
|
1295
|
+
# })
|
1296
|
+
#
|
1297
|
+
# @example Response structure
|
1298
|
+
#
|
1299
|
+
# resp.description #=> String
|
1300
|
+
# resp.last_modified #=> Time
|
1301
|
+
# resp.schema_arn #=> String
|
1302
|
+
# resp.schema_name #=> String
|
1303
|
+
# resp.schema_version #=> String
|
1304
|
+
# resp.tags #=> Hash
|
1305
|
+
# resp.tags["__string"] #=> String
|
1306
|
+
# resp.type #=> String
|
1307
|
+
# resp.version_created_date #=> Time
|
1308
|
+
#
|
1309
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/schemas-2019-12-02/UpdateSchema AWS API Documentation
|
1310
|
+
#
|
1311
|
+
# @overload update_schema(params = {})
|
1312
|
+
# @param [Hash] params ({})
|
1313
|
+
def update_schema(params = {}, options = {})
|
1314
|
+
req = build_request(:update_schema, params)
|
1315
|
+
req.send_request(options)
|
1316
|
+
end
|
1317
|
+
|
1318
|
+
# @!endgroup
|
1319
|
+
|
1320
|
+
# @param params ({})
|
1321
|
+
# @api private
|
1322
|
+
def build_request(operation_name, params = {})
|
1323
|
+
handlers = @handlers.for(operation_name)
|
1324
|
+
context = Seahorse::Client::RequestContext.new(
|
1325
|
+
operation_name: operation_name,
|
1326
|
+
operation: config.api.operation(operation_name),
|
1327
|
+
client: self,
|
1328
|
+
params: params,
|
1329
|
+
config: config)
|
1330
|
+
context[:gem_name] = 'aws-sdk-schemas'
|
1331
|
+
context[:gem_version] = '1.0.0'
|
1332
|
+
Seahorse::Client::Request.new(handlers, context)
|
1333
|
+
end
|
1334
|
+
|
1335
|
+
# Polls an API operation until a resource enters a desired state.
|
1336
|
+
#
|
1337
|
+
# ## Basic Usage
|
1338
|
+
#
|
1339
|
+
# A waiter will call an API operation until:
|
1340
|
+
#
|
1341
|
+
# * It is successful
|
1342
|
+
# * It enters a terminal state
|
1343
|
+
# * It makes the maximum number of attempts
|
1344
|
+
#
|
1345
|
+
# In between attempts, the waiter will sleep.
|
1346
|
+
#
|
1347
|
+
# # polls in a loop, sleeping between attempts
|
1348
|
+
# client.wait_until(waiter_name, params)
|
1349
|
+
#
|
1350
|
+
# ## Configuration
|
1351
|
+
#
|
1352
|
+
# You can configure the maximum number of polling attempts, and the
|
1353
|
+
# delay (in seconds) between each polling attempt. You can pass
|
1354
|
+
# configuration as the final arguments hash.
|
1355
|
+
#
|
1356
|
+
# # poll for ~25 seconds
|
1357
|
+
# client.wait_until(waiter_name, params, {
|
1358
|
+
# max_attempts: 5,
|
1359
|
+
# delay: 5,
|
1360
|
+
# })
|
1361
|
+
#
|
1362
|
+
# ## Callbacks
|
1363
|
+
#
|
1364
|
+
# You can be notified before each polling attempt and before each
|
1365
|
+
# delay. If you throw `:success` or `:failure` from these callbacks,
|
1366
|
+
# it will terminate the waiter.
|
1367
|
+
#
|
1368
|
+
# started_at = Time.now
|
1369
|
+
# client.wait_until(waiter_name, params, {
|
1370
|
+
#
|
1371
|
+
# # disable max attempts
|
1372
|
+
# max_attempts: nil,
|
1373
|
+
#
|
1374
|
+
# # poll for 1 hour, instead of a number of attempts
|
1375
|
+
# before_wait: -> (attempts, response) do
|
1376
|
+
# throw :failure if Time.now - started_at > 3600
|
1377
|
+
# end
|
1378
|
+
# })
|
1379
|
+
#
|
1380
|
+
# ## Handling Errors
|
1381
|
+
#
|
1382
|
+
# When a waiter is unsuccessful, it will raise an error.
|
1383
|
+
# All of the failure errors extend from
|
1384
|
+
# {Aws::Waiters::Errors::WaiterFailed}.
|
1385
|
+
#
|
1386
|
+
# begin
|
1387
|
+
# client.wait_until(...)
|
1388
|
+
# rescue Aws::Waiters::Errors::WaiterFailed
|
1389
|
+
# # resource did not enter the desired state in time
|
1390
|
+
# end
|
1391
|
+
#
|
1392
|
+
# ## Valid Waiters
|
1393
|
+
#
|
1394
|
+
# The following table lists the valid waiter names, the operations they call,
|
1395
|
+
# and the default `:delay` and `:max_attempts` values.
|
1396
|
+
#
|
1397
|
+
# | waiter_name | params | :delay | :max_attempts |
|
1398
|
+
# | ------------------- | ------------------------ | -------- | ------------- |
|
1399
|
+
# | code_binding_exists | {#describe_code_binding} | 2 | 30 |
|
1400
|
+
#
|
1401
|
+
# @raise [Errors::FailureStateError] Raised when the waiter terminates
|
1402
|
+
# because the waiter has entered a state that it will not transition
|
1403
|
+
# out of, preventing success.
|
1404
|
+
#
|
1405
|
+
# @raise [Errors::TooManyAttemptsError] Raised when the configured
|
1406
|
+
# maximum number of attempts have been made, and the waiter is not
|
1407
|
+
# yet successful.
|
1408
|
+
#
|
1409
|
+
# @raise [Errors::UnexpectedError] Raised when an error is encounted
|
1410
|
+
# while polling for a resource that is not expected.
|
1411
|
+
#
|
1412
|
+
# @raise [Errors::NoSuchWaiterError] Raised when you request to wait
|
1413
|
+
# for an unknown state.
|
1414
|
+
#
|
1415
|
+
# @return [Boolean] Returns `true` if the waiter was successful.
|
1416
|
+
# @param [Symbol] waiter_name
|
1417
|
+
# @param [Hash] params ({})
|
1418
|
+
# @param [Hash] options ({})
|
1419
|
+
# @option options [Integer] :max_attempts
|
1420
|
+
# @option options [Integer] :delay
|
1421
|
+
# @option options [Proc] :before_attempt
|
1422
|
+
# @option options [Proc] :before_wait
|
1423
|
+
def wait_until(waiter_name, params = {}, options = {})
|
1424
|
+
w = waiter(waiter_name, options)
|
1425
|
+
yield(w.waiter) if block_given? # deprecated
|
1426
|
+
w.wait(params)
|
1427
|
+
end
|
1428
|
+
|
1429
|
+
# @api private
|
1430
|
+
# @deprecated
|
1431
|
+
def waiter_names
|
1432
|
+
waiters.keys
|
1433
|
+
end
|
1434
|
+
|
1435
|
+
private
|
1436
|
+
|
1437
|
+
# @param [Symbol] waiter_name
|
1438
|
+
# @param [Hash] options ({})
|
1439
|
+
def waiter(waiter_name, options = {})
|
1440
|
+
waiter_class = waiters[waiter_name]
|
1441
|
+
if waiter_class
|
1442
|
+
waiter_class.new(options.merge(client: self))
|
1443
|
+
else
|
1444
|
+
raise Aws::Waiters::Errors::NoSuchWaiterError.new(waiter_name, waiters.keys)
|
1445
|
+
end
|
1446
|
+
end
|
1447
|
+
|
1448
|
+
def waiters
|
1449
|
+
{
|
1450
|
+
code_binding_exists: Waiters::CodeBindingExists
|
1451
|
+
}
|
1452
|
+
end
|
1453
|
+
|
1454
|
+
class << self
|
1455
|
+
|
1456
|
+
# @api private
|
1457
|
+
attr_reader :identifier
|
1458
|
+
|
1459
|
+
# @api private
|
1460
|
+
def errors_module
|
1461
|
+
Errors
|
1462
|
+
end
|
1463
|
+
|
1464
|
+
end
|
1465
|
+
end
|
1466
|
+
end
|