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,112 @@
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
+ module Aws::AmplifyBackend
11
+
12
+ # When AmplifyBackend returns an error response, the Ruby SDK constructs and raises an error.
13
+ # These errors all extend Aws::AmplifyBackend::Errors::ServiceError < {Aws::Errors::ServiceError}
14
+ #
15
+ # You can rescue all AmplifyBackend errors using ServiceError:
16
+ #
17
+ # begin
18
+ # # do stuff
19
+ # rescue Aws::AmplifyBackend::Errors::ServiceError
20
+ # # rescues all AmplifyBackend API errors
21
+ # end
22
+ #
23
+ #
24
+ # ## Request Context
25
+ # ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
26
+ # information about the request that generated the error.
27
+ # See {Seahorse::Client::RequestContext} for more information.
28
+ #
29
+ # ## Error Classes
30
+ # * {BadRequestException}
31
+ # * {GatewayTimeoutException}
32
+ # * {NotFoundException}
33
+ # * {TooManyRequestsException}
34
+ #
35
+ # Additionally, error classes are dynamically generated for service errors based on the error code
36
+ # if they are not defined above.
37
+ module Errors
38
+
39
+ extend Aws::Errors::DynamicErrors
40
+
41
+ class BadRequestException < ServiceError
42
+
43
+ # @param [Seahorse::Client::RequestContext] context
44
+ # @param [String] message
45
+ # @param [Aws::AmplifyBackend::Types::BadRequestException] data
46
+ def initialize(context, message, data = Aws::EmptyStructure.new)
47
+ super(context, message, data)
48
+ end
49
+
50
+ # @return [String]
51
+ def message
52
+ @message || @data[:message]
53
+ end
54
+ end
55
+
56
+ class GatewayTimeoutException < ServiceError
57
+
58
+ # @param [Seahorse::Client::RequestContext] context
59
+ # @param [String] message
60
+ # @param [Aws::AmplifyBackend::Types::GatewayTimeoutException] data
61
+ def initialize(context, message, data = Aws::EmptyStructure.new)
62
+ super(context, message, data)
63
+ end
64
+
65
+ # @return [String]
66
+ def message
67
+ @message || @data[:message]
68
+ end
69
+ end
70
+
71
+ class NotFoundException < ServiceError
72
+
73
+ # @param [Seahorse::Client::RequestContext] context
74
+ # @param [String] message
75
+ # @param [Aws::AmplifyBackend::Types::NotFoundException] data
76
+ def initialize(context, message, data = Aws::EmptyStructure.new)
77
+ super(context, message, data)
78
+ end
79
+
80
+ # @return [String]
81
+ def message
82
+ @message || @data[:message]
83
+ end
84
+
85
+ # @return [String]
86
+ def resource_type
87
+ @data[:resource_type]
88
+ end
89
+ end
90
+
91
+ class TooManyRequestsException < ServiceError
92
+
93
+ # @param [Seahorse::Client::RequestContext] context
94
+ # @param [String] message
95
+ # @param [Aws::AmplifyBackend::Types::TooManyRequestsException] data
96
+ def initialize(context, message, data = Aws::EmptyStructure.new)
97
+ super(context, message, data)
98
+ end
99
+
100
+ # @return [String]
101
+ def limit_type
102
+ @data[:limit_type]
103
+ end
104
+
105
+ # @return [String]
106
+ def message
107
+ @message || @data[:message]
108
+ end
109
+ end
110
+
111
+ end
112
+ end
@@ -0,0 +1,26 @@
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
+ module Aws::AmplifyBackend
11
+
12
+ class Resource
13
+
14
+ # @param options ({})
15
+ # @option options [Client] :client
16
+ def initialize(options = {})
17
+ @client = options[:client] || Client.new(options)
18
+ end
19
+
20
+ # @return [Client]
21
+ def client
22
+ @client
23
+ end
24
+
25
+ end
26
+ end
@@ -0,0 +1,3784 @@
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
+ module Aws::AmplifyBackend
11
+ module Types
12
+
13
+ # The authentication settings for accessing provisioned data models in
14
+ # your Amplify project.
15
+ #
16
+ # @note When making an API call, you may pass BackendAPIAppSyncAuthSettings
17
+ # data as a hash:
18
+ #
19
+ # {
20
+ # cognito_user_pool_id: "__string",
21
+ # description: "__string",
22
+ # expiration_time: 1.0,
23
+ # open_id_auth_ttl: "__string",
24
+ # open_id_client_id: "__string",
25
+ # open_id_iat_ttl: "__string",
26
+ # open_id_issue_url: "__string",
27
+ # open_id_provider_name: "__string",
28
+ # }
29
+ #
30
+ # @!attribute [rw] cognito_user_pool_id
31
+ # The Amazon Cognito user pool id, if Amazon Cognito was used as an
32
+ # authentication setting to access your data models.
33
+ # @return [String]
34
+ #
35
+ # @!attribute [rw] description
36
+ # The api key description for API\_KEY, if it was used as an
37
+ # authentication mechanism to access your data models.
38
+ # @return [String]
39
+ #
40
+ # @!attribute [rw] expiration_time
41
+ # The api key expiration time for API\_KEY, if it was used as an
42
+ # authentication mechanism to access your data models.
43
+ # @return [Float]
44
+ #
45
+ # @!attribute [rw] open_id_auth_ttl
46
+ # The expiry time for the OpenID authentication mechanism.
47
+ # @return [String]
48
+ #
49
+ # @!attribute [rw] open_id_client_id
50
+ # The clientID for openID, if openID was used as an authentication
51
+ # setting to access your data models.
52
+ # @return [String]
53
+ #
54
+ # @!attribute [rw] open_id_iat_ttl
55
+ # The expiry time for the OpenID authentication mechanism.
56
+ # @return [String]
57
+ #
58
+ # @!attribute [rw] open_id_issue_url
59
+ # The openID issuer URL, if openID was used as an authentication
60
+ # setting to access your data models.
61
+ # @return [String]
62
+ #
63
+ # @!attribute [rw] open_id_provider_name
64
+ # The open id provider name, if openID was used as an authentication
65
+ # mechanism to access your data models.
66
+ # @return [String]
67
+ #
68
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/BackendAPIAppSyncAuthSettings AWS API Documentation
69
+ #
70
+ class BackendAPIAppSyncAuthSettings < Struct.new(
71
+ :cognito_user_pool_id,
72
+ :description,
73
+ :expiration_time,
74
+ :open_id_auth_ttl,
75
+ :open_id_client_id,
76
+ :open_id_iat_ttl,
77
+ :open_id_issue_url,
78
+ :open_id_provider_name)
79
+ SENSITIVE = []
80
+ include Aws::Structure
81
+ end
82
+
83
+ # Describes the auth types for your configured data models.
84
+ #
85
+ # @note When making an API call, you may pass BackendAPIAuthType
86
+ # data as a hash:
87
+ #
88
+ # {
89
+ # mode: "API_KEY", # accepts API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT
90
+ # settings: {
91
+ # cognito_user_pool_id: "__string",
92
+ # description: "__string",
93
+ # expiration_time: 1.0,
94
+ # open_id_auth_ttl: "__string",
95
+ # open_id_client_id: "__string",
96
+ # open_id_iat_ttl: "__string",
97
+ # open_id_issue_url: "__string",
98
+ # open_id_provider_name: "__string",
99
+ # },
100
+ # }
101
+ #
102
+ # @!attribute [rw] mode
103
+ # Describes the authentication mode.
104
+ # @return [String]
105
+ #
106
+ # @!attribute [rw] settings
107
+ # Describes settings for the authentication mode.
108
+ # @return [Types::BackendAPIAppSyncAuthSettings]
109
+ #
110
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/BackendAPIAuthType AWS API Documentation
111
+ #
112
+ class BackendAPIAuthType < Struct.new(
113
+ :mode,
114
+ :settings)
115
+ SENSITIVE = []
116
+ include Aws::Structure
117
+ end
118
+
119
+ # The request object for this operation.
120
+ #
121
+ # @!attribute [rw] resource_name
122
+ # The name of this resource.
123
+ # @return [String]
124
+ #
125
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/BackendAPICodegenReqObj AWS API Documentation
126
+ #
127
+ class BackendAPICodegenReqObj < Struct.new(
128
+ :resource_name)
129
+ SENSITIVE = []
130
+ include Aws::Structure
131
+ end
132
+
133
+ # The response object sent when a backend is created.
134
+ #
135
+ # @!attribute [rw] app_id
136
+ # The app ID.
137
+ # @return [String]
138
+ #
139
+ # @!attribute [rw] backend_environment_name
140
+ # The name of the backend environment.
141
+ # @return [String]
142
+ #
143
+ # @!attribute [rw] error
144
+ # If the request failed, this is the returned error.
145
+ # @return [String]
146
+ #
147
+ # @!attribute [rw] job_id
148
+ # The ID for the job.
149
+ # @return [String]
150
+ #
151
+ # @!attribute [rw] operation
152
+ # The name of the operation.
153
+ # @return [String]
154
+ #
155
+ # @!attribute [rw] status
156
+ # The current status of the request.
157
+ # @return [String]
158
+ #
159
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/BackendAPICodegenRespObj AWS API Documentation
160
+ #
161
+ class BackendAPICodegenRespObj < Struct.new(
162
+ :app_id,
163
+ :backend_environment_name,
164
+ :error,
165
+ :job_id,
166
+ :operation,
167
+ :status)
168
+ SENSITIVE = []
169
+ include Aws::Structure
170
+ end
171
+
172
+ # Describes the conflict resolution configuration for your data model
173
+ # configured in your Amplify project.
174
+ #
175
+ # @note When making an API call, you may pass BackendAPIConflictResolution
176
+ # data as a hash:
177
+ #
178
+ # {
179
+ # resolution_strategy: "OPTIMISTIC_CONCURRENCY", # accepts OPTIMISTIC_CONCURRENCY, LAMBDA, AUTOMERGE, NONE
180
+ # }
181
+ #
182
+ # @!attribute [rw] resolution_strategy
183
+ # The strategy for conflict resolution.
184
+ # @return [String]
185
+ #
186
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/BackendAPIConflictResolution AWS API Documentation
187
+ #
188
+ class BackendAPIConflictResolution < Struct.new(
189
+ :resolution_strategy)
190
+ SENSITIVE = []
191
+ include Aws::Structure
192
+ end
193
+
194
+ # The request object for this operation.
195
+ #
196
+ # @!attribute [rw] resource_config
197
+ # Defines the resource configuration for the data model in your
198
+ # Amplify project.
199
+ # @return [Types::BackendAPIResourceConfig]
200
+ #
201
+ # @!attribute [rw] resource_name
202
+ # The name of this resource.
203
+ # @return [String]
204
+ #
205
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/BackendAPIReqObj AWS API Documentation
206
+ #
207
+ class BackendAPIReqObj < Struct.new(
208
+ :resource_config,
209
+ :resource_name)
210
+ SENSITIVE = []
211
+ include Aws::Structure
212
+ end
213
+
214
+ # The resource config for the data model,configured as a part of the
215
+ # Amplify project.
216
+ #
217
+ # @note When making an API call, you may pass BackendAPIResourceConfig
218
+ # data as a hash:
219
+ #
220
+ # {
221
+ # additional_auth_types: [
222
+ # {
223
+ # mode: "API_KEY", # accepts API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT
224
+ # settings: {
225
+ # cognito_user_pool_id: "__string",
226
+ # description: "__string",
227
+ # expiration_time: 1.0,
228
+ # open_id_auth_ttl: "__string",
229
+ # open_id_client_id: "__string",
230
+ # open_id_iat_ttl: "__string",
231
+ # open_id_issue_url: "__string",
232
+ # open_id_provider_name: "__string",
233
+ # },
234
+ # },
235
+ # ],
236
+ # api_name: "__string",
237
+ # conflict_resolution: {
238
+ # resolution_strategy: "OPTIMISTIC_CONCURRENCY", # accepts OPTIMISTIC_CONCURRENCY, LAMBDA, AUTOMERGE, NONE
239
+ # },
240
+ # default_auth_type: {
241
+ # mode: "API_KEY", # accepts API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT
242
+ # settings: {
243
+ # cognito_user_pool_id: "__string",
244
+ # description: "__string",
245
+ # expiration_time: 1.0,
246
+ # open_id_auth_ttl: "__string",
247
+ # open_id_client_id: "__string",
248
+ # open_id_iat_ttl: "__string",
249
+ # open_id_issue_url: "__string",
250
+ # open_id_provider_name: "__string",
251
+ # },
252
+ # },
253
+ # service: "__string",
254
+ # transform_schema: "__string",
255
+ # }
256
+ #
257
+ # @!attribute [rw] additional_auth_types
258
+ # Addition authentication methods used to interact with your data
259
+ # models.
260
+ # @return [Array<Types::BackendAPIAuthType>]
261
+ #
262
+ # @!attribute [rw] api_name
263
+ # The API name used to interact with the data model, configured as a
264
+ # part of the amplify project.
265
+ # @return [String]
266
+ #
267
+ # @!attribute [rw] conflict_resolution
268
+ # The conflict resoultion strategy for your data stored in the data
269
+ # models.
270
+ # @return [Types::BackendAPIConflictResolution]
271
+ #
272
+ # @!attribute [rw] default_auth_type
273
+ # The default authentication type for interacting with the configured
274
+ # data models in your amplify project.
275
+ # @return [Types::BackendAPIAuthType]
276
+ #
277
+ # @!attribute [rw] service
278
+ # The service used to provision and interact with the data model.
279
+ # @return [String]
280
+ #
281
+ # @!attribute [rw] transform_schema
282
+ # The definition of the data model in the annotated transform of the
283
+ # graphql schema.
284
+ # @return [String]
285
+ #
286
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/BackendAPIResourceConfig AWS API Documentation
287
+ #
288
+ class BackendAPIResourceConfig < Struct.new(
289
+ :additional_auth_types,
290
+ :api_name,
291
+ :conflict_resolution,
292
+ :default_auth_type,
293
+ :service,
294
+ :transform_schema)
295
+ SENSITIVE = []
296
+ include Aws::Structure
297
+ end
298
+
299
+ # The response object sent when a backend is created.
300
+ #
301
+ # @!attribute [rw] app_id
302
+ # The app ID.
303
+ # @return [String]
304
+ #
305
+ # @!attribute [rw] backend_environment_name
306
+ # The name of the backend environment.
307
+ # @return [String]
308
+ #
309
+ # @!attribute [rw] error
310
+ # If the request failed, this is the returned error.
311
+ # @return [String]
312
+ #
313
+ # @!attribute [rw] job_id
314
+ # The ID for the job.
315
+ # @return [String]
316
+ #
317
+ # @!attribute [rw] operation
318
+ # The name of the operation.
319
+ # @return [String]
320
+ #
321
+ # @!attribute [rw] status
322
+ # The current status of the request.
323
+ # @return [String]
324
+ #
325
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/BackendAPIRespObj AWS API Documentation
326
+ #
327
+ class BackendAPIRespObj < Struct.new(
328
+ :app_id,
329
+ :backend_environment_name,
330
+ :error,
331
+ :job_id,
332
+ :operation,
333
+ :status)
334
+ SENSITIVE = []
335
+ include Aws::Structure
336
+ end
337
+
338
+ # The response object for this operation.
339
+ #
340
+ # @!attribute [rw] app_id
341
+ # The app ID.
342
+ # @return [String]
343
+ #
344
+ # @!attribute [rw] backend_environment_name
345
+ # The name of the backend environment.
346
+ # @return [String]
347
+ #
348
+ # @!attribute [rw] error
349
+ # If the request failed, this is the returned error.
350
+ # @return [String]
351
+ #
352
+ # @!attribute [rw] job_id
353
+ # The ID for the job.
354
+ # @return [String]
355
+ #
356
+ # @!attribute [rw] operation
357
+ # The name of the operation.
358
+ # @return [String]
359
+ #
360
+ # @!attribute [rw] status
361
+ # The current status of the request.
362
+ # @return [String]
363
+ #
364
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/BackendAuthRespObj AWS API Documentation
365
+ #
366
+ class BackendAuthRespObj < Struct.new(
367
+ :app_id,
368
+ :backend_environment_name,
369
+ :error,
370
+ :job_id,
371
+ :operation,
372
+ :status)
373
+ SENSITIVE = []
374
+ include Aws::Structure
375
+ end
376
+
377
+ # Describes third party social federation configurations for allowing
378
+ # your app users to sign in using OAuth.
379
+ #
380
+ # @note When making an API call, you may pass BackendAuthSocialProviderConfig
381
+ # data as a hash:
382
+ #
383
+ # {
384
+ # client_id: "__string",
385
+ # client_secret: "__string",
386
+ # }
387
+ #
388
+ # @!attribute [rw] client_id
389
+ # Describes the client\_id which can be obtained from the third party
390
+ # social federation provider.
391
+ # @return [String]
392
+ #
393
+ # @!attribute [rw] client_secret
394
+ # Describes the client\_secret which can be obtained from third party
395
+ # social federation providers.
396
+ # @return [String]
397
+ #
398
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/BackendAuthSocialProviderConfig AWS API Documentation
399
+ #
400
+ class BackendAuthSocialProviderConfig < Struct.new(
401
+ :client_id,
402
+ :client_secret)
403
+ SENSITIVE = []
404
+ include Aws::Structure
405
+ end
406
+
407
+ # The response object for this operation.
408
+ #
409
+ # @!attribute [rw] app_id
410
+ # The app ID.
411
+ # @return [String]
412
+ #
413
+ # @!attribute [rw] backend_manager_app_id
414
+ # The app ID for the backend manager.
415
+ # @return [String]
416
+ #
417
+ # @!attribute [rw] error
418
+ # If the request failed, this is the returned error.
419
+ # @return [String]
420
+ #
421
+ # @!attribute [rw] login_auth_config
422
+ # Describes the Amazon Cognito configurations for the Admin UI auth
423
+ # resource to login with.
424
+ # @return [Types::LoginAuthConfigReqObj]
425
+ #
426
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/BackendConfigRespObj AWS API Documentation
427
+ #
428
+ class BackendConfigRespObj < Struct.new(
429
+ :app_id,
430
+ :backend_manager_app_id,
431
+ :error,
432
+ :login_auth_config)
433
+ SENSITIVE = []
434
+ include Aws::Structure
435
+ end
436
+
437
+ # The request object for this operation.
438
+ #
439
+ # @!attribute [rw] operation
440
+ # Filters the list of response objects to only include those with the
441
+ # specified operation name.
442
+ # @return [String]
443
+ #
444
+ # @!attribute [rw] status
445
+ # Filters the list of response objects to only include those with the
446
+ # specified status.
447
+ # @return [String]
448
+ #
449
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/BackendJobReqObj AWS API Documentation
450
+ #
451
+ class BackendJobReqObj < Struct.new(
452
+ :operation,
453
+ :status)
454
+ SENSITIVE = []
455
+ include Aws::Structure
456
+ end
457
+
458
+ # The response object for this operation.
459
+ #
460
+ # @!attribute [rw] app_id
461
+ # The app ID.
462
+ # @return [String]
463
+ #
464
+ # @!attribute [rw] backend_environment_name
465
+ # The name of the backend environment.
466
+ # @return [String]
467
+ #
468
+ # @!attribute [rw] create_time
469
+ # The time when the job was created.
470
+ # @return [String]
471
+ #
472
+ # @!attribute [rw] error
473
+ # If the request failed, this is the returned error.
474
+ # @return [String]
475
+ #
476
+ # @!attribute [rw] job_id
477
+ # The ID for the job.
478
+ # @return [String]
479
+ #
480
+ # @!attribute [rw] operation
481
+ # The name of the operation.
482
+ # @return [String]
483
+ #
484
+ # @!attribute [rw] status
485
+ # The current status of the request.
486
+ # @return [String]
487
+ #
488
+ # @!attribute [rw] update_time
489
+ # The time when the job was last updated.
490
+ # @return [String]
491
+ #
492
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/BackendJobRespObj AWS API Documentation
493
+ #
494
+ class BackendJobRespObj < Struct.new(
495
+ :app_id,
496
+ :backend_environment_name,
497
+ :create_time,
498
+ :error,
499
+ :job_id,
500
+ :operation,
501
+ :status,
502
+ :update_time)
503
+ SENSITIVE = []
504
+ include Aws::Structure
505
+ end
506
+
507
+ # An error returned if a request is not formed properly.
508
+ #
509
+ # @!attribute [rw] message
510
+ # An error message to inform that the request has failed.
511
+ # @return [String]
512
+ #
513
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/BadRequestException AWS API Documentation
514
+ #
515
+ class BadRequestException < Struct.new(
516
+ :message)
517
+ SENSITIVE = []
518
+ include Aws::Structure
519
+ end
520
+
521
+ # The request object for this operation.
522
+ #
523
+ # @!attribute [rw] target_environment_name
524
+ # The name of the destination backend environment to be created.
525
+ # @return [String]
526
+ #
527
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/CloneBackendReqObj AWS API Documentation
528
+ #
529
+ class CloneBackendReqObj < Struct.new(
530
+ :target_environment_name)
531
+ SENSITIVE = []
532
+ include Aws::Structure
533
+ end
534
+
535
+ # @note When making an API call, you may pass CloneBackendRequest
536
+ # data as a hash:
537
+ #
538
+ # {
539
+ # app_id: "__string", # required
540
+ # backend_environment_name: "__string", # required
541
+ # target_environment_name: "__string", # required
542
+ # }
543
+ #
544
+ # @!attribute [rw] app_id
545
+ # @return [String]
546
+ #
547
+ # @!attribute [rw] backend_environment_name
548
+ # @return [String]
549
+ #
550
+ # @!attribute [rw] target_environment_name
551
+ # @return [String]
552
+ #
553
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/CloneBackendRequest AWS API Documentation
554
+ #
555
+ class CloneBackendRequest < Struct.new(
556
+ :app_id,
557
+ :backend_environment_name,
558
+ :target_environment_name)
559
+ SENSITIVE = []
560
+ include Aws::Structure
561
+ end
562
+
563
+ # The response object sent when a backend is created.
564
+ #
565
+ # @!attribute [rw] app_id
566
+ # The app ID.
567
+ # @return [String]
568
+ #
569
+ # @!attribute [rw] backend_environment_name
570
+ # The name of the backend environment.
571
+ # @return [String]
572
+ #
573
+ # @!attribute [rw] error
574
+ # If the request failed, this is the returned error.
575
+ # @return [String]
576
+ #
577
+ # @!attribute [rw] job_id
578
+ # The ID for the job.
579
+ # @return [String]
580
+ #
581
+ # @!attribute [rw] operation
582
+ # The name of the operation.
583
+ # @return [String]
584
+ #
585
+ # @!attribute [rw] status
586
+ # The current status of the request.
587
+ # @return [String]
588
+ #
589
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/CloneBackendRespObj AWS API Documentation
590
+ #
591
+ class CloneBackendRespObj < Struct.new(
592
+ :app_id,
593
+ :backend_environment_name,
594
+ :error,
595
+ :job_id,
596
+ :operation,
597
+ :status)
598
+ SENSITIVE = []
599
+ include Aws::Structure
600
+ end
601
+
602
+ # @!attribute [rw] app_id
603
+ # @return [String]
604
+ #
605
+ # @!attribute [rw] backend_environment_name
606
+ # @return [String]
607
+ #
608
+ # @!attribute [rw] error
609
+ # @return [String]
610
+ #
611
+ # @!attribute [rw] job_id
612
+ # @return [String]
613
+ #
614
+ # @!attribute [rw] operation
615
+ # @return [String]
616
+ #
617
+ # @!attribute [rw] status
618
+ # @return [String]
619
+ #
620
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/CloneBackendResponse AWS API Documentation
621
+ #
622
+ class CloneBackendResponse < Struct.new(
623
+ :app_id,
624
+ :backend_environment_name,
625
+ :error,
626
+ :job_id,
627
+ :operation,
628
+ :status)
629
+ SENSITIVE = []
630
+ include Aws::Structure
631
+ end
632
+
633
+ # The request object for this operation.
634
+ #
635
+ # @!attribute [rw] backend_environment_name
636
+ # The name of the backend environment.
637
+ # @return [String]
638
+ #
639
+ # @!attribute [rw] resource_config
640
+ # The resource configuration for this request.
641
+ # @return [Types::BackendAPIResourceConfig]
642
+ #
643
+ # @!attribute [rw] resource_name
644
+ # The name of this resource.
645
+ # @return [String]
646
+ #
647
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/CreateBackendAPIReqObj AWS API Documentation
648
+ #
649
+ class CreateBackendAPIReqObj < Struct.new(
650
+ :backend_environment_name,
651
+ :resource_config,
652
+ :resource_name)
653
+ SENSITIVE = []
654
+ include Aws::Structure
655
+ end
656
+
657
+ # @note When making an API call, you may pass CreateBackendAPIRequest
658
+ # data as a hash:
659
+ #
660
+ # {
661
+ # app_id: "__string", # required
662
+ # backend_environment_name: "__string", # required
663
+ # resource_config: { # required
664
+ # additional_auth_types: [
665
+ # {
666
+ # mode: "API_KEY", # accepts API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT
667
+ # settings: {
668
+ # cognito_user_pool_id: "__string",
669
+ # description: "__string",
670
+ # expiration_time: 1.0,
671
+ # open_id_auth_ttl: "__string",
672
+ # open_id_client_id: "__string",
673
+ # open_id_iat_ttl: "__string",
674
+ # open_id_issue_url: "__string",
675
+ # open_id_provider_name: "__string",
676
+ # },
677
+ # },
678
+ # ],
679
+ # api_name: "__string",
680
+ # conflict_resolution: {
681
+ # resolution_strategy: "OPTIMISTIC_CONCURRENCY", # accepts OPTIMISTIC_CONCURRENCY, LAMBDA, AUTOMERGE, NONE
682
+ # },
683
+ # default_auth_type: {
684
+ # mode: "API_KEY", # accepts API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT
685
+ # settings: {
686
+ # cognito_user_pool_id: "__string",
687
+ # description: "__string",
688
+ # expiration_time: 1.0,
689
+ # open_id_auth_ttl: "__string",
690
+ # open_id_client_id: "__string",
691
+ # open_id_iat_ttl: "__string",
692
+ # open_id_issue_url: "__string",
693
+ # open_id_provider_name: "__string",
694
+ # },
695
+ # },
696
+ # service: "__string",
697
+ # transform_schema: "__string",
698
+ # },
699
+ # resource_name: "__string", # required
700
+ # }
701
+ #
702
+ # @!attribute [rw] app_id
703
+ # @return [String]
704
+ #
705
+ # @!attribute [rw] backend_environment_name
706
+ # @return [String]
707
+ #
708
+ # @!attribute [rw] resource_config
709
+ # The resource config for the data model,configured as a part of the
710
+ # Amplify project.
711
+ # @return [Types::BackendAPIResourceConfig]
712
+ #
713
+ # @!attribute [rw] resource_name
714
+ # @return [String]
715
+ #
716
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/CreateBackendAPIRequest AWS API Documentation
717
+ #
718
+ class CreateBackendAPIRequest < Struct.new(
719
+ :app_id,
720
+ :backend_environment_name,
721
+ :resource_config,
722
+ :resource_name)
723
+ SENSITIVE = []
724
+ include Aws::Structure
725
+ end
726
+
727
+ # @!attribute [rw] app_id
728
+ # @return [String]
729
+ #
730
+ # @!attribute [rw] backend_environment_name
731
+ # @return [String]
732
+ #
733
+ # @!attribute [rw] error
734
+ # @return [String]
735
+ #
736
+ # @!attribute [rw] job_id
737
+ # @return [String]
738
+ #
739
+ # @!attribute [rw] operation
740
+ # @return [String]
741
+ #
742
+ # @!attribute [rw] status
743
+ # @return [String]
744
+ #
745
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/CreateBackendAPIResponse AWS API Documentation
746
+ #
747
+ class CreateBackendAPIResponse < Struct.new(
748
+ :app_id,
749
+ :backend_environment_name,
750
+ :error,
751
+ :job_id,
752
+ :operation,
753
+ :status)
754
+ SENSITIVE = []
755
+ include Aws::Structure
756
+ end
757
+
758
+ # Describes the forgot password policy for authenticating into the
759
+ # Amlify app.
760
+ #
761
+ # @note When making an API call, you may pass CreateBackendAuthForgotPasswordConfig
762
+ # data as a hash:
763
+ #
764
+ # {
765
+ # delivery_method: "EMAIL", # required, accepts EMAIL, SMS
766
+ # email_settings: {
767
+ # email_message: "__string",
768
+ # email_subject: "__string",
769
+ # },
770
+ # sms_settings: {
771
+ # sms_message: "__string",
772
+ # },
773
+ # }
774
+ #
775
+ # @!attribute [rw] delivery_method
776
+ # Describes which mode to use (either SMS or email) to deliver
777
+ # messages to app users that want to recover their password.
778
+ # @return [String]
779
+ #
780
+ # @!attribute [rw] email_settings
781
+ # The configuration for the email sent when an app user forgets their
782
+ # password.
783
+ # @return [Types::EmailSettings]
784
+ #
785
+ # @!attribute [rw] sms_settings
786
+ # The configuration for the SMS message sent when an app user forgets
787
+ # their password.
788
+ # @return [Types::SmsSettings]
789
+ #
790
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/CreateBackendAuthForgotPasswordConfig AWS API Documentation
791
+ #
792
+ class CreateBackendAuthForgotPasswordConfig < Struct.new(
793
+ :delivery_method,
794
+ :email_settings,
795
+ :sms_settings)
796
+ SENSITIVE = []
797
+ include Aws::Structure
798
+ end
799
+
800
+ # Describes authorization configurations for the auth resources,
801
+ # configures as a part of your Amplify project.
802
+ #
803
+ # @note When making an API call, you may pass CreateBackendAuthIdentityPoolConfig
804
+ # data as a hash:
805
+ #
806
+ # {
807
+ # identity_pool_name: "__string", # required
808
+ # unauthenticated_login: false, # required
809
+ # }
810
+ #
811
+ # @!attribute [rw] identity_pool_name
812
+ # Name of the identity pool used for authorization.
813
+ # @return [String]
814
+ #
815
+ # @!attribute [rw] unauthenticated_login
816
+ # Set to true or false based on whether you want to enable guest
817
+ # authorization to your Amplify app.
818
+ # @return [Boolean]
819
+ #
820
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/CreateBackendAuthIdentityPoolConfig AWS API Documentation
821
+ #
822
+ class CreateBackendAuthIdentityPoolConfig < Struct.new(
823
+ :identity_pool_name,
824
+ :unauthenticated_login)
825
+ SENSITIVE = []
826
+ include Aws::Structure
827
+ end
828
+
829
+ # Describes whether multi-factor authentication policies should be
830
+ # applied for your Amazon Cognito user pool configured as a part of your
831
+ # Amplify project.
832
+ #
833
+ # @note When making an API call, you may pass CreateBackendAuthMFAConfig
834
+ # data as a hash:
835
+ #
836
+ # {
837
+ # mfa_mode: "ON", # required, accepts ON, OFF, OPTIONAL
838
+ # settings: {
839
+ # mfa_types: ["SMS"], # accepts SMS, TOTP
840
+ # sms_message: "__string",
841
+ # },
842
+ # }
843
+ #
844
+ # @!attribute [rw] mfa_mode
845
+ # Describes whether MFA should be \[ON, OFF, OPTIONAL\] for
846
+ # authentication in your Amplify project.
847
+ # @return [String]
848
+ #
849
+ # @!attribute [rw] settings
850
+ # Describes the configuration settings and methods for your Amplify
851
+ # app users to use MFA.
852
+ # @return [Types::Settings]
853
+ #
854
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/CreateBackendAuthMFAConfig AWS API Documentation
855
+ #
856
+ class CreateBackendAuthMFAConfig < Struct.new(
857
+ :mfa_mode,
858
+ :settings)
859
+ SENSITIVE = []
860
+ include Aws::Structure
861
+ end
862
+
863
+ # Creates the OAuth configuration for your Amplify project.
864
+ #
865
+ # @note When making an API call, you may pass CreateBackendAuthOAuthConfig
866
+ # data as a hash:
867
+ #
868
+ # {
869
+ # domain_prefix: "__string",
870
+ # o_auth_grant_type: "CODE", # required, accepts CODE, IMPLICIT
871
+ # o_auth_scopes: ["PHONE"], # required, accepts PHONE, EMAIL, OPENID, PROFILE, AWS_COGNITO_SIGNIN_USER_ADMIN
872
+ # redirect_sign_in_ur_is: ["__string"], # required
873
+ # redirect_sign_out_ur_is: ["__string"], # required
874
+ # social_provider_settings: {
875
+ # facebook: {
876
+ # client_id: "__string",
877
+ # client_secret: "__string",
878
+ # },
879
+ # google: {
880
+ # client_id: "__string",
881
+ # client_secret: "__string",
882
+ # },
883
+ # login_with_amazon: {
884
+ # client_id: "__string",
885
+ # client_secret: "__string",
886
+ # },
887
+ # },
888
+ # }
889
+ #
890
+ # @!attribute [rw] domain_prefix
891
+ # The domain prefix for your Amplify app.
892
+ # @return [String]
893
+ #
894
+ # @!attribute [rw] o_auth_grant_type
895
+ # The OAuth grant type which you use to allow app users to
896
+ # authenticate from your Amplify app.
897
+ # @return [String]
898
+ #
899
+ # @!attribute [rw] o_auth_scopes
900
+ # List of OAuth related flows which use to allow your app users to
901
+ # authenticate from your Amplify app.
902
+ # @return [Array<String>]
903
+ #
904
+ # @!attribute [rw] redirect_sign_in_ur_is
905
+ # The redirected URI for sigining into your Amplify app.
906
+ # @return [Array<String>]
907
+ #
908
+ # @!attribute [rw] redirect_sign_out_ur_is
909
+ # Redirect URLs used by OAuth when a user signs out of an Amplify app.
910
+ # @return [Array<String>]
911
+ #
912
+ # @!attribute [rw] social_provider_settings
913
+ # The settings for using the social providers for access to your
914
+ # Amplify app.
915
+ # @return [Types::SocialProviderSettings]
916
+ #
917
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/CreateBackendAuthOAuthConfig AWS API Documentation
918
+ #
919
+ class CreateBackendAuthOAuthConfig < Struct.new(
920
+ :domain_prefix,
921
+ :o_auth_grant_type,
922
+ :o_auth_scopes,
923
+ :redirect_sign_in_ur_is,
924
+ :redirect_sign_out_ur_is,
925
+ :social_provider_settings)
926
+ SENSITIVE = []
927
+ include Aws::Structure
928
+ end
929
+
930
+ # The password policy configuration for the backend to your Amplify
931
+ # project.
932
+ #
933
+ # @note When making an API call, you may pass CreateBackendAuthPasswordPolicyConfig
934
+ # data as a hash:
935
+ #
936
+ # {
937
+ # additional_constraints: ["REQUIRE_DIGIT"], # accepts REQUIRE_DIGIT, REQUIRE_LOWERCASE, REQUIRE_SYMBOL, REQUIRE_UPPERCASE
938
+ # minimum_length: 1.0, # required
939
+ # }
940
+ #
941
+ # @!attribute [rw] additional_constraints
942
+ # Additional constraints for the pasword used to access the backend of
943
+ # your Amplify project.
944
+ # @return [Array<String>]
945
+ #
946
+ # @!attribute [rw] minimum_length
947
+ # The minimum length of password used to access the backend of your
948
+ # Amplify project.
949
+ # @return [Float]
950
+ #
951
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/CreateBackendAuthPasswordPolicyConfig AWS API Documentation
952
+ #
953
+ class CreateBackendAuthPasswordPolicyConfig < Struct.new(
954
+ :additional_constraints,
955
+ :minimum_length)
956
+ SENSITIVE = []
957
+ include Aws::Structure
958
+ end
959
+
960
+ # The request object for this operation.
961
+ #
962
+ # @!attribute [rw] backend_environment_name
963
+ # The name of the backend environment.
964
+ # @return [String]
965
+ #
966
+ # @!attribute [rw] resource_config
967
+ # The resource configuration for this request object.
968
+ # @return [Types::CreateBackendAuthResourceConfig]
969
+ #
970
+ # @!attribute [rw] resource_name
971
+ # The name of this resource.
972
+ # @return [String]
973
+ #
974
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/CreateBackendAuthReqObj AWS API Documentation
975
+ #
976
+ class CreateBackendAuthReqObj < Struct.new(
977
+ :backend_environment_name,
978
+ :resource_config,
979
+ :resource_name)
980
+ SENSITIVE = []
981
+ include Aws::Structure
982
+ end
983
+
984
+ # @note When making an API call, you may pass CreateBackendAuthRequest
985
+ # data as a hash:
986
+ #
987
+ # {
988
+ # app_id: "__string", # required
989
+ # backend_environment_name: "__string", # required
990
+ # resource_config: { # required
991
+ # auth_resources: "USER_POOL_ONLY", # required, accepts USER_POOL_ONLY, IDENTITY_POOL_AND_USER_POOL
992
+ # identity_pool_configs: {
993
+ # identity_pool_name: "__string", # required
994
+ # unauthenticated_login: false, # required
995
+ # },
996
+ # service: "COGNITO", # required, accepts COGNITO
997
+ # user_pool_configs: { # required
998
+ # forgot_password: {
999
+ # delivery_method: "EMAIL", # required, accepts EMAIL, SMS
1000
+ # email_settings: {
1001
+ # email_message: "__string",
1002
+ # email_subject: "__string",
1003
+ # },
1004
+ # sms_settings: {
1005
+ # sms_message: "__string",
1006
+ # },
1007
+ # },
1008
+ # mfa: {
1009
+ # mfa_mode: "ON", # required, accepts ON, OFF, OPTIONAL
1010
+ # settings: {
1011
+ # mfa_types: ["SMS"], # accepts SMS, TOTP
1012
+ # sms_message: "__string",
1013
+ # },
1014
+ # },
1015
+ # o_auth: {
1016
+ # domain_prefix: "__string",
1017
+ # o_auth_grant_type: "CODE", # required, accepts CODE, IMPLICIT
1018
+ # o_auth_scopes: ["PHONE"], # required, accepts PHONE, EMAIL, OPENID, PROFILE, AWS_COGNITO_SIGNIN_USER_ADMIN
1019
+ # redirect_sign_in_ur_is: ["__string"], # required
1020
+ # redirect_sign_out_ur_is: ["__string"], # required
1021
+ # social_provider_settings: {
1022
+ # facebook: {
1023
+ # client_id: "__string",
1024
+ # client_secret: "__string",
1025
+ # },
1026
+ # google: {
1027
+ # client_id: "__string",
1028
+ # client_secret: "__string",
1029
+ # },
1030
+ # login_with_amazon: {
1031
+ # client_id: "__string",
1032
+ # client_secret: "__string",
1033
+ # },
1034
+ # },
1035
+ # },
1036
+ # password_policy: {
1037
+ # additional_constraints: ["REQUIRE_DIGIT"], # accepts REQUIRE_DIGIT, REQUIRE_LOWERCASE, REQUIRE_SYMBOL, REQUIRE_UPPERCASE
1038
+ # minimum_length: 1.0, # required
1039
+ # },
1040
+ # 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
1041
+ # sign_in_method: "EMAIL", # required, accepts EMAIL, EMAIL_AND_PHONE_NUMBER, PHONE_NUMBER, USERNAME
1042
+ # user_pool_name: "__string", # required
1043
+ # },
1044
+ # },
1045
+ # resource_name: "__string", # required
1046
+ # }
1047
+ #
1048
+ # @!attribute [rw] app_id
1049
+ # @return [String]
1050
+ #
1051
+ # @!attribute [rw] backend_environment_name
1052
+ # @return [String]
1053
+ #
1054
+ # @!attribute [rw] resource_config
1055
+ # Defines the resource configuration when creating an auth resource in
1056
+ # your Amplify project.
1057
+ # @return [Types::CreateBackendAuthResourceConfig]
1058
+ #
1059
+ # @!attribute [rw] resource_name
1060
+ # @return [String]
1061
+ #
1062
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/CreateBackendAuthRequest AWS API Documentation
1063
+ #
1064
+ class CreateBackendAuthRequest < Struct.new(
1065
+ :app_id,
1066
+ :backend_environment_name,
1067
+ :resource_config,
1068
+ :resource_name)
1069
+ SENSITIVE = []
1070
+ include Aws::Structure
1071
+ end
1072
+
1073
+ # Defines the resource configuration when creating an auth resource in
1074
+ # your Amplify project.
1075
+ #
1076
+ # @note When making an API call, you may pass CreateBackendAuthResourceConfig
1077
+ # data as a hash:
1078
+ #
1079
+ # {
1080
+ # auth_resources: "USER_POOL_ONLY", # required, accepts USER_POOL_ONLY, IDENTITY_POOL_AND_USER_POOL
1081
+ # identity_pool_configs: {
1082
+ # identity_pool_name: "__string", # required
1083
+ # unauthenticated_login: false, # required
1084
+ # },
1085
+ # service: "COGNITO", # required, accepts COGNITO
1086
+ # user_pool_configs: { # required
1087
+ # forgot_password: {
1088
+ # delivery_method: "EMAIL", # required, accepts EMAIL, SMS
1089
+ # email_settings: {
1090
+ # email_message: "__string",
1091
+ # email_subject: "__string",
1092
+ # },
1093
+ # sms_settings: {
1094
+ # sms_message: "__string",
1095
+ # },
1096
+ # },
1097
+ # mfa: {
1098
+ # mfa_mode: "ON", # required, accepts ON, OFF, OPTIONAL
1099
+ # settings: {
1100
+ # mfa_types: ["SMS"], # accepts SMS, TOTP
1101
+ # sms_message: "__string",
1102
+ # },
1103
+ # },
1104
+ # o_auth: {
1105
+ # domain_prefix: "__string",
1106
+ # o_auth_grant_type: "CODE", # required, accepts CODE, IMPLICIT
1107
+ # o_auth_scopes: ["PHONE"], # required, accepts PHONE, EMAIL, OPENID, PROFILE, AWS_COGNITO_SIGNIN_USER_ADMIN
1108
+ # redirect_sign_in_ur_is: ["__string"], # required
1109
+ # redirect_sign_out_ur_is: ["__string"], # required
1110
+ # social_provider_settings: {
1111
+ # facebook: {
1112
+ # client_id: "__string",
1113
+ # client_secret: "__string",
1114
+ # },
1115
+ # google: {
1116
+ # client_id: "__string",
1117
+ # client_secret: "__string",
1118
+ # },
1119
+ # login_with_amazon: {
1120
+ # client_id: "__string",
1121
+ # client_secret: "__string",
1122
+ # },
1123
+ # },
1124
+ # },
1125
+ # password_policy: {
1126
+ # additional_constraints: ["REQUIRE_DIGIT"], # accepts REQUIRE_DIGIT, REQUIRE_LOWERCASE, REQUIRE_SYMBOL, REQUIRE_UPPERCASE
1127
+ # minimum_length: 1.0, # required
1128
+ # },
1129
+ # 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
1130
+ # sign_in_method: "EMAIL", # required, accepts EMAIL, EMAIL_AND_PHONE_NUMBER, PHONE_NUMBER, USERNAME
1131
+ # user_pool_name: "__string", # required
1132
+ # },
1133
+ # }
1134
+ #
1135
+ # @!attribute [rw] auth_resources
1136
+ # Defines whether you want to configure only authentication or both
1137
+ # authentication and authorization settings.
1138
+ # @return [String]
1139
+ #
1140
+ # @!attribute [rw] identity_pool_configs
1141
+ # Describes the authorization configuration for the Amazon Cognito
1142
+ # identity pool, provisioned as a part of your auth resource in the
1143
+ # Amplify project.
1144
+ # @return [Types::CreateBackendAuthIdentityPoolConfig]
1145
+ #
1146
+ # @!attribute [rw] service
1147
+ # Defines the service name to use when configuring an authentication
1148
+ # resource in your Amplify project.
1149
+ # @return [String]
1150
+ #
1151
+ # @!attribute [rw] user_pool_configs
1152
+ # Describes authentication configuration for the Amazon Cognito user
1153
+ # pool, provisioned as a part of your auth resource in the Amplify
1154
+ # project.
1155
+ # @return [Types::CreateBackendAuthUserPoolConfig]
1156
+ #
1157
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/CreateBackendAuthResourceConfig AWS API Documentation
1158
+ #
1159
+ class CreateBackendAuthResourceConfig < Struct.new(
1160
+ :auth_resources,
1161
+ :identity_pool_configs,
1162
+ :service,
1163
+ :user_pool_configs)
1164
+ SENSITIVE = []
1165
+ include Aws::Structure
1166
+ end
1167
+
1168
+ # @!attribute [rw] app_id
1169
+ # @return [String]
1170
+ #
1171
+ # @!attribute [rw] backend_environment_name
1172
+ # @return [String]
1173
+ #
1174
+ # @!attribute [rw] error
1175
+ # @return [String]
1176
+ #
1177
+ # @!attribute [rw] job_id
1178
+ # @return [String]
1179
+ #
1180
+ # @!attribute [rw] operation
1181
+ # @return [String]
1182
+ #
1183
+ # @!attribute [rw] status
1184
+ # @return [String]
1185
+ #
1186
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/CreateBackendAuthResponse AWS API Documentation
1187
+ #
1188
+ class CreateBackendAuthResponse < Struct.new(
1189
+ :app_id,
1190
+ :backend_environment_name,
1191
+ :error,
1192
+ :job_id,
1193
+ :operation,
1194
+ :status)
1195
+ SENSITIVE = []
1196
+ include Aws::Structure
1197
+ end
1198
+
1199
+ # Describes the Amazon Cognito user pool configuration for the auth
1200
+ # resource to be configured for your Amplify project.
1201
+ #
1202
+ # @note When making an API call, you may pass CreateBackendAuthUserPoolConfig
1203
+ # data as a hash:
1204
+ #
1205
+ # {
1206
+ # forgot_password: {
1207
+ # delivery_method: "EMAIL", # required, accepts EMAIL, SMS
1208
+ # email_settings: {
1209
+ # email_message: "__string",
1210
+ # email_subject: "__string",
1211
+ # },
1212
+ # sms_settings: {
1213
+ # sms_message: "__string",
1214
+ # },
1215
+ # },
1216
+ # mfa: {
1217
+ # mfa_mode: "ON", # required, accepts ON, OFF, OPTIONAL
1218
+ # settings: {
1219
+ # mfa_types: ["SMS"], # accepts SMS, TOTP
1220
+ # sms_message: "__string",
1221
+ # },
1222
+ # },
1223
+ # o_auth: {
1224
+ # domain_prefix: "__string",
1225
+ # o_auth_grant_type: "CODE", # required, accepts CODE, IMPLICIT
1226
+ # o_auth_scopes: ["PHONE"], # required, accepts PHONE, EMAIL, OPENID, PROFILE, AWS_COGNITO_SIGNIN_USER_ADMIN
1227
+ # redirect_sign_in_ur_is: ["__string"], # required
1228
+ # redirect_sign_out_ur_is: ["__string"], # required
1229
+ # social_provider_settings: {
1230
+ # facebook: {
1231
+ # client_id: "__string",
1232
+ # client_secret: "__string",
1233
+ # },
1234
+ # google: {
1235
+ # client_id: "__string",
1236
+ # client_secret: "__string",
1237
+ # },
1238
+ # login_with_amazon: {
1239
+ # client_id: "__string",
1240
+ # client_secret: "__string",
1241
+ # },
1242
+ # },
1243
+ # },
1244
+ # password_policy: {
1245
+ # additional_constraints: ["REQUIRE_DIGIT"], # accepts REQUIRE_DIGIT, REQUIRE_LOWERCASE, REQUIRE_SYMBOL, REQUIRE_UPPERCASE
1246
+ # minimum_length: 1.0, # required
1247
+ # },
1248
+ # 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
1249
+ # sign_in_method: "EMAIL", # required, accepts EMAIL, EMAIL_AND_PHONE_NUMBER, PHONE_NUMBER, USERNAME
1250
+ # user_pool_name: "__string", # required
1251
+ # }
1252
+ #
1253
+ # @!attribute [rw] forgot_password
1254
+ # Describes the forgotten password policy for your Amazon Cognito user
1255
+ # pool, configured as a part of your Amplify project.
1256
+ # @return [Types::CreateBackendAuthForgotPasswordConfig]
1257
+ #
1258
+ # @!attribute [rw] mfa
1259
+ # Describes whether multi-factor authentication policies should be
1260
+ # applied for your Amazon Cognito user pool configured as a part of
1261
+ # your Amplify project.
1262
+ # @return [Types::CreateBackendAuthMFAConfig]
1263
+ #
1264
+ # @!attribute [rw] o_auth
1265
+ # Describes the OAuth policy and rules for your Amazon Cognito user
1266
+ # pool, configured as a part of your Amplify project.
1267
+ # @return [Types::CreateBackendAuthOAuthConfig]
1268
+ #
1269
+ # @!attribute [rw] password_policy
1270
+ # Describes the password policy for your Amazon Cognito user pool,
1271
+ # configured as a part of your Amplify project.
1272
+ # @return [Types::CreateBackendAuthPasswordPolicyConfig]
1273
+ #
1274
+ # @!attribute [rw] required_sign_up_attributes
1275
+ # The required attributes to sign up new users in the user pool.
1276
+ # @return [Array<String>]
1277
+ #
1278
+ # @!attribute [rw] sign_in_method
1279
+ # Describes the sign-in methods that your Amplify app users to login
1280
+ # using the Amazon Cognito user pool, configured as a part of your
1281
+ # Amplify project.
1282
+ # @return [String]
1283
+ #
1284
+ # @!attribute [rw] user_pool_name
1285
+ # The Amazon Cognito user pool name.
1286
+ # @return [String]
1287
+ #
1288
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/CreateBackendAuthUserPoolConfig AWS API Documentation
1289
+ #
1290
+ class CreateBackendAuthUserPoolConfig < Struct.new(
1291
+ :forgot_password,
1292
+ :mfa,
1293
+ :o_auth,
1294
+ :password_policy,
1295
+ :required_sign_up_attributes,
1296
+ :sign_in_method,
1297
+ :user_pool_name)
1298
+ SENSITIVE = []
1299
+ include Aws::Structure
1300
+ end
1301
+
1302
+ # The request object for this operation.
1303
+ #
1304
+ # @!attribute [rw] backend_manager_app_id
1305
+ # The app ID for the backend manager.
1306
+ # @return [String]
1307
+ #
1308
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/CreateBackendConfigReqObj AWS API Documentation
1309
+ #
1310
+ class CreateBackendConfigReqObj < Struct.new(
1311
+ :backend_manager_app_id)
1312
+ SENSITIVE = []
1313
+ include Aws::Structure
1314
+ end
1315
+
1316
+ # @note When making an API call, you may pass CreateBackendConfigRequest
1317
+ # data as a hash:
1318
+ #
1319
+ # {
1320
+ # app_id: "__string", # required
1321
+ # backend_manager_app_id: "__string",
1322
+ # }
1323
+ #
1324
+ # @!attribute [rw] app_id
1325
+ # @return [String]
1326
+ #
1327
+ # @!attribute [rw] backend_manager_app_id
1328
+ # @return [String]
1329
+ #
1330
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/CreateBackendConfigRequest AWS API Documentation
1331
+ #
1332
+ class CreateBackendConfigRequest < Struct.new(
1333
+ :app_id,
1334
+ :backend_manager_app_id)
1335
+ SENSITIVE = []
1336
+ include Aws::Structure
1337
+ end
1338
+
1339
+ # The response object for this operation.
1340
+ #
1341
+ # @!attribute [rw] app_id
1342
+ # The app ID.
1343
+ # @return [String]
1344
+ #
1345
+ # @!attribute [rw] backend_environment_name
1346
+ # The name of the backend environment.
1347
+ # @return [String]
1348
+ #
1349
+ # @!attribute [rw] job_id
1350
+ # The ID for the job.
1351
+ # @return [String]
1352
+ #
1353
+ # @!attribute [rw] status
1354
+ # The current status of the request.
1355
+ # @return [String]
1356
+ #
1357
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/CreateBackendConfigRespObj AWS API Documentation
1358
+ #
1359
+ class CreateBackendConfigRespObj < Struct.new(
1360
+ :app_id,
1361
+ :backend_environment_name,
1362
+ :job_id,
1363
+ :status)
1364
+ SENSITIVE = []
1365
+ include Aws::Structure
1366
+ end
1367
+
1368
+ # @!attribute [rw] app_id
1369
+ # @return [String]
1370
+ #
1371
+ # @!attribute [rw] backend_environment_name
1372
+ # @return [String]
1373
+ #
1374
+ # @!attribute [rw] job_id
1375
+ # @return [String]
1376
+ #
1377
+ # @!attribute [rw] status
1378
+ # @return [String]
1379
+ #
1380
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/CreateBackendConfigResponse AWS API Documentation
1381
+ #
1382
+ class CreateBackendConfigResponse < Struct.new(
1383
+ :app_id,
1384
+ :backend_environment_name,
1385
+ :job_id,
1386
+ :status)
1387
+ SENSITIVE = []
1388
+ include Aws::Structure
1389
+ end
1390
+
1391
+ # The request object for this operation.
1392
+ #
1393
+ # @!attribute [rw] app_id
1394
+ # The app ID.
1395
+ # @return [String]
1396
+ #
1397
+ # @!attribute [rw] app_name
1398
+ # The name of the app.
1399
+ # @return [String]
1400
+ #
1401
+ # @!attribute [rw] backend_environment_name
1402
+ # The name of the backend environment.
1403
+ # @return [String]
1404
+ #
1405
+ # @!attribute [rw] resource_config
1406
+ # The resource configuration for the create backend request.
1407
+ # @return [Types::ResourceConfig]
1408
+ #
1409
+ # @!attribute [rw] resource_name
1410
+ # The name of the resource.
1411
+ # @return [String]
1412
+ #
1413
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/CreateBackendReqObj AWS API Documentation
1414
+ #
1415
+ class CreateBackendReqObj < Struct.new(
1416
+ :app_id,
1417
+ :app_name,
1418
+ :backend_environment_name,
1419
+ :resource_config,
1420
+ :resource_name)
1421
+ SENSITIVE = []
1422
+ include Aws::Structure
1423
+ end
1424
+
1425
+ # @note When making an API call, you may pass CreateBackendRequest
1426
+ # data as a hash:
1427
+ #
1428
+ # {
1429
+ # app_id: "__string", # required
1430
+ # app_name: "__string", # required
1431
+ # backend_environment_name: "__string", # required
1432
+ # resource_config: {
1433
+ # },
1434
+ # resource_name: "__string",
1435
+ # }
1436
+ #
1437
+ # @!attribute [rw] app_id
1438
+ # @return [String]
1439
+ #
1440
+ # @!attribute [rw] app_name
1441
+ # @return [String]
1442
+ #
1443
+ # @!attribute [rw] backend_environment_name
1444
+ # @return [String]
1445
+ #
1446
+ # @!attribute [rw] resource_config
1447
+ # @return [Types::ResourceConfig]
1448
+ #
1449
+ # @!attribute [rw] resource_name
1450
+ # @return [String]
1451
+ #
1452
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/CreateBackendRequest AWS API Documentation
1453
+ #
1454
+ class CreateBackendRequest < Struct.new(
1455
+ :app_id,
1456
+ :app_name,
1457
+ :backend_environment_name,
1458
+ :resource_config,
1459
+ :resource_name)
1460
+ SENSITIVE = []
1461
+ include Aws::Structure
1462
+ end
1463
+
1464
+ # The response object sent when a backend is created.
1465
+ #
1466
+ # @!attribute [rw] app_id
1467
+ # The app ID.
1468
+ # @return [String]
1469
+ #
1470
+ # @!attribute [rw] backend_environment_name
1471
+ # The name of the backend environment.
1472
+ # @return [String]
1473
+ #
1474
+ # @!attribute [rw] error
1475
+ # If the request failed, this is the returned error.
1476
+ # @return [String]
1477
+ #
1478
+ # @!attribute [rw] job_id
1479
+ # The ID for the job.
1480
+ # @return [String]
1481
+ #
1482
+ # @!attribute [rw] operation
1483
+ # The name of the operation.
1484
+ # @return [String]
1485
+ #
1486
+ # @!attribute [rw] status
1487
+ # The current status of the request.
1488
+ # @return [String]
1489
+ #
1490
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/CreateBackendRespObj AWS API Documentation
1491
+ #
1492
+ class CreateBackendRespObj < Struct.new(
1493
+ :app_id,
1494
+ :backend_environment_name,
1495
+ :error,
1496
+ :job_id,
1497
+ :operation,
1498
+ :status)
1499
+ SENSITIVE = []
1500
+ include Aws::Structure
1501
+ end
1502
+
1503
+ # @!attribute [rw] app_id
1504
+ # @return [String]
1505
+ #
1506
+ # @!attribute [rw] backend_environment_name
1507
+ # @return [String]
1508
+ #
1509
+ # @!attribute [rw] error
1510
+ # @return [String]
1511
+ #
1512
+ # @!attribute [rw] job_id
1513
+ # @return [String]
1514
+ #
1515
+ # @!attribute [rw] operation
1516
+ # @return [String]
1517
+ #
1518
+ # @!attribute [rw] status
1519
+ # @return [String]
1520
+ #
1521
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/CreateBackendResponse AWS API Documentation
1522
+ #
1523
+ class CreateBackendResponse < Struct.new(
1524
+ :app_id,
1525
+ :backend_environment_name,
1526
+ :error,
1527
+ :job_id,
1528
+ :operation,
1529
+ :status)
1530
+ SENSITIVE = []
1531
+ include Aws::Structure
1532
+ end
1533
+
1534
+ # @note When making an API call, you may pass CreateTokenRequest
1535
+ # data as a hash:
1536
+ #
1537
+ # {
1538
+ # app_id: "__string", # required
1539
+ # }
1540
+ #
1541
+ # @!attribute [rw] app_id
1542
+ # @return [String]
1543
+ #
1544
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/CreateTokenRequest AWS API Documentation
1545
+ #
1546
+ class CreateTokenRequest < Struct.new(
1547
+ :app_id)
1548
+ SENSITIVE = []
1549
+ include Aws::Structure
1550
+ end
1551
+
1552
+ # The response object for this operation.
1553
+ #
1554
+ # @!attribute [rw] app_id
1555
+ # The app ID.
1556
+ # @return [String]
1557
+ #
1558
+ # @!attribute [rw] challenge_code
1559
+ # One time challenge code for authenticating into Amplify Admin UI.
1560
+ # @return [String]
1561
+ #
1562
+ # @!attribute [rw] session_id
1563
+ # A unique identifier provided when creating a new challenge token.
1564
+ # @return [String]
1565
+ #
1566
+ # @!attribute [rw] ttl
1567
+ # The expiry time for the one time generated token code.
1568
+ # @return [String]
1569
+ #
1570
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/CreateTokenRespObj AWS API Documentation
1571
+ #
1572
+ class CreateTokenRespObj < Struct.new(
1573
+ :app_id,
1574
+ :challenge_code,
1575
+ :session_id,
1576
+ :ttl)
1577
+ SENSITIVE = []
1578
+ include Aws::Structure
1579
+ end
1580
+
1581
+ # @!attribute [rw] app_id
1582
+ # @return [String]
1583
+ #
1584
+ # @!attribute [rw] challenge_code
1585
+ # @return [String]
1586
+ #
1587
+ # @!attribute [rw] session_id
1588
+ # @return [String]
1589
+ #
1590
+ # @!attribute [rw] ttl
1591
+ # @return [String]
1592
+ #
1593
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/CreateTokenResponse AWS API Documentation
1594
+ #
1595
+ class CreateTokenResponse < Struct.new(
1596
+ :app_id,
1597
+ :challenge_code,
1598
+ :session_id,
1599
+ :ttl)
1600
+ SENSITIVE = []
1601
+ include Aws::Structure
1602
+ end
1603
+
1604
+ # @note When making an API call, you may pass DeleteBackendAPIRequest
1605
+ # data as a hash:
1606
+ #
1607
+ # {
1608
+ # app_id: "__string", # required
1609
+ # backend_environment_name: "__string", # required
1610
+ # resource_config: {
1611
+ # additional_auth_types: [
1612
+ # {
1613
+ # mode: "API_KEY", # accepts API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT
1614
+ # settings: {
1615
+ # cognito_user_pool_id: "__string",
1616
+ # description: "__string",
1617
+ # expiration_time: 1.0,
1618
+ # open_id_auth_ttl: "__string",
1619
+ # open_id_client_id: "__string",
1620
+ # open_id_iat_ttl: "__string",
1621
+ # open_id_issue_url: "__string",
1622
+ # open_id_provider_name: "__string",
1623
+ # },
1624
+ # },
1625
+ # ],
1626
+ # api_name: "__string",
1627
+ # conflict_resolution: {
1628
+ # resolution_strategy: "OPTIMISTIC_CONCURRENCY", # accepts OPTIMISTIC_CONCURRENCY, LAMBDA, AUTOMERGE, NONE
1629
+ # },
1630
+ # default_auth_type: {
1631
+ # mode: "API_KEY", # accepts API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT
1632
+ # settings: {
1633
+ # cognito_user_pool_id: "__string",
1634
+ # description: "__string",
1635
+ # expiration_time: 1.0,
1636
+ # open_id_auth_ttl: "__string",
1637
+ # open_id_client_id: "__string",
1638
+ # open_id_iat_ttl: "__string",
1639
+ # open_id_issue_url: "__string",
1640
+ # open_id_provider_name: "__string",
1641
+ # },
1642
+ # },
1643
+ # service: "__string",
1644
+ # transform_schema: "__string",
1645
+ # },
1646
+ # resource_name: "__string", # required
1647
+ # }
1648
+ #
1649
+ # @!attribute [rw] app_id
1650
+ # @return [String]
1651
+ #
1652
+ # @!attribute [rw] backend_environment_name
1653
+ # @return [String]
1654
+ #
1655
+ # @!attribute [rw] resource_config
1656
+ # The resource config for the data model,configured as a part of the
1657
+ # Amplify project.
1658
+ # @return [Types::BackendAPIResourceConfig]
1659
+ #
1660
+ # @!attribute [rw] resource_name
1661
+ # @return [String]
1662
+ #
1663
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/DeleteBackendAPIRequest AWS API Documentation
1664
+ #
1665
+ class DeleteBackendAPIRequest < Struct.new(
1666
+ :app_id,
1667
+ :backend_environment_name,
1668
+ :resource_config,
1669
+ :resource_name)
1670
+ SENSITIVE = []
1671
+ include Aws::Structure
1672
+ end
1673
+
1674
+ # @!attribute [rw] app_id
1675
+ # @return [String]
1676
+ #
1677
+ # @!attribute [rw] backend_environment_name
1678
+ # @return [String]
1679
+ #
1680
+ # @!attribute [rw] error
1681
+ # @return [String]
1682
+ #
1683
+ # @!attribute [rw] job_id
1684
+ # @return [String]
1685
+ #
1686
+ # @!attribute [rw] operation
1687
+ # @return [String]
1688
+ #
1689
+ # @!attribute [rw] status
1690
+ # @return [String]
1691
+ #
1692
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/DeleteBackendAPIResponse AWS API Documentation
1693
+ #
1694
+ class DeleteBackendAPIResponse < Struct.new(
1695
+ :app_id,
1696
+ :backend_environment_name,
1697
+ :error,
1698
+ :job_id,
1699
+ :operation,
1700
+ :status)
1701
+ SENSITIVE = []
1702
+ include Aws::Structure
1703
+ end
1704
+
1705
+ # @note When making an API call, you may pass DeleteBackendAuthRequest
1706
+ # data as a hash:
1707
+ #
1708
+ # {
1709
+ # app_id: "__string", # required
1710
+ # backend_environment_name: "__string", # required
1711
+ # resource_name: "__string", # required
1712
+ # }
1713
+ #
1714
+ # @!attribute [rw] app_id
1715
+ # @return [String]
1716
+ #
1717
+ # @!attribute [rw] backend_environment_name
1718
+ # @return [String]
1719
+ #
1720
+ # @!attribute [rw] resource_name
1721
+ # @return [String]
1722
+ #
1723
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/DeleteBackendAuthRequest AWS API Documentation
1724
+ #
1725
+ class DeleteBackendAuthRequest < Struct.new(
1726
+ :app_id,
1727
+ :backend_environment_name,
1728
+ :resource_name)
1729
+ SENSITIVE = []
1730
+ include Aws::Structure
1731
+ end
1732
+
1733
+ # @!attribute [rw] app_id
1734
+ # @return [String]
1735
+ #
1736
+ # @!attribute [rw] backend_environment_name
1737
+ # @return [String]
1738
+ #
1739
+ # @!attribute [rw] error
1740
+ # @return [String]
1741
+ #
1742
+ # @!attribute [rw] job_id
1743
+ # @return [String]
1744
+ #
1745
+ # @!attribute [rw] operation
1746
+ # @return [String]
1747
+ #
1748
+ # @!attribute [rw] status
1749
+ # @return [String]
1750
+ #
1751
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/DeleteBackendAuthResponse AWS API Documentation
1752
+ #
1753
+ class DeleteBackendAuthResponse < Struct.new(
1754
+ :app_id,
1755
+ :backend_environment_name,
1756
+ :error,
1757
+ :job_id,
1758
+ :operation,
1759
+ :status)
1760
+ SENSITIVE = []
1761
+ include Aws::Structure
1762
+ end
1763
+
1764
+ # @note When making an API call, you may pass DeleteBackendRequest
1765
+ # data as a hash:
1766
+ #
1767
+ # {
1768
+ # app_id: "__string", # required
1769
+ # backend_environment_name: "__string", # required
1770
+ # }
1771
+ #
1772
+ # @!attribute [rw] app_id
1773
+ # @return [String]
1774
+ #
1775
+ # @!attribute [rw] backend_environment_name
1776
+ # @return [String]
1777
+ #
1778
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/DeleteBackendRequest AWS API Documentation
1779
+ #
1780
+ class DeleteBackendRequest < Struct.new(
1781
+ :app_id,
1782
+ :backend_environment_name)
1783
+ SENSITIVE = []
1784
+ include Aws::Structure
1785
+ end
1786
+
1787
+ # The returned object for a request to delete a backend.
1788
+ #
1789
+ # @!attribute [rw] app_id
1790
+ # The app ID.
1791
+ # @return [String]
1792
+ #
1793
+ # @!attribute [rw] backend_environment_name
1794
+ # The name of the backend environment.
1795
+ # @return [String]
1796
+ #
1797
+ # @!attribute [rw] error
1798
+ # If the request failed, this is the returned error.
1799
+ # @return [String]
1800
+ #
1801
+ # @!attribute [rw] job_id
1802
+ # The ID for the job.
1803
+ # @return [String]
1804
+ #
1805
+ # @!attribute [rw] operation
1806
+ # The name of the operation.
1807
+ # @return [String]
1808
+ #
1809
+ # @!attribute [rw] status
1810
+ # The current status of the request.
1811
+ # @return [String]
1812
+ #
1813
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/DeleteBackendRespObj AWS API Documentation
1814
+ #
1815
+ class DeleteBackendRespObj < Struct.new(
1816
+ :app_id,
1817
+ :backend_environment_name,
1818
+ :error,
1819
+ :job_id,
1820
+ :operation,
1821
+ :status)
1822
+ SENSITIVE = []
1823
+ include Aws::Structure
1824
+ end
1825
+
1826
+ # @!attribute [rw] app_id
1827
+ # @return [String]
1828
+ #
1829
+ # @!attribute [rw] backend_environment_name
1830
+ # @return [String]
1831
+ #
1832
+ # @!attribute [rw] error
1833
+ # @return [String]
1834
+ #
1835
+ # @!attribute [rw] job_id
1836
+ # @return [String]
1837
+ #
1838
+ # @!attribute [rw] operation
1839
+ # @return [String]
1840
+ #
1841
+ # @!attribute [rw] status
1842
+ # @return [String]
1843
+ #
1844
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/DeleteBackendResponse AWS API Documentation
1845
+ #
1846
+ class DeleteBackendResponse < Struct.new(
1847
+ :app_id,
1848
+ :backend_environment_name,
1849
+ :error,
1850
+ :job_id,
1851
+ :operation,
1852
+ :status)
1853
+ SENSITIVE = []
1854
+ include Aws::Structure
1855
+ end
1856
+
1857
+ # @note When making an API call, you may pass DeleteTokenRequest
1858
+ # data as a hash:
1859
+ #
1860
+ # {
1861
+ # app_id: "__string", # required
1862
+ # session_id: "__string", # required
1863
+ # }
1864
+ #
1865
+ # @!attribute [rw] app_id
1866
+ # @return [String]
1867
+ #
1868
+ # @!attribute [rw] session_id
1869
+ # @return [String]
1870
+ #
1871
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/DeleteTokenRequest AWS API Documentation
1872
+ #
1873
+ class DeleteTokenRequest < Struct.new(
1874
+ :app_id,
1875
+ :session_id)
1876
+ SENSITIVE = []
1877
+ include Aws::Structure
1878
+ end
1879
+
1880
+ # The response object for this operation.
1881
+ #
1882
+ # @!attribute [rw] is_success
1883
+ # Indicates whether the request succeeded or failed.
1884
+ # @return [Boolean]
1885
+ #
1886
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/DeleteTokenRespObj AWS API Documentation
1887
+ #
1888
+ class DeleteTokenRespObj < Struct.new(
1889
+ :is_success)
1890
+ SENSITIVE = []
1891
+ include Aws::Structure
1892
+ end
1893
+
1894
+ # @!attribute [rw] is_success
1895
+ # @return [Boolean]
1896
+ #
1897
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/DeleteTokenResponse AWS API Documentation
1898
+ #
1899
+ class DeleteTokenResponse < Struct.new(
1900
+ :is_success)
1901
+ SENSITIVE = []
1902
+ include Aws::Structure
1903
+ end
1904
+
1905
+ # @note When making an API call, you may pass EmailSettings
1906
+ # data as a hash:
1907
+ #
1908
+ # {
1909
+ # email_message: "__string",
1910
+ # email_subject: "__string",
1911
+ # }
1912
+ #
1913
+ # @!attribute [rw] email_message
1914
+ # The body of the email.
1915
+ # @return [String]
1916
+ #
1917
+ # @!attribute [rw] email_subject
1918
+ # The subject of the email.
1919
+ # @return [String]
1920
+ #
1921
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/EmailSettings AWS API Documentation
1922
+ #
1923
+ class EmailSettings < Struct.new(
1924
+ :email_message,
1925
+ :email_subject)
1926
+ SENSITIVE = []
1927
+ include Aws::Structure
1928
+ end
1929
+
1930
+ # An error returned if there's a temporary issue with the service.
1931
+ #
1932
+ # @!attribute [rw] message
1933
+ # @return [String]
1934
+ #
1935
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/GatewayTimeoutException AWS API Documentation
1936
+ #
1937
+ class GatewayTimeoutException < Struct.new(
1938
+ :message)
1939
+ SENSITIVE = []
1940
+ include Aws::Structure
1941
+ end
1942
+
1943
+ # @note When making an API call, you may pass GenerateBackendAPIModelsRequest
1944
+ # data as a hash:
1945
+ #
1946
+ # {
1947
+ # app_id: "__string", # required
1948
+ # backend_environment_name: "__string", # required
1949
+ # resource_name: "__string", # required
1950
+ # }
1951
+ #
1952
+ # @!attribute [rw] app_id
1953
+ # @return [String]
1954
+ #
1955
+ # @!attribute [rw] backend_environment_name
1956
+ # @return [String]
1957
+ #
1958
+ # @!attribute [rw] resource_name
1959
+ # @return [String]
1960
+ #
1961
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/GenerateBackendAPIModelsRequest AWS API Documentation
1962
+ #
1963
+ class GenerateBackendAPIModelsRequest < Struct.new(
1964
+ :app_id,
1965
+ :backend_environment_name,
1966
+ :resource_name)
1967
+ SENSITIVE = []
1968
+ include Aws::Structure
1969
+ end
1970
+
1971
+ # @!attribute [rw] app_id
1972
+ # @return [String]
1973
+ #
1974
+ # @!attribute [rw] backend_environment_name
1975
+ # @return [String]
1976
+ #
1977
+ # @!attribute [rw] error
1978
+ # @return [String]
1979
+ #
1980
+ # @!attribute [rw] job_id
1981
+ # @return [String]
1982
+ #
1983
+ # @!attribute [rw] operation
1984
+ # @return [String]
1985
+ #
1986
+ # @!attribute [rw] status
1987
+ # @return [String]
1988
+ #
1989
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/GenerateBackendAPIModelsResponse AWS API Documentation
1990
+ #
1991
+ class GenerateBackendAPIModelsResponse < Struct.new(
1992
+ :app_id,
1993
+ :backend_environment_name,
1994
+ :error,
1995
+ :job_id,
1996
+ :operation,
1997
+ :status)
1998
+ SENSITIVE = []
1999
+ include Aws::Structure
2000
+ end
2001
+
2002
+ # The response object for this operation.
2003
+ #
2004
+ # @!attribute [rw] models
2005
+ # Stringified JSON of the datastore model.
2006
+ # @return [String]
2007
+ #
2008
+ # @!attribute [rw] status
2009
+ # The current status of the request.
2010
+ # @return [String]
2011
+ #
2012
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/GetBackendAPICodegenRespObj AWS API Documentation
2013
+ #
2014
+ class GetBackendAPICodegenRespObj < Struct.new(
2015
+ :models,
2016
+ :status)
2017
+ SENSITIVE = []
2018
+ include Aws::Structure
2019
+ end
2020
+
2021
+ # @note When making an API call, you may pass GetBackendAPIModelsRequest
2022
+ # data as a hash:
2023
+ #
2024
+ # {
2025
+ # app_id: "__string", # required
2026
+ # backend_environment_name: "__string", # required
2027
+ # resource_name: "__string", # required
2028
+ # }
2029
+ #
2030
+ # @!attribute [rw] app_id
2031
+ # @return [String]
2032
+ #
2033
+ # @!attribute [rw] backend_environment_name
2034
+ # @return [String]
2035
+ #
2036
+ # @!attribute [rw] resource_name
2037
+ # @return [String]
2038
+ #
2039
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/GetBackendAPIModelsRequest AWS API Documentation
2040
+ #
2041
+ class GetBackendAPIModelsRequest < Struct.new(
2042
+ :app_id,
2043
+ :backend_environment_name,
2044
+ :resource_name)
2045
+ SENSITIVE = []
2046
+ include Aws::Structure
2047
+ end
2048
+
2049
+ # @!attribute [rw] models
2050
+ # @return [String]
2051
+ #
2052
+ # @!attribute [rw] status
2053
+ # @return [String]
2054
+ #
2055
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/GetBackendAPIModelsResponse AWS API Documentation
2056
+ #
2057
+ class GetBackendAPIModelsResponse < Struct.new(
2058
+ :models,
2059
+ :status)
2060
+ SENSITIVE = []
2061
+ include Aws::Structure
2062
+ end
2063
+
2064
+ # @note When making an API call, you may pass GetBackendAPIRequest
2065
+ # data as a hash:
2066
+ #
2067
+ # {
2068
+ # app_id: "__string", # required
2069
+ # backend_environment_name: "__string", # required
2070
+ # resource_config: {
2071
+ # additional_auth_types: [
2072
+ # {
2073
+ # mode: "API_KEY", # accepts API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT
2074
+ # settings: {
2075
+ # cognito_user_pool_id: "__string",
2076
+ # description: "__string",
2077
+ # expiration_time: 1.0,
2078
+ # open_id_auth_ttl: "__string",
2079
+ # open_id_client_id: "__string",
2080
+ # open_id_iat_ttl: "__string",
2081
+ # open_id_issue_url: "__string",
2082
+ # open_id_provider_name: "__string",
2083
+ # },
2084
+ # },
2085
+ # ],
2086
+ # api_name: "__string",
2087
+ # conflict_resolution: {
2088
+ # resolution_strategy: "OPTIMISTIC_CONCURRENCY", # accepts OPTIMISTIC_CONCURRENCY, LAMBDA, AUTOMERGE, NONE
2089
+ # },
2090
+ # default_auth_type: {
2091
+ # mode: "API_KEY", # accepts API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT
2092
+ # settings: {
2093
+ # cognito_user_pool_id: "__string",
2094
+ # description: "__string",
2095
+ # expiration_time: 1.0,
2096
+ # open_id_auth_ttl: "__string",
2097
+ # open_id_client_id: "__string",
2098
+ # open_id_iat_ttl: "__string",
2099
+ # open_id_issue_url: "__string",
2100
+ # open_id_provider_name: "__string",
2101
+ # },
2102
+ # },
2103
+ # service: "__string",
2104
+ # transform_schema: "__string",
2105
+ # },
2106
+ # resource_name: "__string", # required
2107
+ # }
2108
+ #
2109
+ # @!attribute [rw] app_id
2110
+ # @return [String]
2111
+ #
2112
+ # @!attribute [rw] backend_environment_name
2113
+ # @return [String]
2114
+ #
2115
+ # @!attribute [rw] resource_config
2116
+ # The resource config for the data model,configured as a part of the
2117
+ # Amplify project.
2118
+ # @return [Types::BackendAPIResourceConfig]
2119
+ #
2120
+ # @!attribute [rw] resource_name
2121
+ # @return [String]
2122
+ #
2123
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/GetBackendAPIRequest AWS API Documentation
2124
+ #
2125
+ class GetBackendAPIRequest < Struct.new(
2126
+ :app_id,
2127
+ :backend_environment_name,
2128
+ :resource_config,
2129
+ :resource_name)
2130
+ SENSITIVE = []
2131
+ include Aws::Structure
2132
+ end
2133
+
2134
+ # The response object for this operation.
2135
+ #
2136
+ # @!attribute [rw] app_id
2137
+ # The app ID.
2138
+ # @return [String]
2139
+ #
2140
+ # @!attribute [rw] backend_environment_name
2141
+ # The name of the backend environment.
2142
+ # @return [String]
2143
+ #
2144
+ # @!attribute [rw] error
2145
+ # If the request failed, this is the returned error.
2146
+ # @return [String]
2147
+ #
2148
+ # @!attribute [rw] resource_config
2149
+ # The resource configuration for this response object.
2150
+ # @return [Types::BackendAPIResourceConfig]
2151
+ #
2152
+ # @!attribute [rw] resource_name
2153
+ # The name of this resource.
2154
+ # @return [String]
2155
+ #
2156
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/GetBackendAPIRespObj AWS API Documentation
2157
+ #
2158
+ class GetBackendAPIRespObj < Struct.new(
2159
+ :app_id,
2160
+ :backend_environment_name,
2161
+ :error,
2162
+ :resource_config,
2163
+ :resource_name)
2164
+ SENSITIVE = []
2165
+ include Aws::Structure
2166
+ end
2167
+
2168
+ # @!attribute [rw] app_id
2169
+ # @return [String]
2170
+ #
2171
+ # @!attribute [rw] backend_environment_name
2172
+ # @return [String]
2173
+ #
2174
+ # @!attribute [rw] error
2175
+ # @return [String]
2176
+ #
2177
+ # @!attribute [rw] resource_config
2178
+ # The resource config for the data model,configured as a part of the
2179
+ # Amplify project.
2180
+ # @return [Types::BackendAPIResourceConfig]
2181
+ #
2182
+ # @!attribute [rw] resource_name
2183
+ # @return [String]
2184
+ #
2185
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/GetBackendAPIResponse AWS API Documentation
2186
+ #
2187
+ class GetBackendAPIResponse < Struct.new(
2188
+ :app_id,
2189
+ :backend_environment_name,
2190
+ :error,
2191
+ :resource_config,
2192
+ :resource_name)
2193
+ SENSITIVE = []
2194
+ include Aws::Structure
2195
+ end
2196
+
2197
+ # The request object for this operation.
2198
+ #
2199
+ # @!attribute [rw] resource_name
2200
+ # The name of this resource.
2201
+ # @return [String]
2202
+ #
2203
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/GetBackendAuthReqObj AWS API Documentation
2204
+ #
2205
+ class GetBackendAuthReqObj < Struct.new(
2206
+ :resource_name)
2207
+ SENSITIVE = []
2208
+ include Aws::Structure
2209
+ end
2210
+
2211
+ # @note When making an API call, you may pass GetBackendAuthRequest
2212
+ # data as a hash:
2213
+ #
2214
+ # {
2215
+ # app_id: "__string", # required
2216
+ # backend_environment_name: "__string", # required
2217
+ # resource_name: "__string", # required
2218
+ # }
2219
+ #
2220
+ # @!attribute [rw] app_id
2221
+ # @return [String]
2222
+ #
2223
+ # @!attribute [rw] backend_environment_name
2224
+ # @return [String]
2225
+ #
2226
+ # @!attribute [rw] resource_name
2227
+ # @return [String]
2228
+ #
2229
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/GetBackendAuthRequest AWS API Documentation
2230
+ #
2231
+ class GetBackendAuthRequest < Struct.new(
2232
+ :app_id,
2233
+ :backend_environment_name,
2234
+ :resource_name)
2235
+ SENSITIVE = []
2236
+ include Aws::Structure
2237
+ end
2238
+
2239
+ # The response object for this operation.
2240
+ #
2241
+ # @!attribute [rw] app_id
2242
+ # The app ID.
2243
+ # @return [String]
2244
+ #
2245
+ # @!attribute [rw] backend_environment_name
2246
+ # The name of the backend environment.
2247
+ # @return [String]
2248
+ #
2249
+ # @!attribute [rw] error
2250
+ # If the request failed, this is the returned error.
2251
+ # @return [String]
2252
+ #
2253
+ # @!attribute [rw] resource_config
2254
+ # The resource configuration for authorization requests to the backend
2255
+ # of your Amplify project.
2256
+ # @return [Types::CreateBackendAuthResourceConfig]
2257
+ #
2258
+ # @!attribute [rw] resource_name
2259
+ # The name of this resource.
2260
+ # @return [String]
2261
+ #
2262
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/GetBackendAuthRespObj AWS API Documentation
2263
+ #
2264
+ class GetBackendAuthRespObj < Struct.new(
2265
+ :app_id,
2266
+ :backend_environment_name,
2267
+ :error,
2268
+ :resource_config,
2269
+ :resource_name)
2270
+ SENSITIVE = []
2271
+ include Aws::Structure
2272
+ end
2273
+
2274
+ # @!attribute [rw] app_id
2275
+ # @return [String]
2276
+ #
2277
+ # @!attribute [rw] backend_environment_name
2278
+ # @return [String]
2279
+ #
2280
+ # @!attribute [rw] error
2281
+ # @return [String]
2282
+ #
2283
+ # @!attribute [rw] resource_config
2284
+ # Defines the resource configuration when creating an auth resource in
2285
+ # your Amplify project.
2286
+ # @return [Types::CreateBackendAuthResourceConfig]
2287
+ #
2288
+ # @!attribute [rw] resource_name
2289
+ # @return [String]
2290
+ #
2291
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/GetBackendAuthResponse AWS API Documentation
2292
+ #
2293
+ class GetBackendAuthResponse < Struct.new(
2294
+ :app_id,
2295
+ :backend_environment_name,
2296
+ :error,
2297
+ :resource_config,
2298
+ :resource_name)
2299
+ SENSITIVE = []
2300
+ include Aws::Structure
2301
+ end
2302
+
2303
+ # @note When making an API call, you may pass GetBackendJobRequest
2304
+ # data as a hash:
2305
+ #
2306
+ # {
2307
+ # app_id: "__string", # required
2308
+ # backend_environment_name: "__string", # required
2309
+ # job_id: "__string", # required
2310
+ # }
2311
+ #
2312
+ # @!attribute [rw] app_id
2313
+ # @return [String]
2314
+ #
2315
+ # @!attribute [rw] backend_environment_name
2316
+ # @return [String]
2317
+ #
2318
+ # @!attribute [rw] job_id
2319
+ # @return [String]
2320
+ #
2321
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/GetBackendJobRequest AWS API Documentation
2322
+ #
2323
+ class GetBackendJobRequest < Struct.new(
2324
+ :app_id,
2325
+ :backend_environment_name,
2326
+ :job_id)
2327
+ SENSITIVE = []
2328
+ include Aws::Structure
2329
+ end
2330
+
2331
+ # @!attribute [rw] app_id
2332
+ # @return [String]
2333
+ #
2334
+ # @!attribute [rw] backend_environment_name
2335
+ # @return [String]
2336
+ #
2337
+ # @!attribute [rw] create_time
2338
+ # @return [String]
2339
+ #
2340
+ # @!attribute [rw] error
2341
+ # @return [String]
2342
+ #
2343
+ # @!attribute [rw] job_id
2344
+ # @return [String]
2345
+ #
2346
+ # @!attribute [rw] operation
2347
+ # @return [String]
2348
+ #
2349
+ # @!attribute [rw] status
2350
+ # @return [String]
2351
+ #
2352
+ # @!attribute [rw] update_time
2353
+ # @return [String]
2354
+ #
2355
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/GetBackendJobResponse AWS API Documentation
2356
+ #
2357
+ class GetBackendJobResponse < Struct.new(
2358
+ :app_id,
2359
+ :backend_environment_name,
2360
+ :create_time,
2361
+ :error,
2362
+ :job_id,
2363
+ :operation,
2364
+ :status,
2365
+ :update_time)
2366
+ SENSITIVE = []
2367
+ include Aws::Structure
2368
+ end
2369
+
2370
+ # The request object for this operation.
2371
+ #
2372
+ # @!attribute [rw] backend_environment_name
2373
+ # The name of the backend environment.
2374
+ # @return [String]
2375
+ #
2376
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/GetBackendReqObj AWS API Documentation
2377
+ #
2378
+ class GetBackendReqObj < Struct.new(
2379
+ :backend_environment_name)
2380
+ SENSITIVE = []
2381
+ include Aws::Structure
2382
+ end
2383
+
2384
+ # @note When making an API call, you may pass GetBackendRequest
2385
+ # data as a hash:
2386
+ #
2387
+ # {
2388
+ # app_id: "__string", # required
2389
+ # backend_environment_name: "__string",
2390
+ # }
2391
+ #
2392
+ # @!attribute [rw] app_id
2393
+ # @return [String]
2394
+ #
2395
+ # @!attribute [rw] backend_environment_name
2396
+ # @return [String]
2397
+ #
2398
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/GetBackendRequest AWS API Documentation
2399
+ #
2400
+ class GetBackendRequest < Struct.new(
2401
+ :app_id,
2402
+ :backend_environment_name)
2403
+ SENSITIVE = []
2404
+ include Aws::Structure
2405
+ end
2406
+
2407
+ # The response object for this operation.
2408
+ #
2409
+ # @!attribute [rw] amplify_meta_config
2410
+ # A stringified version of the current configs for your Amplify
2411
+ # project.
2412
+ # @return [String]
2413
+ #
2414
+ # @!attribute [rw] app_id
2415
+ # The app ID.
2416
+ # @return [String]
2417
+ #
2418
+ # @!attribute [rw] app_name
2419
+ # The name of the app.
2420
+ # @return [String]
2421
+ #
2422
+ # @!attribute [rw] backend_environment_list
2423
+ # A list of backend environments in an array.
2424
+ # @return [Array<String>]
2425
+ #
2426
+ # @!attribute [rw] backend_environment_name
2427
+ # The name of the backend environment.
2428
+ # @return [String]
2429
+ #
2430
+ # @!attribute [rw] error
2431
+ # If the request failed, this is the returned error.
2432
+ # @return [String]
2433
+ #
2434
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/GetBackendRespObj AWS API Documentation
2435
+ #
2436
+ class GetBackendRespObj < Struct.new(
2437
+ :amplify_meta_config,
2438
+ :app_id,
2439
+ :app_name,
2440
+ :backend_environment_list,
2441
+ :backend_environment_name,
2442
+ :error)
2443
+ SENSITIVE = []
2444
+ include Aws::Structure
2445
+ end
2446
+
2447
+ # @!attribute [rw] amplify_meta_config
2448
+ # @return [String]
2449
+ #
2450
+ # @!attribute [rw] app_id
2451
+ # @return [String]
2452
+ #
2453
+ # @!attribute [rw] app_name
2454
+ # @return [String]
2455
+ #
2456
+ # @!attribute [rw] backend_environment_list
2457
+ # @return [Array<String>]
2458
+ #
2459
+ # @!attribute [rw] backend_environment_name
2460
+ # @return [String]
2461
+ #
2462
+ # @!attribute [rw] error
2463
+ # @return [String]
2464
+ #
2465
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/GetBackendResponse AWS API Documentation
2466
+ #
2467
+ class GetBackendResponse < Struct.new(
2468
+ :amplify_meta_config,
2469
+ :app_id,
2470
+ :app_name,
2471
+ :backend_environment_list,
2472
+ :backend_environment_name,
2473
+ :error)
2474
+ SENSITIVE = []
2475
+ include Aws::Structure
2476
+ end
2477
+
2478
+ # @note When making an API call, you may pass GetTokenRequest
2479
+ # data as a hash:
2480
+ #
2481
+ # {
2482
+ # app_id: "__string", # required
2483
+ # session_id: "__string", # required
2484
+ # }
2485
+ #
2486
+ # @!attribute [rw] app_id
2487
+ # @return [String]
2488
+ #
2489
+ # @!attribute [rw] session_id
2490
+ # @return [String]
2491
+ #
2492
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/GetTokenRequest AWS API Documentation
2493
+ #
2494
+ class GetTokenRequest < Struct.new(
2495
+ :app_id,
2496
+ :session_id)
2497
+ SENSITIVE = []
2498
+ include Aws::Structure
2499
+ end
2500
+
2501
+ # The response object for this operation.
2502
+ #
2503
+ # @!attribute [rw] app_id
2504
+ # The app ID.
2505
+ # @return [String]
2506
+ #
2507
+ # @!attribute [rw] challenge_code
2508
+ # The one time challenge code for authenticating into Amplify Admin
2509
+ # UI.
2510
+ # @return [String]
2511
+ #
2512
+ # @!attribute [rw] session_id
2513
+ # A unique identifier provided when creating a new challenge token.
2514
+ # @return [String]
2515
+ #
2516
+ # @!attribute [rw] ttl
2517
+ # The expiry time for the one time generated token code.
2518
+ # @return [String]
2519
+ #
2520
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/GetTokenRespObj AWS API Documentation
2521
+ #
2522
+ class GetTokenRespObj < Struct.new(
2523
+ :app_id,
2524
+ :challenge_code,
2525
+ :session_id,
2526
+ :ttl)
2527
+ SENSITIVE = []
2528
+ include Aws::Structure
2529
+ end
2530
+
2531
+ # @!attribute [rw] app_id
2532
+ # @return [String]
2533
+ #
2534
+ # @!attribute [rw] challenge_code
2535
+ # @return [String]
2536
+ #
2537
+ # @!attribute [rw] session_id
2538
+ # @return [String]
2539
+ #
2540
+ # @!attribute [rw] ttl
2541
+ # @return [String]
2542
+ #
2543
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/GetTokenResponse AWS API Documentation
2544
+ #
2545
+ class GetTokenResponse < Struct.new(
2546
+ :app_id,
2547
+ :challenge_code,
2548
+ :session_id,
2549
+ :ttl)
2550
+ SENSITIVE = []
2551
+ include Aws::Structure
2552
+ end
2553
+
2554
+ # An error returned if there's a temporary issue with the service.
2555
+ #
2556
+ # @!attribute [rw] message
2557
+ # An error message to inform that the request has failed.
2558
+ # @return [String]
2559
+ #
2560
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/InternalServiceException AWS API Documentation
2561
+ #
2562
+ class InternalServiceException < Struct.new(
2563
+ :message)
2564
+ SENSITIVE = []
2565
+ include Aws::Structure
2566
+ end
2567
+
2568
+ # An error that is returned when a limit of a specific type has been
2569
+ # exceeded.
2570
+ #
2571
+ # @!attribute [rw] limit_type
2572
+ # The type of limit that was exceeded.
2573
+ # @return [String]
2574
+ #
2575
+ # @!attribute [rw] message
2576
+ # An error message to inform that the request has failed.
2577
+ # @return [String]
2578
+ #
2579
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/LimitExceededException AWS API Documentation
2580
+ #
2581
+ class LimitExceededException < Struct.new(
2582
+ :limit_type,
2583
+ :message)
2584
+ SENSITIVE = []
2585
+ include Aws::Structure
2586
+ end
2587
+
2588
+ # The request object for this operation.
2589
+ #
2590
+ # @!attribute [rw] job_id
2591
+ # The ID for the job.
2592
+ # @return [String]
2593
+ #
2594
+ # @!attribute [rw] max_results
2595
+ # The maximum number of results you want in the response.
2596
+ # @return [Integer]
2597
+ #
2598
+ # @!attribute [rw] next_token
2599
+ # The token for the next set of results.
2600
+ # @return [String]
2601
+ #
2602
+ # @!attribute [rw] operation
2603
+ # Filters the list of response objects to only include those with the
2604
+ # specified operation name.
2605
+ # @return [String]
2606
+ #
2607
+ # @!attribute [rw] status
2608
+ # Filters the list of response objects to only include those with the
2609
+ # specified status.
2610
+ # @return [String]
2611
+ #
2612
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/ListBackendJobReqObj AWS API Documentation
2613
+ #
2614
+ class ListBackendJobReqObj < Struct.new(
2615
+ :job_id,
2616
+ :max_results,
2617
+ :next_token,
2618
+ :operation,
2619
+ :status)
2620
+ SENSITIVE = []
2621
+ include Aws::Structure
2622
+ end
2623
+
2624
+ # The returned list of backend jobs.
2625
+ #
2626
+ # @!attribute [rw] jobs
2627
+ # An array of jobs and their properties.
2628
+ # @return [Array<Types::BackendJobRespObj>]
2629
+ #
2630
+ # @!attribute [rw] next_token
2631
+ # The token for the next set of results.
2632
+ # @return [String]
2633
+ #
2634
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/ListBackendJobRespObj AWS API Documentation
2635
+ #
2636
+ class ListBackendJobRespObj < Struct.new(
2637
+ :jobs,
2638
+ :next_token)
2639
+ SENSITIVE = []
2640
+ include Aws::Structure
2641
+ end
2642
+
2643
+ # @note When making an API call, you may pass ListBackendJobsRequest
2644
+ # data as a hash:
2645
+ #
2646
+ # {
2647
+ # app_id: "__string", # required
2648
+ # backend_environment_name: "__string", # required
2649
+ # job_id: "__string",
2650
+ # max_results: 1,
2651
+ # next_token: "__string",
2652
+ # operation: "__string",
2653
+ # status: "__string",
2654
+ # }
2655
+ #
2656
+ # @!attribute [rw] app_id
2657
+ # @return [String]
2658
+ #
2659
+ # @!attribute [rw] backend_environment_name
2660
+ # @return [String]
2661
+ #
2662
+ # @!attribute [rw] job_id
2663
+ # @return [String]
2664
+ #
2665
+ # @!attribute [rw] max_results
2666
+ # @return [Integer]
2667
+ #
2668
+ # @!attribute [rw] next_token
2669
+ # @return [String]
2670
+ #
2671
+ # @!attribute [rw] operation
2672
+ # @return [String]
2673
+ #
2674
+ # @!attribute [rw] status
2675
+ # @return [String]
2676
+ #
2677
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/ListBackendJobsRequest AWS API Documentation
2678
+ #
2679
+ class ListBackendJobsRequest < Struct.new(
2680
+ :app_id,
2681
+ :backend_environment_name,
2682
+ :job_id,
2683
+ :max_results,
2684
+ :next_token,
2685
+ :operation,
2686
+ :status)
2687
+ SENSITIVE = []
2688
+ include Aws::Structure
2689
+ end
2690
+
2691
+ # @!attribute [rw] jobs
2692
+ # @return [Array<Types::BackendJobRespObj>]
2693
+ #
2694
+ # @!attribute [rw] next_token
2695
+ # @return [String]
2696
+ #
2697
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/ListBackendJobsResponse AWS API Documentation
2698
+ #
2699
+ class ListBackendJobsResponse < Struct.new(
2700
+ :jobs,
2701
+ :next_token)
2702
+ SENSITIVE = []
2703
+ include Aws::Structure
2704
+ end
2705
+
2706
+ # The request object for this operation.
2707
+ #
2708
+ # @note When making an API call, you may pass LoginAuthConfigReqObj
2709
+ # data as a hash:
2710
+ #
2711
+ # {
2712
+ # aws_cognito_identity_pool_id: "__string",
2713
+ # aws_cognito_region: "__string",
2714
+ # aws_user_pools_id: "__string",
2715
+ # aws_user_pools_web_client_id: "__string",
2716
+ # }
2717
+ #
2718
+ # @!attribute [rw] aws_cognito_identity_pool_id
2719
+ # Amazon Cognito identitypool id used for the Amplify Admin UI login
2720
+ # authorization.
2721
+ # @return [String]
2722
+ #
2723
+ # @!attribute [rw] aws_cognito_region
2724
+ # The AWS Region for the the Amplify Admin login.
2725
+ # @return [String]
2726
+ #
2727
+ # @!attribute [rw] aws_user_pools_id
2728
+ # The Amazon Cognito userpool id used for Amplify Admin UI login
2729
+ # authentication.
2730
+ # @return [String]
2731
+ #
2732
+ # @!attribute [rw] aws_user_pools_web_client_id
2733
+ # The web client ID for the Amazon Cognito userpools.
2734
+ # @return [String]
2735
+ #
2736
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/LoginAuthConfigReqObj AWS API Documentation
2737
+ #
2738
+ class LoginAuthConfigReqObj < Struct.new(
2739
+ :aws_cognito_identity_pool_id,
2740
+ :aws_cognito_region,
2741
+ :aws_user_pools_id,
2742
+ :aws_user_pools_web_client_id)
2743
+ SENSITIVE = []
2744
+ include Aws::Structure
2745
+ end
2746
+
2747
+ # An error returned when a specific resource type is not found.
2748
+ #
2749
+ # @!attribute [rw] message
2750
+ # An error message to inform that the request has failed.
2751
+ # @return [String]
2752
+ #
2753
+ # @!attribute [rw] resource_type
2754
+ # The type of resource that wasn't found.
2755
+ # @return [String]
2756
+ #
2757
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/NotFoundException AWS API Documentation
2758
+ #
2759
+ class NotFoundException < Struct.new(
2760
+ :message,
2761
+ :resource_type)
2762
+ SENSITIVE = []
2763
+ include Aws::Structure
2764
+ end
2765
+
2766
+ # The request object for this operation.
2767
+ #
2768
+ # @!attribute [rw] clean_amplify_app
2769
+ # Cleans up the Amplify Console app if this value is set to true.
2770
+ # @return [Boolean]
2771
+ #
2772
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/RemoveAllBackendsReqObj AWS API Documentation
2773
+ #
2774
+ class RemoveAllBackendsReqObj < Struct.new(
2775
+ :clean_amplify_app)
2776
+ SENSITIVE = []
2777
+ include Aws::Structure
2778
+ end
2779
+
2780
+ # @note When making an API call, you may pass RemoveAllBackendsRequest
2781
+ # data as a hash:
2782
+ #
2783
+ # {
2784
+ # app_id: "__string", # required
2785
+ # clean_amplify_app: false,
2786
+ # }
2787
+ #
2788
+ # @!attribute [rw] app_id
2789
+ # @return [String]
2790
+ #
2791
+ # @!attribute [rw] clean_amplify_app
2792
+ # @return [Boolean]
2793
+ #
2794
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/RemoveAllBackendsRequest AWS API Documentation
2795
+ #
2796
+ class RemoveAllBackendsRequest < Struct.new(
2797
+ :app_id,
2798
+ :clean_amplify_app)
2799
+ SENSITIVE = []
2800
+ include Aws::Structure
2801
+ end
2802
+
2803
+ # The response object for this operation.
2804
+ #
2805
+ # @!attribute [rw] app_id
2806
+ # The app ID.
2807
+ # @return [String]
2808
+ #
2809
+ # @!attribute [rw] error
2810
+ # If the request failed, this is the returned error.
2811
+ # @return [String]
2812
+ #
2813
+ # @!attribute [rw] job_id
2814
+ # The ID for the job.
2815
+ # @return [String]
2816
+ #
2817
+ # @!attribute [rw] operation
2818
+ # The name of the operation.
2819
+ # @return [String]
2820
+ #
2821
+ # @!attribute [rw] status
2822
+ # The current status of the request.
2823
+ # @return [String]
2824
+ #
2825
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/RemoveAllBackendsRespObj AWS API Documentation
2826
+ #
2827
+ class RemoveAllBackendsRespObj < Struct.new(
2828
+ :app_id,
2829
+ :error,
2830
+ :job_id,
2831
+ :operation,
2832
+ :status)
2833
+ SENSITIVE = []
2834
+ include Aws::Structure
2835
+ end
2836
+
2837
+ # @!attribute [rw] app_id
2838
+ # @return [String]
2839
+ #
2840
+ # @!attribute [rw] error
2841
+ # @return [String]
2842
+ #
2843
+ # @!attribute [rw] job_id
2844
+ # @return [String]
2845
+ #
2846
+ # @!attribute [rw] operation
2847
+ # @return [String]
2848
+ #
2849
+ # @!attribute [rw] status
2850
+ # @return [String]
2851
+ #
2852
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/RemoveAllBackendsResponse AWS API Documentation
2853
+ #
2854
+ class RemoveAllBackendsResponse < Struct.new(
2855
+ :app_id,
2856
+ :error,
2857
+ :job_id,
2858
+ :operation,
2859
+ :status)
2860
+ SENSITIVE = []
2861
+ include Aws::Structure
2862
+ end
2863
+
2864
+ # The request object for this operation.
2865
+ #
2866
+ # @!attribute [rw] resource_name
2867
+ # The name of this resource.
2868
+ # @return [String]
2869
+ #
2870
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/RemoveBackendAuthReqObj AWS API Documentation
2871
+ #
2872
+ class RemoveBackendAuthReqObj < Struct.new(
2873
+ :resource_name)
2874
+ SENSITIVE = []
2875
+ include Aws::Structure
2876
+ end
2877
+
2878
+ # @note When making an API call, you may pass RemoveBackendConfigRequest
2879
+ # data as a hash:
2880
+ #
2881
+ # {
2882
+ # app_id: "__string", # required
2883
+ # }
2884
+ #
2885
+ # @!attribute [rw] app_id
2886
+ # @return [String]
2887
+ #
2888
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/RemoveBackendConfigRequest AWS API Documentation
2889
+ #
2890
+ class RemoveBackendConfigRequest < Struct.new(
2891
+ :app_id)
2892
+ SENSITIVE = []
2893
+ include Aws::Structure
2894
+ end
2895
+
2896
+ # The response object for this operation.
2897
+ #
2898
+ # @!attribute [rw] error
2899
+ # If the request failed, this is the returned error.
2900
+ # @return [String]
2901
+ #
2902
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/RemoveBackendConfigRespObj AWS API Documentation
2903
+ #
2904
+ class RemoveBackendConfigRespObj < Struct.new(
2905
+ :error)
2906
+ SENSITIVE = []
2907
+ include Aws::Structure
2908
+ end
2909
+
2910
+ # @!attribute [rw] error
2911
+ # @return [String]
2912
+ #
2913
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/RemoveBackendConfigResponse AWS API Documentation
2914
+ #
2915
+ class RemoveBackendConfigResponse < Struct.new(
2916
+ :error)
2917
+ SENSITIVE = []
2918
+ include Aws::Structure
2919
+ end
2920
+
2921
+ # @api private
2922
+ #
2923
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/ResourceConfig AWS API Documentation
2924
+ #
2925
+ class ResourceConfig < Aws::EmptyStructure; end
2926
+
2927
+ # @note When making an API call, you may pass Settings
2928
+ # data as a hash:
2929
+ #
2930
+ # {
2931
+ # mfa_types: ["SMS"], # accepts SMS, TOTP
2932
+ # sms_message: "__string",
2933
+ # }
2934
+ #
2935
+ # @!attribute [rw] mfa_types
2936
+ # @return [Array<String>]
2937
+ #
2938
+ # @!attribute [rw] sms_message
2939
+ # The body of the SMS message.
2940
+ # @return [String]
2941
+ #
2942
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/Settings AWS API Documentation
2943
+ #
2944
+ class Settings < Struct.new(
2945
+ :mfa_types,
2946
+ :sms_message)
2947
+ SENSITIVE = []
2948
+ include Aws::Structure
2949
+ end
2950
+
2951
+ # @note When making an API call, you may pass SmsSettings
2952
+ # data as a hash:
2953
+ #
2954
+ # {
2955
+ # sms_message: "__string",
2956
+ # }
2957
+ #
2958
+ # @!attribute [rw] sms_message
2959
+ # The body of the SMS message.
2960
+ # @return [String]
2961
+ #
2962
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/SmsSettings AWS API Documentation
2963
+ #
2964
+ class SmsSettings < Struct.new(
2965
+ :sms_message)
2966
+ SENSITIVE = []
2967
+ include Aws::Structure
2968
+ end
2969
+
2970
+ # @note When making an API call, you may pass SocialProviderSettings
2971
+ # data as a hash:
2972
+ #
2973
+ # {
2974
+ # facebook: {
2975
+ # client_id: "__string",
2976
+ # client_secret: "__string",
2977
+ # },
2978
+ # google: {
2979
+ # client_id: "__string",
2980
+ # client_secret: "__string",
2981
+ # },
2982
+ # login_with_amazon: {
2983
+ # client_id: "__string",
2984
+ # client_secret: "__string",
2985
+ # },
2986
+ # }
2987
+ #
2988
+ # @!attribute [rw] facebook
2989
+ # Describes third party social federation configurations for allowing
2990
+ # your app users to sign in using OAuth.
2991
+ # @return [Types::BackendAuthSocialProviderConfig]
2992
+ #
2993
+ # @!attribute [rw] google
2994
+ # Describes third party social federation configurations for allowing
2995
+ # your app users to sign in using OAuth.
2996
+ # @return [Types::BackendAuthSocialProviderConfig]
2997
+ #
2998
+ # @!attribute [rw] login_with_amazon
2999
+ # Describes third party social federation configurations for allowing
3000
+ # your app users to sign in using OAuth.
3001
+ # @return [Types::BackendAuthSocialProviderConfig]
3002
+ #
3003
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/SocialProviderSettings AWS API Documentation
3004
+ #
3005
+ class SocialProviderSettings < Struct.new(
3006
+ :facebook,
3007
+ :google,
3008
+ :login_with_amazon)
3009
+ SENSITIVE = []
3010
+ include Aws::Structure
3011
+ end
3012
+
3013
+ # An error that is returned when a limit of a specific type has been
3014
+ # exceeded.
3015
+ #
3016
+ # @!attribute [rw] limit_type
3017
+ # @return [String]
3018
+ #
3019
+ # @!attribute [rw] message
3020
+ # @return [String]
3021
+ #
3022
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/TooManyRequestsException AWS API Documentation
3023
+ #
3024
+ class TooManyRequestsException < Struct.new(
3025
+ :limit_type,
3026
+ :message)
3027
+ SENSITIVE = []
3028
+ include Aws::Structure
3029
+ end
3030
+
3031
+ # @note When making an API call, you may pass UpdateBackendAPIRequest
3032
+ # data as a hash:
3033
+ #
3034
+ # {
3035
+ # app_id: "__string", # required
3036
+ # backend_environment_name: "__string", # required
3037
+ # resource_config: {
3038
+ # additional_auth_types: [
3039
+ # {
3040
+ # mode: "API_KEY", # accepts API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT
3041
+ # settings: {
3042
+ # cognito_user_pool_id: "__string",
3043
+ # description: "__string",
3044
+ # expiration_time: 1.0,
3045
+ # open_id_auth_ttl: "__string",
3046
+ # open_id_client_id: "__string",
3047
+ # open_id_iat_ttl: "__string",
3048
+ # open_id_issue_url: "__string",
3049
+ # open_id_provider_name: "__string",
3050
+ # },
3051
+ # },
3052
+ # ],
3053
+ # api_name: "__string",
3054
+ # conflict_resolution: {
3055
+ # resolution_strategy: "OPTIMISTIC_CONCURRENCY", # accepts OPTIMISTIC_CONCURRENCY, LAMBDA, AUTOMERGE, NONE
3056
+ # },
3057
+ # default_auth_type: {
3058
+ # mode: "API_KEY", # accepts API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT
3059
+ # settings: {
3060
+ # cognito_user_pool_id: "__string",
3061
+ # description: "__string",
3062
+ # expiration_time: 1.0,
3063
+ # open_id_auth_ttl: "__string",
3064
+ # open_id_client_id: "__string",
3065
+ # open_id_iat_ttl: "__string",
3066
+ # open_id_issue_url: "__string",
3067
+ # open_id_provider_name: "__string",
3068
+ # },
3069
+ # },
3070
+ # service: "__string",
3071
+ # transform_schema: "__string",
3072
+ # },
3073
+ # resource_name: "__string", # required
3074
+ # }
3075
+ #
3076
+ # @!attribute [rw] app_id
3077
+ # @return [String]
3078
+ #
3079
+ # @!attribute [rw] backend_environment_name
3080
+ # @return [String]
3081
+ #
3082
+ # @!attribute [rw] resource_config
3083
+ # The resource config for the data model,configured as a part of the
3084
+ # Amplify project.
3085
+ # @return [Types::BackendAPIResourceConfig]
3086
+ #
3087
+ # @!attribute [rw] resource_name
3088
+ # @return [String]
3089
+ #
3090
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/UpdateBackendAPIRequest AWS API Documentation
3091
+ #
3092
+ class UpdateBackendAPIRequest < Struct.new(
3093
+ :app_id,
3094
+ :backend_environment_name,
3095
+ :resource_config,
3096
+ :resource_name)
3097
+ SENSITIVE = []
3098
+ include Aws::Structure
3099
+ end
3100
+
3101
+ # @!attribute [rw] app_id
3102
+ # @return [String]
3103
+ #
3104
+ # @!attribute [rw] backend_environment_name
3105
+ # @return [String]
3106
+ #
3107
+ # @!attribute [rw] error
3108
+ # @return [String]
3109
+ #
3110
+ # @!attribute [rw] job_id
3111
+ # @return [String]
3112
+ #
3113
+ # @!attribute [rw] operation
3114
+ # @return [String]
3115
+ #
3116
+ # @!attribute [rw] status
3117
+ # @return [String]
3118
+ #
3119
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/UpdateBackendAPIResponse AWS API Documentation
3120
+ #
3121
+ class UpdateBackendAPIResponse < Struct.new(
3122
+ :app_id,
3123
+ :backend_environment_name,
3124
+ :error,
3125
+ :job_id,
3126
+ :operation,
3127
+ :status)
3128
+ SENSITIVE = []
3129
+ include Aws::Structure
3130
+ end
3131
+
3132
+ # Describes the forgot password policy for authenticating into the
3133
+ # Amlify app.
3134
+ #
3135
+ # @note When making an API call, you may pass UpdateBackendAuthForgotPasswordConfig
3136
+ # data as a hash:
3137
+ #
3138
+ # {
3139
+ # delivery_method: "EMAIL", # accepts EMAIL, SMS
3140
+ # email_settings: {
3141
+ # email_message: "__string",
3142
+ # email_subject: "__string",
3143
+ # },
3144
+ # sms_settings: {
3145
+ # sms_message: "__string",
3146
+ # },
3147
+ # }
3148
+ #
3149
+ # @!attribute [rw] delivery_method
3150
+ # Describes which mode to use (either SMS or email) to deliver
3151
+ # messages to app users that want to recover their password.
3152
+ # @return [String]
3153
+ #
3154
+ # @!attribute [rw] email_settings
3155
+ # The configuration for the email sent when an app user forgets their
3156
+ # password.
3157
+ # @return [Types::EmailSettings]
3158
+ #
3159
+ # @!attribute [rw] sms_settings
3160
+ # The configuration for the SMS message sent when an Amplify app user
3161
+ # forgets their password.
3162
+ # @return [Types::SmsSettings]
3163
+ #
3164
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/UpdateBackendAuthForgotPasswordConfig AWS API Documentation
3165
+ #
3166
+ class UpdateBackendAuthForgotPasswordConfig < Struct.new(
3167
+ :delivery_method,
3168
+ :email_settings,
3169
+ :sms_settings)
3170
+ SENSITIVE = []
3171
+ include Aws::Structure
3172
+ end
3173
+
3174
+ # Describes the authorization configuration for the Amazon Cognito
3175
+ # identity pool, provisioned as a part of your auth resource in the
3176
+ # Amplify project.
3177
+ #
3178
+ # @note When making an API call, you may pass UpdateBackendAuthIdentityPoolConfig
3179
+ # data as a hash:
3180
+ #
3181
+ # {
3182
+ # unauthenticated_login: false,
3183
+ # }
3184
+ #
3185
+ # @!attribute [rw] unauthenticated_login
3186
+ # A boolean value which can be set to allow or disallow guest level
3187
+ # authorization into your Amplify app.
3188
+ # @return [Boolean]
3189
+ #
3190
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/UpdateBackendAuthIdentityPoolConfig AWS API Documentation
3191
+ #
3192
+ class UpdateBackendAuthIdentityPoolConfig < Struct.new(
3193
+ :unauthenticated_login)
3194
+ SENSITIVE = []
3195
+ include Aws::Structure
3196
+ end
3197
+
3198
+ # Updates the multi-factor authentication (MFA) configuration for the
3199
+ # backend of your Amplify project.
3200
+ #
3201
+ # @note When making an API call, you may pass UpdateBackendAuthMFAConfig
3202
+ # data as a hash:
3203
+ #
3204
+ # {
3205
+ # mfa_mode: "ON", # accepts ON, OFF, OPTIONAL
3206
+ # settings: {
3207
+ # mfa_types: ["SMS"], # accepts SMS, TOTP
3208
+ # sms_message: "__string",
3209
+ # },
3210
+ # }
3211
+ #
3212
+ # @!attribute [rw] mfa_mode
3213
+ # The MFA mode for the backend of your Amplify project.
3214
+ # @return [String]
3215
+ #
3216
+ # @!attribute [rw] settings
3217
+ # The settings of your MFA configuration for the backend of your
3218
+ # Amplify project.
3219
+ # @return [Types::Settings]
3220
+ #
3221
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/UpdateBackendAuthMFAConfig AWS API Documentation
3222
+ #
3223
+ class UpdateBackendAuthMFAConfig < Struct.new(
3224
+ :mfa_mode,
3225
+ :settings)
3226
+ SENSITIVE = []
3227
+ include Aws::Structure
3228
+ end
3229
+
3230
+ # The OAuth configurations for authenticating users into your Amplify
3231
+ # app.
3232
+ #
3233
+ # @note When making an API call, you may pass UpdateBackendAuthOAuthConfig
3234
+ # data as a hash:
3235
+ #
3236
+ # {
3237
+ # domain_prefix: "__string",
3238
+ # o_auth_grant_type: "CODE", # accepts CODE, IMPLICIT
3239
+ # o_auth_scopes: ["PHONE"], # accepts PHONE, EMAIL, OPENID, PROFILE, AWS_COGNITO_SIGNIN_USER_ADMIN
3240
+ # redirect_sign_in_ur_is: ["__string"],
3241
+ # redirect_sign_out_ur_is: ["__string"],
3242
+ # social_provider_settings: {
3243
+ # facebook: {
3244
+ # client_id: "__string",
3245
+ # client_secret: "__string",
3246
+ # },
3247
+ # google: {
3248
+ # client_id: "__string",
3249
+ # client_secret: "__string",
3250
+ # },
3251
+ # login_with_amazon: {
3252
+ # client_id: "__string",
3253
+ # client_secret: "__string",
3254
+ # },
3255
+ # },
3256
+ # }
3257
+ #
3258
+ # @!attribute [rw] domain_prefix
3259
+ # The Amazon Cognito domain prefix used to create a hosted UI for
3260
+ # authentication.
3261
+ # @return [String]
3262
+ #
3263
+ # @!attribute [rw] o_auth_grant_type
3264
+ # The OAuth grant type to allow app users to authenticate from your
3265
+ # Amplify app.
3266
+ # @return [String]
3267
+ #
3268
+ # @!attribute [rw] o_auth_scopes
3269
+ # The list of OAuth related flows which can allow users to
3270
+ # authenticate from your Amplify app.
3271
+ # @return [Array<String>]
3272
+ #
3273
+ # @!attribute [rw] redirect_sign_in_ur_is
3274
+ # Redirect URLs used by OAuth when a user signs in to an Amplify app.
3275
+ # @return [Array<String>]
3276
+ #
3277
+ # @!attribute [rw] redirect_sign_out_ur_is
3278
+ # Redirect URLs used by OAuth when a user signs out of an Amplify app.
3279
+ # @return [Array<String>]
3280
+ #
3281
+ # @!attribute [rw] social_provider_settings
3282
+ # Describes third party social federation configurations for allowing
3283
+ # your users to sign in with OAuth.
3284
+ # @return [Types::SocialProviderSettings]
3285
+ #
3286
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/UpdateBackendAuthOAuthConfig AWS API Documentation
3287
+ #
3288
+ class UpdateBackendAuthOAuthConfig < Struct.new(
3289
+ :domain_prefix,
3290
+ :o_auth_grant_type,
3291
+ :o_auth_scopes,
3292
+ :redirect_sign_in_ur_is,
3293
+ :redirect_sign_out_ur_is,
3294
+ :social_provider_settings)
3295
+ SENSITIVE = []
3296
+ include Aws::Structure
3297
+ end
3298
+
3299
+ # Describes the password policy for your Amazon Cognito user pool
3300
+ # configured as a part of your Amplify project.
3301
+ #
3302
+ # @note When making an API call, you may pass UpdateBackendAuthPasswordPolicyConfig
3303
+ # data as a hash:
3304
+ #
3305
+ # {
3306
+ # additional_constraints: ["REQUIRE_DIGIT"], # accepts REQUIRE_DIGIT, REQUIRE_LOWERCASE, REQUIRE_SYMBOL, REQUIRE_UPPERCASE
3307
+ # minimum_length: 1.0,
3308
+ # }
3309
+ #
3310
+ # @!attribute [rw] additional_constraints
3311
+ # Describes additional constrains on password requirements to sign in
3312
+ # into the auth resource, configured as a part of your Ampify project.
3313
+ # @return [Array<String>]
3314
+ #
3315
+ # @!attribute [rw] minimum_length
3316
+ # Describes the minimum length of password required to sign in into
3317
+ # the auth resource, configured as a part of your Ampify project.
3318
+ # @return [Float]
3319
+ #
3320
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/UpdateBackendAuthPasswordPolicyConfig AWS API Documentation
3321
+ #
3322
+ class UpdateBackendAuthPasswordPolicyConfig < Struct.new(
3323
+ :additional_constraints,
3324
+ :minimum_length)
3325
+ SENSITIVE = []
3326
+ include Aws::Structure
3327
+ end
3328
+
3329
+ # The request object for this operation.
3330
+ #
3331
+ # @!attribute [rw] resource_config
3332
+ # The resource configuration for this request object.
3333
+ # @return [Types::UpdateBackendAuthResourceConfig]
3334
+ #
3335
+ # @!attribute [rw] resource_name
3336
+ # The name of this resource.
3337
+ # @return [String]
3338
+ #
3339
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/UpdateBackendAuthReqObj AWS API Documentation
3340
+ #
3341
+ class UpdateBackendAuthReqObj < Struct.new(
3342
+ :resource_config,
3343
+ :resource_name)
3344
+ SENSITIVE = []
3345
+ include Aws::Structure
3346
+ end
3347
+
3348
+ # @note When making an API call, you may pass UpdateBackendAuthRequest
3349
+ # data as a hash:
3350
+ #
3351
+ # {
3352
+ # app_id: "__string", # required
3353
+ # backend_environment_name: "__string", # required
3354
+ # resource_config: { # required
3355
+ # auth_resources: "USER_POOL_ONLY", # required, accepts USER_POOL_ONLY, IDENTITY_POOL_AND_USER_POOL
3356
+ # identity_pool_configs: {
3357
+ # unauthenticated_login: false,
3358
+ # },
3359
+ # service: "COGNITO", # required, accepts COGNITO
3360
+ # user_pool_configs: { # required
3361
+ # forgot_password: {
3362
+ # delivery_method: "EMAIL", # accepts EMAIL, SMS
3363
+ # email_settings: {
3364
+ # email_message: "__string",
3365
+ # email_subject: "__string",
3366
+ # },
3367
+ # sms_settings: {
3368
+ # sms_message: "__string",
3369
+ # },
3370
+ # },
3371
+ # mfa: {
3372
+ # mfa_mode: "ON", # accepts ON, OFF, OPTIONAL
3373
+ # settings: {
3374
+ # mfa_types: ["SMS"], # accepts SMS, TOTP
3375
+ # sms_message: "__string",
3376
+ # },
3377
+ # },
3378
+ # o_auth: {
3379
+ # domain_prefix: "__string",
3380
+ # o_auth_grant_type: "CODE", # accepts CODE, IMPLICIT
3381
+ # o_auth_scopes: ["PHONE"], # accepts PHONE, EMAIL, OPENID, PROFILE, AWS_COGNITO_SIGNIN_USER_ADMIN
3382
+ # redirect_sign_in_ur_is: ["__string"],
3383
+ # redirect_sign_out_ur_is: ["__string"],
3384
+ # social_provider_settings: {
3385
+ # facebook: {
3386
+ # client_id: "__string",
3387
+ # client_secret: "__string",
3388
+ # },
3389
+ # google: {
3390
+ # client_id: "__string",
3391
+ # client_secret: "__string",
3392
+ # },
3393
+ # login_with_amazon: {
3394
+ # client_id: "__string",
3395
+ # client_secret: "__string",
3396
+ # },
3397
+ # },
3398
+ # },
3399
+ # password_policy: {
3400
+ # additional_constraints: ["REQUIRE_DIGIT"], # accepts REQUIRE_DIGIT, REQUIRE_LOWERCASE, REQUIRE_SYMBOL, REQUIRE_UPPERCASE
3401
+ # minimum_length: 1.0,
3402
+ # },
3403
+ # },
3404
+ # },
3405
+ # resource_name: "__string", # required
3406
+ # }
3407
+ #
3408
+ # @!attribute [rw] app_id
3409
+ # @return [String]
3410
+ #
3411
+ # @!attribute [rw] backend_environment_name
3412
+ # @return [String]
3413
+ #
3414
+ # @!attribute [rw] resource_config
3415
+ # Defines the resource configuration when updating an authentication
3416
+ # resource in your Amplify project.
3417
+ # @return [Types::UpdateBackendAuthResourceConfig]
3418
+ #
3419
+ # @!attribute [rw] resource_name
3420
+ # @return [String]
3421
+ #
3422
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/UpdateBackendAuthRequest AWS API Documentation
3423
+ #
3424
+ class UpdateBackendAuthRequest < Struct.new(
3425
+ :app_id,
3426
+ :backend_environment_name,
3427
+ :resource_config,
3428
+ :resource_name)
3429
+ SENSITIVE = []
3430
+ include Aws::Structure
3431
+ end
3432
+
3433
+ # Defines the resource configuration when updating an authentication
3434
+ # resource in your Amplify project.
3435
+ #
3436
+ # @note When making an API call, you may pass UpdateBackendAuthResourceConfig
3437
+ # data as a hash:
3438
+ #
3439
+ # {
3440
+ # auth_resources: "USER_POOL_ONLY", # required, accepts USER_POOL_ONLY, IDENTITY_POOL_AND_USER_POOL
3441
+ # identity_pool_configs: {
3442
+ # unauthenticated_login: false,
3443
+ # },
3444
+ # service: "COGNITO", # required, accepts COGNITO
3445
+ # user_pool_configs: { # required
3446
+ # forgot_password: {
3447
+ # delivery_method: "EMAIL", # accepts EMAIL, SMS
3448
+ # email_settings: {
3449
+ # email_message: "__string",
3450
+ # email_subject: "__string",
3451
+ # },
3452
+ # sms_settings: {
3453
+ # sms_message: "__string",
3454
+ # },
3455
+ # },
3456
+ # mfa: {
3457
+ # mfa_mode: "ON", # accepts ON, OFF, OPTIONAL
3458
+ # settings: {
3459
+ # mfa_types: ["SMS"], # accepts SMS, TOTP
3460
+ # sms_message: "__string",
3461
+ # },
3462
+ # },
3463
+ # o_auth: {
3464
+ # domain_prefix: "__string",
3465
+ # o_auth_grant_type: "CODE", # accepts CODE, IMPLICIT
3466
+ # o_auth_scopes: ["PHONE"], # accepts PHONE, EMAIL, OPENID, PROFILE, AWS_COGNITO_SIGNIN_USER_ADMIN
3467
+ # redirect_sign_in_ur_is: ["__string"],
3468
+ # redirect_sign_out_ur_is: ["__string"],
3469
+ # social_provider_settings: {
3470
+ # facebook: {
3471
+ # client_id: "__string",
3472
+ # client_secret: "__string",
3473
+ # },
3474
+ # google: {
3475
+ # client_id: "__string",
3476
+ # client_secret: "__string",
3477
+ # },
3478
+ # login_with_amazon: {
3479
+ # client_id: "__string",
3480
+ # client_secret: "__string",
3481
+ # },
3482
+ # },
3483
+ # },
3484
+ # password_policy: {
3485
+ # additional_constraints: ["REQUIRE_DIGIT"], # accepts REQUIRE_DIGIT, REQUIRE_LOWERCASE, REQUIRE_SYMBOL, REQUIRE_UPPERCASE
3486
+ # minimum_length: 1.0,
3487
+ # },
3488
+ # },
3489
+ # }
3490
+ #
3491
+ # @!attribute [rw] auth_resources
3492
+ # Defines the service name to use when configuring an authentication
3493
+ # resource in your Amplify project.
3494
+ # @return [String]
3495
+ #
3496
+ # @!attribute [rw] identity_pool_configs
3497
+ # Describes the authorization configuration for the Amazon Cognito
3498
+ # identity pool, provisioned as a part of your auth resource in the
3499
+ # Amplify project.
3500
+ # @return [Types::UpdateBackendAuthIdentityPoolConfig]
3501
+ #
3502
+ # @!attribute [rw] service
3503
+ # Defines the service name to use when configuring an authentication
3504
+ # resource in your Amplify project.
3505
+ # @return [String]
3506
+ #
3507
+ # @!attribute [rw] user_pool_configs
3508
+ # Describes the authentication configuration for the Amazon Cognito
3509
+ # userpool, provisioned as a part of your auth resource in the Amplify
3510
+ # project.
3511
+ # @return [Types::UpdateBackendAuthUserPoolConfig]
3512
+ #
3513
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/UpdateBackendAuthResourceConfig AWS API Documentation
3514
+ #
3515
+ class UpdateBackendAuthResourceConfig < Struct.new(
3516
+ :auth_resources,
3517
+ :identity_pool_configs,
3518
+ :service,
3519
+ :user_pool_configs)
3520
+ SENSITIVE = []
3521
+ include Aws::Structure
3522
+ end
3523
+
3524
+ # @!attribute [rw] app_id
3525
+ # @return [String]
3526
+ #
3527
+ # @!attribute [rw] backend_environment_name
3528
+ # @return [String]
3529
+ #
3530
+ # @!attribute [rw] error
3531
+ # @return [String]
3532
+ #
3533
+ # @!attribute [rw] job_id
3534
+ # @return [String]
3535
+ #
3536
+ # @!attribute [rw] operation
3537
+ # @return [String]
3538
+ #
3539
+ # @!attribute [rw] status
3540
+ # @return [String]
3541
+ #
3542
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/UpdateBackendAuthResponse AWS API Documentation
3543
+ #
3544
+ class UpdateBackendAuthResponse < Struct.new(
3545
+ :app_id,
3546
+ :backend_environment_name,
3547
+ :error,
3548
+ :job_id,
3549
+ :operation,
3550
+ :status)
3551
+ SENSITIVE = []
3552
+ include Aws::Structure
3553
+ end
3554
+
3555
+ # Describes the Amazon Cognito user pool configuration for the
3556
+ # authorization resource to be configured for your Amplify project on an
3557
+ # update.
3558
+ #
3559
+ # @note When making an API call, you may pass UpdateBackendAuthUserPoolConfig
3560
+ # data as a hash:
3561
+ #
3562
+ # {
3563
+ # forgot_password: {
3564
+ # delivery_method: "EMAIL", # accepts EMAIL, SMS
3565
+ # email_settings: {
3566
+ # email_message: "__string",
3567
+ # email_subject: "__string",
3568
+ # },
3569
+ # sms_settings: {
3570
+ # sms_message: "__string",
3571
+ # },
3572
+ # },
3573
+ # mfa: {
3574
+ # mfa_mode: "ON", # accepts ON, OFF, OPTIONAL
3575
+ # settings: {
3576
+ # mfa_types: ["SMS"], # accepts SMS, TOTP
3577
+ # sms_message: "__string",
3578
+ # },
3579
+ # },
3580
+ # o_auth: {
3581
+ # domain_prefix: "__string",
3582
+ # o_auth_grant_type: "CODE", # accepts CODE, IMPLICIT
3583
+ # o_auth_scopes: ["PHONE"], # accepts PHONE, EMAIL, OPENID, PROFILE, AWS_COGNITO_SIGNIN_USER_ADMIN
3584
+ # redirect_sign_in_ur_is: ["__string"],
3585
+ # redirect_sign_out_ur_is: ["__string"],
3586
+ # social_provider_settings: {
3587
+ # facebook: {
3588
+ # client_id: "__string",
3589
+ # client_secret: "__string",
3590
+ # },
3591
+ # google: {
3592
+ # client_id: "__string",
3593
+ # client_secret: "__string",
3594
+ # },
3595
+ # login_with_amazon: {
3596
+ # client_id: "__string",
3597
+ # client_secret: "__string",
3598
+ # },
3599
+ # },
3600
+ # },
3601
+ # password_policy: {
3602
+ # additional_constraints: ["REQUIRE_DIGIT"], # accepts REQUIRE_DIGIT, REQUIRE_LOWERCASE, REQUIRE_SYMBOL, REQUIRE_UPPERCASE
3603
+ # minimum_length: 1.0,
3604
+ # },
3605
+ # }
3606
+ #
3607
+ # @!attribute [rw] forgot_password
3608
+ # Describes the forgot password policy for your Amazon Cognito user
3609
+ # pool, configured as a part of your Amplify project.
3610
+ # @return [Types::UpdateBackendAuthForgotPasswordConfig]
3611
+ #
3612
+ # @!attribute [rw] mfa
3613
+ # Describes whether multi-factor authentication policies should be
3614
+ # applied for your Amazon Cognito user pool configured as a part of
3615
+ # your Amplify project.
3616
+ # @return [Types::UpdateBackendAuthMFAConfig]
3617
+ #
3618
+ # @!attribute [rw] o_auth
3619
+ # Describes the OAuth policy and rules for your Amazon Cognito user
3620
+ # pool, configured as a part of your Amplify project.
3621
+ # @return [Types::UpdateBackendAuthOAuthConfig]
3622
+ #
3623
+ # @!attribute [rw] password_policy
3624
+ # Describes the password policy for your Amazon Cognito user pool,
3625
+ # configured as a part of your Amplify project.
3626
+ # @return [Types::UpdateBackendAuthPasswordPolicyConfig]
3627
+ #
3628
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/UpdateBackendAuthUserPoolConfig AWS API Documentation
3629
+ #
3630
+ class UpdateBackendAuthUserPoolConfig < Struct.new(
3631
+ :forgot_password,
3632
+ :mfa,
3633
+ :o_auth,
3634
+ :password_policy)
3635
+ SENSITIVE = []
3636
+ include Aws::Structure
3637
+ end
3638
+
3639
+ # The request object for this operation.
3640
+ #
3641
+ # @!attribute [rw] login_auth_config
3642
+ # Describes the Amazon Cognito configuration for Admin UI access.
3643
+ # @return [Types::LoginAuthConfigReqObj]
3644
+ #
3645
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/UpdateBackendConfigReqObj AWS API Documentation
3646
+ #
3647
+ class UpdateBackendConfigReqObj < Struct.new(
3648
+ :login_auth_config)
3649
+ SENSITIVE = []
3650
+ include Aws::Structure
3651
+ end
3652
+
3653
+ # @note When making an API call, you may pass UpdateBackendConfigRequest
3654
+ # data as a hash:
3655
+ #
3656
+ # {
3657
+ # app_id: "__string", # required
3658
+ # login_auth_config: {
3659
+ # aws_cognito_identity_pool_id: "__string",
3660
+ # aws_cognito_region: "__string",
3661
+ # aws_user_pools_id: "__string",
3662
+ # aws_user_pools_web_client_id: "__string",
3663
+ # },
3664
+ # }
3665
+ #
3666
+ # @!attribute [rw] app_id
3667
+ # @return [String]
3668
+ #
3669
+ # @!attribute [rw] login_auth_config
3670
+ # The request object for this operation.
3671
+ # @return [Types::LoginAuthConfigReqObj]
3672
+ #
3673
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/UpdateBackendConfigRequest AWS API Documentation
3674
+ #
3675
+ class UpdateBackendConfigRequest < Struct.new(
3676
+ :app_id,
3677
+ :login_auth_config)
3678
+ SENSITIVE = []
3679
+ include Aws::Structure
3680
+ end
3681
+
3682
+ # @!attribute [rw] app_id
3683
+ # @return [String]
3684
+ #
3685
+ # @!attribute [rw] backend_manager_app_id
3686
+ # @return [String]
3687
+ #
3688
+ # @!attribute [rw] error
3689
+ # @return [String]
3690
+ #
3691
+ # @!attribute [rw] login_auth_config
3692
+ # The request object for this operation.
3693
+ # @return [Types::LoginAuthConfigReqObj]
3694
+ #
3695
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/UpdateBackendConfigResponse AWS API Documentation
3696
+ #
3697
+ class UpdateBackendConfigResponse < Struct.new(
3698
+ :app_id,
3699
+ :backend_manager_app_id,
3700
+ :error,
3701
+ :login_auth_config)
3702
+ SENSITIVE = []
3703
+ include Aws::Structure
3704
+ end
3705
+
3706
+ # @note When making an API call, you may pass UpdateBackendJobRequest
3707
+ # data as a hash:
3708
+ #
3709
+ # {
3710
+ # app_id: "__string", # required
3711
+ # backend_environment_name: "__string", # required
3712
+ # job_id: "__string", # required
3713
+ # operation: "__string",
3714
+ # status: "__string",
3715
+ # }
3716
+ #
3717
+ # @!attribute [rw] app_id
3718
+ # @return [String]
3719
+ #
3720
+ # @!attribute [rw] backend_environment_name
3721
+ # @return [String]
3722
+ #
3723
+ # @!attribute [rw] job_id
3724
+ # @return [String]
3725
+ #
3726
+ # @!attribute [rw] operation
3727
+ # @return [String]
3728
+ #
3729
+ # @!attribute [rw] status
3730
+ # @return [String]
3731
+ #
3732
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/UpdateBackendJobRequest AWS API Documentation
3733
+ #
3734
+ class UpdateBackendJobRequest < Struct.new(
3735
+ :app_id,
3736
+ :backend_environment_name,
3737
+ :job_id,
3738
+ :operation,
3739
+ :status)
3740
+ SENSITIVE = []
3741
+ include Aws::Structure
3742
+ end
3743
+
3744
+ # @!attribute [rw] app_id
3745
+ # @return [String]
3746
+ #
3747
+ # @!attribute [rw] backend_environment_name
3748
+ # @return [String]
3749
+ #
3750
+ # @!attribute [rw] create_time
3751
+ # @return [String]
3752
+ #
3753
+ # @!attribute [rw] error
3754
+ # @return [String]
3755
+ #
3756
+ # @!attribute [rw] job_id
3757
+ # @return [String]
3758
+ #
3759
+ # @!attribute [rw] operation
3760
+ # @return [String]
3761
+ #
3762
+ # @!attribute [rw] status
3763
+ # @return [String]
3764
+ #
3765
+ # @!attribute [rw] update_time
3766
+ # @return [String]
3767
+ #
3768
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/UpdateBackendJobResponse AWS API Documentation
3769
+ #
3770
+ class UpdateBackendJobResponse < Struct.new(
3771
+ :app_id,
3772
+ :backend_environment_name,
3773
+ :create_time,
3774
+ :error,
3775
+ :job_id,
3776
+ :operation,
3777
+ :status,
3778
+ :update_time)
3779
+ SENSITIVE = []
3780
+ include Aws::Structure
3781
+ end
3782
+
3783
+ end
3784
+ end