aws-sdk-amplify 1.15.0 → 1.20.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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: dd8bdb41bca8bf9b4ba8892872bc4fad4c2df5dd3c28447595764d99f7925b74
4
- data.tar.gz: 836f214954f59f45f30b69585808e3981f9c68028dc2440ea8d15738b92e2f12
3
+ metadata.gz: 839ec4be829737d6749683784879b11e7683f65c0fb0a011617d722753aba644
4
+ data.tar.gz: d5b5e85b2b055a62d435c00fceea214bde066c5f2789eb82bb3a5ddb464a6ff4
5
5
  SHA512:
6
- metadata.gz: 054c8fccb23aee169c154c5080095be345e3461f9e7529019bc5c19be6434a72bbcfebb9257c04bcef8c047cb5a83ae75f54bf2430ef4737c95dc51a94f1cb2e
7
- data.tar.gz: ae98ccf48bae7b3bd998d160dd4eefebe1d30ce8d8e7193b9d4b937ab0594b79bfe59fcdb978b9a3695091bcfa3f7c23fdfaaf8634d020d505e5f64a69896196
6
+ metadata.gz: e801bc58aff85c850b3703f202b420cd512a25fed8a986e857a3689c42afcff98846b969d8b57ab8719e8b9271419b9f09259d1496372c9c3c56283140d4f65e
7
+ data.tar.gz: 56ccf423c515e20a87a22f53ec739c9be42ac1c37ceb14e7d7e3b1a52c93d567103a147814b9d61487e4af5f8ba6218808cf4980c9204f0aea3b3f0782ed4e09
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -45,6 +47,6 @@ require_relative 'aws-sdk-amplify/customizations'
45
47
  # @service
46
48
  module Aws::Amplify
47
49
 
48
- GEM_VERSION = '1.15.0'
50
+ GEM_VERSION = '1.20.0'
49
51
 
50
52
  end
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -24,6 +26,7 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
24
26
  require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
25
27
  require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
26
28
  require 'aws-sdk-core/plugins/transfer_encoding.rb'
29
+ require 'aws-sdk-core/plugins/http_checksum.rb'
27
30
  require 'aws-sdk-core/plugins/signature_v4.rb'
28
31
  require 'aws-sdk-core/plugins/protocols/rest_json.rb'
29
32
 
@@ -69,6 +72,7 @@ module Aws::Amplify
69
72
  add_plugin(Aws::Plugins::ClientMetricsPlugin)
70
73
  add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
71
74
  add_plugin(Aws::Plugins::TransferEncoding)
75
+ add_plugin(Aws::Plugins::HttpChecksum)
72
76
  add_plugin(Aws::Plugins::SignatureV4)
73
77
  add_plugin(Aws::Plugins::Protocols::RestJson)
74
78
 
@@ -105,7 +109,7 @@ module Aws::Amplify
105
109
  # @option options [required, String] :region
106
110
  # The AWS region to connect to. The configured `:region` is
107
111
  # used to determine the service `:endpoint`. When not passed,
108
- # a default `:region` is search for in the following locations:
112
+ # a default `:region` is searched for in the following locations:
109
113
  #
110
114
  # * `Aws.config[:region]`
111
115
  # * `ENV['AWS_REGION']`
@@ -161,7 +165,7 @@ module Aws::Amplify
161
165
  # @option options [String] :endpoint
162
166
  # The client endpoint is normally constructed from the `:region`
163
167
  # option. You should only configure an `:endpoint` when connecting
164
- # to test endpoints. This should be avalid HTTP(S) URI.
168
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
165
169
  #
166
170
  # @option options [Integer] :endpoint_cache_max_entries (1000)
167
171
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -176,7 +180,7 @@ module Aws::Amplify
176
180
  # requests fetching endpoints information. Defaults to 60 sec.
177
181
  #
178
182
  # @option options [Boolean] :endpoint_discovery (false)
179
- # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
183
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
180
184
  #
181
185
  # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
182
186
  # The log formatter.
@@ -269,8 +273,7 @@ module Aws::Amplify
269
273
  #
270
274
  # @option options [Integer] :http_read_timeout (60) The default
271
275
  # number of seconds to wait for response data. This value can
272
- # safely be set
273
- # per-request on the session yielded by {#session_for}.
276
+ # safely be set per-request on the session.
274
277
  #
275
278
  # @option options [Float] :http_idle_timeout (5) The number of
276
279
  # seconds a connection is allowed to sit idle before it is
@@ -282,7 +285,7 @@ module Aws::Amplify
282
285
  # request body. This option has no effect unless the request has
283
286
  # "Expect" header set to "100-continue". Defaults to `nil` which
284
287
  # disables this behaviour. This value can safely be set per
285
- # request on the session yielded by {#session_for}.
288
+ # request on the session.
286
289
  #
287
290
  # @option options [Boolean] :http_wire_trace (false) When `true`,
288
291
  # HTTP debug output will be sent to the `:logger`.
@@ -309,63 +312,68 @@ module Aws::Amplify
309
312
 
310
313
  # @!group API Operations
311
314
 
312
- # Creates a new Amplify App.
315
+ # Creates a new Amplify app.
313
316
  #
314
317
  # @option params [required, String] :name
315
- # Name for the Amplify App
318
+ # The name for the Amplify app.
316
319
  #
317
320
  # @option params [String] :description
318
- # Description for an Amplify App
321
+ # The description for an Amplify app.
319
322
  #
320
323
  # @option params [String] :repository
321
- # Repository for an Amplify App
324
+ # The repository for an Amplify app.
322
325
  #
323
326
  # @option params [String] :platform
324
- # Platform / framework for an Amplify App
327
+ # The platform or framework for an Amplify app.
325
328
  #
326
329
  # @option params [String] :iam_service_role_arn
327
- # AWS IAM service role for an Amplify App
330
+ # The AWS Identity and Access Management (IAM) service role for an
331
+ # Amplify app.
328
332
  #
329
333
  # @option params [String] :oauth_token
330
- # OAuth token for 3rd party source control system for an Amplify App,
331
- # used to create webhook and read-only deploy key. OAuth token is not
332
- # 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.
333
337
  #
334
338
  # @option params [String] :access_token
335
- # Personal Access token for 3rd party source control system for an
336
- # Amplify App, used to create webhook and read-only deploy key. Token is
337
- # 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.
338
342
  #
339
343
  # @option params [Hash<String,String>] :environment_variables
340
- # Environment variables map for an Amplify App.
344
+ # The environment variables map for an Amplify app.
341
345
  #
342
346
  # @option params [Boolean] :enable_branch_auto_build
343
- # 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.
344
352
  #
345
353
  # @option params [Boolean] :enable_basic_auth
346
- # Enable Basic Authorization for an Amplify App, this will apply to all
347
- # 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.
348
356
  #
349
357
  # @option params [String] :basic_auth_credentials
350
- # Credentials for Basic Authorization for an Amplify App.
358
+ # The credentials for basic authorization for an Amplify app.
351
359
  #
352
360
  # @option params [Array<Types::CustomRule>] :custom_rules
353
- # Custom rewrite / redirect rules for an Amplify App.
361
+ # The custom rewrite and redirect rules for an Amplify app.
354
362
  #
355
363
  # @option params [Hash<String,String>] :tags
356
- # Tag for an Amplify App
364
+ # The tag for an Amplify app.
357
365
  #
358
366
  # @option params [String] :build_spec
359
- # BuildSpec for an Amplify App
367
+ # The build specification (build spec) for an Amplify app.
360
368
  #
361
369
  # @option params [Boolean] :enable_auto_branch_creation
362
- # Enables automated branch creation for the Amplify App.
370
+ # Enables automated branch creation for the Amplify app.
363
371
  #
364
372
  # @option params [Array<String>] :auto_branch_creation_patterns
365
- # Automated branch creation glob patterns for the Amplify App.
373
+ # The automated branch creation glob patterns for the Amplify app.
366
374
  #
367
375
  # @option params [Types::AutoBranchCreationConfig] :auto_branch_creation_config
368
- # Automated branch creation config for the Amplify App.
376
+ # The automated branch creation configuration for the Amplify app.
369
377
  #
370
378
  # @return [Types::CreateAppResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
371
379
  #
@@ -385,6 +393,7 @@ module Aws::Amplify
385
393
  # "EnvKey" => "EnvValue",
386
394
  # },
387
395
  # enable_branch_auto_build: false,
396
+ # enable_branch_auto_deletion: false,
388
397
  # enable_basic_auth: false,
389
398
  # basic_auth_credentials: "BasicAuthCredentials",
390
399
  # custom_rules: [
@@ -433,6 +442,7 @@ module Aws::Amplify
433
442
  # resp.app.environment_variables["EnvKey"] #=> String
434
443
  # resp.app.default_domain #=> String
435
444
  # resp.app.enable_branch_auto_build #=> Boolean
445
+ # resp.app.enable_branch_auto_deletion #=> Boolean
436
446
  # resp.app.enable_basic_auth #=> Boolean
437
447
  # resp.app.basic_auth_credentials #=> String
438
448
  # resp.app.custom_rules #=> Array
@@ -468,19 +478,19 @@ module Aws::Amplify
468
478
  req.send_request(options)
469
479
  end
470
480
 
471
- # Creates a new backend environment for an Amplify App.
481
+ # Creates a new backend environment for an Amplify app.
472
482
  #
473
483
  # @option params [required, String] :app_id
474
- # Unique Id for an Amplify App.
484
+ # The unique ID for an Amplify app.
475
485
  #
476
486
  # @option params [required, String] :environment_name
477
- # Name for the backend environment.
487
+ # The name for the backend environment.
478
488
  #
479
489
  # @option params [String] :stack_name
480
- # CloudFormation stack name of backend environment.
490
+ # The AWS CloudFormation stack name of a backend environment.
481
491
  #
482
492
  # @option params [String] :deployment_artifacts
483
- # Name of deployment artifacts.
493
+ # The name of deployment artifacts.
484
494
  #
485
495
  # @return [Types::CreateBackendEnvironmentResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
486
496
  #
@@ -513,22 +523,22 @@ module Aws::Amplify
513
523
  req.send_request(options)
514
524
  end
515
525
 
516
- # Creates a new Branch for an Amplify App.
526
+ # Creates a new branch for an Amplify app.
517
527
  #
518
528
  # @option params [required, String] :app_id
519
- # Unique Id for an Amplify App.
529
+ # The unique ID for an Amplify app.
520
530
  #
521
531
  # @option params [required, String] :branch_name
522
- # Name for the branch.
532
+ # The name for the branch.
523
533
  #
524
534
  # @option params [String] :description
525
- # Description for the branch.
535
+ # The description for the branch.
526
536
  #
527
537
  # @option params [String] :stage
528
- # Stage for the branch.
538
+ # Describes the current stage for the branch.
529
539
  #
530
540
  # @option params [String] :framework
531
- # Framework for the branch.
541
+ # The framework for the branch.
532
542
  #
533
543
  # @option params [Boolean] :enable_notification
534
544
  # Enables notifications for the branch.
@@ -537,34 +547,36 @@ module Aws::Amplify
537
547
  # Enables auto building for the branch.
538
548
  #
539
549
  # @option params [Hash<String,String>] :environment_variables
540
- # Environment Variables for the branch.
550
+ # The environment variables for the branch.
541
551
  #
542
552
  # @option params [String] :basic_auth_credentials
543
- # Basic Authorization credentials for the branch.
553
+ # The basic authorization credentials for the branch.
544
554
  #
545
555
  # @option params [Boolean] :enable_basic_auth
546
- # Enables Basic Auth for the branch.
556
+ # Enables basic authorization for the branch.
547
557
  #
548
558
  # @option params [Hash<String,String>] :tags
549
- # Tag for the branch.
559
+ # The tag for the branch.
550
560
  #
551
561
  # @option params [String] :build_spec
552
- # BuildSpec for the branch.
562
+ # The build specification (build spec) for the branch.
553
563
  #
554
564
  # @option params [String] :ttl
555
- # The content TTL for the website in seconds.
565
+ # The content Time To Live (TTL) for the website in seconds.
556
566
  #
557
567
  # @option params [String] :display_name
558
- # 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.
559
570
  #
560
571
  # @option params [Boolean] :enable_pull_request_preview
561
- # Enables Pull Request Preview for this branch.
572
+ # Enables pull request preview for this branch.
562
573
  #
563
574
  # @option params [String] :pull_request_environment_name
564
- # The Amplify Environment name for the pull request.
575
+ # The Amplify environment name for the pull request.
565
576
  #
566
577
  # @option params [String] :backend_environment_arn
567
- # 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.
568
580
  #
569
581
  # @return [Types::CreateBranchResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
570
582
  #
@@ -638,20 +650,20 @@ module Aws::Amplify
638
650
  req.send_request(options)
639
651
  end
640
652
 
641
- # Create a deployment for manual deploy apps. (Apps are not connected to
642
- # repository)
653
+ # Creates a deployment for a manually deployed Amplify app. Manually
654
+ # deployed apps are not connected to a repository.
643
655
  #
644
656
  # @option params [required, String] :app_id
645
- # Unique Id for an Amplify App.
657
+ # The unique ID for an Amplify app.
646
658
  #
647
659
  # @option params [required, String] :branch_name
648
- # Name for the branch, for the Job.
660
+ # The name for the branch, for the job.
649
661
  #
650
662
  # @option params [Hash<String,String>] :file_map
651
- # Optional file map that contains file name as the key and file content
652
- # md5 hash as the value. If this argument is provided, the service will
653
- # generate different upload url per file. Otherwise, the service will
654
- # 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.
655
667
  #
656
668
  # @return [Types::CreateDeploymentResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
657
669
  #
@@ -685,20 +697,27 @@ module Aws::Amplify
685
697
  req.send_request(options)
686
698
  end
687
699
 
688
- # 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
689
702
  #
690
703
  # @option params [required, String] :app_id
691
- # Unique Id for an Amplify App.
704
+ # The unique ID for an Amplify app.
692
705
  #
693
706
  # @option params [required, String] :domain_name
694
- # Domain name for the Domain Association.
707
+ # The domain name for the domain association.
695
708
  #
696
709
  # @option params [Boolean] :enable_auto_sub_domain
697
- # Enables automated creation of Subdomains for branches. (Currently not
698
- # supported)
710
+ # Enables the automated creation of subdomains for branches.
699
711
  #
700
712
  # @option params [required, Array<Types::SubDomainSetting>] :sub_domain_settings
701
- # 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.
702
721
  #
703
722
  # @return [Types::CreateDomainAssociationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
704
723
  #
@@ -716,6 +735,8 @@ module Aws::Amplify
716
735
  # branch_name: "BranchName", # required
717
736
  # },
718
737
  # ],
738
+ # auto_sub_domain_creation_patterns: ["AutoSubDomainCreationPattern"],
739
+ # auto_sub_domain_iam_role: "AutoSubDomainIAMRole",
719
740
  # })
720
741
  #
721
742
  # @example Response structure
@@ -723,6 +744,9 @@ module Aws::Amplify
723
744
  # resp.domain_association.domain_association_arn #=> String
724
745
  # resp.domain_association.domain_name #=> String
725
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
726
750
  # resp.domain_association.domain_status #=> String, one of "PENDING_VERIFICATION", "IN_PROGRESS", "AVAILABLE", "PENDING_DEPLOYMENT", "FAILED", "CREATING", "REQUESTING_CERTIFICATE", "UPDATING"
727
751
  # resp.domain_association.status_reason #=> String
728
752
  # resp.domain_association.certificate_verification_dns_record #=> String
@@ -741,16 +765,16 @@ module Aws::Amplify
741
765
  req.send_request(options)
742
766
  end
743
767
 
744
- # Create a new webhook on an App.
768
+ # Creates a new webhook on an Amplify app.
745
769
  #
746
770
  # @option params [required, String] :app_id
747
- # Unique Id for an Amplify App.
771
+ # The unique ID for an Amplify app.
748
772
  #
749
773
  # @option params [required, String] :branch_name
750
- # Name for a branch, part of an Amplify App.
774
+ # The name for a branch that is part of an Amplify app.
751
775
  #
752
776
  # @option params [String] :description
753
- # Description for a webhook.
777
+ # The description for a webhook.
754
778
  #
755
779
  # @return [Types::CreateWebhookResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
756
780
  #
@@ -783,10 +807,10 @@ module Aws::Amplify
783
807
  req.send_request(options)
784
808
  end
785
809
 
786
- # Delete an existing Amplify App by appId.
810
+ # Deletes an existing Amplify app specified by an app ID.
787
811
  #
788
812
  # @option params [required, String] :app_id
789
- # Unique Id for an Amplify App.
813
+ # The unique ID for an Amplify app.
790
814
  #
791
815
  # @return [Types::DeleteAppResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
792
816
  #
@@ -815,6 +839,7 @@ module Aws::Amplify
815
839
  # resp.app.environment_variables["EnvKey"] #=> String
816
840
  # resp.app.default_domain #=> String
817
841
  # resp.app.enable_branch_auto_build #=> Boolean
842
+ # resp.app.enable_branch_auto_deletion #=> Boolean
818
843
  # resp.app.enable_basic_auth #=> Boolean
819
844
  # resp.app.basic_auth_credentials #=> String
820
845
  # resp.app.custom_rules #=> Array
@@ -850,13 +875,13 @@ module Aws::Amplify
850
875
  req.send_request(options)
851
876
  end
852
877
 
853
- # Delete backend environment for an Amplify App.
878
+ # Deletes a backend environment for an Amplify app.
854
879
  #
855
880
  # @option params [required, String] :app_id
856
- # Unique Id of an Amplify App.
881
+ # The unique ID of an Amplify app.
857
882
  #
858
883
  # @option params [required, String] :environment_name
859
- # Name of a backend environment of an Amplify App.
884
+ # The name of a backend environment of an Amplify app.
860
885
  #
861
886
  # @return [Types::DeleteBackendEnvironmentResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
862
887
  #
@@ -887,13 +912,13 @@ module Aws::Amplify
887
912
  req.send_request(options)
888
913
  end
889
914
 
890
- # Deletes a branch for an Amplify App.
915
+ # Deletes a branch for an Amplify app.
891
916
  #
892
917
  # @option params [required, String] :app_id
893
- # Unique Id for an Amplify App.
918
+ # The unique ID for an Amplify app.
894
919
  #
895
920
  # @option params [required, String] :branch_name
896
- # Name for the branch.
921
+ # The name for the branch.
897
922
  #
898
923
  # @return [Types::DeleteBranchResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
899
924
  #
@@ -948,13 +973,13 @@ module Aws::Amplify
948
973
  req.send_request(options)
949
974
  end
950
975
 
951
- # Deletes a DomainAssociation.
976
+ # Deletes a domain association for an Amplify app.
952
977
  #
953
978
  # @option params [required, String] :app_id
954
- # Unique Id for an Amplify App.
979
+ # The unique id for an Amplify app.
955
980
  #
956
981
  # @option params [required, String] :domain_name
957
- # Name of the domain.
982
+ # The name of the domain.
958
983
  #
959
984
  # @return [Types::DeleteDomainAssociationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
960
985
  #
@@ -972,6 +997,9 @@ module Aws::Amplify
972
997
  # resp.domain_association.domain_association_arn #=> String
973
998
  # resp.domain_association.domain_name #=> String
974
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
975
1003
  # resp.domain_association.domain_status #=> String, one of "PENDING_VERIFICATION", "IN_PROGRESS", "AVAILABLE", "PENDING_DEPLOYMENT", "FAILED", "CREATING", "REQUESTING_CERTIFICATE", "UPDATING"
976
1004
  # resp.domain_association.status_reason #=> String
977
1005
  # resp.domain_association.certificate_verification_dns_record #=> String
@@ -990,16 +1018,16 @@ module Aws::Amplify
990
1018
  req.send_request(options)
991
1019
  end
992
1020
 
993
- # Delete a job, for an Amplify branch, part of Amplify App.
1021
+ # Deletes a job for a branch of an Amplify app.
994
1022
  #
995
1023
  # @option params [required, String] :app_id
996
- # Unique Id for an Amplify App.
1024
+ # The unique ID for an Amplify app.
997
1025
  #
998
1026
  # @option params [required, String] :branch_name
999
- # Name for the branch, for the Job.
1027
+ # The name for the branch, for the job.
1000
1028
  #
1001
1029
  # @option params [required, String] :job_id
1002
- # Unique Id for the Job.
1030
+ # The unique ID for the job.
1003
1031
  #
1004
1032
  # @return [Types::DeleteJobResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1005
1033
  #
@@ -1037,7 +1065,7 @@ module Aws::Amplify
1037
1065
  # Deletes a webhook.
1038
1066
  #
1039
1067
  # @option params [required, String] :webhook_id
1040
- # Unique Id for a webhook.
1068
+ # The unique ID for a webhook.
1041
1069
  #
1042
1070
  # @return [Types::DeleteWebhookResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1043
1071
  #
@@ -1068,20 +1096,22 @@ module Aws::Amplify
1068
1096
  req.send_request(options)
1069
1097
  end
1070
1098
 
1071
- # Retrieve website access logs for a specific time range via a
1072
- # pre-signed URL.
1099
+ # Returns the website access logs for a specific time range using a
1100
+ # presigned URL.
1073
1101
  #
1074
1102
  # @option params [Time,DateTime,Date,Integer,String] :start_time
1075
- # 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.
1076
1105
  #
1077
1106
  # @option params [Time,DateTime,Date,Integer,String] :end_time
1078
- # 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.
1079
1109
  #
1080
1110
  # @option params [required, String] :domain_name
1081
- # Name of the domain.
1111
+ # The name of the domain.
1082
1112
  #
1083
1113
  # @option params [required, String] :app_id
1084
- # Unique Id for an Amplify App.
1114
+ # The unique ID for an Amplify app.
1085
1115
  #
1086
1116
  # @return [Types::GenerateAccessLogsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1087
1117
  #
@@ -1109,10 +1139,10 @@ module Aws::Amplify
1109
1139
  req.send_request(options)
1110
1140
  end
1111
1141
 
1112
- # Retrieves an existing Amplify App by appId.
1142
+ # Returns an existing Amplify app by appID.
1113
1143
  #
1114
1144
  # @option params [required, String] :app_id
1115
- # Unique Id for an Amplify App.
1145
+ # The unique ID for an Amplify app.
1116
1146
  #
1117
1147
  # @return [Types::GetAppResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1118
1148
  #
@@ -1141,6 +1171,7 @@ module Aws::Amplify
1141
1171
  # resp.app.environment_variables["EnvKey"] #=> String
1142
1172
  # resp.app.default_domain #=> String
1143
1173
  # resp.app.enable_branch_auto_build #=> Boolean
1174
+ # resp.app.enable_branch_auto_deletion #=> Boolean
1144
1175
  # resp.app.enable_basic_auth #=> Boolean
1145
1176
  # resp.app.basic_auth_credentials #=> String
1146
1177
  # resp.app.custom_rules #=> Array
@@ -1176,10 +1207,10 @@ module Aws::Amplify
1176
1207
  req.send_request(options)
1177
1208
  end
1178
1209
 
1179
- # Retrieves artifact info that corresponds to a artifactId.
1210
+ # Returns the artifact info that corresponds to an artifact id.
1180
1211
  #
1181
1212
  # @option params [required, String] :artifact_id
1182
- # Unique Id for a artifact.
1213
+ # The unique ID for an artifact.
1183
1214
  #
1184
1215
  # @return [Types::GetArtifactUrlResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1185
1216
  #
@@ -1206,13 +1237,13 @@ module Aws::Amplify
1206
1237
  req.send_request(options)
1207
1238
  end
1208
1239
 
1209
- # Retrieves a backend environment for an Amplify App.
1240
+ # Returns a backend environment for an Amplify app.
1210
1241
  #
1211
1242
  # @option params [required, String] :app_id
1212
- # Unique Id for an Amplify App.
1243
+ # The unique id for an Amplify app.
1213
1244
  #
1214
1245
  # @option params [required, String] :environment_name
1215
- # Name for the backend environment.
1246
+ # The name for the backend environment.
1216
1247
  #
1217
1248
  # @return [Types::GetBackendEnvironmentResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1218
1249
  #
@@ -1243,13 +1274,13 @@ module Aws::Amplify
1243
1274
  req.send_request(options)
1244
1275
  end
1245
1276
 
1246
- # Retrieves a branch for an Amplify App.
1277
+ # Returns a branch for an Amplify app.
1247
1278
  #
1248
1279
  # @option params [required, String] :app_id
1249
- # Unique Id for an Amplify App.
1280
+ # The unique ID for an Amplify app.
1250
1281
  #
1251
1282
  # @option params [required, String] :branch_name
1252
- # Name for the branch.
1283
+ # The name for the branch.
1253
1284
  #
1254
1285
  # @return [Types::GetBranchResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1255
1286
  #
@@ -1304,13 +1335,13 @@ module Aws::Amplify
1304
1335
  req.send_request(options)
1305
1336
  end
1306
1337
 
1307
- # Retrieves domain info that corresponds to an appId and domainName.
1338
+ # Returns the domain information for an Amplify app.
1308
1339
  #
1309
1340
  # @option params [required, String] :app_id
1310
- # Unique Id for an Amplify App.
1341
+ # The unique id for an Amplify app.
1311
1342
  #
1312
1343
  # @option params [required, String] :domain_name
1313
- # Name of the domain.
1344
+ # The name of the domain.
1314
1345
  #
1315
1346
  # @return [Types::GetDomainAssociationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1316
1347
  #
@@ -1328,6 +1359,9 @@ module Aws::Amplify
1328
1359
  # resp.domain_association.domain_association_arn #=> String
1329
1360
  # resp.domain_association.domain_name #=> String
1330
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
1331
1365
  # resp.domain_association.domain_status #=> String, one of "PENDING_VERIFICATION", "IN_PROGRESS", "AVAILABLE", "PENDING_DEPLOYMENT", "FAILED", "CREATING", "REQUESTING_CERTIFICATE", "UPDATING"
1332
1366
  # resp.domain_association.status_reason #=> String
1333
1367
  # resp.domain_association.certificate_verification_dns_record #=> String
@@ -1346,16 +1380,16 @@ module Aws::Amplify
1346
1380
  req.send_request(options)
1347
1381
  end
1348
1382
 
1349
- # Get a job for a branch, part of an Amplify App.
1383
+ # Returns a job for a branch of an Amplify app.
1350
1384
  #
1351
1385
  # @option params [required, String] :app_id
1352
- # Unique Id for an Amplify App.
1386
+ # The unique ID for an Amplify app.
1353
1387
  #
1354
1388
  # @option params [required, String] :branch_name
1355
- # Name for the branch, for the Job.
1389
+ # The branch name for the job.
1356
1390
  #
1357
1391
  # @option params [required, String] :job_id
1358
- # Unique Id for the Job.
1392
+ # The unique ID for the job.
1359
1393
  #
1360
1394
  # @return [Types::GetJobResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1361
1395
  #
@@ -1403,10 +1437,11 @@ module Aws::Amplify
1403
1437
  req.send_request(options)
1404
1438
  end
1405
1439
 
1406
- # Retrieves webhook info that corresponds to a webhookId.
1440
+ # Returns the webhook information that corresponds to a specified
1441
+ # webhook ID.
1407
1442
  #
1408
1443
  # @option params [required, String] :webhook_id
1409
- # Unique Id for a webhook.
1444
+ # The unique ID for a webhook.
1410
1445
  #
1411
1446
  # @return [Types::GetWebhookResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1412
1447
  #
@@ -1437,14 +1472,14 @@ module Aws::Amplify
1437
1472
  req.send_request(options)
1438
1473
  end
1439
1474
 
1440
- # Lists existing Amplify Apps.
1475
+ # Returns a list of the existing Amplify apps.
1441
1476
  #
1442
1477
  # @option params [String] :next_token
1443
- # Pagination token. If non-null pagination token is returned in a
1444
- # 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.
1445
1480
  #
1446
1481
  # @option params [Integer] :max_results
1447
- # Maximum number of records to list in a single response.
1482
+ # The maximum number of records to list in a single response.
1448
1483
  #
1449
1484
  # @return [Types::ListAppsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1450
1485
  #
@@ -1476,6 +1511,7 @@ module Aws::Amplify
1476
1511
  # resp.apps[0].environment_variables["EnvKey"] #=> String
1477
1512
  # resp.apps[0].default_domain #=> String
1478
1513
  # resp.apps[0].enable_branch_auto_build #=> Boolean
1514
+ # resp.apps[0].enable_branch_auto_deletion #=> Boolean
1479
1515
  # resp.apps[0].enable_basic_auth #=> Boolean
1480
1516
  # resp.apps[0].basic_auth_credentials #=> String
1481
1517
  # resp.apps[0].custom_rules #=> Array
@@ -1512,24 +1548,24 @@ module Aws::Amplify
1512
1548
  req.send_request(options)
1513
1549
  end
1514
1550
 
1515
- # 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.
1516
1552
  #
1517
1553
  # @option params [required, String] :app_id
1518
- # Unique Id for an Amplify App.
1554
+ # The unique ID for an Amplify app.
1519
1555
  #
1520
1556
  # @option params [required, String] :branch_name
1521
- # Name for a branch, part of an Amplify App.
1557
+ # The name of a branch that is part of an Amplify app.
1522
1558
  #
1523
1559
  # @option params [required, String] :job_id
1524
- # Unique Id for an Job.
1560
+ # The unique ID for a job.
1525
1561
  #
1526
1562
  # @option params [String] :next_token
1527
- # Pagination token. Set to null to start listing artifacts from start.
1528
- # If non-null pagination token is returned in a result, then pass its
1529
- # 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.
1530
1566
  #
1531
1567
  # @option params [Integer] :max_results
1532
- # Maximum number of records to list in a single response.
1568
+ # The maximum number of records to list in a single response.
1533
1569
  #
1534
1570
  # @return [Types::ListArtifactsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1535
1571
  #
@@ -1562,21 +1598,21 @@ module Aws::Amplify
1562
1598
  req.send_request(options)
1563
1599
  end
1564
1600
 
1565
- # Lists backend environments for an Amplify App.
1601
+ # Lists the backend environments for an Amplify app.
1566
1602
  #
1567
1603
  # @option params [required, String] :app_id
1568
- # Unique Id for an amplify App.
1604
+ # The unique ID for an Amplify app.
1569
1605
  #
1570
1606
  # @option params [String] :environment_name
1571
- # Name of the backend environment
1607
+ # The name of the backend environment
1572
1608
  #
1573
1609
  # @option params [String] :next_token
1574
- # Pagination token. Set to null to start listing backen environments
1575
- # from start. If a non-null pagination token is returned in a result,
1576
- # 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.
1577
1613
  #
1578
1614
  # @option params [Integer] :max_results
1579
- # Maximum number of records to list in a single response.
1615
+ # The maximum number of records to list in a single response.
1580
1616
  #
1581
1617
  # @return [Types::ListBackendEnvironmentsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1582
1618
  #
@@ -1612,18 +1648,18 @@ module Aws::Amplify
1612
1648
  req.send_request(options)
1613
1649
  end
1614
1650
 
1615
- # Lists branches for an Amplify App.
1651
+ # Lists the branches of an Amplify app.
1616
1652
  #
1617
1653
  # @option params [required, String] :app_id
1618
- # Unique Id for an Amplify App.
1654
+ # The unique ID for an Amplify app.
1619
1655
  #
1620
1656
  # @option params [String] :next_token
1621
- # Pagination token. Set to null to start listing branches from start. If
1622
- # a non-null pagination token is returned in a result, then pass its
1623
- # 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.
1624
1660
  #
1625
1661
  # @option params [Integer] :max_results
1626
- # Maximum number of records to list in a single response.
1662
+ # The maximum number of records to list in a single response.
1627
1663
  #
1628
1664
  # @return [Types::ListBranchesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1629
1665
  #
@@ -1682,18 +1718,18 @@ module Aws::Amplify
1682
1718
  req.send_request(options)
1683
1719
  end
1684
1720
 
1685
- # List domains with an app
1721
+ # Returns the domain associations for an Amplify app.
1686
1722
  #
1687
1723
  # @option params [required, String] :app_id
1688
- # Unique Id for an Amplify App.
1724
+ # The unique ID for an Amplify app.
1689
1725
  #
1690
1726
  # @option params [String] :next_token
1691
- # Pagination token. Set to null to start listing Apps from start. If
1692
- # non-null pagination token is returned in a result, then pass its value
1693
- # 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.
1694
1730
  #
1695
1731
  # @option params [Integer] :max_results
1696
- # Maximum number of records to list in a single response.
1732
+ # The maximum number of records to list in a single response.
1697
1733
  #
1698
1734
  # @return [Types::ListDomainAssociationsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1699
1735
  #
@@ -1714,6 +1750,9 @@ module Aws::Amplify
1714
1750
  # resp.domain_associations[0].domain_association_arn #=> String
1715
1751
  # resp.domain_associations[0].domain_name #=> String
1716
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
1717
1756
  # resp.domain_associations[0].domain_status #=> String, one of "PENDING_VERIFICATION", "IN_PROGRESS", "AVAILABLE", "PENDING_DEPLOYMENT", "FAILED", "CREATING", "REQUESTING_CERTIFICATE", "UPDATING"
1718
1757
  # resp.domain_associations[0].status_reason #=> String
1719
1758
  # resp.domain_associations[0].certificate_verification_dns_record #=> String
@@ -1733,21 +1772,21 @@ module Aws::Amplify
1733
1772
  req.send_request(options)
1734
1773
  end
1735
1774
 
1736
- # List Jobs for a branch, part of an Amplify App.
1775
+ # Lists the jobs for a branch of an Amplify app.
1737
1776
  #
1738
1777
  # @option params [required, String] :app_id
1739
- # Unique Id for an Amplify App.
1778
+ # The unique ID for an Amplify app.
1740
1779
  #
1741
1780
  # @option params [required, String] :branch_name
1742
- # Name for a branch.
1781
+ # The name for a branch.
1743
1782
  #
1744
1783
  # @option params [String] :next_token
1745
- # Pagination token. Set to null to start listing steps from start. If a
1746
- # 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
1747
1786
  # in here to list more steps.
1748
1787
  #
1749
1788
  # @option params [Integer] :max_results
1750
- # Maximum number of records to list in a single response.
1789
+ # The maximum number of records to list in a single response.
1751
1790
  #
1752
1791
  # @return [Types::ListJobsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1753
1792
  #
@@ -1786,10 +1825,10 @@ module Aws::Amplify
1786
1825
  req.send_request(options)
1787
1826
  end
1788
1827
 
1789
- # List tags for resource.
1828
+ # Returns a list of tags for a specified Amazon Resource Name (ARN).
1790
1829
  #
1791
1830
  # @option params [required, String] :resource_arn
1792
- # Resource arn used to list tags.
1831
+ # The Amazon Resource Name (ARN) to use to list tags.
1793
1832
  #
1794
1833
  # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1795
1834
  #
@@ -1815,18 +1854,18 @@ module Aws::Amplify
1815
1854
  req.send_request(options)
1816
1855
  end
1817
1856
 
1818
- # List webhooks with an app.
1857
+ # Returns a list of webhooks for an Amplify app.
1819
1858
  #
1820
1859
  # @option params [required, String] :app_id
1821
- # Unique Id for an Amplify App.
1860
+ # The unique ID for an Amplify app.
1822
1861
  #
1823
1862
  # @option params [String] :next_token
1824
- # Pagination token. Set to null to start listing webhooks from start. If
1825
- # non-null pagination token is returned in a result, then pass its value
1826
- # 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.
1827
1866
  #
1828
1867
  # @option params [Integer] :max_results
1829
- # Maximum number of records to list in a single response.
1868
+ # The maximum number of records to list in a single response.
1830
1869
  #
1831
1870
  # @return [Types::ListWebhooksResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1832
1871
  #
@@ -1862,23 +1901,23 @@ module Aws::Amplify
1862
1901
  req.send_request(options)
1863
1902
  end
1864
1903
 
1865
- # Start a deployment for manual deploy apps. (Apps are not connected to
1866
- # repository)
1904
+ # Starts a deployment for a manually deployed app. Manually deployed
1905
+ # apps are not connected to a repository.
1867
1906
  #
1868
1907
  # @option params [required, String] :app_id
1869
- # Unique Id for an Amplify App.
1908
+ # The unique ID for an Amplify app.
1870
1909
  #
1871
1910
  # @option params [required, String] :branch_name
1872
- # Name for the branch, for the Job.
1911
+ # The name for the branch, for the job.
1873
1912
  #
1874
1913
  # @option params [String] :job_id
1875
- # The job id for this deployment, generated by create deployment
1914
+ # The job ID for this deployment, generated by the create deployment
1876
1915
  # request.
1877
1916
  #
1878
1917
  # @option params [String] :source_url
1879
- # The sourceUrl for this deployment, used when calling start deployment
1880
- # without create deployment. SourceUrl can be any HTTP GET url that is
1881
- # 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.
1882
1921
  #
1883
1922
  # @return [Types::StartDeploymentResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1884
1923
  #
@@ -1914,34 +1953,36 @@ module Aws::Amplify
1914
1953
  req.send_request(options)
1915
1954
  end
1916
1955
 
1917
- # Starts a new job for a branch, part of an Amplify App.
1956
+ # Starts a new job for a branch of an Amplify app.
1918
1957
  #
1919
1958
  # @option params [required, String] :app_id
1920
- # Unique Id for an Amplify App.
1959
+ # The unique ID for an Amplify app.
1921
1960
  #
1922
1961
  # @option params [required, String] :branch_name
1923
- # Name for the branch, for the Job.
1962
+ # The branch name for the job.
1924
1963
  #
1925
1964
  # @option params [String] :job_id
1926
- # 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`.
1927
1967
  #
1928
1968
  # @option params [required, String] :job_type
1929
- # Type for the Job. Available JobTypes are: \\n "RELEASE": Start a new
1930
- # job with the latest change from the specified branch. Only available
1931
- # for apps that have connected to a repository. "RETRY": Retry an
1932
- # 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.
1933
1974
  #
1934
1975
  # @option params [String] :job_reason
1935
- # Descriptive reason for starting this job.
1976
+ # A descriptive reason for starting this job.
1936
1977
  #
1937
1978
  # @option params [String] :commit_id
1938
- # Commit Id from 3rd party repository provider for the Job.
1979
+ # The commit ID from a third-party repository provider for the job.
1939
1980
  #
1940
1981
  # @option params [String] :commit_message
1941
- # Commit message from 3rd party repository provider for the Job.
1982
+ # The commit message from a third-party repository provider for the job.
1942
1983
  #
1943
1984
  # @option params [Time,DateTime,Date,Integer,String] :commit_time
1944
- # Commit date / time for the Job.
1985
+ # The commit date and time for the job.
1945
1986
  #
1946
1987
  # @return [Types::StartJobResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1947
1988
  #
@@ -1981,17 +2022,16 @@ module Aws::Amplify
1981
2022
  req.send_request(options)
1982
2023
  end
1983
2024
 
1984
- # Stop a job that is in progress, for an Amplify branch, part of Amplify
1985
- # App.
2025
+ # Stops a job that is in progress for a branch of an Amplify app.
1986
2026
  #
1987
2027
  # @option params [required, String] :app_id
1988
- # Unique Id for an Amplify App.
2028
+ # The unique ID for an Amplify app.
1989
2029
  #
1990
2030
  # @option params [required, String] :branch_name
1991
- # Name for the branch, for the Job.
2031
+ # The name for the branch, for the job.
1992
2032
  #
1993
2033
  # @option params [required, String] :job_id
1994
- # Unique Id for the Job.
2034
+ # The unique id for the job.
1995
2035
  #
1996
2036
  # @return [Types::StopJobResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1997
2037
  #
@@ -2026,13 +2066,13 @@ module Aws::Amplify
2026
2066
  req.send_request(options)
2027
2067
  end
2028
2068
 
2029
- # Tag resource with tag key and value.
2069
+ # Tags the resource with a tag key and value.
2030
2070
  #
2031
2071
  # @option params [required, String] :resource_arn
2032
- # Resource arn used to tag resource.
2072
+ # The Amazon Resource Name (ARN) to use to tag a resource.
2033
2073
  #
2034
2074
  # @option params [required, Hash<String,String>] :tags
2035
- # Tags used to tag resource.
2075
+ # The tags used to tag the resource.
2036
2076
  #
2037
2077
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2038
2078
  #
@@ -2054,13 +2094,13 @@ module Aws::Amplify
2054
2094
  req.send_request(options)
2055
2095
  end
2056
2096
 
2057
- # Untag resource with resourceArn.
2097
+ # Untags a resource with a specified Amazon Resource Name (ARN).
2058
2098
  #
2059
2099
  # @option params [required, String] :resource_arn
2060
- # Resource arn used to untag resource.
2100
+ # The Amazon Resource Name (ARN) to use to untag a resource.
2061
2101
  #
2062
2102
  # @option params [required, Array<String>] :tag_keys
2063
- # Tag keys used to untag resource.
2103
+ # The tag keys to use to untag a resource.
2064
2104
  #
2065
2105
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2066
2106
  #
@@ -2080,62 +2120,68 @@ module Aws::Amplify
2080
2120
  req.send_request(options)
2081
2121
  end
2082
2122
 
2083
- # Updates an existing Amplify App.
2123
+ # Updates an existing Amplify app.
2084
2124
  #
2085
2125
  # @option params [required, String] :app_id
2086
- # Unique Id for an Amplify App.
2126
+ # The unique ID for an Amplify app.
2087
2127
  #
2088
2128
  # @option params [String] :name
2089
- # Name for an Amplify App.
2129
+ # The name for an Amplify app.
2090
2130
  #
2091
2131
  # @option params [String] :description
2092
- # Description for an Amplify App.
2132
+ # The description for an Amplify app.
2093
2133
  #
2094
2134
  # @option params [String] :platform
2095
- # Platform for an Amplify App.
2135
+ # The platform for an Amplify app.
2096
2136
  #
2097
2137
  # @option params [String] :iam_service_role_arn
2098
- # IAM service role for an Amplify App.
2138
+ # The AWS Identity and Access Management (IAM) service role for an
2139
+ # Amplify app.
2099
2140
  #
2100
2141
  # @option params [Hash<String,String>] :environment_variables
2101
- # Environment Variables for an Amplify App.
2142
+ # The environment variables for an Amplify app.
2102
2143
  #
2103
2144
  # @option params [Boolean] :enable_branch_auto_build
2104
- # 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.
2105
2150
  #
2106
2151
  # @option params [Boolean] :enable_basic_auth
2107
- # Enables Basic Authorization for an Amplify App.
2152
+ # Enables basic authorization for an Amplify app.
2108
2153
  #
2109
2154
  # @option params [String] :basic_auth_credentials
2110
- # Basic Authorization credentials for an Amplify App.
2155
+ # The basic authorization credentials for an Amplify app.
2111
2156
  #
2112
2157
  # @option params [Array<Types::CustomRule>] :custom_rules
2113
- # Custom redirect / rewrite rules for an Amplify App.
2158
+ # The custom redirect and rewrite rules for an Amplify app.
2114
2159
  #
2115
2160
  # @option params [String] :build_spec
2116
- # BuildSpec for an Amplify App.
2161
+ # The build specification (build spec) for an Amplify app.
2117
2162
  #
2118
2163
  # @option params [Boolean] :enable_auto_branch_creation
2119
- # Enables automated branch creation for the Amplify App.
2164
+ # Enables automated branch creation for the Amplify app.
2120
2165
  #
2121
2166
  # @option params [Array<String>] :auto_branch_creation_patterns
2122
- # Automated branch creation glob patterns for the Amplify App.
2167
+ # Describes the automated branch creation glob patterns for the Amplify
2168
+ # app.
2123
2169
  #
2124
2170
  # @option params [Types::AutoBranchCreationConfig] :auto_branch_creation_config
2125
- # Automated branch creation branchConfig for the Amplify App.
2171
+ # The automated branch creation configuration for the Amplify app.
2126
2172
  #
2127
2173
  # @option params [String] :repository
2128
- # Repository for an Amplify App
2174
+ # The name of the repository for an Amplify app
2129
2175
  #
2130
2176
  # @option params [String] :oauth_token
2131
- # OAuth token for 3rd party source control system for an Amplify App,
2132
- # used to create webhook and read-only deploy key. OAuth token is not
2133
- # 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.
2134
2180
  #
2135
2181
  # @option params [String] :access_token
2136
- # Personal Access token for 3rd party source control system for an
2137
- # Amplify App, used to create webhook and read-only deploy key. Token is
2138
- # 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.
2139
2185
  #
2140
2186
  # @return [Types::UpdateAppResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2141
2187
  #
@@ -2153,6 +2199,7 @@ module Aws::Amplify
2153
2199
  # "EnvKey" => "EnvValue",
2154
2200
  # },
2155
2201
  # enable_branch_auto_build: false,
2202
+ # enable_branch_auto_deletion: false,
2156
2203
  # enable_basic_auth: false,
2157
2204
  # basic_auth_credentials: "BasicAuthCredentials",
2158
2205
  # custom_rules: [
@@ -2201,6 +2248,7 @@ module Aws::Amplify
2201
2248
  # resp.app.environment_variables["EnvKey"] #=> String
2202
2249
  # resp.app.default_domain #=> String
2203
2250
  # resp.app.enable_branch_auto_build #=> Boolean
2251
+ # resp.app.enable_branch_auto_deletion #=> Boolean
2204
2252
  # resp.app.enable_basic_auth #=> Boolean
2205
2253
  # resp.app.basic_auth_credentials #=> String
2206
2254
  # resp.app.custom_rules #=> Array
@@ -2236,22 +2284,22 @@ module Aws::Amplify
2236
2284
  req.send_request(options)
2237
2285
  end
2238
2286
 
2239
- # Updates a branch for an Amplify App.
2287
+ # Updates a branch for an Amplify app.
2240
2288
  #
2241
2289
  # @option params [required, String] :app_id
2242
- # Unique Id for an Amplify App.
2290
+ # The unique ID for an Amplify app.
2243
2291
  #
2244
2292
  # @option params [required, String] :branch_name
2245
- # Name for the branch.
2293
+ # The name for the branch.
2246
2294
  #
2247
2295
  # @option params [String] :description
2248
- # Description for the branch.
2296
+ # The description for the branch.
2249
2297
  #
2250
2298
  # @option params [String] :framework
2251
- # Framework for the branch.
2299
+ # The framework for the branch.
2252
2300
  #
2253
2301
  # @option params [String] :stage
2254
- # Stage for the branch.
2302
+ # Describes the current stage for the branch.
2255
2303
  #
2256
2304
  # @option params [Boolean] :enable_notification
2257
2305
  # Enables notifications for the branch.
@@ -2260,31 +2308,33 @@ module Aws::Amplify
2260
2308
  # Enables auto building for the branch.
2261
2309
  #
2262
2310
  # @option params [Hash<String,String>] :environment_variables
2263
- # Environment Variables for the branch.
2311
+ # The environment variables for the branch.
2264
2312
  #
2265
2313
  # @option params [String] :basic_auth_credentials
2266
- # Basic Authorization credentials for the branch.
2314
+ # The basic authorization credentials for the branch.
2267
2315
  #
2268
2316
  # @option params [Boolean] :enable_basic_auth
2269
- # Enables Basic Auth for the branch.
2317
+ # Enables basic authorization for the branch.
2270
2318
  #
2271
2319
  # @option params [String] :build_spec
2272
- # BuildSpec for the branch.
2320
+ # The build specification (build spec) for the branch.
2273
2321
  #
2274
2322
  # @option params [String] :ttl
2275
- # The content TTL for the website in seconds.
2323
+ # The content Time to Live (TTL) for the website in seconds.
2276
2324
  #
2277
2325
  # @option params [String] :display_name
2278
- # 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.
2279
2328
  #
2280
2329
  # @option params [Boolean] :enable_pull_request_preview
2281
- # Enables Pull Request Preview for this branch.
2330
+ # Enables pull request preview for this branch.
2282
2331
  #
2283
2332
  # @option params [String] :pull_request_environment_name
2284
- # The Amplify Environment name for the pull request.
2333
+ # The Amplify environment name for the pull request.
2285
2334
  #
2286
2335
  # @option params [String] :backend_environment_arn
2287
- # 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.
2288
2338
  #
2289
2339
  # @return [Types::UpdateBranchResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2290
2340
  #
@@ -2355,20 +2405,26 @@ module Aws::Amplify
2355
2405
  req.send_request(options)
2356
2406
  end
2357
2407
 
2358
- # Create a new DomainAssociation on an App
2408
+ # Creates a new domain association for an Amplify app.
2359
2409
  #
2360
2410
  # @option params [required, String] :app_id
2361
- # Unique Id for an Amplify App.
2411
+ # The unique ID for an Amplify app.
2362
2412
  #
2363
2413
  # @option params [required, String] :domain_name
2364
- # Name of the domain.
2414
+ # The name of the domain.
2365
2415
  #
2366
2416
  # @option params [Boolean] :enable_auto_sub_domain
2367
- # Enables automated creation of Subdomains for branches. (Currently not
2368
- # supported)
2417
+ # Enables the automated creation of subdomains for branches.
2369
2418
  #
2370
2419
  # @option params [required, Array<Types::SubDomainSetting>] :sub_domain_settings
2371
- # 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.
2372
2428
  #
2373
2429
  # @return [Types::UpdateDomainAssociationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2374
2430
  #
@@ -2386,6 +2442,8 @@ module Aws::Amplify
2386
2442
  # branch_name: "BranchName", # required
2387
2443
  # },
2388
2444
  # ],
2445
+ # auto_sub_domain_creation_patterns: ["AutoSubDomainCreationPattern"],
2446
+ # auto_sub_domain_iam_role: "AutoSubDomainIAMRole",
2389
2447
  # })
2390
2448
  #
2391
2449
  # @example Response structure
@@ -2393,6 +2451,9 @@ module Aws::Amplify
2393
2451
  # resp.domain_association.domain_association_arn #=> String
2394
2452
  # resp.domain_association.domain_name #=> String
2395
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
2396
2457
  # resp.domain_association.domain_status #=> String, one of "PENDING_VERIFICATION", "IN_PROGRESS", "AVAILABLE", "PENDING_DEPLOYMENT", "FAILED", "CREATING", "REQUESTING_CERTIFICATE", "UPDATING"
2397
2458
  # resp.domain_association.status_reason #=> String
2398
2459
  # resp.domain_association.certificate_verification_dns_record #=> String
@@ -2411,16 +2472,16 @@ module Aws::Amplify
2411
2472
  req.send_request(options)
2412
2473
  end
2413
2474
 
2414
- # Update a webhook.
2475
+ # Updates a webhook.
2415
2476
  #
2416
2477
  # @option params [required, String] :webhook_id
2417
- # Unique Id for a webhook.
2478
+ # The unique ID for a webhook.
2418
2479
  #
2419
2480
  # @option params [String] :branch_name
2420
- # Name for a branch, part of an Amplify App.
2481
+ # The name for a branch that is part of an Amplify app.
2421
2482
  #
2422
2483
  # @option params [String] :description
2423
- # Description for a webhook.
2484
+ # The description for a webhook.
2424
2485
  #
2425
2486
  # @return [Types::UpdateWebhookResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2426
2487
  #
@@ -2466,7 +2527,7 @@ module Aws::Amplify
2466
2527
  params: params,
2467
2528
  config: config)
2468
2529
  context[:gem_name] = 'aws-sdk-amplify'
2469
- context[:gem_version] = '1.15.0'
2530
+ context[:gem_version] = '1.20.0'
2470
2531
  Seahorse::Client::Request.new(handlers, context)
2471
2532
  end
2472
2533