aws-sdk-amplifybackend 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: c84c5a9e8aa3b5d5f7fb2371a04c34092d3c8b6465d260433b63ddbe0e18b710
4
+ data.tar.gz: bd4ebd53e44d6eb4d9ea215706aab2d9be019108737710a70ce58d1e99af0eb3
5
+ SHA512:
6
+ metadata.gz: d278ecd022ec3519797d6fe250b3c8e42f5ae7240c107dc346769347d26cb0c0670acb905086f82b755f7273c70a1d8f6a63c9c6fe83b95fe6cb22da245971ca
7
+ data.tar.gz: ac26cdd63fc314d4560d8bcd507d468c105f1018ea3348c1f439d63142849292bf08c81606ce567fe569334a46a6dd76b33d9f93fa2f24ab015acba646f34604
@@ -0,0 +1,53 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+
11
+ require 'aws-sdk-core'
12
+ require 'aws-sigv4'
13
+
14
+ require_relative 'aws-sdk-amplifybackend/types'
15
+ require_relative 'aws-sdk-amplifybackend/client_api'
16
+ require_relative 'aws-sdk-amplifybackend/client'
17
+ require_relative 'aws-sdk-amplifybackend/errors'
18
+ require_relative 'aws-sdk-amplifybackend/resource'
19
+ require_relative 'aws-sdk-amplifybackend/customizations'
20
+
21
+ # This module provides support for AmplifyBackend. This module is available in the
22
+ # `aws-sdk-amplifybackend` gem.
23
+ #
24
+ # # Client
25
+ #
26
+ # The {Client} class provides one method for each API operation. Operation
27
+ # methods each accept a hash of request parameters and return a response
28
+ # structure.
29
+ #
30
+ # amplify_backend = Aws::AmplifyBackend::Client.new
31
+ # resp = amplify_backend.clone_backend(params)
32
+ #
33
+ # See {Client} for more information.
34
+ #
35
+ # # Errors
36
+ #
37
+ # Errors returned from AmplifyBackend are defined in the
38
+ # {Errors} module and all extend {Errors::ServiceError}.
39
+ #
40
+ # begin
41
+ # # do stuff
42
+ # rescue Aws::AmplifyBackend::Errors::ServiceError
43
+ # # rescues all AmplifyBackend API errors
44
+ # end
45
+ #
46
+ # See {Errors} for more information.
47
+ #
48
+ # @!group service
49
+ module Aws::AmplifyBackend
50
+
51
+ GEM_VERSION = '1.0.0'
52
+
53
+ end
@@ -0,0 +1,1689 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ require 'seahorse/client/plugins/content_length.rb'
11
+ require 'aws-sdk-core/plugins/credentials_configuration.rb'
12
+ require 'aws-sdk-core/plugins/logging.rb'
13
+ require 'aws-sdk-core/plugins/param_converter.rb'
14
+ require 'aws-sdk-core/plugins/param_validator.rb'
15
+ require 'aws-sdk-core/plugins/user_agent.rb'
16
+ require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
17
+ require 'aws-sdk-core/plugins/retry_errors.rb'
18
+ require 'aws-sdk-core/plugins/global_configuration.rb'
19
+ require 'aws-sdk-core/plugins/regional_endpoint.rb'
20
+ require 'aws-sdk-core/plugins/endpoint_discovery.rb'
21
+ require 'aws-sdk-core/plugins/endpoint_pattern.rb'
22
+ require 'aws-sdk-core/plugins/response_paging.rb'
23
+ require 'aws-sdk-core/plugins/stub_responses.rb'
24
+ require 'aws-sdk-core/plugins/idempotency_token.rb'
25
+ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
26
+ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
27
+ require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
28
+ require 'aws-sdk-core/plugins/transfer_encoding.rb'
29
+ require 'aws-sdk-core/plugins/http_checksum.rb'
30
+ require 'aws-sdk-core/plugins/signature_v4.rb'
31
+ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
32
+
33
+ Aws::Plugins::GlobalConfiguration.add_identifier(:amplifybackend)
34
+
35
+ module Aws::AmplifyBackend
36
+ # An API client for AmplifyBackend. To construct a client, you need to configure a `:region` and `:credentials`.
37
+ #
38
+ # client = Aws::AmplifyBackend::Client.new(
39
+ # region: region_name,
40
+ # credentials: credentials,
41
+ # # ...
42
+ # )
43
+ #
44
+ # For details on configuring region and credentials see
45
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
46
+ #
47
+ # See {#initialize} for a full list of supported configuration options.
48
+ class Client < Seahorse::Client::Base
49
+
50
+ include Aws::ClientStubs
51
+
52
+ @identifier = :amplifybackend
53
+
54
+ set_api(ClientApi::API)
55
+
56
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
57
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
58
+ add_plugin(Aws::Plugins::Logging)
59
+ add_plugin(Aws::Plugins::ParamConverter)
60
+ add_plugin(Aws::Plugins::ParamValidator)
61
+ add_plugin(Aws::Plugins::UserAgent)
62
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
63
+ add_plugin(Aws::Plugins::RetryErrors)
64
+ add_plugin(Aws::Plugins::GlobalConfiguration)
65
+ add_plugin(Aws::Plugins::RegionalEndpoint)
66
+ add_plugin(Aws::Plugins::EndpointDiscovery)
67
+ add_plugin(Aws::Plugins::EndpointPattern)
68
+ add_plugin(Aws::Plugins::ResponsePaging)
69
+ add_plugin(Aws::Plugins::StubResponses)
70
+ add_plugin(Aws::Plugins::IdempotencyToken)
71
+ add_plugin(Aws::Plugins::JsonvalueConverter)
72
+ add_plugin(Aws::Plugins::ClientMetricsPlugin)
73
+ add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
74
+ add_plugin(Aws::Plugins::TransferEncoding)
75
+ add_plugin(Aws::Plugins::HttpChecksum)
76
+ add_plugin(Aws::Plugins::SignatureV4)
77
+ add_plugin(Aws::Plugins::Protocols::RestJson)
78
+
79
+ # @overload initialize(options)
80
+ # @param [Hash] options
81
+ # @option options [required, Aws::CredentialProvider] :credentials
82
+ # Your AWS credentials. This can be an instance of any one of the
83
+ # following classes:
84
+ #
85
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
86
+ # credentials.
87
+ #
88
+ # * `Aws::SharedCredentials` - Used for loading static credentials from a
89
+ # shared file, such as `~/.aws/config`.
90
+ #
91
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
92
+ #
93
+ # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
94
+ # assume a role after providing credentials via the web.
95
+ #
96
+ # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
97
+ # access token generated from `aws login`.
98
+ #
99
+ # * `Aws::ProcessCredentials` - Used for loading credentials from a
100
+ # process that outputs to stdout.
101
+ #
102
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
103
+ # from an EC2 IMDS on an EC2 instance.
104
+ #
105
+ # * `Aws::ECSCredentials` - Used for loading credentials from
106
+ # instances running in ECS.
107
+ #
108
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
109
+ # from the Cognito Identity service.
110
+ #
111
+ # When `:credentials` are not configured directly, the following
112
+ # locations will be searched for credentials:
113
+ #
114
+ # * `Aws.config[:credentials]`
115
+ # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
116
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
117
+ # * `~/.aws/credentials`
118
+ # * `~/.aws/config`
119
+ # * EC2/ECS IMDS instance profile - When used by default, the timeouts
120
+ # are very aggressive. Construct and pass an instance of
121
+ # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
122
+ # enable retries and extended timeouts.
123
+ #
124
+ # @option options [required, String] :region
125
+ # The AWS region to connect to. The configured `:region` is
126
+ # used to determine the service `:endpoint`. When not passed,
127
+ # a default `:region` is searched for in the following locations:
128
+ #
129
+ # * `Aws.config[:region]`
130
+ # * `ENV['AWS_REGION']`
131
+ # * `ENV['AMAZON_REGION']`
132
+ # * `ENV['AWS_DEFAULT_REGION']`
133
+ # * `~/.aws/credentials`
134
+ # * `~/.aws/config`
135
+ #
136
+ # @option options [String] :access_key_id
137
+ #
138
+ # @option options [Boolean] :active_endpoint_cache (false)
139
+ # When set to `true`, a thread polling for endpoints will be running in
140
+ # the background every 60 secs (default). Defaults to `false`.
141
+ #
142
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
143
+ # Used only in `adaptive` retry mode. When true, the request will sleep
144
+ # until there is sufficent client side capacity to retry the request.
145
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
146
+ # not retry instead of sleeping.
147
+ #
148
+ # @option options [Boolean] :client_side_monitoring (false)
149
+ # When `true`, client-side metrics will be collected for all API requests from
150
+ # this client.
151
+ #
152
+ # @option options [String] :client_side_monitoring_client_id ("")
153
+ # Allows you to provide an identifier for this client which will be attached to
154
+ # all generated client side metrics. Defaults to an empty string.
155
+ #
156
+ # @option options [String] :client_side_monitoring_host ("127.0.0.1")
157
+ # Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
158
+ # side monitoring agent is running on, where client metrics will be published via UDP.
159
+ #
160
+ # @option options [Integer] :client_side_monitoring_port (31000)
161
+ # Required for publishing client metrics. The port that the client side monitoring
162
+ # agent is running on, where client metrics will be published via UDP.
163
+ #
164
+ # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
165
+ # Allows you to provide a custom client-side monitoring publisher class. By default,
166
+ # will use the Client Side Monitoring Agent Publisher.
167
+ #
168
+ # @option options [Boolean] :convert_params (true)
169
+ # When `true`, an attempt is made to coerce request parameters into
170
+ # the required types.
171
+ #
172
+ # @option options [Boolean] :correct_clock_skew (true)
173
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
174
+ # a clock skew correction and retry requests with skewed client clocks.
175
+ #
176
+ # @option options [Boolean] :disable_host_prefix_injection (false)
177
+ # Set to true to disable SDK automatically adding host prefix
178
+ # to default service endpoint when available.
179
+ #
180
+ # @option options [String] :endpoint
181
+ # The client endpoint is normally constructed from the `:region`
182
+ # option. You should only configure an `:endpoint` when connecting
183
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
184
+ #
185
+ # @option options [Integer] :endpoint_cache_max_entries (1000)
186
+ # Used for the maximum size limit of the LRU cache storing endpoints data
187
+ # for endpoint discovery enabled operations. Defaults to 1000.
188
+ #
189
+ # @option options [Integer] :endpoint_cache_max_threads (10)
190
+ # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
191
+ #
192
+ # @option options [Integer] :endpoint_cache_poll_interval (60)
193
+ # When :endpoint_discovery and :active_endpoint_cache is enabled,
194
+ # Use this option to config the time interval in seconds for making
195
+ # requests fetching endpoints information. Defaults to 60 sec.
196
+ #
197
+ # @option options [Boolean] :endpoint_discovery (false)
198
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
199
+ #
200
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
201
+ # The log formatter.
202
+ #
203
+ # @option options [Symbol] :log_level (:info)
204
+ # The log level to send messages to the `:logger` at.
205
+ #
206
+ # @option options [Logger] :logger
207
+ # The Logger instance to send log messages to. If this option
208
+ # is not set, logging will be disabled.
209
+ #
210
+ # @option options [Integer] :max_attempts (3)
211
+ # An integer representing the maximum number attempts that will be made for
212
+ # a single request, including the initial attempt. For example,
213
+ # setting this value to 5 will result in a request being retried up to
214
+ # 4 times. Used in `standard` and `adaptive` retry modes.
215
+ #
216
+ # @option options [String] :profile ("default")
217
+ # Used when loading credentials from the shared credentials file
218
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
219
+ #
220
+ # @option options [Proc] :retry_backoff
221
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
222
+ # This option is only used in the `legacy` retry mode.
223
+ #
224
+ # @option options [Float] :retry_base_delay (0.3)
225
+ # The base delay in seconds used by the default backoff function. This option
226
+ # is only used in the `legacy` retry mode.
227
+ #
228
+ # @option options [Symbol] :retry_jitter (:none)
229
+ # A delay randomiser function used by the default backoff function.
230
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
231
+ # otherwise a Proc that takes and returns a number. This option is only used
232
+ # in the `legacy` retry mode.
233
+ #
234
+ # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
235
+ #
236
+ # @option options [Integer] :retry_limit (3)
237
+ # The maximum number of times to retry failed requests. Only
238
+ # ~ 500 level server errors and certain ~ 400 level client errors
239
+ # are retried. Generally, these are throttling errors, data
240
+ # checksum errors, networking errors, timeout errors, auth errors,
241
+ # endpoint discovery, and errors from expired credentials.
242
+ # This option is only used in the `legacy` retry mode.
243
+ #
244
+ # @option options [Integer] :retry_max_delay (0)
245
+ # The maximum number of seconds to delay between retries (0 for no limit)
246
+ # used by the default backoff function. This option is only used in the
247
+ # `legacy` retry mode.
248
+ #
249
+ # @option options [String] :retry_mode ("legacy")
250
+ # Specifies which retry algorithm to use. Values are:
251
+ #
252
+ # * `legacy` - The pre-existing retry behavior. This is default value if
253
+ # no retry mode is provided.
254
+ #
255
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
256
+ # This includes support for retry quotas, which limit the number of
257
+ # unsuccessful retries a client can make.
258
+ #
259
+ # * `adaptive` - An experimental retry mode that includes all the
260
+ # functionality of `standard` mode along with automatic client side
261
+ # throttling. This is a provisional mode that may change behavior
262
+ # in the future.
263
+ #
264
+ #
265
+ # @option options [String] :secret_access_key
266
+ #
267
+ # @option options [String] :session_token
268
+ #
269
+ # @option options [Boolean] :stub_responses (false)
270
+ # Causes the client to return stubbed responses. By default
271
+ # fake responses are generated and returned. You can specify
272
+ # the response data to return or errors to raise by calling
273
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
274
+ #
275
+ # ** Please note ** When response stubbing is enabled, no HTTP
276
+ # requests are made, and retries are disabled.
277
+ #
278
+ # @option options [Boolean] :validate_params (true)
279
+ # When `true`, request parameters are validated before
280
+ # sending the request.
281
+ #
282
+ # @option options [URI::HTTP,String] :http_proxy A proxy to send
283
+ # requests through. Formatted like 'http://proxy.com:123'.
284
+ #
285
+ # @option options [Float] :http_open_timeout (15) The number of
286
+ # seconds to wait when opening a HTTP session before raising a
287
+ # `Timeout::Error`.
288
+ #
289
+ # @option options [Integer] :http_read_timeout (60) The default
290
+ # number of seconds to wait for response data. This value can
291
+ # safely be set per-request on the session.
292
+ #
293
+ # @option options [Float] :http_idle_timeout (5) The number of
294
+ # seconds a connection is allowed to sit idle before it is
295
+ # considered stale. Stale connections are closed and removed
296
+ # from the pool before making a request.
297
+ #
298
+ # @option options [Float] :http_continue_timeout (1) The number of
299
+ # seconds to wait for a 100-continue response before sending the
300
+ # request body. This option has no effect unless the request has
301
+ # "Expect" header set to "100-continue". Defaults to `nil` which
302
+ # disables this behaviour. This value can safely be set per
303
+ # request on the session.
304
+ #
305
+ # @option options [Boolean] :http_wire_trace (false) When `true`,
306
+ # HTTP debug output will be sent to the `:logger`.
307
+ #
308
+ # @option options [Boolean] :ssl_verify_peer (true) When `true`,
309
+ # SSL peer certificates are verified when establishing a
310
+ # connection.
311
+ #
312
+ # @option options [String] :ssl_ca_bundle Full path to the SSL
313
+ # certificate authority bundle file that should be used when
314
+ # verifying peer certificates. If you do not pass
315
+ # `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
316
+ # will be used if available.
317
+ #
318
+ # @option options [String] :ssl_ca_directory Full path of the
319
+ # directory that contains the unbundled SSL certificate
320
+ # authority files for verifying peer certificates. If you do
321
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
322
+ # system default will be used if available.
323
+ #
324
+ def initialize(*args)
325
+ super
326
+ end
327
+
328
+ # @!group API Operations
329
+
330
+ # This operation clones an existing backend.
331
+ #
332
+ # @option params [required, String] :app_id
333
+ #
334
+ # @option params [required, String] :backend_environment_name
335
+ #
336
+ # @option params [required, String] :target_environment_name
337
+ #
338
+ # @return [Types::CloneBackendResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
339
+ #
340
+ # * {Types::CloneBackendResponse#app_id #app_id} => String
341
+ # * {Types::CloneBackendResponse#backend_environment_name #backend_environment_name} => String
342
+ # * {Types::CloneBackendResponse#error #error} => String
343
+ # * {Types::CloneBackendResponse#job_id #job_id} => String
344
+ # * {Types::CloneBackendResponse#operation #operation} => String
345
+ # * {Types::CloneBackendResponse#status #status} => String
346
+ #
347
+ # @example Request syntax with placeholder values
348
+ #
349
+ # resp = client.clone_backend({
350
+ # app_id: "__string", # required
351
+ # backend_environment_name: "__string", # required
352
+ # target_environment_name: "__string", # required
353
+ # })
354
+ #
355
+ # @example Response structure
356
+ #
357
+ # resp.app_id #=> String
358
+ # resp.backend_environment_name #=> String
359
+ # resp.error #=> String
360
+ # resp.job_id #=> String
361
+ # resp.operation #=> String
362
+ # resp.status #=> String
363
+ #
364
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/CloneBackend AWS API Documentation
365
+ #
366
+ # @overload clone_backend(params = {})
367
+ # @param [Hash] params ({})
368
+ def clone_backend(params = {}, options = {})
369
+ req = build_request(:clone_backend, params)
370
+ req.send_request(options)
371
+ end
372
+
373
+ # This operation creates a backend for an Amplify app. Backends are
374
+ # automatically created at the time of app creation.
375
+ #
376
+ # @option params [required, String] :app_id
377
+ #
378
+ # @option params [required, String] :app_name
379
+ #
380
+ # @option params [required, String] :backend_environment_name
381
+ #
382
+ # @option params [Types::ResourceConfig] :resource_config
383
+ #
384
+ # @option params [String] :resource_name
385
+ #
386
+ # @return [Types::CreateBackendResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
387
+ #
388
+ # * {Types::CreateBackendResponse#app_id #app_id} => String
389
+ # * {Types::CreateBackendResponse#backend_environment_name #backend_environment_name} => String
390
+ # * {Types::CreateBackendResponse#error #error} => String
391
+ # * {Types::CreateBackendResponse#job_id #job_id} => String
392
+ # * {Types::CreateBackendResponse#operation #operation} => String
393
+ # * {Types::CreateBackendResponse#status #status} => String
394
+ #
395
+ # @example Request syntax with placeholder values
396
+ #
397
+ # resp = client.create_backend({
398
+ # app_id: "__string", # required
399
+ # app_name: "__string", # required
400
+ # backend_environment_name: "__string", # required
401
+ # resource_config: {
402
+ # },
403
+ # resource_name: "__string",
404
+ # })
405
+ #
406
+ # @example Response structure
407
+ #
408
+ # resp.app_id #=> String
409
+ # resp.backend_environment_name #=> String
410
+ # resp.error #=> String
411
+ # resp.job_id #=> String
412
+ # resp.operation #=> String
413
+ # resp.status #=> String
414
+ #
415
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/CreateBackend AWS API Documentation
416
+ #
417
+ # @overload create_backend(params = {})
418
+ # @param [Hash] params ({})
419
+ def create_backend(params = {}, options = {})
420
+ req = build_request(:create_backend, params)
421
+ req.send_request(options)
422
+ end
423
+
424
+ # Creates a new backend API resource.
425
+ #
426
+ # @option params [required, String] :app_id
427
+ #
428
+ # @option params [required, String] :backend_environment_name
429
+ #
430
+ # @option params [required, Types::BackendAPIResourceConfig] :resource_config
431
+ # The resource config for the data model,configured as a part of the
432
+ # Amplify project.
433
+ #
434
+ # @option params [required, String] :resource_name
435
+ #
436
+ # @return [Types::CreateBackendAPIResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
437
+ #
438
+ # * {Types::CreateBackendAPIResponse#app_id #app_id} => String
439
+ # * {Types::CreateBackendAPIResponse#backend_environment_name #backend_environment_name} => String
440
+ # * {Types::CreateBackendAPIResponse#error #error} => String
441
+ # * {Types::CreateBackendAPIResponse#job_id #job_id} => String
442
+ # * {Types::CreateBackendAPIResponse#operation #operation} => String
443
+ # * {Types::CreateBackendAPIResponse#status #status} => String
444
+ #
445
+ # @example Request syntax with placeholder values
446
+ #
447
+ # resp = client.create_backend_api({
448
+ # app_id: "__string", # required
449
+ # backend_environment_name: "__string", # required
450
+ # resource_config: { # required
451
+ # additional_auth_types: [
452
+ # {
453
+ # mode: "API_KEY", # accepts API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT
454
+ # settings: {
455
+ # cognito_user_pool_id: "__string",
456
+ # description: "__string",
457
+ # expiration_time: 1.0,
458
+ # open_id_auth_ttl: "__string",
459
+ # open_id_client_id: "__string",
460
+ # open_id_iat_ttl: "__string",
461
+ # open_id_issue_url: "__string",
462
+ # open_id_provider_name: "__string",
463
+ # },
464
+ # },
465
+ # ],
466
+ # api_name: "__string",
467
+ # conflict_resolution: {
468
+ # resolution_strategy: "OPTIMISTIC_CONCURRENCY", # accepts OPTIMISTIC_CONCURRENCY, LAMBDA, AUTOMERGE, NONE
469
+ # },
470
+ # default_auth_type: {
471
+ # mode: "API_KEY", # accepts API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT
472
+ # settings: {
473
+ # cognito_user_pool_id: "__string",
474
+ # description: "__string",
475
+ # expiration_time: 1.0,
476
+ # open_id_auth_ttl: "__string",
477
+ # open_id_client_id: "__string",
478
+ # open_id_iat_ttl: "__string",
479
+ # open_id_issue_url: "__string",
480
+ # open_id_provider_name: "__string",
481
+ # },
482
+ # },
483
+ # service: "__string",
484
+ # transform_schema: "__string",
485
+ # },
486
+ # resource_name: "__string", # required
487
+ # })
488
+ #
489
+ # @example Response structure
490
+ #
491
+ # resp.app_id #=> String
492
+ # resp.backend_environment_name #=> String
493
+ # resp.error #=> String
494
+ # resp.job_id #=> String
495
+ # resp.operation #=> String
496
+ # resp.status #=> String
497
+ #
498
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/CreateBackendAPI AWS API Documentation
499
+ #
500
+ # @overload create_backend_api(params = {})
501
+ # @param [Hash] params ({})
502
+ def create_backend_api(params = {}, options = {})
503
+ req = build_request(:create_backend_api, params)
504
+ req.send_request(options)
505
+ end
506
+
507
+ # Creates a new backend authentication resource.
508
+ #
509
+ # @option params [required, String] :app_id
510
+ #
511
+ # @option params [required, String] :backend_environment_name
512
+ #
513
+ # @option params [required, Types::CreateBackendAuthResourceConfig] :resource_config
514
+ # Defines the resource configuration when creating an auth resource in
515
+ # your Amplify project.
516
+ #
517
+ # @option params [required, String] :resource_name
518
+ #
519
+ # @return [Types::CreateBackendAuthResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
520
+ #
521
+ # * {Types::CreateBackendAuthResponse#app_id #app_id} => String
522
+ # * {Types::CreateBackendAuthResponse#backend_environment_name #backend_environment_name} => String
523
+ # * {Types::CreateBackendAuthResponse#error #error} => String
524
+ # * {Types::CreateBackendAuthResponse#job_id #job_id} => String
525
+ # * {Types::CreateBackendAuthResponse#operation #operation} => String
526
+ # * {Types::CreateBackendAuthResponse#status #status} => String
527
+ #
528
+ # @example Request syntax with placeholder values
529
+ #
530
+ # resp = client.create_backend_auth({
531
+ # app_id: "__string", # required
532
+ # backend_environment_name: "__string", # required
533
+ # resource_config: { # required
534
+ # auth_resources: "USER_POOL_ONLY", # required, accepts USER_POOL_ONLY, IDENTITY_POOL_AND_USER_POOL
535
+ # identity_pool_configs: {
536
+ # identity_pool_name: "__string", # required
537
+ # unauthenticated_login: false, # required
538
+ # },
539
+ # service: "COGNITO", # required, accepts COGNITO
540
+ # user_pool_configs: { # required
541
+ # forgot_password: {
542
+ # delivery_method: "EMAIL", # required, accepts EMAIL, SMS
543
+ # email_settings: {
544
+ # email_message: "__string",
545
+ # email_subject: "__string",
546
+ # },
547
+ # sms_settings: {
548
+ # sms_message: "__string",
549
+ # },
550
+ # },
551
+ # mfa: {
552
+ # mfa_mode: "ON", # required, accepts ON, OFF, OPTIONAL
553
+ # settings: {
554
+ # mfa_types: ["SMS"], # accepts SMS, TOTP
555
+ # sms_message: "__string",
556
+ # },
557
+ # },
558
+ # o_auth: {
559
+ # domain_prefix: "__string",
560
+ # o_auth_grant_type: "CODE", # required, accepts CODE, IMPLICIT
561
+ # o_auth_scopes: ["PHONE"], # required, accepts PHONE, EMAIL, OPENID, PROFILE, AWS_COGNITO_SIGNIN_USER_ADMIN
562
+ # redirect_sign_in_ur_is: ["__string"], # required
563
+ # redirect_sign_out_ur_is: ["__string"], # required
564
+ # social_provider_settings: {
565
+ # facebook: {
566
+ # client_id: "__string",
567
+ # client_secret: "__string",
568
+ # },
569
+ # google: {
570
+ # client_id: "__string",
571
+ # client_secret: "__string",
572
+ # },
573
+ # login_with_amazon: {
574
+ # client_id: "__string",
575
+ # client_secret: "__string",
576
+ # },
577
+ # },
578
+ # },
579
+ # password_policy: {
580
+ # additional_constraints: ["REQUIRE_DIGIT"], # accepts REQUIRE_DIGIT, REQUIRE_LOWERCASE, REQUIRE_SYMBOL, REQUIRE_UPPERCASE
581
+ # minimum_length: 1.0, # required
582
+ # },
583
+ # required_sign_up_attributes: ["ADDRESS"], # required, accepts ADDRESS, BIRTHDATE, EMAIL, FAMILY_NAME, GENDER, GIVEN_NAME, LOCALE, MIDDLE_NAME, NAME, NICKNAME, PHONE_NUMBER, PICTURE, PREFERRED_USERNAME, PROFILE, UPDATED_AT, WEBSITE, ZONE_INFO
584
+ # sign_in_method: "EMAIL", # required, accepts EMAIL, EMAIL_AND_PHONE_NUMBER, PHONE_NUMBER, USERNAME
585
+ # user_pool_name: "__string", # required
586
+ # },
587
+ # },
588
+ # resource_name: "__string", # required
589
+ # })
590
+ #
591
+ # @example Response structure
592
+ #
593
+ # resp.app_id #=> String
594
+ # resp.backend_environment_name #=> String
595
+ # resp.error #=> String
596
+ # resp.job_id #=> String
597
+ # resp.operation #=> String
598
+ # resp.status #=> String
599
+ #
600
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/CreateBackendAuth AWS API Documentation
601
+ #
602
+ # @overload create_backend_auth(params = {})
603
+ # @param [Hash] params ({})
604
+ def create_backend_auth(params = {}, options = {})
605
+ req = build_request(:create_backend_auth, params)
606
+ req.send_request(options)
607
+ end
608
+
609
+ # Creates a config object for a backend.
610
+ #
611
+ # @option params [required, String] :app_id
612
+ #
613
+ # @option params [String] :backend_manager_app_id
614
+ #
615
+ # @return [Types::CreateBackendConfigResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
616
+ #
617
+ # * {Types::CreateBackendConfigResponse#app_id #app_id} => String
618
+ # * {Types::CreateBackendConfigResponse#backend_environment_name #backend_environment_name} => String
619
+ # * {Types::CreateBackendConfigResponse#job_id #job_id} => String
620
+ # * {Types::CreateBackendConfigResponse#status #status} => String
621
+ #
622
+ # @example Request syntax with placeholder values
623
+ #
624
+ # resp = client.create_backend_config({
625
+ # app_id: "__string", # required
626
+ # backend_manager_app_id: "__string",
627
+ # })
628
+ #
629
+ # @example Response structure
630
+ #
631
+ # resp.app_id #=> String
632
+ # resp.backend_environment_name #=> String
633
+ # resp.job_id #=> String
634
+ # resp.status #=> String
635
+ #
636
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/CreateBackendConfig AWS API Documentation
637
+ #
638
+ # @overload create_backend_config(params = {})
639
+ # @param [Hash] params ({})
640
+ def create_backend_config(params = {}, options = {})
641
+ req = build_request(:create_backend_config, params)
642
+ req.send_request(options)
643
+ end
644
+
645
+ # Generates a one time challenge code to authenticate a user into your
646
+ # Amplify Admin UI.
647
+ #
648
+ # @option params [required, String] :app_id
649
+ #
650
+ # @return [Types::CreateTokenResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
651
+ #
652
+ # * {Types::CreateTokenResponse#app_id #app_id} => String
653
+ # * {Types::CreateTokenResponse#challenge_code #challenge_code} => String
654
+ # * {Types::CreateTokenResponse#session_id #session_id} => String
655
+ # * {Types::CreateTokenResponse#ttl #ttl} => String
656
+ #
657
+ # @example Request syntax with placeholder values
658
+ #
659
+ # resp = client.create_token({
660
+ # app_id: "__string", # required
661
+ # })
662
+ #
663
+ # @example Response structure
664
+ #
665
+ # resp.app_id #=> String
666
+ # resp.challenge_code #=> String
667
+ # resp.session_id #=> String
668
+ # resp.ttl #=> String
669
+ #
670
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/CreateToken AWS API Documentation
671
+ #
672
+ # @overload create_token(params = {})
673
+ # @param [Hash] params ({})
674
+ def create_token(params = {}, options = {})
675
+ req = build_request(:create_token, params)
676
+ req.send_request(options)
677
+ end
678
+
679
+ # Removes an existing environment from your Ampify project.
680
+ #
681
+ # @option params [required, String] :app_id
682
+ #
683
+ # @option params [required, String] :backend_environment_name
684
+ #
685
+ # @return [Types::DeleteBackendResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
686
+ #
687
+ # * {Types::DeleteBackendResponse#app_id #app_id} => String
688
+ # * {Types::DeleteBackendResponse#backend_environment_name #backend_environment_name} => String
689
+ # * {Types::DeleteBackendResponse#error #error} => String
690
+ # * {Types::DeleteBackendResponse#job_id #job_id} => String
691
+ # * {Types::DeleteBackendResponse#operation #operation} => String
692
+ # * {Types::DeleteBackendResponse#status #status} => String
693
+ #
694
+ # @example Request syntax with placeholder values
695
+ #
696
+ # resp = client.delete_backend({
697
+ # app_id: "__string", # required
698
+ # backend_environment_name: "__string", # required
699
+ # })
700
+ #
701
+ # @example Response structure
702
+ #
703
+ # resp.app_id #=> String
704
+ # resp.backend_environment_name #=> String
705
+ # resp.error #=> String
706
+ # resp.job_id #=> String
707
+ # resp.operation #=> String
708
+ # resp.status #=> String
709
+ #
710
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/DeleteBackend AWS API Documentation
711
+ #
712
+ # @overload delete_backend(params = {})
713
+ # @param [Hash] params ({})
714
+ def delete_backend(params = {}, options = {})
715
+ req = build_request(:delete_backend, params)
716
+ req.send_request(options)
717
+ end
718
+
719
+ # Deletes an existing backend API resource.
720
+ #
721
+ # @option params [required, String] :app_id
722
+ #
723
+ # @option params [required, String] :backend_environment_name
724
+ #
725
+ # @option params [Types::BackendAPIResourceConfig] :resource_config
726
+ # The resource config for the data model,configured as a part of the
727
+ # Amplify project.
728
+ #
729
+ # @option params [required, String] :resource_name
730
+ #
731
+ # @return [Types::DeleteBackendAPIResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
732
+ #
733
+ # * {Types::DeleteBackendAPIResponse#app_id #app_id} => String
734
+ # * {Types::DeleteBackendAPIResponse#backend_environment_name #backend_environment_name} => String
735
+ # * {Types::DeleteBackendAPIResponse#error #error} => String
736
+ # * {Types::DeleteBackendAPIResponse#job_id #job_id} => String
737
+ # * {Types::DeleteBackendAPIResponse#operation #operation} => String
738
+ # * {Types::DeleteBackendAPIResponse#status #status} => String
739
+ #
740
+ # @example Request syntax with placeholder values
741
+ #
742
+ # resp = client.delete_backend_api({
743
+ # app_id: "__string", # required
744
+ # backend_environment_name: "__string", # required
745
+ # resource_config: {
746
+ # additional_auth_types: [
747
+ # {
748
+ # mode: "API_KEY", # accepts API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT
749
+ # settings: {
750
+ # cognito_user_pool_id: "__string",
751
+ # description: "__string",
752
+ # expiration_time: 1.0,
753
+ # open_id_auth_ttl: "__string",
754
+ # open_id_client_id: "__string",
755
+ # open_id_iat_ttl: "__string",
756
+ # open_id_issue_url: "__string",
757
+ # open_id_provider_name: "__string",
758
+ # },
759
+ # },
760
+ # ],
761
+ # api_name: "__string",
762
+ # conflict_resolution: {
763
+ # resolution_strategy: "OPTIMISTIC_CONCURRENCY", # accepts OPTIMISTIC_CONCURRENCY, LAMBDA, AUTOMERGE, NONE
764
+ # },
765
+ # default_auth_type: {
766
+ # mode: "API_KEY", # accepts API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT
767
+ # settings: {
768
+ # cognito_user_pool_id: "__string",
769
+ # description: "__string",
770
+ # expiration_time: 1.0,
771
+ # open_id_auth_ttl: "__string",
772
+ # open_id_client_id: "__string",
773
+ # open_id_iat_ttl: "__string",
774
+ # open_id_issue_url: "__string",
775
+ # open_id_provider_name: "__string",
776
+ # },
777
+ # },
778
+ # service: "__string",
779
+ # transform_schema: "__string",
780
+ # },
781
+ # resource_name: "__string", # required
782
+ # })
783
+ #
784
+ # @example Response structure
785
+ #
786
+ # resp.app_id #=> String
787
+ # resp.backend_environment_name #=> String
788
+ # resp.error #=> String
789
+ # resp.job_id #=> String
790
+ # resp.operation #=> String
791
+ # resp.status #=> String
792
+ #
793
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/DeleteBackendAPI AWS API Documentation
794
+ #
795
+ # @overload delete_backend_api(params = {})
796
+ # @param [Hash] params ({})
797
+ def delete_backend_api(params = {}, options = {})
798
+ req = build_request(:delete_backend_api, params)
799
+ req.send_request(options)
800
+ end
801
+
802
+ # Deletes an existing backend authentication resource.
803
+ #
804
+ # @option params [required, String] :app_id
805
+ #
806
+ # @option params [required, String] :backend_environment_name
807
+ #
808
+ # @option params [required, String] :resource_name
809
+ #
810
+ # @return [Types::DeleteBackendAuthResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
811
+ #
812
+ # * {Types::DeleteBackendAuthResponse#app_id #app_id} => String
813
+ # * {Types::DeleteBackendAuthResponse#backend_environment_name #backend_environment_name} => String
814
+ # * {Types::DeleteBackendAuthResponse#error #error} => String
815
+ # * {Types::DeleteBackendAuthResponse#job_id #job_id} => String
816
+ # * {Types::DeleteBackendAuthResponse#operation #operation} => String
817
+ # * {Types::DeleteBackendAuthResponse#status #status} => String
818
+ #
819
+ # @example Request syntax with placeholder values
820
+ #
821
+ # resp = client.delete_backend_auth({
822
+ # app_id: "__string", # required
823
+ # backend_environment_name: "__string", # required
824
+ # resource_name: "__string", # required
825
+ # })
826
+ #
827
+ # @example Response structure
828
+ #
829
+ # resp.app_id #=> String
830
+ # resp.backend_environment_name #=> String
831
+ # resp.error #=> String
832
+ # resp.job_id #=> String
833
+ # resp.operation #=> String
834
+ # resp.status #=> String
835
+ #
836
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/DeleteBackendAuth AWS API Documentation
837
+ #
838
+ # @overload delete_backend_auth(params = {})
839
+ # @param [Hash] params ({})
840
+ def delete_backend_auth(params = {}, options = {})
841
+ req = build_request(:delete_backend_auth, params)
842
+ req.send_request(options)
843
+ end
844
+
845
+ # Deletes the challenge token based on the given appId and sessionId.
846
+ #
847
+ # @option params [required, String] :app_id
848
+ #
849
+ # @option params [required, String] :session_id
850
+ #
851
+ # @return [Types::DeleteTokenResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
852
+ #
853
+ # * {Types::DeleteTokenResponse#is_success #is_success} => Boolean
854
+ #
855
+ # @example Request syntax with placeholder values
856
+ #
857
+ # resp = client.delete_token({
858
+ # app_id: "__string", # required
859
+ # session_id: "__string", # required
860
+ # })
861
+ #
862
+ # @example Response structure
863
+ #
864
+ # resp.is_success #=> Boolean
865
+ #
866
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/DeleteToken AWS API Documentation
867
+ #
868
+ # @overload delete_token(params = {})
869
+ # @param [Hash] params ({})
870
+ def delete_token(params = {}, options = {})
871
+ req = build_request(:delete_token, params)
872
+ req.send_request(options)
873
+ end
874
+
875
+ # Generates a model schema for an existing backend API resource.
876
+ #
877
+ # @option params [required, String] :app_id
878
+ #
879
+ # @option params [required, String] :backend_environment_name
880
+ #
881
+ # @option params [required, String] :resource_name
882
+ #
883
+ # @return [Types::GenerateBackendAPIModelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
884
+ #
885
+ # * {Types::GenerateBackendAPIModelsResponse#app_id #app_id} => String
886
+ # * {Types::GenerateBackendAPIModelsResponse#backend_environment_name #backend_environment_name} => String
887
+ # * {Types::GenerateBackendAPIModelsResponse#error #error} => String
888
+ # * {Types::GenerateBackendAPIModelsResponse#job_id #job_id} => String
889
+ # * {Types::GenerateBackendAPIModelsResponse#operation #operation} => String
890
+ # * {Types::GenerateBackendAPIModelsResponse#status #status} => String
891
+ #
892
+ # @example Request syntax with placeholder values
893
+ #
894
+ # resp = client.generate_backend_api_models({
895
+ # app_id: "__string", # required
896
+ # backend_environment_name: "__string", # required
897
+ # resource_name: "__string", # required
898
+ # })
899
+ #
900
+ # @example Response structure
901
+ #
902
+ # resp.app_id #=> String
903
+ # resp.backend_environment_name #=> String
904
+ # resp.error #=> String
905
+ # resp.job_id #=> String
906
+ # resp.operation #=> String
907
+ # resp.status #=> String
908
+ #
909
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/GenerateBackendAPIModels AWS API Documentation
910
+ #
911
+ # @overload generate_backend_api_models(params = {})
912
+ # @param [Hash] params ({})
913
+ def generate_backend_api_models(params = {}, options = {})
914
+ req = build_request(:generate_backend_api_models, params)
915
+ req.send_request(options)
916
+ end
917
+
918
+ # Provides project level details for your Amplify UI project.
919
+ #
920
+ # @option params [required, String] :app_id
921
+ #
922
+ # @option params [String] :backend_environment_name
923
+ #
924
+ # @return [Types::GetBackendResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
925
+ #
926
+ # * {Types::GetBackendResponse#amplify_meta_config #amplify_meta_config} => String
927
+ # * {Types::GetBackendResponse#app_id #app_id} => String
928
+ # * {Types::GetBackendResponse#app_name #app_name} => String
929
+ # * {Types::GetBackendResponse#backend_environment_list #backend_environment_list} => Array&lt;String&gt;
930
+ # * {Types::GetBackendResponse#backend_environment_name #backend_environment_name} => String
931
+ # * {Types::GetBackendResponse#error #error} => String
932
+ #
933
+ # @example Request syntax with placeholder values
934
+ #
935
+ # resp = client.get_backend({
936
+ # app_id: "__string", # required
937
+ # backend_environment_name: "__string",
938
+ # })
939
+ #
940
+ # @example Response structure
941
+ #
942
+ # resp.amplify_meta_config #=> String
943
+ # resp.app_id #=> String
944
+ # resp.app_name #=> String
945
+ # resp.backend_environment_list #=> Array
946
+ # resp.backend_environment_list[0] #=> String
947
+ # resp.backend_environment_name #=> String
948
+ # resp.error #=> String
949
+ #
950
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/GetBackend AWS API Documentation
951
+ #
952
+ # @overload get_backend(params = {})
953
+ # @param [Hash] params ({})
954
+ def get_backend(params = {}, options = {})
955
+ req = build_request(:get_backend, params)
956
+ req.send_request(options)
957
+ end
958
+
959
+ # Gets the details for a backend api.
960
+ #
961
+ # @option params [required, String] :app_id
962
+ #
963
+ # @option params [required, String] :backend_environment_name
964
+ #
965
+ # @option params [Types::BackendAPIResourceConfig] :resource_config
966
+ # The resource config for the data model,configured as a part of the
967
+ # Amplify project.
968
+ #
969
+ # @option params [required, String] :resource_name
970
+ #
971
+ # @return [Types::GetBackendAPIResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
972
+ #
973
+ # * {Types::GetBackendAPIResponse#app_id #app_id} => String
974
+ # * {Types::GetBackendAPIResponse#backend_environment_name #backend_environment_name} => String
975
+ # * {Types::GetBackendAPIResponse#error #error} => String
976
+ # * {Types::GetBackendAPIResponse#resource_config #resource_config} => Types::BackendAPIResourceConfig
977
+ # * {Types::GetBackendAPIResponse#resource_name #resource_name} => String
978
+ #
979
+ # @example Request syntax with placeholder values
980
+ #
981
+ # resp = client.get_backend_api({
982
+ # app_id: "__string", # required
983
+ # backend_environment_name: "__string", # required
984
+ # resource_config: {
985
+ # additional_auth_types: [
986
+ # {
987
+ # mode: "API_KEY", # accepts API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT
988
+ # settings: {
989
+ # cognito_user_pool_id: "__string",
990
+ # description: "__string",
991
+ # expiration_time: 1.0,
992
+ # open_id_auth_ttl: "__string",
993
+ # open_id_client_id: "__string",
994
+ # open_id_iat_ttl: "__string",
995
+ # open_id_issue_url: "__string",
996
+ # open_id_provider_name: "__string",
997
+ # },
998
+ # },
999
+ # ],
1000
+ # api_name: "__string",
1001
+ # conflict_resolution: {
1002
+ # resolution_strategy: "OPTIMISTIC_CONCURRENCY", # accepts OPTIMISTIC_CONCURRENCY, LAMBDA, AUTOMERGE, NONE
1003
+ # },
1004
+ # default_auth_type: {
1005
+ # mode: "API_KEY", # accepts API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT
1006
+ # settings: {
1007
+ # cognito_user_pool_id: "__string",
1008
+ # description: "__string",
1009
+ # expiration_time: 1.0,
1010
+ # open_id_auth_ttl: "__string",
1011
+ # open_id_client_id: "__string",
1012
+ # open_id_iat_ttl: "__string",
1013
+ # open_id_issue_url: "__string",
1014
+ # open_id_provider_name: "__string",
1015
+ # },
1016
+ # },
1017
+ # service: "__string",
1018
+ # transform_schema: "__string",
1019
+ # },
1020
+ # resource_name: "__string", # required
1021
+ # })
1022
+ #
1023
+ # @example Response structure
1024
+ #
1025
+ # resp.app_id #=> String
1026
+ # resp.backend_environment_name #=> String
1027
+ # resp.error #=> String
1028
+ # resp.resource_config.additional_auth_types #=> Array
1029
+ # resp.resource_config.additional_auth_types[0].mode #=> String, one of "API_KEY", "AWS_IAM", "AMAZON_COGNITO_USER_POOLS", "OPENID_CONNECT"
1030
+ # resp.resource_config.additional_auth_types[0].settings.cognito_user_pool_id #=> String
1031
+ # resp.resource_config.additional_auth_types[0].settings.description #=> String
1032
+ # resp.resource_config.additional_auth_types[0].settings.expiration_time #=> Float
1033
+ # resp.resource_config.additional_auth_types[0].settings.open_id_auth_ttl #=> String
1034
+ # resp.resource_config.additional_auth_types[0].settings.open_id_client_id #=> String
1035
+ # resp.resource_config.additional_auth_types[0].settings.open_id_iat_ttl #=> String
1036
+ # resp.resource_config.additional_auth_types[0].settings.open_id_issue_url #=> String
1037
+ # resp.resource_config.additional_auth_types[0].settings.open_id_provider_name #=> String
1038
+ # resp.resource_config.api_name #=> String
1039
+ # resp.resource_config.conflict_resolution.resolution_strategy #=> String, one of "OPTIMISTIC_CONCURRENCY", "LAMBDA", "AUTOMERGE", "NONE"
1040
+ # resp.resource_config.default_auth_type.mode #=> String, one of "API_KEY", "AWS_IAM", "AMAZON_COGNITO_USER_POOLS", "OPENID_CONNECT"
1041
+ # resp.resource_config.default_auth_type.settings.cognito_user_pool_id #=> String
1042
+ # resp.resource_config.default_auth_type.settings.description #=> String
1043
+ # resp.resource_config.default_auth_type.settings.expiration_time #=> Float
1044
+ # resp.resource_config.default_auth_type.settings.open_id_auth_ttl #=> String
1045
+ # resp.resource_config.default_auth_type.settings.open_id_client_id #=> String
1046
+ # resp.resource_config.default_auth_type.settings.open_id_iat_ttl #=> String
1047
+ # resp.resource_config.default_auth_type.settings.open_id_issue_url #=> String
1048
+ # resp.resource_config.default_auth_type.settings.open_id_provider_name #=> String
1049
+ # resp.resource_config.service #=> String
1050
+ # resp.resource_config.transform_schema #=> String
1051
+ # resp.resource_name #=> String
1052
+ #
1053
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/GetBackendAPI AWS API Documentation
1054
+ #
1055
+ # @overload get_backend_api(params = {})
1056
+ # @param [Hash] params ({})
1057
+ def get_backend_api(params = {}, options = {})
1058
+ req = build_request(:get_backend_api, params)
1059
+ req.send_request(options)
1060
+ end
1061
+
1062
+ # Generates a model schema for existing backend API resource.
1063
+ #
1064
+ # @option params [required, String] :app_id
1065
+ #
1066
+ # @option params [required, String] :backend_environment_name
1067
+ #
1068
+ # @option params [required, String] :resource_name
1069
+ #
1070
+ # @return [Types::GetBackendAPIModelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1071
+ #
1072
+ # * {Types::GetBackendAPIModelsResponse#models #models} => String
1073
+ # * {Types::GetBackendAPIModelsResponse#status #status} => String
1074
+ #
1075
+ # @example Request syntax with placeholder values
1076
+ #
1077
+ # resp = client.get_backend_api_models({
1078
+ # app_id: "__string", # required
1079
+ # backend_environment_name: "__string", # required
1080
+ # resource_name: "__string", # required
1081
+ # })
1082
+ #
1083
+ # @example Response structure
1084
+ #
1085
+ # resp.models #=> String
1086
+ # resp.status #=> String, one of "LATEST", "STALE"
1087
+ #
1088
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/GetBackendAPIModels AWS API Documentation
1089
+ #
1090
+ # @overload get_backend_api_models(params = {})
1091
+ # @param [Hash] params ({})
1092
+ def get_backend_api_models(params = {}, options = {})
1093
+ req = build_request(:get_backend_api_models, params)
1094
+ req.send_request(options)
1095
+ end
1096
+
1097
+ # Gets a backend auth details.
1098
+ #
1099
+ # @option params [required, String] :app_id
1100
+ #
1101
+ # @option params [required, String] :backend_environment_name
1102
+ #
1103
+ # @option params [required, String] :resource_name
1104
+ #
1105
+ # @return [Types::GetBackendAuthResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1106
+ #
1107
+ # * {Types::GetBackendAuthResponse#app_id #app_id} => String
1108
+ # * {Types::GetBackendAuthResponse#backend_environment_name #backend_environment_name} => String
1109
+ # * {Types::GetBackendAuthResponse#error #error} => String
1110
+ # * {Types::GetBackendAuthResponse#resource_config #resource_config} => Types::CreateBackendAuthResourceConfig
1111
+ # * {Types::GetBackendAuthResponse#resource_name #resource_name} => String
1112
+ #
1113
+ # @example Request syntax with placeholder values
1114
+ #
1115
+ # resp = client.get_backend_auth({
1116
+ # app_id: "__string", # required
1117
+ # backend_environment_name: "__string", # required
1118
+ # resource_name: "__string", # required
1119
+ # })
1120
+ #
1121
+ # @example Response structure
1122
+ #
1123
+ # resp.app_id #=> String
1124
+ # resp.backend_environment_name #=> String
1125
+ # resp.error #=> String
1126
+ # resp.resource_config.auth_resources #=> String, one of "USER_POOL_ONLY", "IDENTITY_POOL_AND_USER_POOL"
1127
+ # resp.resource_config.identity_pool_configs.identity_pool_name #=> String
1128
+ # resp.resource_config.identity_pool_configs.unauthenticated_login #=> Boolean
1129
+ # resp.resource_config.service #=> String, one of "COGNITO"
1130
+ # resp.resource_config.user_pool_configs.forgot_password.delivery_method #=> String, one of "EMAIL", "SMS"
1131
+ # resp.resource_config.user_pool_configs.forgot_password.email_settings.email_message #=> String
1132
+ # resp.resource_config.user_pool_configs.forgot_password.email_settings.email_subject #=> String
1133
+ # resp.resource_config.user_pool_configs.forgot_password.sms_settings.sms_message #=> String
1134
+ # resp.resource_config.user_pool_configs.mfa.mfa_mode #=> String, one of "ON", "OFF", "OPTIONAL"
1135
+ # resp.resource_config.user_pool_configs.mfa.settings.mfa_types #=> Array
1136
+ # resp.resource_config.user_pool_configs.mfa.settings.mfa_types[0] #=> String, one of "SMS", "TOTP"
1137
+ # resp.resource_config.user_pool_configs.mfa.settings.sms_message #=> String
1138
+ # resp.resource_config.user_pool_configs.o_auth.domain_prefix #=> String
1139
+ # resp.resource_config.user_pool_configs.o_auth.o_auth_grant_type #=> String, one of "CODE", "IMPLICIT"
1140
+ # resp.resource_config.user_pool_configs.o_auth.o_auth_scopes #=> Array
1141
+ # resp.resource_config.user_pool_configs.o_auth.o_auth_scopes[0] #=> String, one of "PHONE", "EMAIL", "OPENID", "PROFILE", "AWS_COGNITO_SIGNIN_USER_ADMIN"
1142
+ # resp.resource_config.user_pool_configs.o_auth.redirect_sign_in_ur_is #=> Array
1143
+ # resp.resource_config.user_pool_configs.o_auth.redirect_sign_in_ur_is[0] #=> String
1144
+ # resp.resource_config.user_pool_configs.o_auth.redirect_sign_out_ur_is #=> Array
1145
+ # resp.resource_config.user_pool_configs.o_auth.redirect_sign_out_ur_is[0] #=> String
1146
+ # resp.resource_config.user_pool_configs.o_auth.social_provider_settings.facebook.client_id #=> String
1147
+ # resp.resource_config.user_pool_configs.o_auth.social_provider_settings.facebook.client_secret #=> String
1148
+ # resp.resource_config.user_pool_configs.o_auth.social_provider_settings.google.client_id #=> String
1149
+ # resp.resource_config.user_pool_configs.o_auth.social_provider_settings.google.client_secret #=> String
1150
+ # resp.resource_config.user_pool_configs.o_auth.social_provider_settings.login_with_amazon.client_id #=> String
1151
+ # resp.resource_config.user_pool_configs.o_auth.social_provider_settings.login_with_amazon.client_secret #=> String
1152
+ # resp.resource_config.user_pool_configs.password_policy.additional_constraints #=> Array
1153
+ # resp.resource_config.user_pool_configs.password_policy.additional_constraints[0] #=> String, one of "REQUIRE_DIGIT", "REQUIRE_LOWERCASE", "REQUIRE_SYMBOL", "REQUIRE_UPPERCASE"
1154
+ # resp.resource_config.user_pool_configs.password_policy.minimum_length #=> Float
1155
+ # resp.resource_config.user_pool_configs.required_sign_up_attributes #=> Array
1156
+ # resp.resource_config.user_pool_configs.required_sign_up_attributes[0] #=> String, one of "ADDRESS", "BIRTHDATE", "EMAIL", "FAMILY_NAME", "GENDER", "GIVEN_NAME", "LOCALE", "MIDDLE_NAME", "NAME", "NICKNAME", "PHONE_NUMBER", "PICTURE", "PREFERRED_USERNAME", "PROFILE", "UPDATED_AT", "WEBSITE", "ZONE_INFO"
1157
+ # resp.resource_config.user_pool_configs.sign_in_method #=> String, one of "EMAIL", "EMAIL_AND_PHONE_NUMBER", "PHONE_NUMBER", "USERNAME"
1158
+ # resp.resource_config.user_pool_configs.user_pool_name #=> String
1159
+ # resp.resource_name #=> String
1160
+ #
1161
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/GetBackendAuth AWS API Documentation
1162
+ #
1163
+ # @overload get_backend_auth(params = {})
1164
+ # @param [Hash] params ({})
1165
+ def get_backend_auth(params = {}, options = {})
1166
+ req = build_request(:get_backend_auth, params)
1167
+ req.send_request(options)
1168
+ end
1169
+
1170
+ # Returns information about a specific job.
1171
+ #
1172
+ # @option params [required, String] :app_id
1173
+ #
1174
+ # @option params [required, String] :backend_environment_name
1175
+ #
1176
+ # @option params [required, String] :job_id
1177
+ #
1178
+ # @return [Types::GetBackendJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1179
+ #
1180
+ # * {Types::GetBackendJobResponse#app_id #app_id} => String
1181
+ # * {Types::GetBackendJobResponse#backend_environment_name #backend_environment_name} => String
1182
+ # * {Types::GetBackendJobResponse#create_time #create_time} => String
1183
+ # * {Types::GetBackendJobResponse#error #error} => String
1184
+ # * {Types::GetBackendJobResponse#job_id #job_id} => String
1185
+ # * {Types::GetBackendJobResponse#operation #operation} => String
1186
+ # * {Types::GetBackendJobResponse#status #status} => String
1187
+ # * {Types::GetBackendJobResponse#update_time #update_time} => String
1188
+ #
1189
+ # @example Request syntax with placeholder values
1190
+ #
1191
+ # resp = client.get_backend_job({
1192
+ # app_id: "__string", # required
1193
+ # backend_environment_name: "__string", # required
1194
+ # job_id: "__string", # required
1195
+ # })
1196
+ #
1197
+ # @example Response structure
1198
+ #
1199
+ # resp.app_id #=> String
1200
+ # resp.backend_environment_name #=> String
1201
+ # resp.create_time #=> String
1202
+ # resp.error #=> String
1203
+ # resp.job_id #=> String
1204
+ # resp.operation #=> String
1205
+ # resp.status #=> String
1206
+ # resp.update_time #=> String
1207
+ #
1208
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/GetBackendJob AWS API Documentation
1209
+ #
1210
+ # @overload get_backend_job(params = {})
1211
+ # @param [Hash] params ({})
1212
+ def get_backend_job(params = {}, options = {})
1213
+ req = build_request(:get_backend_job, params)
1214
+ req.send_request(options)
1215
+ end
1216
+
1217
+ # Gets the challenge token based on the given appId and sessionId.
1218
+ #
1219
+ # @option params [required, String] :app_id
1220
+ #
1221
+ # @option params [required, String] :session_id
1222
+ #
1223
+ # @return [Types::GetTokenResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1224
+ #
1225
+ # * {Types::GetTokenResponse#app_id #app_id} => String
1226
+ # * {Types::GetTokenResponse#challenge_code #challenge_code} => String
1227
+ # * {Types::GetTokenResponse#session_id #session_id} => String
1228
+ # * {Types::GetTokenResponse#ttl #ttl} => String
1229
+ #
1230
+ # @example Request syntax with placeholder values
1231
+ #
1232
+ # resp = client.get_token({
1233
+ # app_id: "__string", # required
1234
+ # session_id: "__string", # required
1235
+ # })
1236
+ #
1237
+ # @example Response structure
1238
+ #
1239
+ # resp.app_id #=> String
1240
+ # resp.challenge_code #=> String
1241
+ # resp.session_id #=> String
1242
+ # resp.ttl #=> String
1243
+ #
1244
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/GetToken AWS API Documentation
1245
+ #
1246
+ # @overload get_token(params = {})
1247
+ # @param [Hash] params ({})
1248
+ def get_token(params = {}, options = {})
1249
+ req = build_request(:get_token, params)
1250
+ req.send_request(options)
1251
+ end
1252
+
1253
+ # Lists the jobs for the backend of an Amplify app.
1254
+ #
1255
+ # @option params [required, String] :app_id
1256
+ #
1257
+ # @option params [required, String] :backend_environment_name
1258
+ #
1259
+ # @option params [String] :job_id
1260
+ #
1261
+ # @option params [Integer] :max_results
1262
+ #
1263
+ # @option params [String] :next_token
1264
+ #
1265
+ # @option params [String] :operation
1266
+ #
1267
+ # @option params [String] :status
1268
+ #
1269
+ # @return [Types::ListBackendJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1270
+ #
1271
+ # * {Types::ListBackendJobsResponse#jobs #jobs} => Array&lt;Types::BackendJobRespObj&gt;
1272
+ # * {Types::ListBackendJobsResponse#next_token #next_token} => String
1273
+ #
1274
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1275
+ #
1276
+ # @example Request syntax with placeholder values
1277
+ #
1278
+ # resp = client.list_backend_jobs({
1279
+ # app_id: "__string", # required
1280
+ # backend_environment_name: "__string", # required
1281
+ # job_id: "__string",
1282
+ # max_results: 1,
1283
+ # next_token: "__string",
1284
+ # operation: "__string",
1285
+ # status: "__string",
1286
+ # })
1287
+ #
1288
+ # @example Response structure
1289
+ #
1290
+ # resp.jobs #=> Array
1291
+ # resp.jobs[0].app_id #=> String
1292
+ # resp.jobs[0].backend_environment_name #=> String
1293
+ # resp.jobs[0].create_time #=> String
1294
+ # resp.jobs[0].error #=> String
1295
+ # resp.jobs[0].job_id #=> String
1296
+ # resp.jobs[0].operation #=> String
1297
+ # resp.jobs[0].status #=> String
1298
+ # resp.jobs[0].update_time #=> String
1299
+ # resp.next_token #=> String
1300
+ #
1301
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/ListBackendJobs AWS API Documentation
1302
+ #
1303
+ # @overload list_backend_jobs(params = {})
1304
+ # @param [Hash] params ({})
1305
+ def list_backend_jobs(params = {}, options = {})
1306
+ req = build_request(:list_backend_jobs, params)
1307
+ req.send_request(options)
1308
+ end
1309
+
1310
+ # Removes all backend environments from your Amplify project.
1311
+ #
1312
+ # @option params [required, String] :app_id
1313
+ #
1314
+ # @option params [Boolean] :clean_amplify_app
1315
+ #
1316
+ # @return [Types::RemoveAllBackendsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1317
+ #
1318
+ # * {Types::RemoveAllBackendsResponse#app_id #app_id} => String
1319
+ # * {Types::RemoveAllBackendsResponse#error #error} => String
1320
+ # * {Types::RemoveAllBackendsResponse#job_id #job_id} => String
1321
+ # * {Types::RemoveAllBackendsResponse#operation #operation} => String
1322
+ # * {Types::RemoveAllBackendsResponse#status #status} => String
1323
+ #
1324
+ # @example Request syntax with placeholder values
1325
+ #
1326
+ # resp = client.remove_all_backends({
1327
+ # app_id: "__string", # required
1328
+ # clean_amplify_app: false,
1329
+ # })
1330
+ #
1331
+ # @example Response structure
1332
+ #
1333
+ # resp.app_id #=> String
1334
+ # resp.error #=> String
1335
+ # resp.job_id #=> String
1336
+ # resp.operation #=> String
1337
+ # resp.status #=> String
1338
+ #
1339
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/RemoveAllBackends AWS API Documentation
1340
+ #
1341
+ # @overload remove_all_backends(params = {})
1342
+ # @param [Hash] params ({})
1343
+ def remove_all_backends(params = {}, options = {})
1344
+ req = build_request(:remove_all_backends, params)
1345
+ req.send_request(options)
1346
+ end
1347
+
1348
+ # Removes the AWS resources required to access the Amplify Admin UI.
1349
+ #
1350
+ # @option params [required, String] :app_id
1351
+ #
1352
+ # @return [Types::RemoveBackendConfigResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1353
+ #
1354
+ # * {Types::RemoveBackendConfigResponse#error #error} => String
1355
+ #
1356
+ # @example Request syntax with placeholder values
1357
+ #
1358
+ # resp = client.remove_backend_config({
1359
+ # app_id: "__string", # required
1360
+ # })
1361
+ #
1362
+ # @example Response structure
1363
+ #
1364
+ # resp.error #=> String
1365
+ #
1366
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/RemoveBackendConfig AWS API Documentation
1367
+ #
1368
+ # @overload remove_backend_config(params = {})
1369
+ # @param [Hash] params ({})
1370
+ def remove_backend_config(params = {}, options = {})
1371
+ req = build_request(:remove_backend_config, params)
1372
+ req.send_request(options)
1373
+ end
1374
+
1375
+ # Updates an existing backend API resource.
1376
+ #
1377
+ # @option params [required, String] :app_id
1378
+ #
1379
+ # @option params [required, String] :backend_environment_name
1380
+ #
1381
+ # @option params [Types::BackendAPIResourceConfig] :resource_config
1382
+ # The resource config for the data model,configured as a part of the
1383
+ # Amplify project.
1384
+ #
1385
+ # @option params [required, String] :resource_name
1386
+ #
1387
+ # @return [Types::UpdateBackendAPIResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1388
+ #
1389
+ # * {Types::UpdateBackendAPIResponse#app_id #app_id} => String
1390
+ # * {Types::UpdateBackendAPIResponse#backend_environment_name #backend_environment_name} => String
1391
+ # * {Types::UpdateBackendAPIResponse#error #error} => String
1392
+ # * {Types::UpdateBackendAPIResponse#job_id #job_id} => String
1393
+ # * {Types::UpdateBackendAPIResponse#operation #operation} => String
1394
+ # * {Types::UpdateBackendAPIResponse#status #status} => String
1395
+ #
1396
+ # @example Request syntax with placeholder values
1397
+ #
1398
+ # resp = client.update_backend_api({
1399
+ # app_id: "__string", # required
1400
+ # backend_environment_name: "__string", # required
1401
+ # resource_config: {
1402
+ # additional_auth_types: [
1403
+ # {
1404
+ # mode: "API_KEY", # accepts API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT
1405
+ # settings: {
1406
+ # cognito_user_pool_id: "__string",
1407
+ # description: "__string",
1408
+ # expiration_time: 1.0,
1409
+ # open_id_auth_ttl: "__string",
1410
+ # open_id_client_id: "__string",
1411
+ # open_id_iat_ttl: "__string",
1412
+ # open_id_issue_url: "__string",
1413
+ # open_id_provider_name: "__string",
1414
+ # },
1415
+ # },
1416
+ # ],
1417
+ # api_name: "__string",
1418
+ # conflict_resolution: {
1419
+ # resolution_strategy: "OPTIMISTIC_CONCURRENCY", # accepts OPTIMISTIC_CONCURRENCY, LAMBDA, AUTOMERGE, NONE
1420
+ # },
1421
+ # default_auth_type: {
1422
+ # mode: "API_KEY", # accepts API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT
1423
+ # settings: {
1424
+ # cognito_user_pool_id: "__string",
1425
+ # description: "__string",
1426
+ # expiration_time: 1.0,
1427
+ # open_id_auth_ttl: "__string",
1428
+ # open_id_client_id: "__string",
1429
+ # open_id_iat_ttl: "__string",
1430
+ # open_id_issue_url: "__string",
1431
+ # open_id_provider_name: "__string",
1432
+ # },
1433
+ # },
1434
+ # service: "__string",
1435
+ # transform_schema: "__string",
1436
+ # },
1437
+ # resource_name: "__string", # required
1438
+ # })
1439
+ #
1440
+ # @example Response structure
1441
+ #
1442
+ # resp.app_id #=> String
1443
+ # resp.backend_environment_name #=> String
1444
+ # resp.error #=> String
1445
+ # resp.job_id #=> String
1446
+ # resp.operation #=> String
1447
+ # resp.status #=> String
1448
+ #
1449
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/UpdateBackendAPI AWS API Documentation
1450
+ #
1451
+ # @overload update_backend_api(params = {})
1452
+ # @param [Hash] params ({})
1453
+ def update_backend_api(params = {}, options = {})
1454
+ req = build_request(:update_backend_api, params)
1455
+ req.send_request(options)
1456
+ end
1457
+
1458
+ # Updates an existing backend authentication resource.
1459
+ #
1460
+ # @option params [required, String] :app_id
1461
+ #
1462
+ # @option params [required, String] :backend_environment_name
1463
+ #
1464
+ # @option params [required, Types::UpdateBackendAuthResourceConfig] :resource_config
1465
+ # Defines the resource configuration when updating an authentication
1466
+ # resource in your Amplify project.
1467
+ #
1468
+ # @option params [required, String] :resource_name
1469
+ #
1470
+ # @return [Types::UpdateBackendAuthResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1471
+ #
1472
+ # * {Types::UpdateBackendAuthResponse#app_id #app_id} => String
1473
+ # * {Types::UpdateBackendAuthResponse#backend_environment_name #backend_environment_name} => String
1474
+ # * {Types::UpdateBackendAuthResponse#error #error} => String
1475
+ # * {Types::UpdateBackendAuthResponse#job_id #job_id} => String
1476
+ # * {Types::UpdateBackendAuthResponse#operation #operation} => String
1477
+ # * {Types::UpdateBackendAuthResponse#status #status} => String
1478
+ #
1479
+ # @example Request syntax with placeholder values
1480
+ #
1481
+ # resp = client.update_backend_auth({
1482
+ # app_id: "__string", # required
1483
+ # backend_environment_name: "__string", # required
1484
+ # resource_config: { # required
1485
+ # auth_resources: "USER_POOL_ONLY", # required, accepts USER_POOL_ONLY, IDENTITY_POOL_AND_USER_POOL
1486
+ # identity_pool_configs: {
1487
+ # unauthenticated_login: false,
1488
+ # },
1489
+ # service: "COGNITO", # required, accepts COGNITO
1490
+ # user_pool_configs: { # required
1491
+ # forgot_password: {
1492
+ # delivery_method: "EMAIL", # accepts EMAIL, SMS
1493
+ # email_settings: {
1494
+ # email_message: "__string",
1495
+ # email_subject: "__string",
1496
+ # },
1497
+ # sms_settings: {
1498
+ # sms_message: "__string",
1499
+ # },
1500
+ # },
1501
+ # mfa: {
1502
+ # mfa_mode: "ON", # accepts ON, OFF, OPTIONAL
1503
+ # settings: {
1504
+ # mfa_types: ["SMS"], # accepts SMS, TOTP
1505
+ # sms_message: "__string",
1506
+ # },
1507
+ # },
1508
+ # o_auth: {
1509
+ # domain_prefix: "__string",
1510
+ # o_auth_grant_type: "CODE", # accepts CODE, IMPLICIT
1511
+ # o_auth_scopes: ["PHONE"], # accepts PHONE, EMAIL, OPENID, PROFILE, AWS_COGNITO_SIGNIN_USER_ADMIN
1512
+ # redirect_sign_in_ur_is: ["__string"],
1513
+ # redirect_sign_out_ur_is: ["__string"],
1514
+ # social_provider_settings: {
1515
+ # facebook: {
1516
+ # client_id: "__string",
1517
+ # client_secret: "__string",
1518
+ # },
1519
+ # google: {
1520
+ # client_id: "__string",
1521
+ # client_secret: "__string",
1522
+ # },
1523
+ # login_with_amazon: {
1524
+ # client_id: "__string",
1525
+ # client_secret: "__string",
1526
+ # },
1527
+ # },
1528
+ # },
1529
+ # password_policy: {
1530
+ # additional_constraints: ["REQUIRE_DIGIT"], # accepts REQUIRE_DIGIT, REQUIRE_LOWERCASE, REQUIRE_SYMBOL, REQUIRE_UPPERCASE
1531
+ # minimum_length: 1.0,
1532
+ # },
1533
+ # },
1534
+ # },
1535
+ # resource_name: "__string", # required
1536
+ # })
1537
+ #
1538
+ # @example Response structure
1539
+ #
1540
+ # resp.app_id #=> String
1541
+ # resp.backend_environment_name #=> String
1542
+ # resp.error #=> String
1543
+ # resp.job_id #=> String
1544
+ # resp.operation #=> String
1545
+ # resp.status #=> String
1546
+ #
1547
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/UpdateBackendAuth AWS API Documentation
1548
+ #
1549
+ # @overload update_backend_auth(params = {})
1550
+ # @param [Hash] params ({})
1551
+ def update_backend_auth(params = {}, options = {})
1552
+ req = build_request(:update_backend_auth, params)
1553
+ req.send_request(options)
1554
+ end
1555
+
1556
+ # Updates the AWS resources required to access the Amplify Admin UI.
1557
+ #
1558
+ # @option params [required, String] :app_id
1559
+ #
1560
+ # @option params [Types::LoginAuthConfigReqObj] :login_auth_config
1561
+ # The request object for this operation.
1562
+ #
1563
+ # @return [Types::UpdateBackendConfigResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1564
+ #
1565
+ # * {Types::UpdateBackendConfigResponse#app_id #app_id} => String
1566
+ # * {Types::UpdateBackendConfigResponse#backend_manager_app_id #backend_manager_app_id} => String
1567
+ # * {Types::UpdateBackendConfigResponse#error #error} => String
1568
+ # * {Types::UpdateBackendConfigResponse#login_auth_config #login_auth_config} => Types::LoginAuthConfigReqObj
1569
+ #
1570
+ # @example Request syntax with placeholder values
1571
+ #
1572
+ # resp = client.update_backend_config({
1573
+ # app_id: "__string", # required
1574
+ # login_auth_config: {
1575
+ # aws_cognito_identity_pool_id: "__string",
1576
+ # aws_cognito_region: "__string",
1577
+ # aws_user_pools_id: "__string",
1578
+ # aws_user_pools_web_client_id: "__string",
1579
+ # },
1580
+ # })
1581
+ #
1582
+ # @example Response structure
1583
+ #
1584
+ # resp.app_id #=> String
1585
+ # resp.backend_manager_app_id #=> String
1586
+ # resp.error #=> String
1587
+ # resp.login_auth_config.aws_cognito_identity_pool_id #=> String
1588
+ # resp.login_auth_config.aws_cognito_region #=> String
1589
+ # resp.login_auth_config.aws_user_pools_id #=> String
1590
+ # resp.login_auth_config.aws_user_pools_web_client_id #=> String
1591
+ #
1592
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/UpdateBackendConfig AWS API Documentation
1593
+ #
1594
+ # @overload update_backend_config(params = {})
1595
+ # @param [Hash] params ({})
1596
+ def update_backend_config(params = {}, options = {})
1597
+ req = build_request(:update_backend_config, params)
1598
+ req.send_request(options)
1599
+ end
1600
+
1601
+ # Updates a specific job.
1602
+ #
1603
+ # @option params [required, String] :app_id
1604
+ #
1605
+ # @option params [required, String] :backend_environment_name
1606
+ #
1607
+ # @option params [required, String] :job_id
1608
+ #
1609
+ # @option params [String] :operation
1610
+ #
1611
+ # @option params [String] :status
1612
+ #
1613
+ # @return [Types::UpdateBackendJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1614
+ #
1615
+ # * {Types::UpdateBackendJobResponse#app_id #app_id} => String
1616
+ # * {Types::UpdateBackendJobResponse#backend_environment_name #backend_environment_name} => String
1617
+ # * {Types::UpdateBackendJobResponse#create_time #create_time} => String
1618
+ # * {Types::UpdateBackendJobResponse#error #error} => String
1619
+ # * {Types::UpdateBackendJobResponse#job_id #job_id} => String
1620
+ # * {Types::UpdateBackendJobResponse#operation #operation} => String
1621
+ # * {Types::UpdateBackendJobResponse#status #status} => String
1622
+ # * {Types::UpdateBackendJobResponse#update_time #update_time} => String
1623
+ #
1624
+ # @example Request syntax with placeholder values
1625
+ #
1626
+ # resp = client.update_backend_job({
1627
+ # app_id: "__string", # required
1628
+ # backend_environment_name: "__string", # required
1629
+ # job_id: "__string", # required
1630
+ # operation: "__string",
1631
+ # status: "__string",
1632
+ # })
1633
+ #
1634
+ # @example Response structure
1635
+ #
1636
+ # resp.app_id #=> String
1637
+ # resp.backend_environment_name #=> String
1638
+ # resp.create_time #=> String
1639
+ # resp.error #=> String
1640
+ # resp.job_id #=> String
1641
+ # resp.operation #=> String
1642
+ # resp.status #=> String
1643
+ # resp.update_time #=> String
1644
+ #
1645
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/UpdateBackendJob AWS API Documentation
1646
+ #
1647
+ # @overload update_backend_job(params = {})
1648
+ # @param [Hash] params ({})
1649
+ def update_backend_job(params = {}, options = {})
1650
+ req = build_request(:update_backend_job, params)
1651
+ req.send_request(options)
1652
+ end
1653
+
1654
+ # @!endgroup
1655
+
1656
+ # @param params ({})
1657
+ # @api private
1658
+ def build_request(operation_name, params = {})
1659
+ handlers = @handlers.for(operation_name)
1660
+ context = Seahorse::Client::RequestContext.new(
1661
+ operation_name: operation_name,
1662
+ operation: config.api.operation(operation_name),
1663
+ client: self,
1664
+ params: params,
1665
+ config: config)
1666
+ context[:gem_name] = 'aws-sdk-amplifybackend'
1667
+ context[:gem_version] = '1.0.0'
1668
+ Seahorse::Client::Request.new(handlers, context)
1669
+ end
1670
+
1671
+ # @api private
1672
+ # @deprecated
1673
+ def waiter_names
1674
+ []
1675
+ end
1676
+
1677
+ class << self
1678
+
1679
+ # @api private
1680
+ attr_reader :identifier
1681
+
1682
+ # @api private
1683
+ def errors_module
1684
+ Errors
1685
+ end
1686
+
1687
+ end
1688
+ end
1689
+ end