aws-sdk-amplify 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
File without changes
@@ -0,0 +1,14 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws::Amplify
9
+ module Errors
10
+
11
+ extend Aws::Errors::DynamicErrors
12
+
13
+ end
14
+ end
@@ -0,0 +1,23 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws::Amplify
9
+ class Resource
10
+
11
+ # @param options ({})
12
+ # @option options [Client] :client
13
+ def initialize(options = {})
14
+ @client = options[:client] || Client.new(options)
15
+ end
16
+
17
+ # @return [Client]
18
+ def client
19
+ @client
20
+ end
21
+
22
+ end
23
+ end
@@ -0,0 +1,1681 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws::Amplify
9
+ module Types
10
+
11
+ # Amplify App represents different branches of a repository for
12
+ # building, deploying, and hosting.
13
+ #
14
+ # @!attribute [rw] app_id
15
+ # Unique Id for the Amplify App.
16
+ # @return [String]
17
+ #
18
+ # @!attribute [rw] app_arn
19
+ # ARN for the Amplify App.
20
+ # @return [String]
21
+ #
22
+ # @!attribute [rw] name
23
+ # Name for the Amplify App.
24
+ # @return [String]
25
+ #
26
+ # @!attribute [rw] tags
27
+ # Tag for Amplify App.
28
+ # @return [Hash<String,String>]
29
+ #
30
+ # @!attribute [rw] description
31
+ # Description for the Amplify App.
32
+ # @return [String]
33
+ #
34
+ # @!attribute [rw] repository
35
+ # Repository for the Amplify App.
36
+ # @return [String]
37
+ #
38
+ # @!attribute [rw] platform
39
+ # Platform for the Amplify App.
40
+ # @return [String]
41
+ #
42
+ # @!attribute [rw] create_time
43
+ # Create date / time for the Amplify App.
44
+ # @return [Time]
45
+ #
46
+ # @!attribute [rw] update_time
47
+ # Update date / time for the Amplify App.
48
+ # @return [Time]
49
+ #
50
+ # @!attribute [rw] iam_service_role_arn
51
+ # IAM service role ARN for the Amplify App.
52
+ # @return [String]
53
+ #
54
+ # @!attribute [rw] environment_variables
55
+ # Environment Variables for the Amplify App.
56
+ # @return [Hash<String,String>]
57
+ #
58
+ # @!attribute [rw] default_domain
59
+ # Default domain for the Amplify App.
60
+ # @return [String]
61
+ #
62
+ # @!attribute [rw] enable_branch_auto_build
63
+ # Enables auto-building of branches for the Amplify App.
64
+ # @return [Boolean]
65
+ #
66
+ # @!attribute [rw] enable_basic_auth
67
+ # Enables Basic Authorization for branches for the Amplify App.
68
+ # @return [Boolean]
69
+ #
70
+ # @!attribute [rw] basic_auth_credentials
71
+ # Basic Authorization credentials for branches for the Amplify App.
72
+ # @return [String]
73
+ #
74
+ # @!attribute [rw] custom_rules
75
+ # Custom redirect / rewrite rules for the Amplify App.
76
+ # @return [Array<Types::CustomRule>]
77
+ #
78
+ # @!attribute [rw] production_branch
79
+ # Structure with Production Branch information.
80
+ # @return [Types::ProductionBranch]
81
+ #
82
+ # @!attribute [rw] build_spec
83
+ # BuildSpec content for Amplify App.
84
+ # @return [String]
85
+ #
86
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/App AWS API Documentation
87
+ #
88
+ class App < Struct.new(
89
+ :app_id,
90
+ :app_arn,
91
+ :name,
92
+ :tags,
93
+ :description,
94
+ :repository,
95
+ :platform,
96
+ :create_time,
97
+ :update_time,
98
+ :iam_service_role_arn,
99
+ :environment_variables,
100
+ :default_domain,
101
+ :enable_branch_auto_build,
102
+ :enable_basic_auth,
103
+ :basic_auth_credentials,
104
+ :custom_rules,
105
+ :production_branch,
106
+ :build_spec)
107
+ include Aws::Structure
108
+ end
109
+
110
+ # Branch for an Amplify App, which maps to a 3rd party repository
111
+ # branch.
112
+ #
113
+ # @!attribute [rw] branch_arn
114
+ # ARN for a branch, part of an Amplify App.
115
+ # @return [String]
116
+ #
117
+ # @!attribute [rw] branch_name
118
+ # Name for a branch, part of an Amplify App.
119
+ # @return [String]
120
+ #
121
+ # @!attribute [rw] description
122
+ # Description for a branch, part of an Amplify App.
123
+ # @return [String]
124
+ #
125
+ # @!attribute [rw] tags
126
+ # Tag for branch for Amplify App.
127
+ # @return [Hash<String,String>]
128
+ #
129
+ # @!attribute [rw] stage
130
+ # Stage for a branch, part of an Amplify App.
131
+ # @return [String]
132
+ #
133
+ # @!attribute [rw] display_name
134
+ # Display name for a branch, part of an Amplify App.
135
+ # @return [String]
136
+ #
137
+ # @!attribute [rw] enable_notification
138
+ # Enables notifications for a branch, part of an Amplify App.
139
+ # @return [Boolean]
140
+ #
141
+ # @!attribute [rw] create_time
142
+ # Creation date and time for a branch, part of an Amplify App.
143
+ # @return [Time]
144
+ #
145
+ # @!attribute [rw] update_time
146
+ # Last updated date and time for a branch, part of an Amplify App.
147
+ # @return [Time]
148
+ #
149
+ # @!attribute [rw] environment_variables
150
+ # Environment Variables specific to a branch, part of an Amplify App.
151
+ # @return [Hash<String,String>]
152
+ #
153
+ # @!attribute [rw] enable_auto_build
154
+ # Enables auto-building on push for a branch, part of an Amplify App.
155
+ # @return [Boolean]
156
+ #
157
+ # @!attribute [rw] custom_domains
158
+ # Custom domains for a branch, part of an Amplify App.
159
+ # @return [Array<String>]
160
+ #
161
+ # @!attribute [rw] framework
162
+ # Framework for a branch, part of an Amplify App.
163
+ # @return [String]
164
+ #
165
+ # @!attribute [rw] active_job_id
166
+ # Id of the active job for a branch, part of an Amplify App.
167
+ # @return [String]
168
+ #
169
+ # @!attribute [rw] total_number_of_jobs
170
+ # Total number of Jobs part of an Amplify App.
171
+ # @return [String]
172
+ #
173
+ # @!attribute [rw] enable_basic_auth
174
+ # Enables Basic Authorization for a branch, part of an Amplify App.
175
+ # @return [Boolean]
176
+ #
177
+ # @!attribute [rw] thumbnail_url
178
+ # Thumbnail Url for the branch.
179
+ # @return [String]
180
+ #
181
+ # @!attribute [rw] basic_auth_credentials
182
+ # Basic Authorization credentials for a branch, part of an Amplify
183
+ # App.
184
+ # @return [String]
185
+ #
186
+ # @!attribute [rw] build_spec
187
+ # BuildSpec content for branch for Amplify App.
188
+ # @return [String]
189
+ #
190
+ # @!attribute [rw] ttl
191
+ # The content TTL for the website in seconds.
192
+ # @return [String]
193
+ #
194
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/Branch AWS API Documentation
195
+ #
196
+ class Branch < Struct.new(
197
+ :branch_arn,
198
+ :branch_name,
199
+ :description,
200
+ :tags,
201
+ :stage,
202
+ :display_name,
203
+ :enable_notification,
204
+ :create_time,
205
+ :update_time,
206
+ :environment_variables,
207
+ :enable_auto_build,
208
+ :custom_domains,
209
+ :framework,
210
+ :active_job_id,
211
+ :total_number_of_jobs,
212
+ :enable_basic_auth,
213
+ :thumbnail_url,
214
+ :basic_auth_credentials,
215
+ :build_spec,
216
+ :ttl)
217
+ include Aws::Structure
218
+ end
219
+
220
+ # Request structure used to create Apps in Amplify.
221
+ #
222
+ # @note When making an API call, you may pass CreateAppRequest
223
+ # data as a hash:
224
+ #
225
+ # {
226
+ # name: "Name", # required
227
+ # description: "Description",
228
+ # repository: "Repository", # required
229
+ # platform: "IOS", # required, accepts IOS, ANDROID, WEB, REACT_NATIVE
230
+ # iam_service_role_arn: "ServiceRoleArn",
231
+ # oauth_token: "OauthToken", # required
232
+ # environment_variables: {
233
+ # "EnvKey" => "EnvValue",
234
+ # },
235
+ # enable_branch_auto_build: false,
236
+ # enable_basic_auth: false,
237
+ # basic_auth_credentials: "BasicAuthCredentials",
238
+ # custom_rules: [
239
+ # {
240
+ # source: "Source", # required
241
+ # target: "Target", # required
242
+ # status: "Status",
243
+ # condition: "Condition",
244
+ # },
245
+ # ],
246
+ # tags: {
247
+ # "TagKey" => "TagValue",
248
+ # },
249
+ # build_spec: "BuildSpec",
250
+ # }
251
+ #
252
+ # @!attribute [rw] name
253
+ # Name for the Amplify App
254
+ # @return [String]
255
+ #
256
+ # @!attribute [rw] description
257
+ # Description for an Amplify App
258
+ # @return [String]
259
+ #
260
+ # @!attribute [rw] repository
261
+ # Repository for an Amplify App
262
+ # @return [String]
263
+ #
264
+ # @!attribute [rw] platform
265
+ # Platform / framework for an Amplify App
266
+ # @return [String]
267
+ #
268
+ # @!attribute [rw] iam_service_role_arn
269
+ # AWS IAM service role for an Amplify App
270
+ # @return [String]
271
+ #
272
+ # @!attribute [rw] oauth_token
273
+ # OAuth token for 3rd party source control system for an Amplify App,
274
+ # used to create webhook and read-only deploy key. OAuth token is not
275
+ # stored.
276
+ # @return [String]
277
+ #
278
+ # @!attribute [rw] environment_variables
279
+ # Environment variables map for an Amplify App.
280
+ # @return [Hash<String,String>]
281
+ #
282
+ # @!attribute [rw] enable_branch_auto_build
283
+ # Enable the auto building of branches for an Amplify App.
284
+ # @return [Boolean]
285
+ #
286
+ # @!attribute [rw] enable_basic_auth
287
+ # Enable Basic Authorization for an Amplify App, this will apply to
288
+ # all branches part of this App.
289
+ # @return [Boolean]
290
+ #
291
+ # @!attribute [rw] basic_auth_credentials
292
+ # Credentials for Basic Authorization for an Amplify App.
293
+ # @return [String]
294
+ #
295
+ # @!attribute [rw] custom_rules
296
+ # Custom rewrite / redirect rules for an Amplify App.
297
+ # @return [Array<Types::CustomRule>]
298
+ #
299
+ # @!attribute [rw] tags
300
+ # Tag for an Amplify App
301
+ # @return [Hash<String,String>]
302
+ #
303
+ # @!attribute [rw] build_spec
304
+ # BuildSpec for an Amplify App
305
+ # @return [String]
306
+ #
307
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/CreateAppRequest AWS API Documentation
308
+ #
309
+ class CreateAppRequest < Struct.new(
310
+ :name,
311
+ :description,
312
+ :repository,
313
+ :platform,
314
+ :iam_service_role_arn,
315
+ :oauth_token,
316
+ :environment_variables,
317
+ :enable_branch_auto_build,
318
+ :enable_basic_auth,
319
+ :basic_auth_credentials,
320
+ :custom_rules,
321
+ :tags,
322
+ :build_spec)
323
+ include Aws::Structure
324
+ end
325
+
326
+ # @!attribute [rw] app
327
+ # Amplify App represents different branches of a repository for
328
+ # building, deploying, and hosting.
329
+ # @return [Types::App]
330
+ #
331
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/CreateAppResult AWS API Documentation
332
+ #
333
+ class CreateAppResult < Struct.new(
334
+ :app)
335
+ include Aws::Structure
336
+ end
337
+
338
+ # Request structure for a branch create request.
339
+ #
340
+ # @note When making an API call, you may pass CreateBranchRequest
341
+ # data as a hash:
342
+ #
343
+ # {
344
+ # app_id: "AppId", # required
345
+ # branch_name: "BranchName", # required
346
+ # description: "Description",
347
+ # stage: "PRODUCTION", # accepts PRODUCTION, BETA, DEVELOPMENT, EXPERIMENTAL
348
+ # framework: "Framework",
349
+ # enable_notification: false,
350
+ # enable_auto_build: false,
351
+ # environment_variables: {
352
+ # "EnvKey" => "EnvValue",
353
+ # },
354
+ # basic_auth_credentials: "BasicAuthCredentials",
355
+ # enable_basic_auth: false,
356
+ # tags: {
357
+ # "TagKey" => "TagValue",
358
+ # },
359
+ # build_spec: "BuildSpec",
360
+ # ttl: "TTL",
361
+ # }
362
+ #
363
+ # @!attribute [rw] app_id
364
+ # Unique Id for an Amplify App.
365
+ # @return [String]
366
+ #
367
+ # @!attribute [rw] branch_name
368
+ # Name for the branch.
369
+ # @return [String]
370
+ #
371
+ # @!attribute [rw] description
372
+ # Description for the branch.
373
+ # @return [String]
374
+ #
375
+ # @!attribute [rw] stage
376
+ # Stage for the branch.
377
+ # @return [String]
378
+ #
379
+ # @!attribute [rw] framework
380
+ # Framework for the branch.
381
+ # @return [String]
382
+ #
383
+ # @!attribute [rw] enable_notification
384
+ # Enables notifications for the branch.
385
+ # @return [Boolean]
386
+ #
387
+ # @!attribute [rw] enable_auto_build
388
+ # Enables auto building for the branch.
389
+ # @return [Boolean]
390
+ #
391
+ # @!attribute [rw] environment_variables
392
+ # Environment Variables for the branch.
393
+ # @return [Hash<String,String>]
394
+ #
395
+ # @!attribute [rw] basic_auth_credentials
396
+ # Basic Authorization credentials for the branch.
397
+ # @return [String]
398
+ #
399
+ # @!attribute [rw] enable_basic_auth
400
+ # Enables Basic Auth for the branch.
401
+ # @return [Boolean]
402
+ #
403
+ # @!attribute [rw] tags
404
+ # Tag for the branch.
405
+ # @return [Hash<String,String>]
406
+ #
407
+ # @!attribute [rw] build_spec
408
+ # BuildSpec for the branch.
409
+ # @return [String]
410
+ #
411
+ # @!attribute [rw] ttl
412
+ # The content TTL for the website in seconds.
413
+ # @return [String]
414
+ #
415
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/CreateBranchRequest AWS API Documentation
416
+ #
417
+ class CreateBranchRequest < Struct.new(
418
+ :app_id,
419
+ :branch_name,
420
+ :description,
421
+ :stage,
422
+ :framework,
423
+ :enable_notification,
424
+ :enable_auto_build,
425
+ :environment_variables,
426
+ :basic_auth_credentials,
427
+ :enable_basic_auth,
428
+ :tags,
429
+ :build_spec,
430
+ :ttl)
431
+ include Aws::Structure
432
+ end
433
+
434
+ # Result structure for create branch request.
435
+ #
436
+ # @!attribute [rw] branch
437
+ # Branch structure for an Amplify App.
438
+ # @return [Types::Branch]
439
+ #
440
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/CreateBranchResult AWS API Documentation
441
+ #
442
+ class CreateBranchResult < Struct.new(
443
+ :branch)
444
+ include Aws::Structure
445
+ end
446
+
447
+ # Request structure for create Domain Association request.
448
+ #
449
+ # @note When making an API call, you may pass CreateDomainAssociationRequest
450
+ # data as a hash:
451
+ #
452
+ # {
453
+ # app_id: "AppId", # required
454
+ # domain_name: "DomainName", # required
455
+ # enable_auto_sub_domain: false,
456
+ # sub_domain_settings: [ # required
457
+ # {
458
+ # prefix: "DomainPrefix", # required
459
+ # branch_name: "BranchName", # required
460
+ # },
461
+ # ],
462
+ # }
463
+ #
464
+ # @!attribute [rw] app_id
465
+ # Unique Id for an Amplify App.
466
+ # @return [String]
467
+ #
468
+ # @!attribute [rw] domain_name
469
+ # Domain name for the Domain Association.
470
+ # @return [String]
471
+ #
472
+ # @!attribute [rw] enable_auto_sub_domain
473
+ # Enables automated creation of Subdomains for branches.
474
+ # @return [Boolean]
475
+ #
476
+ # @!attribute [rw] sub_domain_settings
477
+ # Setting structure for the Subdomain.
478
+ # @return [Array<Types::SubDomainSetting>]
479
+ #
480
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/CreateDomainAssociationRequest AWS API Documentation
481
+ #
482
+ class CreateDomainAssociationRequest < Struct.new(
483
+ :app_id,
484
+ :domain_name,
485
+ :enable_auto_sub_domain,
486
+ :sub_domain_settings)
487
+ include Aws::Structure
488
+ end
489
+
490
+ # Result structure for the create Domain Association request.
491
+ #
492
+ # @!attribute [rw] domain_association
493
+ # Domain Association structure.
494
+ # @return [Types::DomainAssociation]
495
+ #
496
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/CreateDomainAssociationResult AWS API Documentation
497
+ #
498
+ class CreateDomainAssociationResult < Struct.new(
499
+ :domain_association)
500
+ include Aws::Structure
501
+ end
502
+
503
+ # Custom rewrite / redirect rule.
504
+ #
505
+ # @note When making an API call, you may pass CustomRule
506
+ # data as a hash:
507
+ #
508
+ # {
509
+ # source: "Source", # required
510
+ # target: "Target", # required
511
+ # status: "Status",
512
+ # condition: "Condition",
513
+ # }
514
+ #
515
+ # @!attribute [rw] source
516
+ # The source pattern for a URL rewrite or redirect rule.
517
+ # @return [String]
518
+ #
519
+ # @!attribute [rw] target
520
+ # The target pattern for a URL rewrite or redirect rule.
521
+ # @return [String]
522
+ #
523
+ # @!attribute [rw] status
524
+ # The status code for a URL rewrite or redirect rule.
525
+ # @return [String]
526
+ #
527
+ # @!attribute [rw] condition
528
+ # The condition for a URL rewrite or redirect rule, e.g. country code.
529
+ # @return [String]
530
+ #
531
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/CustomRule AWS API Documentation
532
+ #
533
+ class CustomRule < Struct.new(
534
+ :source,
535
+ :target,
536
+ :status,
537
+ :condition)
538
+ include Aws::Structure
539
+ end
540
+
541
+ # Request structure for an Amplify App delete request.
542
+ #
543
+ # @note When making an API call, you may pass DeleteAppRequest
544
+ # data as a hash:
545
+ #
546
+ # {
547
+ # app_id: "AppId", # required
548
+ # }
549
+ #
550
+ # @!attribute [rw] app_id
551
+ # Unique Id for an Amplify App.
552
+ # @return [String]
553
+ #
554
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/DeleteAppRequest AWS API Documentation
555
+ #
556
+ class DeleteAppRequest < Struct.new(
557
+ :app_id)
558
+ include Aws::Structure
559
+ end
560
+
561
+ # Result structure for an Amplify App delete request.
562
+ #
563
+ # @!attribute [rw] app
564
+ # Amplify App represents different branches of a repository for
565
+ # building, deploying, and hosting.
566
+ # @return [Types::App]
567
+ #
568
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/DeleteAppResult AWS API Documentation
569
+ #
570
+ class DeleteAppResult < Struct.new(
571
+ :app)
572
+ include Aws::Structure
573
+ end
574
+
575
+ # Request structure for delete branch request.
576
+ #
577
+ # @note When making an API call, you may pass DeleteBranchRequest
578
+ # data as a hash:
579
+ #
580
+ # {
581
+ # app_id: "AppId", # required
582
+ # branch_name: "BranchName", # required
583
+ # }
584
+ #
585
+ # @!attribute [rw] app_id
586
+ # Unique Id for an Amplify App.
587
+ # @return [String]
588
+ #
589
+ # @!attribute [rw] branch_name
590
+ # Name for the branch.
591
+ # @return [String]
592
+ #
593
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/DeleteBranchRequest AWS API Documentation
594
+ #
595
+ class DeleteBranchRequest < Struct.new(
596
+ :app_id,
597
+ :branch_name)
598
+ include Aws::Structure
599
+ end
600
+
601
+ # Result structure for delete branch request.
602
+ #
603
+ # @!attribute [rw] branch
604
+ # Branch structure for an Amplify App.
605
+ # @return [Types::Branch]
606
+ #
607
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/DeleteBranchResult AWS API Documentation
608
+ #
609
+ class DeleteBranchResult < Struct.new(
610
+ :branch)
611
+ include Aws::Structure
612
+ end
613
+
614
+ # Request structure for the delete Domain Association request.
615
+ #
616
+ # @note When making an API call, you may pass DeleteDomainAssociationRequest
617
+ # data as a hash:
618
+ #
619
+ # {
620
+ # app_id: "AppId", # required
621
+ # domain_name: "DomainName", # required
622
+ # }
623
+ #
624
+ # @!attribute [rw] app_id
625
+ # Unique Id for an Amplify App.
626
+ # @return [String]
627
+ #
628
+ # @!attribute [rw] domain_name
629
+ # Name of the domain.
630
+ # @return [String]
631
+ #
632
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/DeleteDomainAssociationRequest AWS API Documentation
633
+ #
634
+ class DeleteDomainAssociationRequest < Struct.new(
635
+ :app_id,
636
+ :domain_name)
637
+ include Aws::Structure
638
+ end
639
+
640
+ # @!attribute [rw] domain_association
641
+ # Structure for Domain Association, which associates a custom domain
642
+ # with an Amplify App.
643
+ # @return [Types::DomainAssociation]
644
+ #
645
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/DeleteDomainAssociationResult AWS API Documentation
646
+ #
647
+ class DeleteDomainAssociationResult < Struct.new(
648
+ :domain_association)
649
+ include Aws::Structure
650
+ end
651
+
652
+ # Request structure for delete job request.
653
+ #
654
+ # @note When making an API call, you may pass DeleteJobRequest
655
+ # data as a hash:
656
+ #
657
+ # {
658
+ # app_id: "AppId", # required
659
+ # branch_name: "BranchName", # required
660
+ # job_id: "JobId", # required
661
+ # }
662
+ #
663
+ # @!attribute [rw] app_id
664
+ # Unique Id for an Amplify App.
665
+ # @return [String]
666
+ #
667
+ # @!attribute [rw] branch_name
668
+ # Name for the branch, for the Job.
669
+ # @return [String]
670
+ #
671
+ # @!attribute [rw] job_id
672
+ # Unique Id for the Job.
673
+ # @return [String]
674
+ #
675
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/DeleteJobRequest AWS API Documentation
676
+ #
677
+ class DeleteJobRequest < Struct.new(
678
+ :app_id,
679
+ :branch_name,
680
+ :job_id)
681
+ include Aws::Structure
682
+ end
683
+
684
+ # Result structure for the delete job request.
685
+ #
686
+ # @!attribute [rw] job_summary
687
+ # Structure for the summary of a Job.
688
+ # @return [Types::JobSummary]
689
+ #
690
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/DeleteJobResult AWS API Documentation
691
+ #
692
+ class DeleteJobResult < Struct.new(
693
+ :job_summary)
694
+ include Aws::Structure
695
+ end
696
+
697
+ # Structure for Domain Association, which associates a custom domain
698
+ # with an Amplify App.
699
+ #
700
+ # @!attribute [rw] domain_association_arn
701
+ # ARN for the Domain Association.
702
+ # @return [String]
703
+ #
704
+ # @!attribute [rw] domain_name
705
+ # Name of the domain.
706
+ # @return [String]
707
+ #
708
+ # @!attribute [rw] enable_auto_sub_domain
709
+ # Enables automated creation of Subdomains for branches.
710
+ # @return [Boolean]
711
+ #
712
+ # @!attribute [rw] domain_status
713
+ # Status fo the Domain Association.
714
+ # @return [String]
715
+ #
716
+ # @!attribute [rw] status_reason
717
+ # Reason for the current status of the Domain Association.
718
+ # @return [String]
719
+ #
720
+ # @!attribute [rw] certificate_verification_dns_record
721
+ # DNS Record for certificate verification.
722
+ # @return [String]
723
+ #
724
+ # @!attribute [rw] sub_domains
725
+ # Subdomains for the Domain Association.
726
+ # @return [Array<Types::SubDomain>]
727
+ #
728
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/DomainAssociation AWS API Documentation
729
+ #
730
+ class DomainAssociation < Struct.new(
731
+ :domain_association_arn,
732
+ :domain_name,
733
+ :enable_auto_sub_domain,
734
+ :domain_status,
735
+ :status_reason,
736
+ :certificate_verification_dns_record,
737
+ :sub_domains)
738
+ include Aws::Structure
739
+ end
740
+
741
+ # Request structure for get App request.
742
+ #
743
+ # @note When making an API call, you may pass GetAppRequest
744
+ # data as a hash:
745
+ #
746
+ # {
747
+ # app_id: "AppId", # required
748
+ # }
749
+ #
750
+ # @!attribute [rw] app_id
751
+ # Unique Id for an Amplify App.
752
+ # @return [String]
753
+ #
754
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GetAppRequest AWS API Documentation
755
+ #
756
+ class GetAppRequest < Struct.new(
757
+ :app_id)
758
+ include Aws::Structure
759
+ end
760
+
761
+ # @!attribute [rw] app
762
+ # Amplify App represents different branches of a repository for
763
+ # building, deploying, and hosting.
764
+ # @return [Types::App]
765
+ #
766
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GetAppResult AWS API Documentation
767
+ #
768
+ class GetAppResult < Struct.new(
769
+ :app)
770
+ include Aws::Structure
771
+ end
772
+
773
+ # Result structure for get branch request.
774
+ #
775
+ # @note When making an API call, you may pass GetBranchRequest
776
+ # data as a hash:
777
+ #
778
+ # {
779
+ # app_id: "AppId", # required
780
+ # branch_name: "BranchName", # required
781
+ # }
782
+ #
783
+ # @!attribute [rw] app_id
784
+ # Unique Id for an Amplify App.
785
+ # @return [String]
786
+ #
787
+ # @!attribute [rw] branch_name
788
+ # Name for the branch.
789
+ # @return [String]
790
+ #
791
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GetBranchRequest AWS API Documentation
792
+ #
793
+ class GetBranchRequest < Struct.new(
794
+ :app_id,
795
+ :branch_name)
796
+ include Aws::Structure
797
+ end
798
+
799
+ # @!attribute [rw] branch
800
+ # Branch for an Amplify App, which maps to a 3rd party repository
801
+ # branch.
802
+ # @return [Types::Branch]
803
+ #
804
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GetBranchResult AWS API Documentation
805
+ #
806
+ class GetBranchResult < Struct.new(
807
+ :branch)
808
+ include Aws::Structure
809
+ end
810
+
811
+ # Request structure for the get Domain Association request.
812
+ #
813
+ # @note When making an API call, you may pass GetDomainAssociationRequest
814
+ # data as a hash:
815
+ #
816
+ # {
817
+ # app_id: "AppId", # required
818
+ # domain_name: "DomainName", # required
819
+ # }
820
+ #
821
+ # @!attribute [rw] app_id
822
+ # Unique Id for an Amplify App.
823
+ # @return [String]
824
+ #
825
+ # @!attribute [rw] domain_name
826
+ # Name of the domain.
827
+ # @return [String]
828
+ #
829
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GetDomainAssociationRequest AWS API Documentation
830
+ #
831
+ class GetDomainAssociationRequest < Struct.new(
832
+ :app_id,
833
+ :domain_name)
834
+ include Aws::Structure
835
+ end
836
+
837
+ # Result structure for the get Domain Association request.
838
+ #
839
+ # @!attribute [rw] domain_association
840
+ # Domain Association structure.
841
+ # @return [Types::DomainAssociation]
842
+ #
843
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GetDomainAssociationResult AWS API Documentation
844
+ #
845
+ class GetDomainAssociationResult < Struct.new(
846
+ :domain_association)
847
+ include Aws::Structure
848
+ end
849
+
850
+ # Request structure for get job request.
851
+ #
852
+ # @note When making an API call, you may pass GetJobRequest
853
+ # data as a hash:
854
+ #
855
+ # {
856
+ # app_id: "AppId", # required
857
+ # branch_name: "BranchName", # required
858
+ # job_id: "JobId", # required
859
+ # }
860
+ #
861
+ # @!attribute [rw] app_id
862
+ # Unique Id for an Amplify App.
863
+ # @return [String]
864
+ #
865
+ # @!attribute [rw] branch_name
866
+ # Name for the branch, for the Job.
867
+ # @return [String]
868
+ #
869
+ # @!attribute [rw] job_id
870
+ # Unique Id for the Job.
871
+ # @return [String]
872
+ #
873
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GetJobRequest AWS API Documentation
874
+ #
875
+ class GetJobRequest < Struct.new(
876
+ :app_id,
877
+ :branch_name,
878
+ :job_id)
879
+ include Aws::Structure
880
+ end
881
+
882
+ # @!attribute [rw] job
883
+ # Structure for an execution job for an Amplify App.
884
+ # @return [Types::Job]
885
+ #
886
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GetJobResult AWS API Documentation
887
+ #
888
+ class GetJobResult < Struct.new(
889
+ :job)
890
+ include Aws::Structure
891
+ end
892
+
893
+ # Structure for an execution job for an Amplify App.
894
+ #
895
+ # @!attribute [rw] summary
896
+ # Summary for an execution job for an Amplify App.
897
+ # @return [Types::JobSummary]
898
+ #
899
+ # @!attribute [rw] steps
900
+ # Execution steps for an execution job, for an Amplify App.
901
+ # @return [Array<Types::Step>]
902
+ #
903
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/Job AWS API Documentation
904
+ #
905
+ class Job < Struct.new(
906
+ :summary,
907
+ :steps)
908
+ include Aws::Structure
909
+ end
910
+
911
+ # Structure for the summary of a Job.
912
+ #
913
+ # @!attribute [rw] job_arn
914
+ # Arn for the Job.
915
+ # @return [String]
916
+ #
917
+ # @!attribute [rw] job_id
918
+ # Unique Id for the Job.
919
+ # @return [String]
920
+ #
921
+ # @!attribute [rw] commit_id
922
+ # Commit Id from 3rd party repository provider for the Job.
923
+ # @return [String]
924
+ #
925
+ # @!attribute [rw] commit_message
926
+ # Commit message from 3rd party repository provider for the Job.
927
+ # @return [String]
928
+ #
929
+ # @!attribute [rw] commit_time
930
+ # Commit date / time for the Job.
931
+ # @return [Time]
932
+ #
933
+ # @!attribute [rw] start_time
934
+ # Start date / time for the Job.
935
+ # @return [Time]
936
+ #
937
+ # @!attribute [rw] status
938
+ # Status for the Job.
939
+ # @return [String]
940
+ #
941
+ # @!attribute [rw] end_time
942
+ # End date / time for the Job.
943
+ # @return [Time]
944
+ #
945
+ # @!attribute [rw] job_type
946
+ # Type for the Job.
947
+ # @return [String]
948
+ #
949
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/JobSummary AWS API Documentation
950
+ #
951
+ class JobSummary < Struct.new(
952
+ :job_arn,
953
+ :job_id,
954
+ :commit_id,
955
+ :commit_message,
956
+ :commit_time,
957
+ :start_time,
958
+ :status,
959
+ :end_time,
960
+ :job_type)
961
+ include Aws::Structure
962
+ end
963
+
964
+ # Request structure for an Amplify App list request.
965
+ #
966
+ # @note When making an API call, you may pass ListAppsRequest
967
+ # data as a hash:
968
+ #
969
+ # {
970
+ # next_token: "NextToken",
971
+ # max_results: 1,
972
+ # }
973
+ #
974
+ # @!attribute [rw] next_token
975
+ # Pagination token. If non-null pagination token is returned in a
976
+ # result, then pass its value in another request to fetch more
977
+ # entries.
978
+ # @return [String]
979
+ #
980
+ # @!attribute [rw] max_results
981
+ # Maximum number of records to list in a single response.
982
+ # @return [Integer]
983
+ #
984
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListAppsRequest AWS API Documentation
985
+ #
986
+ class ListAppsRequest < Struct.new(
987
+ :next_token,
988
+ :max_results)
989
+ include Aws::Structure
990
+ end
991
+
992
+ # Result structure for an Amplify App list request.
993
+ #
994
+ # @!attribute [rw] apps
995
+ # List of Amplify Apps.
996
+ # @return [Array<Types::App>]
997
+ #
998
+ # @!attribute [rw] next_token
999
+ # Pagination token. Set to null to start listing Apps from start. If
1000
+ # non-null pagination token is returned in a result, then pass its
1001
+ # value in here to list more projects.
1002
+ # @return [String]
1003
+ #
1004
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListAppsResult AWS API Documentation
1005
+ #
1006
+ class ListAppsResult < Struct.new(
1007
+ :apps,
1008
+ :next_token)
1009
+ include Aws::Structure
1010
+ end
1011
+
1012
+ # Request structure for list branches request.
1013
+ #
1014
+ # @note When making an API call, you may pass ListBranchesRequest
1015
+ # data as a hash:
1016
+ #
1017
+ # {
1018
+ # app_id: "AppId", # required
1019
+ # next_token: "NextToken",
1020
+ # max_results: 1,
1021
+ # }
1022
+ #
1023
+ # @!attribute [rw] app_id
1024
+ # Unique Id for an Amplify App.
1025
+ # @return [String]
1026
+ #
1027
+ # @!attribute [rw] next_token
1028
+ # Pagination token. Set to null to start listing branches from start.
1029
+ # If a non-null pagination token is returned in a result, then pass
1030
+ # its value in here to list more branches.
1031
+ # @return [String]
1032
+ #
1033
+ # @!attribute [rw] max_results
1034
+ # Maximum number of records to list in a single response.
1035
+ # @return [Integer]
1036
+ #
1037
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListBranchesRequest AWS API Documentation
1038
+ #
1039
+ class ListBranchesRequest < Struct.new(
1040
+ :app_id,
1041
+ :next_token,
1042
+ :max_results)
1043
+ include Aws::Structure
1044
+ end
1045
+
1046
+ # Result structure for list branches request.
1047
+ #
1048
+ # @!attribute [rw] branches
1049
+ # List of branches for an Amplify App.
1050
+ # @return [Array<Types::Branch>]
1051
+ #
1052
+ # @!attribute [rw] next_token
1053
+ # Pagination token. If non-null pagination token is returned in a
1054
+ # result, then pass its value in another request to fetch more
1055
+ # entries.
1056
+ # @return [String]
1057
+ #
1058
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListBranchesResult AWS API Documentation
1059
+ #
1060
+ class ListBranchesResult < Struct.new(
1061
+ :branches,
1062
+ :next_token)
1063
+ include Aws::Structure
1064
+ end
1065
+
1066
+ # Request structure for the list Domain Associations request.
1067
+ #
1068
+ # @note When making an API call, you may pass ListDomainAssociationsRequest
1069
+ # data as a hash:
1070
+ #
1071
+ # {
1072
+ # app_id: "AppId", # required
1073
+ # next_token: "NextToken",
1074
+ # max_results: 1,
1075
+ # }
1076
+ #
1077
+ # @!attribute [rw] app_id
1078
+ # Unique Id for an Amplify App.
1079
+ # @return [String]
1080
+ #
1081
+ # @!attribute [rw] next_token
1082
+ # Pagination token. Set to null to start listing Apps from start. If
1083
+ # non-null pagination token is returned in a result, then pass its
1084
+ # value in here to list more projects.
1085
+ # @return [String]
1086
+ #
1087
+ # @!attribute [rw] max_results
1088
+ # Maximum number of records to list in a single response.
1089
+ # @return [Integer]
1090
+ #
1091
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListDomainAssociationsRequest AWS API Documentation
1092
+ #
1093
+ class ListDomainAssociationsRequest < Struct.new(
1094
+ :app_id,
1095
+ :next_token,
1096
+ :max_results)
1097
+ include Aws::Structure
1098
+ end
1099
+
1100
+ # Result structure for the list Domain Association request.
1101
+ #
1102
+ # @!attribute [rw] domain_associations
1103
+ # List of Domain Associations.
1104
+ # @return [Array<Types::DomainAssociation>]
1105
+ #
1106
+ # @!attribute [rw] next_token
1107
+ # Pagination token. If non-null pagination token is returned in a
1108
+ # result, then pass its value in another request to fetch more
1109
+ # entries.
1110
+ # @return [String]
1111
+ #
1112
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListDomainAssociationsResult AWS API Documentation
1113
+ #
1114
+ class ListDomainAssociationsResult < Struct.new(
1115
+ :domain_associations,
1116
+ :next_token)
1117
+ include Aws::Structure
1118
+ end
1119
+
1120
+ # Request structure for list job request.
1121
+ #
1122
+ # @note When making an API call, you may pass ListJobsRequest
1123
+ # data as a hash:
1124
+ #
1125
+ # {
1126
+ # app_id: "AppId", # required
1127
+ # branch_name: "BranchName", # required
1128
+ # next_token: "NextToken",
1129
+ # max_results: 1,
1130
+ # }
1131
+ #
1132
+ # @!attribute [rw] app_id
1133
+ # Unique Id for an Amplify App.
1134
+ # @return [String]
1135
+ #
1136
+ # @!attribute [rw] branch_name
1137
+ # Name for a branch.
1138
+ # @return [String]
1139
+ #
1140
+ # @!attribute [rw] next_token
1141
+ # Pagination token. Set to null to start listing steps from start. If
1142
+ # a non-null pagination token is returned in a result, then pass its
1143
+ # value in here to list more steps.
1144
+ # @return [String]
1145
+ #
1146
+ # @!attribute [rw] max_results
1147
+ # Maximum number of records to list in a single response.
1148
+ # @return [Integer]
1149
+ #
1150
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListJobsRequest AWS API Documentation
1151
+ #
1152
+ class ListJobsRequest < Struct.new(
1153
+ :app_id,
1154
+ :branch_name,
1155
+ :next_token,
1156
+ :max_results)
1157
+ include Aws::Structure
1158
+ end
1159
+
1160
+ # Maximum number of records to list in a single response.
1161
+ #
1162
+ # @!attribute [rw] job_summaries
1163
+ # Result structure for list job result request.
1164
+ # @return [Array<Types::JobSummary>]
1165
+ #
1166
+ # @!attribute [rw] next_token
1167
+ # Pagination token. If non-null pagination token is returned in a
1168
+ # result, then pass its value in another request to fetch more
1169
+ # entries.
1170
+ # @return [String]
1171
+ #
1172
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListJobsResult AWS API Documentation
1173
+ #
1174
+ class ListJobsResult < Struct.new(
1175
+ :job_summaries,
1176
+ :next_token)
1177
+ include Aws::Structure
1178
+ end
1179
+
1180
+ # Structure with Production Branch information.
1181
+ #
1182
+ # @!attribute [rw] last_deploy_time
1183
+ # Last Deploy Time of Production Branch.
1184
+ # @return [Time]
1185
+ #
1186
+ # @!attribute [rw] status
1187
+ # Status of Production Branch.
1188
+ # @return [String]
1189
+ #
1190
+ # @!attribute [rw] thumbnail_url
1191
+ # Thumbnail Url for Production Branch.
1192
+ # @return [String]
1193
+ #
1194
+ # @!attribute [rw] branch_name
1195
+ # Branch Name for Production Branch.
1196
+ # @return [String]
1197
+ #
1198
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ProductionBranch AWS API Documentation
1199
+ #
1200
+ class ProductionBranch < Struct.new(
1201
+ :last_deploy_time,
1202
+ :status,
1203
+ :thumbnail_url,
1204
+ :branch_name)
1205
+ include Aws::Structure
1206
+ end
1207
+
1208
+ # Request structure for Start job request.
1209
+ #
1210
+ # @note When making an API call, you may pass StartJobRequest
1211
+ # data as a hash:
1212
+ #
1213
+ # {
1214
+ # app_id: "AppId", # required
1215
+ # branch_name: "BranchName", # required
1216
+ # job_id: "JobId",
1217
+ # job_type: "RELEASE", # required, accepts RELEASE, RETRY, WEB_HOOK
1218
+ # job_reason: "JobReason",
1219
+ # commit_id: "CommitId",
1220
+ # commit_message: "CommitMessage",
1221
+ # commit_time: Time.now,
1222
+ # }
1223
+ #
1224
+ # @!attribute [rw] app_id
1225
+ # Unique Id for an Amplify App.
1226
+ # @return [String]
1227
+ #
1228
+ # @!attribute [rw] branch_name
1229
+ # Name for the branch, for the Job.
1230
+ # @return [String]
1231
+ #
1232
+ # @!attribute [rw] job_id
1233
+ # Unique Id for the Job.
1234
+ # @return [String]
1235
+ #
1236
+ # @!attribute [rw] job_type
1237
+ # Type for the Job.
1238
+ # @return [String]
1239
+ #
1240
+ # @!attribute [rw] job_reason
1241
+ # Reason for the Job.
1242
+ # @return [String]
1243
+ #
1244
+ # @!attribute [rw] commit_id
1245
+ # Commit Id from 3rd party repository provider for the Job.
1246
+ # @return [String]
1247
+ #
1248
+ # @!attribute [rw] commit_message
1249
+ # Commit message from 3rd party repository provider for the Job.
1250
+ # @return [String]
1251
+ #
1252
+ # @!attribute [rw] commit_time
1253
+ # Commit date / time for the Job.
1254
+ # @return [Time]
1255
+ #
1256
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/StartJobRequest AWS API Documentation
1257
+ #
1258
+ class StartJobRequest < Struct.new(
1259
+ :app_id,
1260
+ :branch_name,
1261
+ :job_id,
1262
+ :job_type,
1263
+ :job_reason,
1264
+ :commit_id,
1265
+ :commit_message,
1266
+ :commit_time)
1267
+ include Aws::Structure
1268
+ end
1269
+
1270
+ # Result structure for run job request.
1271
+ #
1272
+ # @!attribute [rw] job_summary
1273
+ # Summary for the Job.
1274
+ # @return [Types::JobSummary]
1275
+ #
1276
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/StartJobResult AWS API Documentation
1277
+ #
1278
+ class StartJobResult < Struct.new(
1279
+ :job_summary)
1280
+ include Aws::Structure
1281
+ end
1282
+
1283
+ # Structure for an execution step for an execution job, for an Amplify
1284
+ # App.
1285
+ #
1286
+ # @!attribute [rw] step_name
1287
+ # Name of the execution step.
1288
+ # @return [String]
1289
+ #
1290
+ # @!attribute [rw] start_time
1291
+ # Start date/ time of the execution step.
1292
+ # @return [Time]
1293
+ #
1294
+ # @!attribute [rw] status
1295
+ # Status of the execution step.
1296
+ # @return [String]
1297
+ #
1298
+ # @!attribute [rw] end_time
1299
+ # End date/ time of the execution step.
1300
+ # @return [Time]
1301
+ #
1302
+ # @!attribute [rw] log_url
1303
+ # Url to the logs for the execution step.
1304
+ # @return [String]
1305
+ #
1306
+ # @!attribute [rw] artifacts_url
1307
+ # Url to teh artifact for the execution step.
1308
+ # @return [String]
1309
+ #
1310
+ # @!attribute [rw] screenshots
1311
+ # List of screenshot Urls for the execution step, if relevant.
1312
+ # @return [Hash<String,String>]
1313
+ #
1314
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/Step AWS API Documentation
1315
+ #
1316
+ class Step < Struct.new(
1317
+ :step_name,
1318
+ :start_time,
1319
+ :status,
1320
+ :end_time,
1321
+ :log_url,
1322
+ :artifacts_url,
1323
+ :screenshots)
1324
+ include Aws::Structure
1325
+ end
1326
+
1327
+ # Request structure for stop job request.
1328
+ #
1329
+ # @note When making an API call, you may pass StopJobRequest
1330
+ # data as a hash:
1331
+ #
1332
+ # {
1333
+ # app_id: "AppId", # required
1334
+ # branch_name: "BranchName", # required
1335
+ # job_id: "JobId", # required
1336
+ # }
1337
+ #
1338
+ # @!attribute [rw] app_id
1339
+ # Unique Id for an Amplify App.
1340
+ # @return [String]
1341
+ #
1342
+ # @!attribute [rw] branch_name
1343
+ # Name for the branch, for the Job.
1344
+ # @return [String]
1345
+ #
1346
+ # @!attribute [rw] job_id
1347
+ # Unique Id for the Job.
1348
+ # @return [String]
1349
+ #
1350
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/StopJobRequest AWS API Documentation
1351
+ #
1352
+ class StopJobRequest < Struct.new(
1353
+ :app_id,
1354
+ :branch_name,
1355
+ :job_id)
1356
+ include Aws::Structure
1357
+ end
1358
+
1359
+ # Result structure for the stop job request.
1360
+ #
1361
+ # @!attribute [rw] job_summary
1362
+ # Summary for the Job.
1363
+ # @return [Types::JobSummary]
1364
+ #
1365
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/StopJobResult AWS API Documentation
1366
+ #
1367
+ class StopJobResult < Struct.new(
1368
+ :job_summary)
1369
+ include Aws::Structure
1370
+ end
1371
+
1372
+ # Subdomain for the Domain Association.
1373
+ #
1374
+ # @!attribute [rw] sub_domain_setting
1375
+ # Setting structure for the Subdomain.
1376
+ # @return [Types::SubDomainSetting]
1377
+ #
1378
+ # @!attribute [rw] verified
1379
+ # Verified status of the Subdomain
1380
+ # @return [Boolean]
1381
+ #
1382
+ # @!attribute [rw] dns_record
1383
+ # DNS record for the Subdomain.
1384
+ # @return [String]
1385
+ #
1386
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/SubDomain AWS API Documentation
1387
+ #
1388
+ class SubDomain < Struct.new(
1389
+ :sub_domain_setting,
1390
+ :verified,
1391
+ :dns_record)
1392
+ include Aws::Structure
1393
+ end
1394
+
1395
+ # Setting for the Subdomain.
1396
+ #
1397
+ # @note When making an API call, you may pass SubDomainSetting
1398
+ # data as a hash:
1399
+ #
1400
+ # {
1401
+ # prefix: "DomainPrefix", # required
1402
+ # branch_name: "BranchName", # required
1403
+ # }
1404
+ #
1405
+ # @!attribute [rw] prefix
1406
+ # Prefix setting for the Subdomain.
1407
+ # @return [String]
1408
+ #
1409
+ # @!attribute [rw] branch_name
1410
+ # Branch name setting for the Subdomain.
1411
+ # @return [String]
1412
+ #
1413
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/SubDomainSetting AWS API Documentation
1414
+ #
1415
+ class SubDomainSetting < Struct.new(
1416
+ :prefix,
1417
+ :branch_name)
1418
+ include Aws::Structure
1419
+ end
1420
+
1421
+ # Request structure for update App request.
1422
+ #
1423
+ # @note When making an API call, you may pass UpdateAppRequest
1424
+ # data as a hash:
1425
+ #
1426
+ # {
1427
+ # app_id: "AppId", # required
1428
+ # name: "Name",
1429
+ # description: "Description",
1430
+ # platform: "IOS", # accepts IOS, ANDROID, WEB, REACT_NATIVE
1431
+ # iam_service_role_arn: "ServiceRoleArn",
1432
+ # environment_variables: {
1433
+ # "EnvKey" => "EnvValue",
1434
+ # },
1435
+ # enable_branch_auto_build: false,
1436
+ # enable_basic_auth: false,
1437
+ # basic_auth_credentials: "BasicAuthCredentials",
1438
+ # custom_rules: [
1439
+ # {
1440
+ # source: "Source", # required
1441
+ # target: "Target", # required
1442
+ # status: "Status",
1443
+ # condition: "Condition",
1444
+ # },
1445
+ # ],
1446
+ # build_spec: "BuildSpec",
1447
+ # }
1448
+ #
1449
+ # @!attribute [rw] app_id
1450
+ # Unique Id for an Amplify App.
1451
+ # @return [String]
1452
+ #
1453
+ # @!attribute [rw] name
1454
+ # Name for an Amplify App.
1455
+ # @return [String]
1456
+ #
1457
+ # @!attribute [rw] description
1458
+ # Description for an Amplify App.
1459
+ # @return [String]
1460
+ #
1461
+ # @!attribute [rw] platform
1462
+ # Platform for an Amplify App.
1463
+ # @return [String]
1464
+ #
1465
+ # @!attribute [rw] iam_service_role_arn
1466
+ # IAM service role for an Amplify App.
1467
+ # @return [String]
1468
+ #
1469
+ # @!attribute [rw] environment_variables
1470
+ # Environment Variables for an Amplify App.
1471
+ # @return [Hash<String,String>]
1472
+ #
1473
+ # @!attribute [rw] enable_branch_auto_build
1474
+ # Enables branch auto-building for an Amplify App.
1475
+ # @return [Boolean]
1476
+ #
1477
+ # @!attribute [rw] enable_basic_auth
1478
+ # Enables Basic Authorization for an Amplify App.
1479
+ # @return [Boolean]
1480
+ #
1481
+ # @!attribute [rw] basic_auth_credentials
1482
+ # Basic Authorization credentials for an Amplify App.
1483
+ # @return [String]
1484
+ #
1485
+ # @!attribute [rw] custom_rules
1486
+ # Custom redirect / rewrite rules for an Amplify App.
1487
+ # @return [Array<Types::CustomRule>]
1488
+ #
1489
+ # @!attribute [rw] build_spec
1490
+ # BuildSpec for an Amplify App.
1491
+ # @return [String]
1492
+ #
1493
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/UpdateAppRequest AWS API Documentation
1494
+ #
1495
+ class UpdateAppRequest < Struct.new(
1496
+ :app_id,
1497
+ :name,
1498
+ :description,
1499
+ :platform,
1500
+ :iam_service_role_arn,
1501
+ :environment_variables,
1502
+ :enable_branch_auto_build,
1503
+ :enable_basic_auth,
1504
+ :basic_auth_credentials,
1505
+ :custom_rules,
1506
+ :build_spec)
1507
+ include Aws::Structure
1508
+ end
1509
+
1510
+ # Result structure for an Amplify App update request.
1511
+ #
1512
+ # @!attribute [rw] app
1513
+ # App structure for the updated App.
1514
+ # @return [Types::App]
1515
+ #
1516
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/UpdateAppResult AWS API Documentation
1517
+ #
1518
+ class UpdateAppResult < Struct.new(
1519
+ :app)
1520
+ include Aws::Structure
1521
+ end
1522
+
1523
+ # Request structure for update branch request.
1524
+ #
1525
+ # @note When making an API call, you may pass UpdateBranchRequest
1526
+ # data as a hash:
1527
+ #
1528
+ # {
1529
+ # app_id: "AppId", # required
1530
+ # branch_name: "BranchName", # required
1531
+ # description: "Description",
1532
+ # framework: "Framework",
1533
+ # stage: "PRODUCTION", # accepts PRODUCTION, BETA, DEVELOPMENT, EXPERIMENTAL
1534
+ # enable_notification: false,
1535
+ # enable_auto_build: false,
1536
+ # environment_variables: {
1537
+ # "EnvKey" => "EnvValue",
1538
+ # },
1539
+ # basic_auth_credentials: "BasicAuthCredentials",
1540
+ # enable_basic_auth: false,
1541
+ # build_spec: "BuildSpec",
1542
+ # ttl: "TTL",
1543
+ # }
1544
+ #
1545
+ # @!attribute [rw] app_id
1546
+ # Unique Id for an Amplify App.
1547
+ # @return [String]
1548
+ #
1549
+ # @!attribute [rw] branch_name
1550
+ # Name for the branch.
1551
+ # @return [String]
1552
+ #
1553
+ # @!attribute [rw] description
1554
+ # Description for the branch.
1555
+ # @return [String]
1556
+ #
1557
+ # @!attribute [rw] framework
1558
+ # Framework for the branch.
1559
+ # @return [String]
1560
+ #
1561
+ # @!attribute [rw] stage
1562
+ # Stage for the branch.
1563
+ # @return [String]
1564
+ #
1565
+ # @!attribute [rw] enable_notification
1566
+ # Enables notifications for the branch.
1567
+ # @return [Boolean]
1568
+ #
1569
+ # @!attribute [rw] enable_auto_build
1570
+ # Enables auto building for the branch.
1571
+ # @return [Boolean]
1572
+ #
1573
+ # @!attribute [rw] environment_variables
1574
+ # Environment Variables for the branch.
1575
+ # @return [Hash<String,String>]
1576
+ #
1577
+ # @!attribute [rw] basic_auth_credentials
1578
+ # Basic Authorization credentials for the branch.
1579
+ # @return [String]
1580
+ #
1581
+ # @!attribute [rw] enable_basic_auth
1582
+ # Enables Basic Auth for the branch.
1583
+ # @return [Boolean]
1584
+ #
1585
+ # @!attribute [rw] build_spec
1586
+ # BuildSpec for the branch.
1587
+ # @return [String]
1588
+ #
1589
+ # @!attribute [rw] ttl
1590
+ # The content TTL for the website in seconds.
1591
+ # @return [String]
1592
+ #
1593
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/UpdateBranchRequest AWS API Documentation
1594
+ #
1595
+ class UpdateBranchRequest < Struct.new(
1596
+ :app_id,
1597
+ :branch_name,
1598
+ :description,
1599
+ :framework,
1600
+ :stage,
1601
+ :enable_notification,
1602
+ :enable_auto_build,
1603
+ :environment_variables,
1604
+ :basic_auth_credentials,
1605
+ :enable_basic_auth,
1606
+ :build_spec,
1607
+ :ttl)
1608
+ include Aws::Structure
1609
+ end
1610
+
1611
+ # Result structure for update branch request.
1612
+ #
1613
+ # @!attribute [rw] branch
1614
+ # Branch structure for an Amplify App.
1615
+ # @return [Types::Branch]
1616
+ #
1617
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/UpdateBranchResult AWS API Documentation
1618
+ #
1619
+ class UpdateBranchResult < Struct.new(
1620
+ :branch)
1621
+ include Aws::Structure
1622
+ end
1623
+
1624
+ # Request structure for update Domain Association request.
1625
+ #
1626
+ # @note When making an API call, you may pass UpdateDomainAssociationRequest
1627
+ # data as a hash:
1628
+ #
1629
+ # {
1630
+ # app_id: "AppId", # required
1631
+ # domain_name: "DomainName", # required
1632
+ # enable_auto_sub_domain: false,
1633
+ # sub_domain_settings: [ # required
1634
+ # {
1635
+ # prefix: "DomainPrefix", # required
1636
+ # branch_name: "BranchName", # required
1637
+ # },
1638
+ # ],
1639
+ # }
1640
+ #
1641
+ # @!attribute [rw] app_id
1642
+ # Unique Id for an Amplify App.
1643
+ # @return [String]
1644
+ #
1645
+ # @!attribute [rw] domain_name
1646
+ # Name of the domain.
1647
+ # @return [String]
1648
+ #
1649
+ # @!attribute [rw] enable_auto_sub_domain
1650
+ # Enables automated creation of Subdomains for branches.
1651
+ # @return [Boolean]
1652
+ #
1653
+ # @!attribute [rw] sub_domain_settings
1654
+ # Setting structure for the Subdomain.
1655
+ # @return [Array<Types::SubDomainSetting>]
1656
+ #
1657
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/UpdateDomainAssociationRequest AWS API Documentation
1658
+ #
1659
+ class UpdateDomainAssociationRequest < Struct.new(
1660
+ :app_id,
1661
+ :domain_name,
1662
+ :enable_auto_sub_domain,
1663
+ :sub_domain_settings)
1664
+ include Aws::Structure
1665
+ end
1666
+
1667
+ # Result structure for the update Domain Association request.
1668
+ #
1669
+ # @!attribute [rw] domain_association
1670
+ # Domain Association structure.
1671
+ # @return [Types::DomainAssociation]
1672
+ #
1673
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/UpdateDomainAssociationResult AWS API Documentation
1674
+ #
1675
+ class UpdateDomainAssociationResult < Struct.new(
1676
+ :domain_association)
1677
+ include Aws::Structure
1678
+ end
1679
+
1680
+ end
1681
+ end