aws-sdk-amplifybackend 1.29.0 → 1.30.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
data/sig/client.rbs ADDED
@@ -0,0 +1,851 @@
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/version-3/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws
9
+ module AmplifyBackend
10
+ class Client < ::Seahorse::Client::Base
11
+ include ::Aws::ClientStubs
12
+
13
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/AmplifyBackend/Client.html#initialize-instance_method
14
+ def self.new: (
15
+ ?credentials: untyped,
16
+ ?region: String,
17
+ ?access_key_id: String,
18
+ ?active_endpoint_cache: bool,
19
+ ?adaptive_retry_wait_to_fill: bool,
20
+ ?client_side_monitoring: bool,
21
+ ?client_side_monitoring_client_id: String,
22
+ ?client_side_monitoring_host: String,
23
+ ?client_side_monitoring_port: Integer,
24
+ ?client_side_monitoring_publisher: untyped,
25
+ ?convert_params: bool,
26
+ ?correct_clock_skew: bool,
27
+ ?defaults_mode: String,
28
+ ?disable_host_prefix_injection: bool,
29
+ ?disable_request_compression: bool,
30
+ ?endpoint: String,
31
+ ?endpoint_cache_max_entries: Integer,
32
+ ?endpoint_cache_max_threads: Integer,
33
+ ?endpoint_cache_poll_interval: Integer,
34
+ ?endpoint_discovery: bool,
35
+ ?ignore_configured_endpoint_urls: bool,
36
+ ?log_formatter: untyped,
37
+ ?log_level: Symbol,
38
+ ?logger: untyped,
39
+ ?max_attempts: Integer,
40
+ ?profile: String,
41
+ ?request_min_compression_size_bytes: Integer,
42
+ ?retry_backoff: Proc,
43
+ ?retry_base_delay: Float,
44
+ ?retry_jitter: (:none | :equal | :full | ^(Integer) -> Integer),
45
+ ?retry_limit: Integer,
46
+ ?retry_max_delay: Integer,
47
+ ?retry_mode: ("legacy" | "standard" | "adaptive"),
48
+ ?sdk_ua_app_id: String,
49
+ ?secret_access_key: String,
50
+ ?session_token: String,
51
+ ?stub_responses: untyped,
52
+ ?token_provider: untyped,
53
+ ?use_dualstack_endpoint: bool,
54
+ ?use_fips_endpoint: bool,
55
+ ?validate_params: bool,
56
+ ?endpoint_provider: untyped,
57
+ ?http_proxy: String,
58
+ ?http_open_timeout: (Float | Integer),
59
+ ?http_read_timeout: (Float | Integer),
60
+ ?http_idle_timeout: (Float | Integer),
61
+ ?http_continue_timeout: (Float | Integer),
62
+ ?ssl_timeout: (Float | Integer | nil),
63
+ ?http_wire_trace: bool,
64
+ ?ssl_verify_peer: bool,
65
+ ?ssl_ca_bundle: String,
66
+ ?ssl_ca_directory: String,
67
+ ?ssl_ca_store: String,
68
+ ?on_chunk_received: Proc,
69
+ ?on_chunk_sent: Proc,
70
+ ?raise_response_errors: bool
71
+ ) -> instance
72
+ | (?Hash[Symbol, untyped]) -> instance
73
+
74
+
75
+ interface _CloneBackendResponseSuccess
76
+ include ::Seahorse::Client::_ResponseSuccess[Types::CloneBackendResponse]
77
+ def app_id: () -> ::String
78
+ def backend_environment_name: () -> ::String
79
+ def job_id: () -> ::String
80
+ def operation: () -> ::String
81
+ def status: () -> ::String
82
+ end
83
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/AmplifyBackend/Client.html#clone_backend-instance_method
84
+ def clone_backend: (
85
+ app_id: ::String,
86
+ backend_environment_name: ::String,
87
+ target_environment_name: ::String
88
+ ) -> _CloneBackendResponseSuccess
89
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CloneBackendResponseSuccess
90
+
91
+ interface _CreateBackendResponseSuccess
92
+ include ::Seahorse::Client::_ResponseSuccess[Types::CreateBackendResponse]
93
+ def app_id: () -> ::String
94
+ def backend_environment_name: () -> ::String
95
+ def job_id: () -> ::String
96
+ def operation: () -> ::String
97
+ def status: () -> ::String
98
+ end
99
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/AmplifyBackend/Client.html#create_backend-instance_method
100
+ def create_backend: (
101
+ app_id: ::String,
102
+ app_name: ::String,
103
+ backend_environment_name: ::String,
104
+ ?resource_config: {
105
+ },
106
+ ?resource_name: ::String
107
+ ) -> _CreateBackendResponseSuccess
108
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateBackendResponseSuccess
109
+
110
+ interface _CreateBackendAPIResponseSuccess
111
+ include ::Seahorse::Client::_ResponseSuccess[Types::CreateBackendAPIResponse]
112
+ def app_id: () -> ::String
113
+ def backend_environment_name: () -> ::String
114
+ def job_id: () -> ::String
115
+ def operation: () -> ::String
116
+ def status: () -> ::String
117
+ end
118
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/AmplifyBackend/Client.html#create_backend_api-instance_method
119
+ def create_backend_api: (
120
+ app_id: ::String,
121
+ backend_environment_name: ::String,
122
+ resource_config: {
123
+ additional_auth_types: Array[
124
+ {
125
+ mode: ("API_KEY" | "AWS_IAM" | "AMAZON_COGNITO_USER_POOLS" | "OPENID_CONNECT")?,
126
+ settings: {
127
+ cognito_user_pool_id: ::String?,
128
+ description: ::String?,
129
+ expiration_time: ::Float?,
130
+ open_id_auth_ttl: ::String?,
131
+ open_id_client_id: ::String?,
132
+ open_id_iat_ttl: ::String?,
133
+ open_id_issue_url: ::String?,
134
+ open_id_provider_name: ::String?
135
+ }?
136
+ },
137
+ ]?,
138
+ api_name: ::String?,
139
+ conflict_resolution: {
140
+ resolution_strategy: ("OPTIMISTIC_CONCURRENCY" | "LAMBDA" | "AUTOMERGE" | "NONE")?
141
+ }?,
142
+ default_auth_type: {
143
+ mode: ("API_KEY" | "AWS_IAM" | "AMAZON_COGNITO_USER_POOLS" | "OPENID_CONNECT")?,
144
+ settings: {
145
+ cognito_user_pool_id: ::String?,
146
+ description: ::String?,
147
+ expiration_time: ::Float?,
148
+ open_id_auth_ttl: ::String?,
149
+ open_id_client_id: ::String?,
150
+ open_id_iat_ttl: ::String?,
151
+ open_id_issue_url: ::String?,
152
+ open_id_provider_name: ::String?
153
+ }?
154
+ }?,
155
+ service: ::String?,
156
+ transform_schema: ::String?
157
+ },
158
+ resource_name: ::String
159
+ ) -> _CreateBackendAPIResponseSuccess
160
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateBackendAPIResponseSuccess
161
+
162
+ interface _CreateBackendAuthResponseSuccess
163
+ include ::Seahorse::Client::_ResponseSuccess[Types::CreateBackendAuthResponse]
164
+ def app_id: () -> ::String
165
+ def backend_environment_name: () -> ::String
166
+ def job_id: () -> ::String
167
+ def operation: () -> ::String
168
+ def status: () -> ::String
169
+ end
170
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/AmplifyBackend/Client.html#create_backend_auth-instance_method
171
+ def create_backend_auth: (
172
+ app_id: ::String,
173
+ backend_environment_name: ::String,
174
+ resource_config: {
175
+ auth_resources: ("USER_POOL_ONLY" | "IDENTITY_POOL_AND_USER_POOL"),
176
+ identity_pool_configs: {
177
+ identity_pool_name: ::String,
178
+ unauthenticated_login: bool
179
+ }?,
180
+ service: ("COGNITO"),
181
+ user_pool_configs: {
182
+ forgot_password: {
183
+ delivery_method: ("EMAIL" | "SMS"),
184
+ email_settings: {
185
+ email_message: ::String?,
186
+ email_subject: ::String?
187
+ }?,
188
+ sms_settings: {
189
+ sms_message: ::String?
190
+ }?
191
+ }?,
192
+ mfa: {
193
+ mfa_mode: ("ON" | "OFF" | "OPTIONAL"),
194
+ settings: {
195
+ mfa_types: Array[("SMS" | "TOTP")]?,
196
+ sms_message: ::String?
197
+ }?
198
+ }?,
199
+ o_auth: {
200
+ domain_prefix: ::String?,
201
+ o_auth_grant_type: ("CODE" | "IMPLICIT"),
202
+ o_auth_scopes: Array[("PHONE" | "EMAIL" | "OPENID" | "PROFILE" | "AWS_COGNITO_SIGNIN_USER_ADMIN")],
203
+ redirect_sign_in_ur_is: Array[::String],
204
+ redirect_sign_out_ur_is: Array[::String],
205
+ social_provider_settings: {
206
+ facebook: {
207
+ client_id: ::String?,
208
+ client_secret: ::String?
209
+ }?,
210
+ google: {
211
+ client_id: ::String?,
212
+ client_secret: ::String?
213
+ }?,
214
+ login_with_amazon: {
215
+ client_id: ::String?,
216
+ client_secret: ::String?
217
+ }?,
218
+ sign_in_with_apple: {
219
+ client_id: ::String?,
220
+ key_id: ::String?,
221
+ private_key: ::String?,
222
+ team_id: ::String?
223
+ }?
224
+ }?
225
+ }?,
226
+ password_policy: {
227
+ additional_constraints: Array[("REQUIRE_DIGIT" | "REQUIRE_LOWERCASE" | "REQUIRE_SYMBOL" | "REQUIRE_UPPERCASE")]?,
228
+ minimum_length: ::Float
229
+ }?,
230
+ required_sign_up_attributes: Array[("ADDRESS" | "BIRTHDATE" | "EMAIL" | "FAMILY_NAME" | "GENDER" | "GIVEN_NAME" | "LOCALE" | "MIDDLE_NAME" | "NAME" | "NICKNAME" | "PHONE_NUMBER" | "PICTURE" | "PREFERRED_USERNAME" | "PROFILE" | "UPDATED_AT" | "WEBSITE" | "ZONE_INFO")],
231
+ sign_in_method: ("EMAIL" | "EMAIL_AND_PHONE_NUMBER" | "PHONE_NUMBER" | "USERNAME"),
232
+ user_pool_name: ::String,
233
+ verification_message: {
234
+ delivery_method: ("EMAIL" | "SMS"),
235
+ email_settings: {
236
+ email_message: ::String?,
237
+ email_subject: ::String?
238
+ }?,
239
+ sms_settings: {
240
+ sms_message: ::String?
241
+ }?
242
+ }?
243
+ }
244
+ },
245
+ resource_name: ::String
246
+ ) -> _CreateBackendAuthResponseSuccess
247
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateBackendAuthResponseSuccess
248
+
249
+ interface _CreateBackendConfigResponseSuccess
250
+ include ::Seahorse::Client::_ResponseSuccess[Types::CreateBackendConfigResponse]
251
+ def app_id: () -> ::String
252
+ def backend_environment_name: () -> ::String
253
+ def job_id: () -> ::String
254
+ def status: () -> ::String
255
+ end
256
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/AmplifyBackend/Client.html#create_backend_config-instance_method
257
+ def create_backend_config: (
258
+ app_id: ::String,
259
+ ?backend_manager_app_id: ::String
260
+ ) -> _CreateBackendConfigResponseSuccess
261
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateBackendConfigResponseSuccess
262
+
263
+ interface _CreateBackendStorageResponseSuccess
264
+ include ::Seahorse::Client::_ResponseSuccess[Types::CreateBackendStorageResponse]
265
+ def app_id: () -> ::String
266
+ def backend_environment_name: () -> ::String
267
+ def job_id: () -> ::String
268
+ def status: () -> ::String
269
+ end
270
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/AmplifyBackend/Client.html#create_backend_storage-instance_method
271
+ def create_backend_storage: (
272
+ app_id: ::String,
273
+ backend_environment_name: ::String,
274
+ resource_config: {
275
+ bucket_name: ::String?,
276
+ permissions: {
277
+ authenticated: Array[("READ" | "CREATE_AND_UPDATE" | "DELETE")],
278
+ un_authenticated: Array[("READ" | "CREATE_AND_UPDATE" | "DELETE")]?
279
+ },
280
+ service_name: ("S3")
281
+ },
282
+ resource_name: ::String
283
+ ) -> _CreateBackendStorageResponseSuccess
284
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateBackendStorageResponseSuccess
285
+
286
+ interface _CreateTokenResponseSuccess
287
+ include ::Seahorse::Client::_ResponseSuccess[Types::CreateTokenResponse]
288
+ def app_id: () -> ::String
289
+ def challenge_code: () -> ::String
290
+ def session_id: () -> ::String
291
+ def ttl: () -> ::String
292
+ end
293
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/AmplifyBackend/Client.html#create_token-instance_method
294
+ def create_token: (
295
+ app_id: ::String
296
+ ) -> _CreateTokenResponseSuccess
297
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateTokenResponseSuccess
298
+
299
+ interface _DeleteBackendResponseSuccess
300
+ include ::Seahorse::Client::_ResponseSuccess[Types::DeleteBackendResponse]
301
+ def app_id: () -> ::String
302
+ def backend_environment_name: () -> ::String
303
+ def job_id: () -> ::String
304
+ def operation: () -> ::String
305
+ def status: () -> ::String
306
+ end
307
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/AmplifyBackend/Client.html#delete_backend-instance_method
308
+ def delete_backend: (
309
+ app_id: ::String,
310
+ backend_environment_name: ::String
311
+ ) -> _DeleteBackendResponseSuccess
312
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteBackendResponseSuccess
313
+
314
+ interface _DeleteBackendAPIResponseSuccess
315
+ include ::Seahorse::Client::_ResponseSuccess[Types::DeleteBackendAPIResponse]
316
+ def app_id: () -> ::String
317
+ def backend_environment_name: () -> ::String
318
+ def job_id: () -> ::String
319
+ def operation: () -> ::String
320
+ def status: () -> ::String
321
+ end
322
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/AmplifyBackend/Client.html#delete_backend_api-instance_method
323
+ def delete_backend_api: (
324
+ app_id: ::String,
325
+ backend_environment_name: ::String,
326
+ ?resource_config: {
327
+ additional_auth_types: Array[
328
+ {
329
+ mode: ("API_KEY" | "AWS_IAM" | "AMAZON_COGNITO_USER_POOLS" | "OPENID_CONNECT")?,
330
+ settings: {
331
+ cognito_user_pool_id: ::String?,
332
+ description: ::String?,
333
+ expiration_time: ::Float?,
334
+ open_id_auth_ttl: ::String?,
335
+ open_id_client_id: ::String?,
336
+ open_id_iat_ttl: ::String?,
337
+ open_id_issue_url: ::String?,
338
+ open_id_provider_name: ::String?
339
+ }?
340
+ },
341
+ ]?,
342
+ api_name: ::String?,
343
+ conflict_resolution: {
344
+ resolution_strategy: ("OPTIMISTIC_CONCURRENCY" | "LAMBDA" | "AUTOMERGE" | "NONE")?
345
+ }?,
346
+ default_auth_type: {
347
+ mode: ("API_KEY" | "AWS_IAM" | "AMAZON_COGNITO_USER_POOLS" | "OPENID_CONNECT")?,
348
+ settings: {
349
+ cognito_user_pool_id: ::String?,
350
+ description: ::String?,
351
+ expiration_time: ::Float?,
352
+ open_id_auth_ttl: ::String?,
353
+ open_id_client_id: ::String?,
354
+ open_id_iat_ttl: ::String?,
355
+ open_id_issue_url: ::String?,
356
+ open_id_provider_name: ::String?
357
+ }?
358
+ }?,
359
+ service: ::String?,
360
+ transform_schema: ::String?
361
+ },
362
+ resource_name: ::String
363
+ ) -> _DeleteBackendAPIResponseSuccess
364
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteBackendAPIResponseSuccess
365
+
366
+ interface _DeleteBackendAuthResponseSuccess
367
+ include ::Seahorse::Client::_ResponseSuccess[Types::DeleteBackendAuthResponse]
368
+ def app_id: () -> ::String
369
+ def backend_environment_name: () -> ::String
370
+ def job_id: () -> ::String
371
+ def operation: () -> ::String
372
+ def status: () -> ::String
373
+ end
374
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/AmplifyBackend/Client.html#delete_backend_auth-instance_method
375
+ def delete_backend_auth: (
376
+ app_id: ::String,
377
+ backend_environment_name: ::String,
378
+ resource_name: ::String
379
+ ) -> _DeleteBackendAuthResponseSuccess
380
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteBackendAuthResponseSuccess
381
+
382
+ interface _DeleteBackendStorageResponseSuccess
383
+ include ::Seahorse::Client::_ResponseSuccess[Types::DeleteBackendStorageResponse]
384
+ def app_id: () -> ::String
385
+ def backend_environment_name: () -> ::String
386
+ def job_id: () -> ::String
387
+ def status: () -> ::String
388
+ end
389
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/AmplifyBackend/Client.html#delete_backend_storage-instance_method
390
+ def delete_backend_storage: (
391
+ app_id: ::String,
392
+ backend_environment_name: ::String,
393
+ resource_name: ::String,
394
+ service_name: ("S3")
395
+ ) -> _DeleteBackendStorageResponseSuccess
396
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteBackendStorageResponseSuccess
397
+
398
+ interface _DeleteTokenResponseSuccess
399
+ include ::Seahorse::Client::_ResponseSuccess[Types::DeleteTokenResponse]
400
+ def is_success: () -> bool
401
+ end
402
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/AmplifyBackend/Client.html#delete_token-instance_method
403
+ def delete_token: (
404
+ app_id: ::String,
405
+ session_id: ::String
406
+ ) -> _DeleteTokenResponseSuccess
407
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteTokenResponseSuccess
408
+
409
+ interface _GenerateBackendAPIModelsResponseSuccess
410
+ include ::Seahorse::Client::_ResponseSuccess[Types::GenerateBackendAPIModelsResponse]
411
+ def app_id: () -> ::String
412
+ def backend_environment_name: () -> ::String
413
+ def job_id: () -> ::String
414
+ def operation: () -> ::String
415
+ def status: () -> ::String
416
+ end
417
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/AmplifyBackend/Client.html#generate_backend_api_models-instance_method
418
+ def generate_backend_api_models: (
419
+ app_id: ::String,
420
+ backend_environment_name: ::String,
421
+ resource_name: ::String
422
+ ) -> _GenerateBackendAPIModelsResponseSuccess
423
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GenerateBackendAPIModelsResponseSuccess
424
+
425
+ interface _GetBackendResponseSuccess
426
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetBackendResponse]
427
+ def amplify_feature_flags: () -> ::String
428
+ def amplify_meta_config: () -> ::String
429
+ def app_id: () -> ::String
430
+ def app_name: () -> ::String
431
+ def backend_environment_list: () -> ::Array[::String]
432
+ def backend_environment_name: () -> ::String
433
+ end
434
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/AmplifyBackend/Client.html#get_backend-instance_method
435
+ def get_backend: (
436
+ app_id: ::String,
437
+ ?backend_environment_name: ::String
438
+ ) -> _GetBackendResponseSuccess
439
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetBackendResponseSuccess
440
+
441
+ interface _GetBackendAPIResponseSuccess
442
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetBackendAPIResponse]
443
+ def app_id: () -> ::String
444
+ def backend_environment_name: () -> ::String
445
+ def resource_config: () -> Types::BackendAPIResourceConfig
446
+ def resource_name: () -> ::String
447
+ end
448
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/AmplifyBackend/Client.html#get_backend_api-instance_method
449
+ def get_backend_api: (
450
+ app_id: ::String,
451
+ backend_environment_name: ::String,
452
+ ?resource_config: {
453
+ additional_auth_types: Array[
454
+ {
455
+ mode: ("API_KEY" | "AWS_IAM" | "AMAZON_COGNITO_USER_POOLS" | "OPENID_CONNECT")?,
456
+ settings: {
457
+ cognito_user_pool_id: ::String?,
458
+ description: ::String?,
459
+ expiration_time: ::Float?,
460
+ open_id_auth_ttl: ::String?,
461
+ open_id_client_id: ::String?,
462
+ open_id_iat_ttl: ::String?,
463
+ open_id_issue_url: ::String?,
464
+ open_id_provider_name: ::String?
465
+ }?
466
+ },
467
+ ]?,
468
+ api_name: ::String?,
469
+ conflict_resolution: {
470
+ resolution_strategy: ("OPTIMISTIC_CONCURRENCY" | "LAMBDA" | "AUTOMERGE" | "NONE")?
471
+ }?,
472
+ default_auth_type: {
473
+ mode: ("API_KEY" | "AWS_IAM" | "AMAZON_COGNITO_USER_POOLS" | "OPENID_CONNECT")?,
474
+ settings: {
475
+ cognito_user_pool_id: ::String?,
476
+ description: ::String?,
477
+ expiration_time: ::Float?,
478
+ open_id_auth_ttl: ::String?,
479
+ open_id_client_id: ::String?,
480
+ open_id_iat_ttl: ::String?,
481
+ open_id_issue_url: ::String?,
482
+ open_id_provider_name: ::String?
483
+ }?
484
+ }?,
485
+ service: ::String?,
486
+ transform_schema: ::String?
487
+ },
488
+ resource_name: ::String
489
+ ) -> _GetBackendAPIResponseSuccess
490
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetBackendAPIResponseSuccess
491
+
492
+ interface _GetBackendAPIModelsResponseSuccess
493
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetBackendAPIModelsResponse]
494
+ def models: () -> ::String
495
+ def status: () -> ("LATEST" | "STALE")
496
+ def model_introspection_schema: () -> ::String
497
+ end
498
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/AmplifyBackend/Client.html#get_backend_api_models-instance_method
499
+ def get_backend_api_models: (
500
+ app_id: ::String,
501
+ backend_environment_name: ::String,
502
+ resource_name: ::String
503
+ ) -> _GetBackendAPIModelsResponseSuccess
504
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetBackendAPIModelsResponseSuccess
505
+
506
+ interface _GetBackendAuthResponseSuccess
507
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetBackendAuthResponse]
508
+ def app_id: () -> ::String
509
+ def backend_environment_name: () -> ::String
510
+ def resource_config: () -> Types::CreateBackendAuthResourceConfig
511
+ def resource_name: () -> ::String
512
+ end
513
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/AmplifyBackend/Client.html#get_backend_auth-instance_method
514
+ def get_backend_auth: (
515
+ app_id: ::String,
516
+ backend_environment_name: ::String,
517
+ resource_name: ::String
518
+ ) -> _GetBackendAuthResponseSuccess
519
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetBackendAuthResponseSuccess
520
+
521
+ interface _GetBackendJobResponseSuccess
522
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetBackendJobResponse]
523
+ def app_id: () -> ::String
524
+ def backend_environment_name: () -> ::String
525
+ def create_time: () -> ::String
526
+ def job_id: () -> ::String
527
+ def operation: () -> ::String
528
+ def status: () -> ::String
529
+ def update_time: () -> ::String
530
+ end
531
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/AmplifyBackend/Client.html#get_backend_job-instance_method
532
+ def get_backend_job: (
533
+ app_id: ::String,
534
+ backend_environment_name: ::String,
535
+ job_id: ::String
536
+ ) -> _GetBackendJobResponseSuccess
537
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetBackendJobResponseSuccess
538
+
539
+ interface _GetBackendStorageResponseSuccess
540
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetBackendStorageResponse]
541
+ def app_id: () -> ::String
542
+ def backend_environment_name: () -> ::String
543
+ def resource_config: () -> Types::GetBackendStorageResourceConfig
544
+ def resource_name: () -> ::String
545
+ end
546
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/AmplifyBackend/Client.html#get_backend_storage-instance_method
547
+ def get_backend_storage: (
548
+ app_id: ::String,
549
+ backend_environment_name: ::String,
550
+ resource_name: ::String
551
+ ) -> _GetBackendStorageResponseSuccess
552
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetBackendStorageResponseSuccess
553
+
554
+ interface _GetTokenResponseSuccess
555
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetTokenResponse]
556
+ def app_id: () -> ::String
557
+ def challenge_code: () -> ::String
558
+ def session_id: () -> ::String
559
+ def ttl: () -> ::String
560
+ end
561
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/AmplifyBackend/Client.html#get_token-instance_method
562
+ def get_token: (
563
+ app_id: ::String,
564
+ session_id: ::String
565
+ ) -> _GetTokenResponseSuccess
566
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetTokenResponseSuccess
567
+
568
+ interface _ImportBackendAuthResponseSuccess
569
+ include ::Seahorse::Client::_ResponseSuccess[Types::ImportBackendAuthResponse]
570
+ def app_id: () -> ::String
571
+ def backend_environment_name: () -> ::String
572
+ def job_id: () -> ::String
573
+ def operation: () -> ::String
574
+ def status: () -> ::String
575
+ end
576
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/AmplifyBackend/Client.html#import_backend_auth-instance_method
577
+ def import_backend_auth: (
578
+ app_id: ::String,
579
+ backend_environment_name: ::String,
580
+ ?identity_pool_id: ::String,
581
+ native_client_id: ::String,
582
+ user_pool_id: ::String,
583
+ web_client_id: ::String
584
+ ) -> _ImportBackendAuthResponseSuccess
585
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ImportBackendAuthResponseSuccess
586
+
587
+ interface _ImportBackendStorageResponseSuccess
588
+ include ::Seahorse::Client::_ResponseSuccess[Types::ImportBackendStorageResponse]
589
+ def app_id: () -> ::String
590
+ def backend_environment_name: () -> ::String
591
+ def job_id: () -> ::String
592
+ def status: () -> ::String
593
+ end
594
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/AmplifyBackend/Client.html#import_backend_storage-instance_method
595
+ def import_backend_storage: (
596
+ app_id: ::String,
597
+ backend_environment_name: ::String,
598
+ ?bucket_name: ::String,
599
+ service_name: ("S3")
600
+ ) -> _ImportBackendStorageResponseSuccess
601
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ImportBackendStorageResponseSuccess
602
+
603
+ interface _ListBackendJobsResponseSuccess
604
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListBackendJobsResponse]
605
+ def jobs: () -> ::Array[Types::BackendJobRespObj]
606
+ def next_token: () -> ::String
607
+ end
608
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/AmplifyBackend/Client.html#list_backend_jobs-instance_method
609
+ def list_backend_jobs: (
610
+ app_id: ::String,
611
+ backend_environment_name: ::String,
612
+ ?job_id: ::String,
613
+ ?max_results: ::Integer,
614
+ ?next_token: ::String,
615
+ ?operation: ::String,
616
+ ?status: ::String
617
+ ) -> _ListBackendJobsResponseSuccess
618
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListBackendJobsResponseSuccess
619
+
620
+ interface _ListS3BucketsResponseSuccess
621
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListS3BucketsResponse]
622
+ def buckets: () -> ::Array[Types::S3BucketInfo]
623
+ def next_token: () -> ::String
624
+ end
625
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/AmplifyBackend/Client.html#list_s3_buckets-instance_method
626
+ def list_s3_buckets: (
627
+ ?next_token: ::String
628
+ ) -> _ListS3BucketsResponseSuccess
629
+ | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListS3BucketsResponseSuccess
630
+
631
+ interface _RemoveAllBackendsResponseSuccess
632
+ include ::Seahorse::Client::_ResponseSuccess[Types::RemoveAllBackendsResponse]
633
+ def app_id: () -> ::String
634
+ def job_id: () -> ::String
635
+ def operation: () -> ::String
636
+ def status: () -> ::String
637
+ end
638
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/AmplifyBackend/Client.html#remove_all_backends-instance_method
639
+ def remove_all_backends: (
640
+ app_id: ::String,
641
+ ?clean_amplify_app: bool
642
+ ) -> _RemoveAllBackendsResponseSuccess
643
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _RemoveAllBackendsResponseSuccess
644
+
645
+ interface _RemoveBackendConfigResponseSuccess
646
+ include ::Seahorse::Client::_ResponseSuccess[Types::RemoveBackendConfigResponse]
647
+ end
648
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/AmplifyBackend/Client.html#remove_backend_config-instance_method
649
+ def remove_backend_config: (
650
+ app_id: ::String
651
+ ) -> _RemoveBackendConfigResponseSuccess
652
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _RemoveBackendConfigResponseSuccess
653
+
654
+ interface _UpdateBackendAPIResponseSuccess
655
+ include ::Seahorse::Client::_ResponseSuccess[Types::UpdateBackendAPIResponse]
656
+ def app_id: () -> ::String
657
+ def backend_environment_name: () -> ::String
658
+ def job_id: () -> ::String
659
+ def operation: () -> ::String
660
+ def status: () -> ::String
661
+ end
662
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/AmplifyBackend/Client.html#update_backend_api-instance_method
663
+ def update_backend_api: (
664
+ app_id: ::String,
665
+ backend_environment_name: ::String,
666
+ ?resource_config: {
667
+ additional_auth_types: Array[
668
+ {
669
+ mode: ("API_KEY" | "AWS_IAM" | "AMAZON_COGNITO_USER_POOLS" | "OPENID_CONNECT")?,
670
+ settings: {
671
+ cognito_user_pool_id: ::String?,
672
+ description: ::String?,
673
+ expiration_time: ::Float?,
674
+ open_id_auth_ttl: ::String?,
675
+ open_id_client_id: ::String?,
676
+ open_id_iat_ttl: ::String?,
677
+ open_id_issue_url: ::String?,
678
+ open_id_provider_name: ::String?
679
+ }?
680
+ },
681
+ ]?,
682
+ api_name: ::String?,
683
+ conflict_resolution: {
684
+ resolution_strategy: ("OPTIMISTIC_CONCURRENCY" | "LAMBDA" | "AUTOMERGE" | "NONE")?
685
+ }?,
686
+ default_auth_type: {
687
+ mode: ("API_KEY" | "AWS_IAM" | "AMAZON_COGNITO_USER_POOLS" | "OPENID_CONNECT")?,
688
+ settings: {
689
+ cognito_user_pool_id: ::String?,
690
+ description: ::String?,
691
+ expiration_time: ::Float?,
692
+ open_id_auth_ttl: ::String?,
693
+ open_id_client_id: ::String?,
694
+ open_id_iat_ttl: ::String?,
695
+ open_id_issue_url: ::String?,
696
+ open_id_provider_name: ::String?
697
+ }?
698
+ }?,
699
+ service: ::String?,
700
+ transform_schema: ::String?
701
+ },
702
+ resource_name: ::String
703
+ ) -> _UpdateBackendAPIResponseSuccess
704
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateBackendAPIResponseSuccess
705
+
706
+ interface _UpdateBackendAuthResponseSuccess
707
+ include ::Seahorse::Client::_ResponseSuccess[Types::UpdateBackendAuthResponse]
708
+ def app_id: () -> ::String
709
+ def backend_environment_name: () -> ::String
710
+ def job_id: () -> ::String
711
+ def operation: () -> ::String
712
+ def status: () -> ::String
713
+ end
714
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/AmplifyBackend/Client.html#update_backend_auth-instance_method
715
+ def update_backend_auth: (
716
+ app_id: ::String,
717
+ backend_environment_name: ::String,
718
+ resource_config: {
719
+ auth_resources: ("USER_POOL_ONLY" | "IDENTITY_POOL_AND_USER_POOL"),
720
+ identity_pool_configs: {
721
+ unauthenticated_login: bool?
722
+ }?,
723
+ service: ("COGNITO"),
724
+ user_pool_configs: {
725
+ forgot_password: {
726
+ delivery_method: ("EMAIL" | "SMS")?,
727
+ email_settings: {
728
+ email_message: ::String?,
729
+ email_subject: ::String?
730
+ }?,
731
+ sms_settings: {
732
+ sms_message: ::String?
733
+ }?
734
+ }?,
735
+ mfa: {
736
+ mfa_mode: ("ON" | "OFF" | "OPTIONAL")?,
737
+ settings: {
738
+ mfa_types: Array[("SMS" | "TOTP")]?,
739
+ sms_message: ::String?
740
+ }?
741
+ }?,
742
+ o_auth: {
743
+ domain_prefix: ::String?,
744
+ o_auth_grant_type: ("CODE" | "IMPLICIT")?,
745
+ o_auth_scopes: Array[("PHONE" | "EMAIL" | "OPENID" | "PROFILE" | "AWS_COGNITO_SIGNIN_USER_ADMIN")]?,
746
+ redirect_sign_in_ur_is: Array[::String]?,
747
+ redirect_sign_out_ur_is: Array[::String]?,
748
+ social_provider_settings: {
749
+ facebook: {
750
+ client_id: ::String?,
751
+ client_secret: ::String?
752
+ }?,
753
+ google: {
754
+ client_id: ::String?,
755
+ client_secret: ::String?
756
+ }?,
757
+ login_with_amazon: {
758
+ client_id: ::String?,
759
+ client_secret: ::String?
760
+ }?,
761
+ sign_in_with_apple: {
762
+ client_id: ::String?,
763
+ key_id: ::String?,
764
+ private_key: ::String?,
765
+ team_id: ::String?
766
+ }?
767
+ }?
768
+ }?,
769
+ password_policy: {
770
+ additional_constraints: Array[("REQUIRE_DIGIT" | "REQUIRE_LOWERCASE" | "REQUIRE_SYMBOL" | "REQUIRE_UPPERCASE")]?,
771
+ minimum_length: ::Float?
772
+ }?,
773
+ verification_message: {
774
+ delivery_method: ("EMAIL" | "SMS"),
775
+ email_settings: {
776
+ email_message: ::String?,
777
+ email_subject: ::String?
778
+ }?,
779
+ sms_settings: {
780
+ sms_message: ::String?
781
+ }?
782
+ }?
783
+ }
784
+ },
785
+ resource_name: ::String
786
+ ) -> _UpdateBackendAuthResponseSuccess
787
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateBackendAuthResponseSuccess
788
+
789
+ interface _UpdateBackendConfigResponseSuccess
790
+ include ::Seahorse::Client::_ResponseSuccess[Types::UpdateBackendConfigResponse]
791
+ def app_id: () -> ::String
792
+ def backend_manager_app_id: () -> ::String
793
+ def login_auth_config: () -> Types::LoginAuthConfigReqObj
794
+ end
795
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/AmplifyBackend/Client.html#update_backend_config-instance_method
796
+ def update_backend_config: (
797
+ app_id: ::String,
798
+ ?login_auth_config: {
799
+ aws_cognito_identity_pool_id: ::String?,
800
+ aws_cognito_region: ::String?,
801
+ aws_user_pools_id: ::String?,
802
+ aws_user_pools_web_client_id: ::String?
803
+ }
804
+ ) -> _UpdateBackendConfigResponseSuccess
805
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateBackendConfigResponseSuccess
806
+
807
+ interface _UpdateBackendJobResponseSuccess
808
+ include ::Seahorse::Client::_ResponseSuccess[Types::UpdateBackendJobResponse]
809
+ def app_id: () -> ::String
810
+ def backend_environment_name: () -> ::String
811
+ def create_time: () -> ::String
812
+ def job_id: () -> ::String
813
+ def operation: () -> ::String
814
+ def status: () -> ::String
815
+ def update_time: () -> ::String
816
+ end
817
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/AmplifyBackend/Client.html#update_backend_job-instance_method
818
+ def update_backend_job: (
819
+ app_id: ::String,
820
+ backend_environment_name: ::String,
821
+ job_id: ::String,
822
+ ?operation: ::String,
823
+ ?status: ::String
824
+ ) -> _UpdateBackendJobResponseSuccess
825
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateBackendJobResponseSuccess
826
+
827
+ interface _UpdateBackendStorageResponseSuccess
828
+ include ::Seahorse::Client::_ResponseSuccess[Types::UpdateBackendStorageResponse]
829
+ def app_id: () -> ::String
830
+ def backend_environment_name: () -> ::String
831
+ def job_id: () -> ::String
832
+ def status: () -> ::String
833
+ end
834
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/AmplifyBackend/Client.html#update_backend_storage-instance_method
835
+ def update_backend_storage: (
836
+ app_id: ::String,
837
+ backend_environment_name: ::String,
838
+ resource_config: {
839
+ permissions: {
840
+ authenticated: Array[("READ" | "CREATE_AND_UPDATE" | "DELETE")],
841
+ un_authenticated: Array[("READ" | "CREATE_AND_UPDATE" | "DELETE")]?
842
+ },
843
+ service_name: ("S3")
844
+ },
845
+ resource_name: ::String
846
+ ) -> _UpdateBackendStorageResponseSuccess
847
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateBackendStorageResponseSuccess
848
+ end
849
+ end
850
+ end
851
+