aws-sdk-amplify 1.19.0 → 1.20.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 37d13bd4ed8f6e22ad5b55fd7fd87bfd4476cbfafd20314d41d4e1626cdcf421
4
- data.tar.gz: e328f1cf91dca614a5c12d130e7e06b0b34f19c47bd192dfc633b0ddb518d2c2
3
+ metadata.gz: 839ec4be829737d6749683784879b11e7683f65c0fb0a011617d722753aba644
4
+ data.tar.gz: d5b5e85b2b055a62d435c00fceea214bde066c5f2789eb82bb3a5ddb464a6ff4
5
5
  SHA512:
6
- metadata.gz: 2a89eb481238b133d9e3545bbecf88058c207bd0eaedde219c02df03167e56b03020bfdc324d72bf21f519b8cba75f41c417a7e09a9938e9d30b127edc11444a
7
- data.tar.gz: 936bb9d1b66a5a876bbc8cad8f39bf1d7737a1ef3478cf636c37561f30dbcd504fc270f6dfa8128556b3d36402840f81b8895d909c21b5e25d24c69af161e0e8
6
+ metadata.gz: e801bc58aff85c850b3703f202b420cd512a25fed8a986e857a3689c42afcff98846b969d8b57ab8719e8b9271419b9f09259d1496372c9c3c56283140d4f65e
7
+ data.tar.gz: 56ccf423c515e20a87a22f53ec739c9be42ac1c37ceb14e7d7e3b1a52c93d567103a147814b9d61487e4af5f8ba6218808cf4980c9204f0aea3b3f0782ed4e09
@@ -47,6 +47,6 @@ require_relative 'aws-sdk-amplify/customizations'
47
47
  # @service
48
48
  module Aws::Amplify
49
49
 
50
- GEM_VERSION = '1.19.0'
50
+ GEM_VERSION = '1.20.0'
51
51
 
52
52
  end
@@ -312,63 +312,68 @@ module Aws::Amplify
312
312
 
313
313
  # @!group API Operations
314
314
 
315
- # Creates a new Amplify App.
315
+ # Creates a new Amplify app.
316
316
  #
317
317
  # @option params [required, String] :name
318
- # Name for the Amplify App
318
+ # The name for the Amplify app.
319
319
  #
320
320
  # @option params [String] :description
321
- # Description for an Amplify App
321
+ # The description for an Amplify app.
322
322
  #
323
323
  # @option params [String] :repository
324
- # Repository for an Amplify App
324
+ # The repository for an Amplify app.
325
325
  #
326
326
  # @option params [String] :platform
327
- # Platform / framework for an Amplify App
327
+ # The platform or framework for an Amplify app.
328
328
  #
329
329
  # @option params [String] :iam_service_role_arn
330
- # AWS IAM service role for an Amplify App
330
+ # The AWS Identity and Access Management (IAM) service role for an
331
+ # Amplify app.
331
332
  #
332
333
  # @option params [String] :oauth_token
333
- # OAuth token for 3rd party source control system for an Amplify App,
334
- # used to create webhook and read-only deploy key. OAuth token is not
335
- # stored.
334
+ # The OAuth token for a third-party source control system for an Amplify
335
+ # app. The OAuth token is used to create a webhook and a read-only
336
+ # deploy key. The OAuth token is not stored.
336
337
  #
337
338
  # @option params [String] :access_token
338
- # Personal Access token for 3rd party source control system for an
339
- # Amplify App, used to create webhook and read-only deploy key. Token is
340
- # not stored.
339
+ # The personal access token for a third-party source control system for
340
+ # an Amplify app. The personal access token is used to create a webhook
341
+ # and a read-only deploy key. The token is not stored.
341
342
  #
342
343
  # @option params [Hash<String,String>] :environment_variables
343
- # Environment variables map for an Amplify App.
344
+ # The environment variables map for an Amplify app.
344
345
  #
345
346
  # @option params [Boolean] :enable_branch_auto_build
346
- # Enable the auto building of branches for an Amplify App.
347
+ # Enables the auto building of branches for an Amplify app.
348
+ #
349
+ # @option params [Boolean] :enable_branch_auto_deletion
350
+ # Automatically disconnects a branch in the Amplify Console when you
351
+ # delete a branch from your Git repository.
347
352
  #
348
353
  # @option params [Boolean] :enable_basic_auth
349
- # Enable Basic Authorization for an Amplify App, this will apply to all
350
- # branches part of this App.
354
+ # Enables basic authorization for an Amplify app. This will apply to all
355
+ # branches that are part of this app.
351
356
  #
352
357
  # @option params [String] :basic_auth_credentials
353
- # Credentials for Basic Authorization for an Amplify App.
358
+ # The credentials for basic authorization for an Amplify app.
354
359
  #
355
360
  # @option params [Array<Types::CustomRule>] :custom_rules
356
- # Custom rewrite / redirect rules for an Amplify App.
361
+ # The custom rewrite and redirect rules for an Amplify app.
357
362
  #
358
363
  # @option params [Hash<String,String>] :tags
359
- # Tag for an Amplify App
364
+ # The tag for an Amplify app.
360
365
  #
361
366
  # @option params [String] :build_spec
362
- # BuildSpec for an Amplify App
367
+ # The build specification (build spec) for an Amplify app.
363
368
  #
364
369
  # @option params [Boolean] :enable_auto_branch_creation
365
- # Enables automated branch creation for the Amplify App.
370
+ # Enables automated branch creation for the Amplify app.
366
371
  #
367
372
  # @option params [Array<String>] :auto_branch_creation_patterns
368
- # Automated branch creation glob patterns for the Amplify App.
373
+ # The automated branch creation glob patterns for the Amplify app.
369
374
  #
370
375
  # @option params [Types::AutoBranchCreationConfig] :auto_branch_creation_config
371
- # Automated branch creation config for the Amplify App.
376
+ # The automated branch creation configuration for the Amplify app.
372
377
  #
373
378
  # @return [Types::CreateAppResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
374
379
  #
@@ -388,6 +393,7 @@ module Aws::Amplify
388
393
  # "EnvKey" => "EnvValue",
389
394
  # },
390
395
  # enable_branch_auto_build: false,
396
+ # enable_branch_auto_deletion: false,
391
397
  # enable_basic_auth: false,
392
398
  # basic_auth_credentials: "BasicAuthCredentials",
393
399
  # custom_rules: [
@@ -436,6 +442,7 @@ module Aws::Amplify
436
442
  # resp.app.environment_variables["EnvKey"] #=> String
437
443
  # resp.app.default_domain #=> String
438
444
  # resp.app.enable_branch_auto_build #=> Boolean
445
+ # resp.app.enable_branch_auto_deletion #=> Boolean
439
446
  # resp.app.enable_basic_auth #=> Boolean
440
447
  # resp.app.basic_auth_credentials #=> String
441
448
  # resp.app.custom_rules #=> Array
@@ -471,19 +478,19 @@ module Aws::Amplify
471
478
  req.send_request(options)
472
479
  end
473
480
 
474
- # Creates a new backend environment for an Amplify App.
481
+ # Creates a new backend environment for an Amplify app.
475
482
  #
476
483
  # @option params [required, String] :app_id
477
- # Unique Id for an Amplify App.
484
+ # The unique ID for an Amplify app.
478
485
  #
479
486
  # @option params [required, String] :environment_name
480
- # Name for the backend environment.
487
+ # The name for the backend environment.
481
488
  #
482
489
  # @option params [String] :stack_name
483
- # CloudFormation stack name of backend environment.
490
+ # The AWS CloudFormation stack name of a backend environment.
484
491
  #
485
492
  # @option params [String] :deployment_artifacts
486
- # Name of deployment artifacts.
493
+ # The name of deployment artifacts.
487
494
  #
488
495
  # @return [Types::CreateBackendEnvironmentResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
489
496
  #
@@ -516,22 +523,22 @@ module Aws::Amplify
516
523
  req.send_request(options)
517
524
  end
518
525
 
519
- # Creates a new Branch for an Amplify App.
526
+ # Creates a new branch for an Amplify app.
520
527
  #
521
528
  # @option params [required, String] :app_id
522
- # Unique Id for an Amplify App.
529
+ # The unique ID for an Amplify app.
523
530
  #
524
531
  # @option params [required, String] :branch_name
525
- # Name for the branch.
532
+ # The name for the branch.
526
533
  #
527
534
  # @option params [String] :description
528
- # Description for the branch.
535
+ # The description for the branch.
529
536
  #
530
537
  # @option params [String] :stage
531
- # Stage for the branch.
538
+ # Describes the current stage for the branch.
532
539
  #
533
540
  # @option params [String] :framework
534
- # Framework for the branch.
541
+ # The framework for the branch.
535
542
  #
536
543
  # @option params [Boolean] :enable_notification
537
544
  # Enables notifications for the branch.
@@ -540,34 +547,36 @@ module Aws::Amplify
540
547
  # Enables auto building for the branch.
541
548
  #
542
549
  # @option params [Hash<String,String>] :environment_variables
543
- # Environment Variables for the branch.
550
+ # The environment variables for the branch.
544
551
  #
545
552
  # @option params [String] :basic_auth_credentials
546
- # Basic Authorization credentials for the branch.
553
+ # The basic authorization credentials for the branch.
547
554
  #
548
555
  # @option params [Boolean] :enable_basic_auth
549
- # Enables Basic Auth for the branch.
556
+ # Enables basic authorization for the branch.
550
557
  #
551
558
  # @option params [Hash<String,String>] :tags
552
- # Tag for the branch.
559
+ # The tag for the branch.
553
560
  #
554
561
  # @option params [String] :build_spec
555
- # BuildSpec for the branch.
562
+ # The build specification (build spec) for the branch.
556
563
  #
557
564
  # @option params [String] :ttl
558
- # The content TTL for the website in seconds.
565
+ # The content Time To Live (TTL) for the website in seconds.
559
566
  #
560
567
  # @option params [String] :display_name
561
- # Display name for a branch, will use as the default domain prefix.
568
+ # The display name for a branch. This is used as the default domain
569
+ # prefix.
562
570
  #
563
571
  # @option params [Boolean] :enable_pull_request_preview
564
- # Enables Pull Request Preview for this branch.
572
+ # Enables pull request preview for this branch.
565
573
  #
566
574
  # @option params [String] :pull_request_environment_name
567
- # The Amplify Environment name for the pull request.
575
+ # The Amplify environment name for the pull request.
568
576
  #
569
577
  # @option params [String] :backend_environment_arn
570
- # ARN for a Backend Environment, part of an Amplify App.
578
+ # The Amazon Resource Name (ARN) for a backend environment that is part
579
+ # of an Amplify app.
571
580
  #
572
581
  # @return [Types::CreateBranchResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
573
582
  #
@@ -641,20 +650,20 @@ module Aws::Amplify
641
650
  req.send_request(options)
642
651
  end
643
652
 
644
- # Create a deployment for manual deploy apps. (Apps are not connected to
645
- # repository)
653
+ # Creates a deployment for a manually deployed Amplify app. Manually
654
+ # deployed apps are not connected to a repository.
646
655
  #
647
656
  # @option params [required, String] :app_id
648
- # Unique Id for an Amplify App.
657
+ # The unique ID for an Amplify app.
649
658
  #
650
659
  # @option params [required, String] :branch_name
651
- # Name for the branch, for the Job.
660
+ # The name for the branch, for the job.
652
661
  #
653
662
  # @option params [Hash<String,String>] :file_map
654
- # Optional file map that contains file name as the key and file content
655
- # md5 hash as the value. If this argument is provided, the service will
656
- # generate different upload url per file. Otherwise, the service will
657
- # only generate a single upload url for the zipped files.
663
+ # An optional file map that contains the file name as the key and the
664
+ # file content md5 hash as the value. If this argument is provided, the
665
+ # service will generate a unique upload URL per file. Otherwise, the
666
+ # service will only generate a single upload URL for the zipped files.
658
667
  #
659
668
  # @return [Types::CreateDeploymentResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
660
669
  #
@@ -688,20 +697,27 @@ module Aws::Amplify
688
697
  req.send_request(options)
689
698
  end
690
699
 
691
- # Create a new DomainAssociation on an App
700
+ # Creates a new domain association for an Amplify app. This action
701
+ # associates a custom domain with the Amplify app
692
702
  #
693
703
  # @option params [required, String] :app_id
694
- # Unique Id for an Amplify App.
704
+ # The unique ID for an Amplify app.
695
705
  #
696
706
  # @option params [required, String] :domain_name
697
- # Domain name for the Domain Association.
707
+ # The domain name for the domain association.
698
708
  #
699
709
  # @option params [Boolean] :enable_auto_sub_domain
700
- # Enables automated creation of Subdomains for branches. (Currently not
701
- # supported)
710
+ # Enables the automated creation of subdomains for branches.
702
711
  #
703
712
  # @option params [required, Array<Types::SubDomainSetting>] :sub_domain_settings
704
- # Setting structure for the Subdomain.
713
+ # The setting for the subdomain.
714
+ #
715
+ # @option params [Array<String>] :auto_sub_domain_creation_patterns
716
+ # Sets the branch patterns for automatic subdomain creation.
717
+ #
718
+ # @option params [String] :auto_sub_domain_iam_role
719
+ # The required AWS Identity and Access Management (IAM) service role for
720
+ # the Amazon Resource Name (ARN) for automatically creating subdomains.
705
721
  #
706
722
  # @return [Types::CreateDomainAssociationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
707
723
  #
@@ -719,6 +735,8 @@ module Aws::Amplify
719
735
  # branch_name: "BranchName", # required
720
736
  # },
721
737
  # ],
738
+ # auto_sub_domain_creation_patterns: ["AutoSubDomainCreationPattern"],
739
+ # auto_sub_domain_iam_role: "AutoSubDomainIAMRole",
722
740
  # })
723
741
  #
724
742
  # @example Response structure
@@ -726,6 +744,9 @@ module Aws::Amplify
726
744
  # resp.domain_association.domain_association_arn #=> String
727
745
  # resp.domain_association.domain_name #=> String
728
746
  # resp.domain_association.enable_auto_sub_domain #=> Boolean
747
+ # resp.domain_association.auto_sub_domain_creation_patterns #=> Array
748
+ # resp.domain_association.auto_sub_domain_creation_patterns[0] #=> String
749
+ # resp.domain_association.auto_sub_domain_iam_role #=> String
729
750
  # resp.domain_association.domain_status #=> String, one of "PENDING_VERIFICATION", "IN_PROGRESS", "AVAILABLE", "PENDING_DEPLOYMENT", "FAILED", "CREATING", "REQUESTING_CERTIFICATE", "UPDATING"
730
751
  # resp.domain_association.status_reason #=> String
731
752
  # resp.domain_association.certificate_verification_dns_record #=> String
@@ -744,16 +765,16 @@ module Aws::Amplify
744
765
  req.send_request(options)
745
766
  end
746
767
 
747
- # Create a new webhook on an App.
768
+ # Creates a new webhook on an Amplify app.
748
769
  #
749
770
  # @option params [required, String] :app_id
750
- # Unique Id for an Amplify App.
771
+ # The unique ID for an Amplify app.
751
772
  #
752
773
  # @option params [required, String] :branch_name
753
- # Name for a branch, part of an Amplify App.
774
+ # The name for a branch that is part of an Amplify app.
754
775
  #
755
776
  # @option params [String] :description
756
- # Description for a webhook.
777
+ # The description for a webhook.
757
778
  #
758
779
  # @return [Types::CreateWebhookResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
759
780
  #
@@ -786,10 +807,10 @@ module Aws::Amplify
786
807
  req.send_request(options)
787
808
  end
788
809
 
789
- # Delete an existing Amplify App by appId.
810
+ # Deletes an existing Amplify app specified by an app ID.
790
811
  #
791
812
  # @option params [required, String] :app_id
792
- # Unique Id for an Amplify App.
813
+ # The unique ID for an Amplify app.
793
814
  #
794
815
  # @return [Types::DeleteAppResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
795
816
  #
@@ -818,6 +839,7 @@ module Aws::Amplify
818
839
  # resp.app.environment_variables["EnvKey"] #=> String
819
840
  # resp.app.default_domain #=> String
820
841
  # resp.app.enable_branch_auto_build #=> Boolean
842
+ # resp.app.enable_branch_auto_deletion #=> Boolean
821
843
  # resp.app.enable_basic_auth #=> Boolean
822
844
  # resp.app.basic_auth_credentials #=> String
823
845
  # resp.app.custom_rules #=> Array
@@ -853,13 +875,13 @@ module Aws::Amplify
853
875
  req.send_request(options)
854
876
  end
855
877
 
856
- # Delete backend environment for an Amplify App.
878
+ # Deletes a backend environment for an Amplify app.
857
879
  #
858
880
  # @option params [required, String] :app_id
859
- # Unique Id of an Amplify App.
881
+ # The unique ID of an Amplify app.
860
882
  #
861
883
  # @option params [required, String] :environment_name
862
- # Name of a backend environment of an Amplify App.
884
+ # The name of a backend environment of an Amplify app.
863
885
  #
864
886
  # @return [Types::DeleteBackendEnvironmentResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
865
887
  #
@@ -890,13 +912,13 @@ module Aws::Amplify
890
912
  req.send_request(options)
891
913
  end
892
914
 
893
- # Deletes a branch for an Amplify App.
915
+ # Deletes a branch for an Amplify app.
894
916
  #
895
917
  # @option params [required, String] :app_id
896
- # Unique Id for an Amplify App.
918
+ # The unique ID for an Amplify app.
897
919
  #
898
920
  # @option params [required, String] :branch_name
899
- # Name for the branch.
921
+ # The name for the branch.
900
922
  #
901
923
  # @return [Types::DeleteBranchResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
902
924
  #
@@ -951,13 +973,13 @@ module Aws::Amplify
951
973
  req.send_request(options)
952
974
  end
953
975
 
954
- # Deletes a DomainAssociation.
976
+ # Deletes a domain association for an Amplify app.
955
977
  #
956
978
  # @option params [required, String] :app_id
957
- # Unique Id for an Amplify App.
979
+ # The unique id for an Amplify app.
958
980
  #
959
981
  # @option params [required, String] :domain_name
960
- # Name of the domain.
982
+ # The name of the domain.
961
983
  #
962
984
  # @return [Types::DeleteDomainAssociationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
963
985
  #
@@ -975,6 +997,9 @@ module Aws::Amplify
975
997
  # resp.domain_association.domain_association_arn #=> String
976
998
  # resp.domain_association.domain_name #=> String
977
999
  # resp.domain_association.enable_auto_sub_domain #=> Boolean
1000
+ # resp.domain_association.auto_sub_domain_creation_patterns #=> Array
1001
+ # resp.domain_association.auto_sub_domain_creation_patterns[0] #=> String
1002
+ # resp.domain_association.auto_sub_domain_iam_role #=> String
978
1003
  # resp.domain_association.domain_status #=> String, one of "PENDING_VERIFICATION", "IN_PROGRESS", "AVAILABLE", "PENDING_DEPLOYMENT", "FAILED", "CREATING", "REQUESTING_CERTIFICATE", "UPDATING"
979
1004
  # resp.domain_association.status_reason #=> String
980
1005
  # resp.domain_association.certificate_verification_dns_record #=> String
@@ -993,16 +1018,16 @@ module Aws::Amplify
993
1018
  req.send_request(options)
994
1019
  end
995
1020
 
996
- # Delete a job, for an Amplify branch, part of Amplify App.
1021
+ # Deletes a job for a branch of an Amplify app.
997
1022
  #
998
1023
  # @option params [required, String] :app_id
999
- # Unique Id for an Amplify App.
1024
+ # The unique ID for an Amplify app.
1000
1025
  #
1001
1026
  # @option params [required, String] :branch_name
1002
- # Name for the branch, for the Job.
1027
+ # The name for the branch, for the job.
1003
1028
  #
1004
1029
  # @option params [required, String] :job_id
1005
- # Unique Id for the Job.
1030
+ # The unique ID for the job.
1006
1031
  #
1007
1032
  # @return [Types::DeleteJobResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1008
1033
  #
@@ -1040,7 +1065,7 @@ module Aws::Amplify
1040
1065
  # Deletes a webhook.
1041
1066
  #
1042
1067
  # @option params [required, String] :webhook_id
1043
- # Unique Id for a webhook.
1068
+ # The unique ID for a webhook.
1044
1069
  #
1045
1070
  # @return [Types::DeleteWebhookResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1046
1071
  #
@@ -1071,20 +1096,22 @@ module Aws::Amplify
1071
1096
  req.send_request(options)
1072
1097
  end
1073
1098
 
1074
- # Retrieve website access logs for a specific time range via a
1075
- # pre-signed URL.
1099
+ # Returns the website access logs for a specific time range using a
1100
+ # presigned URL.
1076
1101
  #
1077
1102
  # @option params [Time,DateTime,Date,Integer,String] :start_time
1078
- # The time at which the logs should start, inclusive.
1103
+ # The time at which the logs should start. The time range specified is
1104
+ # inclusive of the start time.
1079
1105
  #
1080
1106
  # @option params [Time,DateTime,Date,Integer,String] :end_time
1081
- # The time at which the logs should end, inclusive.
1107
+ # The time at which the logs should end. The time range specified is
1108
+ # inclusive of the end time.
1082
1109
  #
1083
1110
  # @option params [required, String] :domain_name
1084
- # Name of the domain.
1111
+ # The name of the domain.
1085
1112
  #
1086
1113
  # @option params [required, String] :app_id
1087
- # Unique Id for an Amplify App.
1114
+ # The unique ID for an Amplify app.
1088
1115
  #
1089
1116
  # @return [Types::GenerateAccessLogsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1090
1117
  #
@@ -1112,10 +1139,10 @@ module Aws::Amplify
1112
1139
  req.send_request(options)
1113
1140
  end
1114
1141
 
1115
- # Retrieves an existing Amplify App by appId.
1142
+ # Returns an existing Amplify app by appID.
1116
1143
  #
1117
1144
  # @option params [required, String] :app_id
1118
- # Unique Id for an Amplify App.
1145
+ # The unique ID for an Amplify app.
1119
1146
  #
1120
1147
  # @return [Types::GetAppResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1121
1148
  #
@@ -1144,6 +1171,7 @@ module Aws::Amplify
1144
1171
  # resp.app.environment_variables["EnvKey"] #=> String
1145
1172
  # resp.app.default_domain #=> String
1146
1173
  # resp.app.enable_branch_auto_build #=> Boolean
1174
+ # resp.app.enable_branch_auto_deletion #=> Boolean
1147
1175
  # resp.app.enable_basic_auth #=> Boolean
1148
1176
  # resp.app.basic_auth_credentials #=> String
1149
1177
  # resp.app.custom_rules #=> Array
@@ -1179,10 +1207,10 @@ module Aws::Amplify
1179
1207
  req.send_request(options)
1180
1208
  end
1181
1209
 
1182
- # Retrieves artifact info that corresponds to a artifactId.
1210
+ # Returns the artifact info that corresponds to an artifact id.
1183
1211
  #
1184
1212
  # @option params [required, String] :artifact_id
1185
- # Unique Id for a artifact.
1213
+ # The unique ID for an artifact.
1186
1214
  #
1187
1215
  # @return [Types::GetArtifactUrlResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1188
1216
  #
@@ -1209,13 +1237,13 @@ module Aws::Amplify
1209
1237
  req.send_request(options)
1210
1238
  end
1211
1239
 
1212
- # Retrieves a backend environment for an Amplify App.
1240
+ # Returns a backend environment for an Amplify app.
1213
1241
  #
1214
1242
  # @option params [required, String] :app_id
1215
- # Unique Id for an Amplify App.
1243
+ # The unique id for an Amplify app.
1216
1244
  #
1217
1245
  # @option params [required, String] :environment_name
1218
- # Name for the backend environment.
1246
+ # The name for the backend environment.
1219
1247
  #
1220
1248
  # @return [Types::GetBackendEnvironmentResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1221
1249
  #
@@ -1246,13 +1274,13 @@ module Aws::Amplify
1246
1274
  req.send_request(options)
1247
1275
  end
1248
1276
 
1249
- # Retrieves a branch for an Amplify App.
1277
+ # Returns a branch for an Amplify app.
1250
1278
  #
1251
1279
  # @option params [required, String] :app_id
1252
- # Unique Id for an Amplify App.
1280
+ # The unique ID for an Amplify app.
1253
1281
  #
1254
1282
  # @option params [required, String] :branch_name
1255
- # Name for the branch.
1283
+ # The name for the branch.
1256
1284
  #
1257
1285
  # @return [Types::GetBranchResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1258
1286
  #
@@ -1307,13 +1335,13 @@ module Aws::Amplify
1307
1335
  req.send_request(options)
1308
1336
  end
1309
1337
 
1310
- # Retrieves domain info that corresponds to an appId and domainName.
1338
+ # Returns the domain information for an Amplify app.
1311
1339
  #
1312
1340
  # @option params [required, String] :app_id
1313
- # Unique Id for an Amplify App.
1341
+ # The unique id for an Amplify app.
1314
1342
  #
1315
1343
  # @option params [required, String] :domain_name
1316
- # Name of the domain.
1344
+ # The name of the domain.
1317
1345
  #
1318
1346
  # @return [Types::GetDomainAssociationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1319
1347
  #
@@ -1331,6 +1359,9 @@ module Aws::Amplify
1331
1359
  # resp.domain_association.domain_association_arn #=> String
1332
1360
  # resp.domain_association.domain_name #=> String
1333
1361
  # resp.domain_association.enable_auto_sub_domain #=> Boolean
1362
+ # resp.domain_association.auto_sub_domain_creation_patterns #=> Array
1363
+ # resp.domain_association.auto_sub_domain_creation_patterns[0] #=> String
1364
+ # resp.domain_association.auto_sub_domain_iam_role #=> String
1334
1365
  # resp.domain_association.domain_status #=> String, one of "PENDING_VERIFICATION", "IN_PROGRESS", "AVAILABLE", "PENDING_DEPLOYMENT", "FAILED", "CREATING", "REQUESTING_CERTIFICATE", "UPDATING"
1335
1366
  # resp.domain_association.status_reason #=> String
1336
1367
  # resp.domain_association.certificate_verification_dns_record #=> String
@@ -1349,16 +1380,16 @@ module Aws::Amplify
1349
1380
  req.send_request(options)
1350
1381
  end
1351
1382
 
1352
- # Get a job for a branch, part of an Amplify App.
1383
+ # Returns a job for a branch of an Amplify app.
1353
1384
  #
1354
1385
  # @option params [required, String] :app_id
1355
- # Unique Id for an Amplify App.
1386
+ # The unique ID for an Amplify app.
1356
1387
  #
1357
1388
  # @option params [required, String] :branch_name
1358
- # Name for the branch, for the Job.
1389
+ # The branch name for the job.
1359
1390
  #
1360
1391
  # @option params [required, String] :job_id
1361
- # Unique Id for the Job.
1392
+ # The unique ID for the job.
1362
1393
  #
1363
1394
  # @return [Types::GetJobResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1364
1395
  #
@@ -1406,10 +1437,11 @@ module Aws::Amplify
1406
1437
  req.send_request(options)
1407
1438
  end
1408
1439
 
1409
- # Retrieves webhook info that corresponds to a webhookId.
1440
+ # Returns the webhook information that corresponds to a specified
1441
+ # webhook ID.
1410
1442
  #
1411
1443
  # @option params [required, String] :webhook_id
1412
- # Unique Id for a webhook.
1444
+ # The unique ID for a webhook.
1413
1445
  #
1414
1446
  # @return [Types::GetWebhookResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1415
1447
  #
@@ -1440,14 +1472,14 @@ module Aws::Amplify
1440
1472
  req.send_request(options)
1441
1473
  end
1442
1474
 
1443
- # Lists existing Amplify Apps.
1475
+ # Returns a list of the existing Amplify apps.
1444
1476
  #
1445
1477
  # @option params [String] :next_token
1446
- # Pagination token. If non-null pagination token is returned in a
1447
- # result, then pass its value in another request to fetch more entries.
1478
+ # A pagination token. If non-null, the pagination token is returned in a
1479
+ # result. Pass its value in another request to retrieve more entries.
1448
1480
  #
1449
1481
  # @option params [Integer] :max_results
1450
- # Maximum number of records to list in a single response.
1482
+ # The maximum number of records to list in a single response.
1451
1483
  #
1452
1484
  # @return [Types::ListAppsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1453
1485
  #
@@ -1479,6 +1511,7 @@ module Aws::Amplify
1479
1511
  # resp.apps[0].environment_variables["EnvKey"] #=> String
1480
1512
  # resp.apps[0].default_domain #=> String
1481
1513
  # resp.apps[0].enable_branch_auto_build #=> Boolean
1514
+ # resp.apps[0].enable_branch_auto_deletion #=> Boolean
1482
1515
  # resp.apps[0].enable_basic_auth #=> Boolean
1483
1516
  # resp.apps[0].basic_auth_credentials #=> String
1484
1517
  # resp.apps[0].custom_rules #=> Array
@@ -1515,24 +1548,24 @@ module Aws::Amplify
1515
1548
  req.send_request(options)
1516
1549
  end
1517
1550
 
1518
- # List artifacts with an app, a branch, a job and an artifact type.
1551
+ # Returns a list of artifacts for a specified app, branch, and job.
1519
1552
  #
1520
1553
  # @option params [required, String] :app_id
1521
- # Unique Id for an Amplify App.
1554
+ # The unique ID for an Amplify app.
1522
1555
  #
1523
1556
  # @option params [required, String] :branch_name
1524
- # Name for a branch, part of an Amplify App.
1557
+ # The name of a branch that is part of an Amplify app.
1525
1558
  #
1526
1559
  # @option params [required, String] :job_id
1527
- # Unique Id for an Job.
1560
+ # The unique ID for a job.
1528
1561
  #
1529
1562
  # @option params [String] :next_token
1530
- # Pagination token. Set to null to start listing artifacts from start.
1531
- # If non-null pagination token is returned in a result, then pass its
1532
- # value in here to list more artifacts.
1563
+ # A pagination token. Set to null to start listing artifacts from start.
1564
+ # If a non-null pagination token is returned in a result, pass its value
1565
+ # in here to list more artifacts.
1533
1566
  #
1534
1567
  # @option params [Integer] :max_results
1535
- # Maximum number of records to list in a single response.
1568
+ # The maximum number of records to list in a single response.
1536
1569
  #
1537
1570
  # @return [Types::ListArtifactsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1538
1571
  #
@@ -1565,21 +1598,21 @@ module Aws::Amplify
1565
1598
  req.send_request(options)
1566
1599
  end
1567
1600
 
1568
- # Lists backend environments for an Amplify App.
1601
+ # Lists the backend environments for an Amplify app.
1569
1602
  #
1570
1603
  # @option params [required, String] :app_id
1571
- # Unique Id for an amplify App.
1604
+ # The unique ID for an Amplify app.
1572
1605
  #
1573
1606
  # @option params [String] :environment_name
1574
- # Name of the backend environment
1607
+ # The name of the backend environment
1575
1608
  #
1576
1609
  # @option params [String] :next_token
1577
- # Pagination token. Set to null to start listing backen environments
1578
- # from start. If a non-null pagination token is returned in a result,
1579
- # then pass its value in here to list more backend environments.
1610
+ # A pagination token. Set to null to start listing backend environments
1611
+ # from the start. If a non-null pagination token is returned in a
1612
+ # result, pass its value in here to list more backend environments.
1580
1613
  #
1581
1614
  # @option params [Integer] :max_results
1582
- # Maximum number of records to list in a single response.
1615
+ # The maximum number of records to list in a single response.
1583
1616
  #
1584
1617
  # @return [Types::ListBackendEnvironmentsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1585
1618
  #
@@ -1615,18 +1648,18 @@ module Aws::Amplify
1615
1648
  req.send_request(options)
1616
1649
  end
1617
1650
 
1618
- # Lists branches for an Amplify App.
1651
+ # Lists the branches of an Amplify app.
1619
1652
  #
1620
1653
  # @option params [required, String] :app_id
1621
- # Unique Id for an Amplify App.
1654
+ # The unique ID for an Amplify app.
1622
1655
  #
1623
1656
  # @option params [String] :next_token
1624
- # Pagination token. Set to null to start listing branches from start. If
1625
- # a non-null pagination token is returned in a result, then pass its
1626
- # value in here to list more branches.
1657
+ # A pagination token. Set to null to start listing branches from the
1658
+ # start. If a non-null pagination token is returned in a result, pass
1659
+ # its value in here to list more branches.
1627
1660
  #
1628
1661
  # @option params [Integer] :max_results
1629
- # Maximum number of records to list in a single response.
1662
+ # The maximum number of records to list in a single response.
1630
1663
  #
1631
1664
  # @return [Types::ListBranchesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1632
1665
  #
@@ -1685,18 +1718,18 @@ module Aws::Amplify
1685
1718
  req.send_request(options)
1686
1719
  end
1687
1720
 
1688
- # List domains with an app
1721
+ # Returns the domain associations for an Amplify app.
1689
1722
  #
1690
1723
  # @option params [required, String] :app_id
1691
- # Unique Id for an Amplify App.
1724
+ # The unique ID for an Amplify app.
1692
1725
  #
1693
1726
  # @option params [String] :next_token
1694
- # Pagination token. Set to null to start listing Apps from start. If
1695
- # non-null pagination token is returned in a result, then pass its value
1696
- # in here to list more projects.
1727
+ # A pagination token. Set to null to start listing apps from the start.
1728
+ # If non-null, a pagination token is returned in a result. Pass its
1729
+ # value in here to list more projects.
1697
1730
  #
1698
1731
  # @option params [Integer] :max_results
1699
- # Maximum number of records to list in a single response.
1732
+ # The maximum number of records to list in a single response.
1700
1733
  #
1701
1734
  # @return [Types::ListDomainAssociationsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1702
1735
  #
@@ -1717,6 +1750,9 @@ module Aws::Amplify
1717
1750
  # resp.domain_associations[0].domain_association_arn #=> String
1718
1751
  # resp.domain_associations[0].domain_name #=> String
1719
1752
  # resp.domain_associations[0].enable_auto_sub_domain #=> Boolean
1753
+ # resp.domain_associations[0].auto_sub_domain_creation_patterns #=> Array
1754
+ # resp.domain_associations[0].auto_sub_domain_creation_patterns[0] #=> String
1755
+ # resp.domain_associations[0].auto_sub_domain_iam_role #=> String
1720
1756
  # resp.domain_associations[0].domain_status #=> String, one of "PENDING_VERIFICATION", "IN_PROGRESS", "AVAILABLE", "PENDING_DEPLOYMENT", "FAILED", "CREATING", "REQUESTING_CERTIFICATE", "UPDATING"
1721
1757
  # resp.domain_associations[0].status_reason #=> String
1722
1758
  # resp.domain_associations[0].certificate_verification_dns_record #=> String
@@ -1736,21 +1772,21 @@ module Aws::Amplify
1736
1772
  req.send_request(options)
1737
1773
  end
1738
1774
 
1739
- # List Jobs for a branch, part of an Amplify App.
1775
+ # Lists the jobs for a branch of an Amplify app.
1740
1776
  #
1741
1777
  # @option params [required, String] :app_id
1742
- # Unique Id for an Amplify App.
1778
+ # The unique ID for an Amplify app.
1743
1779
  #
1744
1780
  # @option params [required, String] :branch_name
1745
- # Name for a branch.
1781
+ # The name for a branch.
1746
1782
  #
1747
1783
  # @option params [String] :next_token
1748
- # Pagination token. Set to null to start listing steps from start. If a
1749
- # non-null pagination token is returned in a result, then pass its value
1784
+ # A pagination token. Set to null to start listing steps from the start.
1785
+ # If a non-null pagination token is returned in a result, pass its value
1750
1786
  # in here to list more steps.
1751
1787
  #
1752
1788
  # @option params [Integer] :max_results
1753
- # Maximum number of records to list in a single response.
1789
+ # The maximum number of records to list in a single response.
1754
1790
  #
1755
1791
  # @return [Types::ListJobsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1756
1792
  #
@@ -1789,10 +1825,10 @@ module Aws::Amplify
1789
1825
  req.send_request(options)
1790
1826
  end
1791
1827
 
1792
- # List tags for resource.
1828
+ # Returns a list of tags for a specified Amazon Resource Name (ARN).
1793
1829
  #
1794
1830
  # @option params [required, String] :resource_arn
1795
- # Resource arn used to list tags.
1831
+ # The Amazon Resource Name (ARN) to use to list tags.
1796
1832
  #
1797
1833
  # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1798
1834
  #
@@ -1818,18 +1854,18 @@ module Aws::Amplify
1818
1854
  req.send_request(options)
1819
1855
  end
1820
1856
 
1821
- # List webhooks with an app.
1857
+ # Returns a list of webhooks for an Amplify app.
1822
1858
  #
1823
1859
  # @option params [required, String] :app_id
1824
- # Unique Id for an Amplify App.
1860
+ # The unique ID for an Amplify app.
1825
1861
  #
1826
1862
  # @option params [String] :next_token
1827
- # Pagination token. Set to null to start listing webhooks from start. If
1828
- # non-null pagination token is returned in a result, then pass its value
1829
- # in here to list more webhooks.
1863
+ # A pagination token. Set to null to start listing webhooks from the
1864
+ # start. If non-null,the pagination token is returned in a result. Pass
1865
+ # its value in here to list more webhooks.
1830
1866
  #
1831
1867
  # @option params [Integer] :max_results
1832
- # Maximum number of records to list in a single response.
1868
+ # The maximum number of records to list in a single response.
1833
1869
  #
1834
1870
  # @return [Types::ListWebhooksResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1835
1871
  #
@@ -1865,23 +1901,23 @@ module Aws::Amplify
1865
1901
  req.send_request(options)
1866
1902
  end
1867
1903
 
1868
- # Start a deployment for manual deploy apps. (Apps are not connected to
1869
- # repository)
1904
+ # Starts a deployment for a manually deployed app. Manually deployed
1905
+ # apps are not connected to a repository.
1870
1906
  #
1871
1907
  # @option params [required, String] :app_id
1872
- # Unique Id for an Amplify App.
1908
+ # The unique ID for an Amplify app.
1873
1909
  #
1874
1910
  # @option params [required, String] :branch_name
1875
- # Name for the branch, for the Job.
1911
+ # The name for the branch, for the job.
1876
1912
  #
1877
1913
  # @option params [String] :job_id
1878
- # The job id for this deployment, generated by create deployment
1914
+ # The job ID for this deployment, generated by the create deployment
1879
1915
  # request.
1880
1916
  #
1881
1917
  # @option params [String] :source_url
1882
- # The sourceUrl for this deployment, used when calling start deployment
1883
- # without create deployment. SourceUrl can be any HTTP GET url that is
1884
- # public accessible and downloads a single zip.
1918
+ # The source URL for this deployment, used when calling start deployment
1919
+ # without create deployment. The source URL can be any HTTP GET URL that
1920
+ # is publicly accessible and downloads a single .zip file.
1885
1921
  #
1886
1922
  # @return [Types::StartDeploymentResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1887
1923
  #
@@ -1917,34 +1953,36 @@ module Aws::Amplify
1917
1953
  req.send_request(options)
1918
1954
  end
1919
1955
 
1920
- # Starts a new job for a branch, part of an Amplify App.
1956
+ # Starts a new job for a branch of an Amplify app.
1921
1957
  #
1922
1958
  # @option params [required, String] :app_id
1923
- # Unique Id for an Amplify App.
1959
+ # The unique ID for an Amplify app.
1924
1960
  #
1925
1961
  # @option params [required, String] :branch_name
1926
- # Name for the branch, for the Job.
1962
+ # The branch name for the job.
1927
1963
  #
1928
1964
  # @option params [String] :job_id
1929
- # Unique Id for an existing job. Required for "RETRY" JobType.
1965
+ # The unique ID for an existing job. This is required if the value of
1966
+ # `jobType` is `RETRY`.
1930
1967
  #
1931
1968
  # @option params [required, String] :job_type
1932
- # Type for the Job. Available JobTypes are: \\n "RELEASE": Start a new
1933
- # job with the latest change from the specified branch. Only available
1934
- # for apps that have connected to a repository. "RETRY": Retry an
1935
- # existing job. JobId is required for this type of job.
1969
+ # Describes the type for the job. The job type `RELEASE` starts a new
1970
+ # job with the latest change from the specified branch. This value is
1971
+ # available only for apps that are connected to a repository. The job
1972
+ # type `RETRY` retries an existing job. If the job type value is
1973
+ # `RETRY`, the `jobId` is also required.
1936
1974
  #
1937
1975
  # @option params [String] :job_reason
1938
- # Descriptive reason for starting this job.
1976
+ # A descriptive reason for starting this job.
1939
1977
  #
1940
1978
  # @option params [String] :commit_id
1941
- # Commit Id from 3rd party repository provider for the Job.
1979
+ # The commit ID from a third-party repository provider for the job.
1942
1980
  #
1943
1981
  # @option params [String] :commit_message
1944
- # Commit message from 3rd party repository provider for the Job.
1982
+ # The commit message from a third-party repository provider for the job.
1945
1983
  #
1946
1984
  # @option params [Time,DateTime,Date,Integer,String] :commit_time
1947
- # Commit date / time for the Job.
1985
+ # The commit date and time for the job.
1948
1986
  #
1949
1987
  # @return [Types::StartJobResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1950
1988
  #
@@ -1984,17 +2022,16 @@ module Aws::Amplify
1984
2022
  req.send_request(options)
1985
2023
  end
1986
2024
 
1987
- # Stop a job that is in progress, for an Amplify branch, part of Amplify
1988
- # App.
2025
+ # Stops a job that is in progress for a branch of an Amplify app.
1989
2026
  #
1990
2027
  # @option params [required, String] :app_id
1991
- # Unique Id for an Amplify App.
2028
+ # The unique ID for an Amplify app.
1992
2029
  #
1993
2030
  # @option params [required, String] :branch_name
1994
- # Name for the branch, for the Job.
2031
+ # The name for the branch, for the job.
1995
2032
  #
1996
2033
  # @option params [required, String] :job_id
1997
- # Unique Id for the Job.
2034
+ # The unique id for the job.
1998
2035
  #
1999
2036
  # @return [Types::StopJobResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2000
2037
  #
@@ -2029,13 +2066,13 @@ module Aws::Amplify
2029
2066
  req.send_request(options)
2030
2067
  end
2031
2068
 
2032
- # Tag resource with tag key and value.
2069
+ # Tags the resource with a tag key and value.
2033
2070
  #
2034
2071
  # @option params [required, String] :resource_arn
2035
- # Resource arn used to tag resource.
2072
+ # The Amazon Resource Name (ARN) to use to tag a resource.
2036
2073
  #
2037
2074
  # @option params [required, Hash<String,String>] :tags
2038
- # Tags used to tag resource.
2075
+ # The tags used to tag the resource.
2039
2076
  #
2040
2077
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2041
2078
  #
@@ -2057,13 +2094,13 @@ module Aws::Amplify
2057
2094
  req.send_request(options)
2058
2095
  end
2059
2096
 
2060
- # Untag resource with resourceArn.
2097
+ # Untags a resource with a specified Amazon Resource Name (ARN).
2061
2098
  #
2062
2099
  # @option params [required, String] :resource_arn
2063
- # Resource arn used to untag resource.
2100
+ # The Amazon Resource Name (ARN) to use to untag a resource.
2064
2101
  #
2065
2102
  # @option params [required, Array<String>] :tag_keys
2066
- # Tag keys used to untag resource.
2103
+ # The tag keys to use to untag a resource.
2067
2104
  #
2068
2105
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2069
2106
  #
@@ -2083,62 +2120,68 @@ module Aws::Amplify
2083
2120
  req.send_request(options)
2084
2121
  end
2085
2122
 
2086
- # Updates an existing Amplify App.
2123
+ # Updates an existing Amplify app.
2087
2124
  #
2088
2125
  # @option params [required, String] :app_id
2089
- # Unique Id for an Amplify App.
2126
+ # The unique ID for an Amplify app.
2090
2127
  #
2091
2128
  # @option params [String] :name
2092
- # Name for an Amplify App.
2129
+ # The name for an Amplify app.
2093
2130
  #
2094
2131
  # @option params [String] :description
2095
- # Description for an Amplify App.
2132
+ # The description for an Amplify app.
2096
2133
  #
2097
2134
  # @option params [String] :platform
2098
- # Platform for an Amplify App.
2135
+ # The platform for an Amplify app.
2099
2136
  #
2100
2137
  # @option params [String] :iam_service_role_arn
2101
- # IAM service role for an Amplify App.
2138
+ # The AWS Identity and Access Management (IAM) service role for an
2139
+ # Amplify app.
2102
2140
  #
2103
2141
  # @option params [Hash<String,String>] :environment_variables
2104
- # Environment Variables for an Amplify App.
2142
+ # The environment variables for an Amplify app.
2105
2143
  #
2106
2144
  # @option params [Boolean] :enable_branch_auto_build
2107
- # Enables branch auto-building for an Amplify App.
2145
+ # Enables branch auto-building for an Amplify app.
2146
+ #
2147
+ # @option params [Boolean] :enable_branch_auto_deletion
2148
+ # Automatically disconnects a branch in the Amplify Console when you
2149
+ # delete a branch from your Git repository.
2108
2150
  #
2109
2151
  # @option params [Boolean] :enable_basic_auth
2110
- # Enables Basic Authorization for an Amplify App.
2152
+ # Enables basic authorization for an Amplify app.
2111
2153
  #
2112
2154
  # @option params [String] :basic_auth_credentials
2113
- # Basic Authorization credentials for an Amplify App.
2155
+ # The basic authorization credentials for an Amplify app.
2114
2156
  #
2115
2157
  # @option params [Array<Types::CustomRule>] :custom_rules
2116
- # Custom redirect / rewrite rules for an Amplify App.
2158
+ # The custom redirect and rewrite rules for an Amplify app.
2117
2159
  #
2118
2160
  # @option params [String] :build_spec
2119
- # BuildSpec for an Amplify App.
2161
+ # The build specification (build spec) for an Amplify app.
2120
2162
  #
2121
2163
  # @option params [Boolean] :enable_auto_branch_creation
2122
- # Enables automated branch creation for the Amplify App.
2164
+ # Enables automated branch creation for the Amplify app.
2123
2165
  #
2124
2166
  # @option params [Array<String>] :auto_branch_creation_patterns
2125
- # Automated branch creation glob patterns for the Amplify App.
2167
+ # Describes the automated branch creation glob patterns for the Amplify
2168
+ # app.
2126
2169
  #
2127
2170
  # @option params [Types::AutoBranchCreationConfig] :auto_branch_creation_config
2128
- # Automated branch creation branchConfig for the Amplify App.
2171
+ # The automated branch creation configuration for the Amplify app.
2129
2172
  #
2130
2173
  # @option params [String] :repository
2131
- # Repository for an Amplify App
2174
+ # The name of the repository for an Amplify app
2132
2175
  #
2133
2176
  # @option params [String] :oauth_token
2134
- # OAuth token for 3rd party source control system for an Amplify App,
2135
- # used to create webhook and read-only deploy key. OAuth token is not
2136
- # stored.
2177
+ # The OAuth token for a third-party source control system for an Amplify
2178
+ # app. The token is used to create a webhook and a read-only deploy key.
2179
+ # The OAuth token is not stored.
2137
2180
  #
2138
2181
  # @option params [String] :access_token
2139
- # Personal Access token for 3rd party source control system for an
2140
- # Amplify App, used to create webhook and read-only deploy key. Token is
2141
- # not stored.
2182
+ # The personal access token for a third-party source control system for
2183
+ # an Amplify app. The token is used to create webhook and a read-only
2184
+ # deploy key. The token is not stored.
2142
2185
  #
2143
2186
  # @return [Types::UpdateAppResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2144
2187
  #
@@ -2156,6 +2199,7 @@ module Aws::Amplify
2156
2199
  # "EnvKey" => "EnvValue",
2157
2200
  # },
2158
2201
  # enable_branch_auto_build: false,
2202
+ # enable_branch_auto_deletion: false,
2159
2203
  # enable_basic_auth: false,
2160
2204
  # basic_auth_credentials: "BasicAuthCredentials",
2161
2205
  # custom_rules: [
@@ -2204,6 +2248,7 @@ module Aws::Amplify
2204
2248
  # resp.app.environment_variables["EnvKey"] #=> String
2205
2249
  # resp.app.default_domain #=> String
2206
2250
  # resp.app.enable_branch_auto_build #=> Boolean
2251
+ # resp.app.enable_branch_auto_deletion #=> Boolean
2207
2252
  # resp.app.enable_basic_auth #=> Boolean
2208
2253
  # resp.app.basic_auth_credentials #=> String
2209
2254
  # resp.app.custom_rules #=> Array
@@ -2239,22 +2284,22 @@ module Aws::Amplify
2239
2284
  req.send_request(options)
2240
2285
  end
2241
2286
 
2242
- # Updates a branch for an Amplify App.
2287
+ # Updates a branch for an Amplify app.
2243
2288
  #
2244
2289
  # @option params [required, String] :app_id
2245
- # Unique Id for an Amplify App.
2290
+ # The unique ID for an Amplify app.
2246
2291
  #
2247
2292
  # @option params [required, String] :branch_name
2248
- # Name for the branch.
2293
+ # The name for the branch.
2249
2294
  #
2250
2295
  # @option params [String] :description
2251
- # Description for the branch.
2296
+ # The description for the branch.
2252
2297
  #
2253
2298
  # @option params [String] :framework
2254
- # Framework for the branch.
2299
+ # The framework for the branch.
2255
2300
  #
2256
2301
  # @option params [String] :stage
2257
- # Stage for the branch.
2302
+ # Describes the current stage for the branch.
2258
2303
  #
2259
2304
  # @option params [Boolean] :enable_notification
2260
2305
  # Enables notifications for the branch.
@@ -2263,31 +2308,33 @@ module Aws::Amplify
2263
2308
  # Enables auto building for the branch.
2264
2309
  #
2265
2310
  # @option params [Hash<String,String>] :environment_variables
2266
- # Environment Variables for the branch.
2311
+ # The environment variables for the branch.
2267
2312
  #
2268
2313
  # @option params [String] :basic_auth_credentials
2269
- # Basic Authorization credentials for the branch.
2314
+ # The basic authorization credentials for the branch.
2270
2315
  #
2271
2316
  # @option params [Boolean] :enable_basic_auth
2272
- # Enables Basic Auth for the branch.
2317
+ # Enables basic authorization for the branch.
2273
2318
  #
2274
2319
  # @option params [String] :build_spec
2275
- # BuildSpec for the branch.
2320
+ # The build specification (build spec) for the branch.
2276
2321
  #
2277
2322
  # @option params [String] :ttl
2278
- # The content TTL for the website in seconds.
2323
+ # The content Time to Live (TTL) for the website in seconds.
2279
2324
  #
2280
2325
  # @option params [String] :display_name
2281
- # Display name for a branch, will use as the default domain prefix.
2326
+ # The display name for a branch. This is used as the default domain
2327
+ # prefix.
2282
2328
  #
2283
2329
  # @option params [Boolean] :enable_pull_request_preview
2284
- # Enables Pull Request Preview for this branch.
2330
+ # Enables pull request preview for this branch.
2285
2331
  #
2286
2332
  # @option params [String] :pull_request_environment_name
2287
- # The Amplify Environment name for the pull request.
2333
+ # The Amplify environment name for the pull request.
2288
2334
  #
2289
2335
  # @option params [String] :backend_environment_arn
2290
- # ARN for a Backend Environment, part of an Amplify App.
2336
+ # The Amazon Resource Name (ARN) for a backend environment that is part
2337
+ # of an Amplify app.
2291
2338
  #
2292
2339
  # @return [Types::UpdateBranchResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2293
2340
  #
@@ -2358,20 +2405,26 @@ module Aws::Amplify
2358
2405
  req.send_request(options)
2359
2406
  end
2360
2407
 
2361
- # Create a new DomainAssociation on an App
2408
+ # Creates a new domain association for an Amplify app.
2362
2409
  #
2363
2410
  # @option params [required, String] :app_id
2364
- # Unique Id for an Amplify App.
2411
+ # The unique ID for an Amplify app.
2365
2412
  #
2366
2413
  # @option params [required, String] :domain_name
2367
- # Name of the domain.
2414
+ # The name of the domain.
2368
2415
  #
2369
2416
  # @option params [Boolean] :enable_auto_sub_domain
2370
- # Enables automated creation of Subdomains for branches. (Currently not
2371
- # supported)
2417
+ # Enables the automated creation of subdomains for branches.
2372
2418
  #
2373
2419
  # @option params [required, Array<Types::SubDomainSetting>] :sub_domain_settings
2374
- # Setting structure for the Subdomain.
2420
+ # Describes the settings for the subdomain.
2421
+ #
2422
+ # @option params [Array<String>] :auto_sub_domain_creation_patterns
2423
+ # Sets the branch patterns for automatic subdomain creation.
2424
+ #
2425
+ # @option params [String] :auto_sub_domain_iam_role
2426
+ # The required AWS Identity and Access Management (IAM) service role for
2427
+ # the Amazon Resource Name (ARN) for automatically creating subdomains.
2375
2428
  #
2376
2429
  # @return [Types::UpdateDomainAssociationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2377
2430
  #
@@ -2389,6 +2442,8 @@ module Aws::Amplify
2389
2442
  # branch_name: "BranchName", # required
2390
2443
  # },
2391
2444
  # ],
2445
+ # auto_sub_domain_creation_patterns: ["AutoSubDomainCreationPattern"],
2446
+ # auto_sub_domain_iam_role: "AutoSubDomainIAMRole",
2392
2447
  # })
2393
2448
  #
2394
2449
  # @example Response structure
@@ -2396,6 +2451,9 @@ module Aws::Amplify
2396
2451
  # resp.domain_association.domain_association_arn #=> String
2397
2452
  # resp.domain_association.domain_name #=> String
2398
2453
  # resp.domain_association.enable_auto_sub_domain #=> Boolean
2454
+ # resp.domain_association.auto_sub_domain_creation_patterns #=> Array
2455
+ # resp.domain_association.auto_sub_domain_creation_patterns[0] #=> String
2456
+ # resp.domain_association.auto_sub_domain_iam_role #=> String
2399
2457
  # resp.domain_association.domain_status #=> String, one of "PENDING_VERIFICATION", "IN_PROGRESS", "AVAILABLE", "PENDING_DEPLOYMENT", "FAILED", "CREATING", "REQUESTING_CERTIFICATE", "UPDATING"
2400
2458
  # resp.domain_association.status_reason #=> String
2401
2459
  # resp.domain_association.certificate_verification_dns_record #=> String
@@ -2414,16 +2472,16 @@ module Aws::Amplify
2414
2472
  req.send_request(options)
2415
2473
  end
2416
2474
 
2417
- # Update a webhook.
2475
+ # Updates a webhook.
2418
2476
  #
2419
2477
  # @option params [required, String] :webhook_id
2420
- # Unique Id for a webhook.
2478
+ # The unique ID for a webhook.
2421
2479
  #
2422
2480
  # @option params [String] :branch_name
2423
- # Name for a branch, part of an Amplify App.
2481
+ # The name for a branch that is part of an Amplify app.
2424
2482
  #
2425
2483
  # @option params [String] :description
2426
- # Description for a webhook.
2484
+ # The description for a webhook.
2427
2485
  #
2428
2486
  # @return [Types::UpdateWebhookResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2429
2487
  #
@@ -2469,7 +2527,7 @@ module Aws::Amplify
2469
2527
  params: params,
2470
2528
  config: config)
2471
2529
  context[:gem_name] = 'aws-sdk-amplify'
2472
- context[:gem_version] = '1.19.0'
2530
+ context[:gem_version] = '1.20.0'
2473
2531
  Seahorse::Client::Request.new(handlers, context)
2474
2532
  end
2475
2533