aws-sdk-amplify 1.19.0 → 1.24.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: 37d13bd4ed8f6e22ad5b55fd7fd87bfd4476cbfafd20314d41d4e1626cdcf421
4
- data.tar.gz: e328f1cf91dca614a5c12d130e7e06b0b34f19c47bd192dfc633b0ddb518d2c2
3
+ metadata.gz: 6e95b2d21cdb08b098eb663a3dff11260503a126924e8d3b49ecb337e743e168
4
+ data.tar.gz: 75fed94b84e976ffbbf424c7673cc508b31f063e2d519b035c1ee0927f16db3f
5
5
  SHA512:
6
- metadata.gz: 2a89eb481238b133d9e3545bbecf88058c207bd0eaedde219c02df03167e56b03020bfdc324d72bf21f519b8cba75f41c417a7e09a9938e9d30b127edc11444a
7
- data.tar.gz: 936bb9d1b66a5a876bbc8cad8f39bf1d7737a1ef3478cf636c37561f30dbcd504fc270f6dfa8128556b3d36402840f81b8895d909c21b5e25d24c69af161e0e8
6
+ metadata.gz: 63bf5eaa73461991155ec71549ecdad5c9d1a589a1f3f4c8e083ae7a1c2235d261e3390f1dfe8823236778589e357190927ac24c0264d290eb6322af6bc064d5
7
+ data.tar.gz: 361355eff5f3eec30305a72aac72927b9366fdf43fbbc5961363d7f49edda1bdf76c77067d5ece6a692fb68403da63dcf5b74ca80c050428a6f22d9e71cee7ed
@@ -7,6 +7,7 @@
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
10
+
10
11
  require 'aws-sdk-core'
11
12
  require 'aws-sigv4'
12
13
 
@@ -44,9 +45,9 @@ require_relative 'aws-sdk-amplify/customizations'
44
45
  #
45
46
  # See {Errors} for more information.
46
47
  #
47
- # @service
48
+ # @!group service
48
49
  module Aws::Amplify
49
50
 
50
- GEM_VERSION = '1.19.0'
51
+ GEM_VERSION = '1.24.0'
51
52
 
52
53
  end
@@ -85,13 +85,28 @@ module Aws::Amplify
85
85
  # * `Aws::Credentials` - Used for configuring static, non-refreshing
86
86
  # credentials.
87
87
  #
88
+ # * `Aws::SharedCredentials` - Used for loading static credentials from a
89
+ # shared file, such as `~/.aws/config`.
90
+ #
91
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
92
+ #
93
+ # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
94
+ # assume a role after providing credentials via the web.
95
+ #
96
+ # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
97
+ # access token generated from `aws login`.
98
+ #
99
+ # * `Aws::ProcessCredentials` - Used for loading credentials from a
100
+ # process that outputs to stdout.
101
+ #
88
102
  # * `Aws::InstanceProfileCredentials` - Used for loading credentials
89
103
  # from an EC2 IMDS on an EC2 instance.
90
104
  #
91
- # * `Aws::SharedCredentials` - Used for loading credentials from a
92
- # shared file, such as `~/.aws/config`.
105
+ # * `Aws::ECSCredentials` - Used for loading credentials from
106
+ # instances running in ECS.
93
107
  #
94
- # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
108
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
109
+ # from the Cognito Identity service.
95
110
  #
96
111
  # When `:credentials` are not configured directly, the following
97
112
  # locations will be searched for credentials:
@@ -101,10 +116,10 @@ module Aws::Amplify
101
116
  # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
102
117
  # * `~/.aws/credentials`
103
118
  # * `~/.aws/config`
104
- # * EC2 IMDS instance profile - When used by default, the timeouts are
105
- # very aggressive. Construct and pass an instance of
106
- # `Aws::InstanceProfileCredentails` to enable retries and extended
107
- # timeouts.
119
+ # * EC2/ECS IMDS instance profile - When used by default, the timeouts
120
+ # are very aggressive. Construct and pass an instance of
121
+ # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
122
+ # enable retries and extended timeouts.
108
123
  #
109
124
  # @option options [required, String] :region
110
125
  # The AWS region to connect to. The configured `:region` is
@@ -312,63 +327,68 @@ module Aws::Amplify
312
327
 
313
328
  # @!group API Operations
314
329
 
315
- # Creates a new Amplify App.
330
+ # Creates a new Amplify app.
316
331
  #
317
332
  # @option params [required, String] :name
318
- # Name for the Amplify App
333
+ # The name for the Amplify app.
319
334
  #
320
335
  # @option params [String] :description
321
- # Description for an Amplify App
336
+ # The description for an Amplify app.
322
337
  #
323
338
  # @option params [String] :repository
324
- # Repository for an Amplify App
339
+ # The repository for an Amplify app.
325
340
  #
326
341
  # @option params [String] :platform
327
- # Platform / framework for an Amplify App
342
+ # The platform or framework for an Amplify app.
328
343
  #
329
344
  # @option params [String] :iam_service_role_arn
330
- # AWS IAM service role for an Amplify App
345
+ # The AWS Identity and Access Management (IAM) service role for an
346
+ # Amplify app.
331
347
  #
332
348
  # @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.
349
+ # The OAuth token for a third-party source control system for an Amplify
350
+ # app. The OAuth token is used to create a webhook and a read-only
351
+ # deploy key. The OAuth token is not stored.
336
352
  #
337
353
  # @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.
354
+ # The personal access token for a third-party source control system for
355
+ # an Amplify app. The personal access token is used to create a webhook
356
+ # and a read-only deploy key. The token is not stored.
341
357
  #
342
358
  # @option params [Hash<String,String>] :environment_variables
343
- # Environment variables map for an Amplify App.
359
+ # The environment variables map for an Amplify app.
344
360
  #
345
361
  # @option params [Boolean] :enable_branch_auto_build
346
- # Enable the auto building of branches for an Amplify App.
362
+ # Enables the auto building of branches for an Amplify app.
363
+ #
364
+ # @option params [Boolean] :enable_branch_auto_deletion
365
+ # Automatically disconnects a branch in the Amplify Console when you
366
+ # delete a branch from your Git repository.
347
367
  #
348
368
  # @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.
369
+ # Enables basic authorization for an Amplify app. This will apply to all
370
+ # branches that are part of this app.
351
371
  #
352
372
  # @option params [String] :basic_auth_credentials
353
- # Credentials for Basic Authorization for an Amplify App.
373
+ # The credentials for basic authorization for an Amplify app.
354
374
  #
355
375
  # @option params [Array<Types::CustomRule>] :custom_rules
356
- # Custom rewrite / redirect rules for an Amplify App.
376
+ # The custom rewrite and redirect rules for an Amplify app.
357
377
  #
358
378
  # @option params [Hash<String,String>] :tags
359
- # Tag for an Amplify App
379
+ # The tag for an Amplify app.
360
380
  #
361
381
  # @option params [String] :build_spec
362
- # BuildSpec for an Amplify App
382
+ # The build specification (build spec) for an Amplify app.
363
383
  #
364
384
  # @option params [Boolean] :enable_auto_branch_creation
365
- # Enables automated branch creation for the Amplify App.
385
+ # Enables automated branch creation for the Amplify app.
366
386
  #
367
387
  # @option params [Array<String>] :auto_branch_creation_patterns
368
- # Automated branch creation glob patterns for the Amplify App.
388
+ # The automated branch creation glob patterns for the Amplify app.
369
389
  #
370
390
  # @option params [Types::AutoBranchCreationConfig] :auto_branch_creation_config
371
- # Automated branch creation config for the Amplify App.
391
+ # The automated branch creation configuration for the Amplify app.
372
392
  #
373
393
  # @return [Types::CreateAppResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
374
394
  #
@@ -388,6 +408,7 @@ module Aws::Amplify
388
408
  # "EnvKey" => "EnvValue",
389
409
  # },
390
410
  # enable_branch_auto_build: false,
411
+ # enable_branch_auto_deletion: false,
391
412
  # enable_basic_auth: false,
392
413
  # basic_auth_credentials: "BasicAuthCredentials",
393
414
  # custom_rules: [
@@ -436,6 +457,7 @@ module Aws::Amplify
436
457
  # resp.app.environment_variables["EnvKey"] #=> String
437
458
  # resp.app.default_domain #=> String
438
459
  # resp.app.enable_branch_auto_build #=> Boolean
460
+ # resp.app.enable_branch_auto_deletion #=> Boolean
439
461
  # resp.app.enable_basic_auth #=> Boolean
440
462
  # resp.app.basic_auth_credentials #=> String
441
463
  # resp.app.custom_rules #=> Array
@@ -471,19 +493,19 @@ module Aws::Amplify
471
493
  req.send_request(options)
472
494
  end
473
495
 
474
- # Creates a new backend environment for an Amplify App.
496
+ # Creates a new backend environment for an Amplify app.
475
497
  #
476
498
  # @option params [required, String] :app_id
477
- # Unique Id for an Amplify App.
499
+ # The unique ID for an Amplify app.
478
500
  #
479
501
  # @option params [required, String] :environment_name
480
- # Name for the backend environment.
502
+ # The name for the backend environment.
481
503
  #
482
504
  # @option params [String] :stack_name
483
- # CloudFormation stack name of backend environment.
505
+ # The AWS CloudFormation stack name of a backend environment.
484
506
  #
485
507
  # @option params [String] :deployment_artifacts
486
- # Name of deployment artifacts.
508
+ # The name of deployment artifacts.
487
509
  #
488
510
  # @return [Types::CreateBackendEnvironmentResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
489
511
  #
@@ -516,22 +538,22 @@ module Aws::Amplify
516
538
  req.send_request(options)
517
539
  end
518
540
 
519
- # Creates a new Branch for an Amplify App.
541
+ # Creates a new branch for an Amplify app.
520
542
  #
521
543
  # @option params [required, String] :app_id
522
- # Unique Id for an Amplify App.
544
+ # The unique ID for an Amplify app.
523
545
  #
524
546
  # @option params [required, String] :branch_name
525
- # Name for the branch.
547
+ # The name for the branch.
526
548
  #
527
549
  # @option params [String] :description
528
- # Description for the branch.
550
+ # The description for the branch.
529
551
  #
530
552
  # @option params [String] :stage
531
- # Stage for the branch.
553
+ # Describes the current stage for the branch.
532
554
  #
533
555
  # @option params [String] :framework
534
- # Framework for the branch.
556
+ # The framework for the branch.
535
557
  #
536
558
  # @option params [Boolean] :enable_notification
537
559
  # Enables notifications for the branch.
@@ -540,34 +562,36 @@ module Aws::Amplify
540
562
  # Enables auto building for the branch.
541
563
  #
542
564
  # @option params [Hash<String,String>] :environment_variables
543
- # Environment Variables for the branch.
565
+ # The environment variables for the branch.
544
566
  #
545
567
  # @option params [String] :basic_auth_credentials
546
- # Basic Authorization credentials for the branch.
568
+ # The basic authorization credentials for the branch.
547
569
  #
548
570
  # @option params [Boolean] :enable_basic_auth
549
- # Enables Basic Auth for the branch.
571
+ # Enables basic authorization for the branch.
550
572
  #
551
573
  # @option params [Hash<String,String>] :tags
552
- # Tag for the branch.
574
+ # The tag for the branch.
553
575
  #
554
576
  # @option params [String] :build_spec
555
- # BuildSpec for the branch.
577
+ # The build specification (build spec) for the branch.
556
578
  #
557
579
  # @option params [String] :ttl
558
- # The content TTL for the website in seconds.
580
+ # The content Time To Live (TTL) for the website in seconds.
559
581
  #
560
582
  # @option params [String] :display_name
561
- # Display name for a branch, will use as the default domain prefix.
583
+ # The display name for a branch. This is used as the default domain
584
+ # prefix.
562
585
  #
563
586
  # @option params [Boolean] :enable_pull_request_preview
564
- # Enables Pull Request Preview for this branch.
587
+ # Enables pull request preview for this branch.
565
588
  #
566
589
  # @option params [String] :pull_request_environment_name
567
- # The Amplify Environment name for the pull request.
590
+ # The Amplify environment name for the pull request.
568
591
  #
569
592
  # @option params [String] :backend_environment_arn
570
- # ARN for a Backend Environment, part of an Amplify App.
593
+ # The Amazon Resource Name (ARN) for a backend environment that is part
594
+ # of an Amplify app.
571
595
  #
572
596
  # @return [Types::CreateBranchResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
573
597
  #
@@ -641,20 +665,20 @@ module Aws::Amplify
641
665
  req.send_request(options)
642
666
  end
643
667
 
644
- # Create a deployment for manual deploy apps. (Apps are not connected to
645
- # repository)
668
+ # Creates a deployment for a manually deployed Amplify app. Manually
669
+ # deployed apps are not connected to a repository.
646
670
  #
647
671
  # @option params [required, String] :app_id
648
- # Unique Id for an Amplify App.
672
+ # The unique ID for an Amplify app.
649
673
  #
650
674
  # @option params [required, String] :branch_name
651
- # Name for the branch, for the Job.
675
+ # The name for the branch, for the job.
652
676
  #
653
677
  # @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.
678
+ # An optional file map that contains the file name as the key and the
679
+ # file content md5 hash as the value. If this argument is provided, the
680
+ # service will generate a unique upload URL per file. Otherwise, the
681
+ # service will only generate a single upload URL for the zipped files.
658
682
  #
659
683
  # @return [Types::CreateDeploymentResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
660
684
  #
@@ -688,20 +712,27 @@ module Aws::Amplify
688
712
  req.send_request(options)
689
713
  end
690
714
 
691
- # Create a new DomainAssociation on an App
715
+ # Creates a new domain association for an Amplify app. This action
716
+ # associates a custom domain with the Amplify app
692
717
  #
693
718
  # @option params [required, String] :app_id
694
- # Unique Id for an Amplify App.
719
+ # The unique ID for an Amplify app.
695
720
  #
696
721
  # @option params [required, String] :domain_name
697
- # Domain name for the Domain Association.
722
+ # The domain name for the domain association.
698
723
  #
699
724
  # @option params [Boolean] :enable_auto_sub_domain
700
- # Enables automated creation of Subdomains for branches. (Currently not
701
- # supported)
725
+ # Enables the automated creation of subdomains for branches.
702
726
  #
703
727
  # @option params [required, Array<Types::SubDomainSetting>] :sub_domain_settings
704
- # Setting structure for the Subdomain.
728
+ # The setting for the subdomain.
729
+ #
730
+ # @option params [Array<String>] :auto_sub_domain_creation_patterns
731
+ # Sets the branch patterns for automatic subdomain creation.
732
+ #
733
+ # @option params [String] :auto_sub_domain_iam_role
734
+ # The required AWS Identity and Access Management (IAM) service role for
735
+ # the Amazon Resource Name (ARN) for automatically creating subdomains.
705
736
  #
706
737
  # @return [Types::CreateDomainAssociationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
707
738
  #
@@ -719,6 +750,8 @@ module Aws::Amplify
719
750
  # branch_name: "BranchName", # required
720
751
  # },
721
752
  # ],
753
+ # auto_sub_domain_creation_patterns: ["AutoSubDomainCreationPattern"],
754
+ # auto_sub_domain_iam_role: "AutoSubDomainIAMRole",
722
755
  # })
723
756
  #
724
757
  # @example Response structure
@@ -726,6 +759,9 @@ module Aws::Amplify
726
759
  # resp.domain_association.domain_association_arn #=> String
727
760
  # resp.domain_association.domain_name #=> String
728
761
  # resp.domain_association.enable_auto_sub_domain #=> Boolean
762
+ # resp.domain_association.auto_sub_domain_creation_patterns #=> Array
763
+ # resp.domain_association.auto_sub_domain_creation_patterns[0] #=> String
764
+ # resp.domain_association.auto_sub_domain_iam_role #=> String
729
765
  # resp.domain_association.domain_status #=> String, one of "PENDING_VERIFICATION", "IN_PROGRESS", "AVAILABLE", "PENDING_DEPLOYMENT", "FAILED", "CREATING", "REQUESTING_CERTIFICATE", "UPDATING"
730
766
  # resp.domain_association.status_reason #=> String
731
767
  # resp.domain_association.certificate_verification_dns_record #=> String
@@ -744,16 +780,16 @@ module Aws::Amplify
744
780
  req.send_request(options)
745
781
  end
746
782
 
747
- # Create a new webhook on an App.
783
+ # Creates a new webhook on an Amplify app.
748
784
  #
749
785
  # @option params [required, String] :app_id
750
- # Unique Id for an Amplify App.
786
+ # The unique ID for an Amplify app.
751
787
  #
752
788
  # @option params [required, String] :branch_name
753
- # Name for a branch, part of an Amplify App.
789
+ # The name for a branch that is part of an Amplify app.
754
790
  #
755
791
  # @option params [String] :description
756
- # Description for a webhook.
792
+ # The description for a webhook.
757
793
  #
758
794
  # @return [Types::CreateWebhookResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
759
795
  #
@@ -786,10 +822,10 @@ module Aws::Amplify
786
822
  req.send_request(options)
787
823
  end
788
824
 
789
- # Delete an existing Amplify App by appId.
825
+ # Deletes an existing Amplify app specified by an app ID.
790
826
  #
791
827
  # @option params [required, String] :app_id
792
- # Unique Id for an Amplify App.
828
+ # The unique ID for an Amplify app.
793
829
  #
794
830
  # @return [Types::DeleteAppResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
795
831
  #
@@ -818,6 +854,7 @@ module Aws::Amplify
818
854
  # resp.app.environment_variables["EnvKey"] #=> String
819
855
  # resp.app.default_domain #=> String
820
856
  # resp.app.enable_branch_auto_build #=> Boolean
857
+ # resp.app.enable_branch_auto_deletion #=> Boolean
821
858
  # resp.app.enable_basic_auth #=> Boolean
822
859
  # resp.app.basic_auth_credentials #=> String
823
860
  # resp.app.custom_rules #=> Array
@@ -853,13 +890,13 @@ module Aws::Amplify
853
890
  req.send_request(options)
854
891
  end
855
892
 
856
- # Delete backend environment for an Amplify App.
893
+ # Deletes a backend environment for an Amplify app.
857
894
  #
858
895
  # @option params [required, String] :app_id
859
- # Unique Id of an Amplify App.
896
+ # The unique ID of an Amplify app.
860
897
  #
861
898
  # @option params [required, String] :environment_name
862
- # Name of a backend environment of an Amplify App.
899
+ # The name of a backend environment of an Amplify app.
863
900
  #
864
901
  # @return [Types::DeleteBackendEnvironmentResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
865
902
  #
@@ -890,13 +927,13 @@ module Aws::Amplify
890
927
  req.send_request(options)
891
928
  end
892
929
 
893
- # Deletes a branch for an Amplify App.
930
+ # Deletes a branch for an Amplify app.
894
931
  #
895
932
  # @option params [required, String] :app_id
896
- # Unique Id for an Amplify App.
933
+ # The unique ID for an Amplify app.
897
934
  #
898
935
  # @option params [required, String] :branch_name
899
- # Name for the branch.
936
+ # The name for the branch.
900
937
  #
901
938
  # @return [Types::DeleteBranchResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
902
939
  #
@@ -951,13 +988,13 @@ module Aws::Amplify
951
988
  req.send_request(options)
952
989
  end
953
990
 
954
- # Deletes a DomainAssociation.
991
+ # Deletes a domain association for an Amplify app.
955
992
  #
956
993
  # @option params [required, String] :app_id
957
- # Unique Id for an Amplify App.
994
+ # The unique id for an Amplify app.
958
995
  #
959
996
  # @option params [required, String] :domain_name
960
- # Name of the domain.
997
+ # The name of the domain.
961
998
  #
962
999
  # @return [Types::DeleteDomainAssociationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
963
1000
  #
@@ -975,6 +1012,9 @@ module Aws::Amplify
975
1012
  # resp.domain_association.domain_association_arn #=> String
976
1013
  # resp.domain_association.domain_name #=> String
977
1014
  # resp.domain_association.enable_auto_sub_domain #=> Boolean
1015
+ # resp.domain_association.auto_sub_domain_creation_patterns #=> Array
1016
+ # resp.domain_association.auto_sub_domain_creation_patterns[0] #=> String
1017
+ # resp.domain_association.auto_sub_domain_iam_role #=> String
978
1018
  # resp.domain_association.domain_status #=> String, one of "PENDING_VERIFICATION", "IN_PROGRESS", "AVAILABLE", "PENDING_DEPLOYMENT", "FAILED", "CREATING", "REQUESTING_CERTIFICATE", "UPDATING"
979
1019
  # resp.domain_association.status_reason #=> String
980
1020
  # resp.domain_association.certificate_verification_dns_record #=> String
@@ -993,16 +1033,16 @@ module Aws::Amplify
993
1033
  req.send_request(options)
994
1034
  end
995
1035
 
996
- # Delete a job, for an Amplify branch, part of Amplify App.
1036
+ # Deletes a job for a branch of an Amplify app.
997
1037
  #
998
1038
  # @option params [required, String] :app_id
999
- # Unique Id for an Amplify App.
1039
+ # The unique ID for an Amplify app.
1000
1040
  #
1001
1041
  # @option params [required, String] :branch_name
1002
- # Name for the branch, for the Job.
1042
+ # The name for the branch, for the job.
1003
1043
  #
1004
1044
  # @option params [required, String] :job_id
1005
- # Unique Id for the Job.
1045
+ # The unique ID for the job.
1006
1046
  #
1007
1047
  # @return [Types::DeleteJobResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1008
1048
  #
@@ -1040,7 +1080,7 @@ module Aws::Amplify
1040
1080
  # Deletes a webhook.
1041
1081
  #
1042
1082
  # @option params [required, String] :webhook_id
1043
- # Unique Id for a webhook.
1083
+ # The unique ID for a webhook.
1044
1084
  #
1045
1085
  # @return [Types::DeleteWebhookResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1046
1086
  #
@@ -1071,20 +1111,22 @@ module Aws::Amplify
1071
1111
  req.send_request(options)
1072
1112
  end
1073
1113
 
1074
- # Retrieve website access logs for a specific time range via a
1075
- # pre-signed URL.
1114
+ # Returns the website access logs for a specific time range using a
1115
+ # presigned URL.
1076
1116
  #
1077
1117
  # @option params [Time,DateTime,Date,Integer,String] :start_time
1078
- # The time at which the logs should start, inclusive.
1118
+ # The time at which the logs should start. The time range specified is
1119
+ # inclusive of the start time.
1079
1120
  #
1080
1121
  # @option params [Time,DateTime,Date,Integer,String] :end_time
1081
- # The time at which the logs should end, inclusive.
1122
+ # The time at which the logs should end. The time range specified is
1123
+ # inclusive of the end time.
1082
1124
  #
1083
1125
  # @option params [required, String] :domain_name
1084
- # Name of the domain.
1126
+ # The name of the domain.
1085
1127
  #
1086
1128
  # @option params [required, String] :app_id
1087
- # Unique Id for an Amplify App.
1129
+ # The unique ID for an Amplify app.
1088
1130
  #
1089
1131
  # @return [Types::GenerateAccessLogsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1090
1132
  #
@@ -1112,10 +1154,10 @@ module Aws::Amplify
1112
1154
  req.send_request(options)
1113
1155
  end
1114
1156
 
1115
- # Retrieves an existing Amplify App by appId.
1157
+ # Returns an existing Amplify app by appID.
1116
1158
  #
1117
1159
  # @option params [required, String] :app_id
1118
- # Unique Id for an Amplify App.
1160
+ # The unique ID for an Amplify app.
1119
1161
  #
1120
1162
  # @return [Types::GetAppResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1121
1163
  #
@@ -1144,6 +1186,7 @@ module Aws::Amplify
1144
1186
  # resp.app.environment_variables["EnvKey"] #=> String
1145
1187
  # resp.app.default_domain #=> String
1146
1188
  # resp.app.enable_branch_auto_build #=> Boolean
1189
+ # resp.app.enable_branch_auto_deletion #=> Boolean
1147
1190
  # resp.app.enable_basic_auth #=> Boolean
1148
1191
  # resp.app.basic_auth_credentials #=> String
1149
1192
  # resp.app.custom_rules #=> Array
@@ -1179,10 +1222,10 @@ module Aws::Amplify
1179
1222
  req.send_request(options)
1180
1223
  end
1181
1224
 
1182
- # Retrieves artifact info that corresponds to a artifactId.
1225
+ # Returns the artifact info that corresponds to an artifact id.
1183
1226
  #
1184
1227
  # @option params [required, String] :artifact_id
1185
- # Unique Id for a artifact.
1228
+ # The unique ID for an artifact.
1186
1229
  #
1187
1230
  # @return [Types::GetArtifactUrlResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1188
1231
  #
@@ -1209,13 +1252,13 @@ module Aws::Amplify
1209
1252
  req.send_request(options)
1210
1253
  end
1211
1254
 
1212
- # Retrieves a backend environment for an Amplify App.
1255
+ # Returns a backend environment for an Amplify app.
1213
1256
  #
1214
1257
  # @option params [required, String] :app_id
1215
- # Unique Id for an Amplify App.
1258
+ # The unique id for an Amplify app.
1216
1259
  #
1217
1260
  # @option params [required, String] :environment_name
1218
- # Name for the backend environment.
1261
+ # The name for the backend environment.
1219
1262
  #
1220
1263
  # @return [Types::GetBackendEnvironmentResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1221
1264
  #
@@ -1246,13 +1289,13 @@ module Aws::Amplify
1246
1289
  req.send_request(options)
1247
1290
  end
1248
1291
 
1249
- # Retrieves a branch for an Amplify App.
1292
+ # Returns a branch for an Amplify app.
1250
1293
  #
1251
1294
  # @option params [required, String] :app_id
1252
- # Unique Id for an Amplify App.
1295
+ # The unique ID for an Amplify app.
1253
1296
  #
1254
1297
  # @option params [required, String] :branch_name
1255
- # Name for the branch.
1298
+ # The name for the branch.
1256
1299
  #
1257
1300
  # @return [Types::GetBranchResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1258
1301
  #
@@ -1307,13 +1350,13 @@ module Aws::Amplify
1307
1350
  req.send_request(options)
1308
1351
  end
1309
1352
 
1310
- # Retrieves domain info that corresponds to an appId and domainName.
1353
+ # Returns the domain information for an Amplify app.
1311
1354
  #
1312
1355
  # @option params [required, String] :app_id
1313
- # Unique Id for an Amplify App.
1356
+ # The unique id for an Amplify app.
1314
1357
  #
1315
1358
  # @option params [required, String] :domain_name
1316
- # Name of the domain.
1359
+ # The name of the domain.
1317
1360
  #
1318
1361
  # @return [Types::GetDomainAssociationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1319
1362
  #
@@ -1331,6 +1374,9 @@ module Aws::Amplify
1331
1374
  # resp.domain_association.domain_association_arn #=> String
1332
1375
  # resp.domain_association.domain_name #=> String
1333
1376
  # resp.domain_association.enable_auto_sub_domain #=> Boolean
1377
+ # resp.domain_association.auto_sub_domain_creation_patterns #=> Array
1378
+ # resp.domain_association.auto_sub_domain_creation_patterns[0] #=> String
1379
+ # resp.domain_association.auto_sub_domain_iam_role #=> String
1334
1380
  # resp.domain_association.domain_status #=> String, one of "PENDING_VERIFICATION", "IN_PROGRESS", "AVAILABLE", "PENDING_DEPLOYMENT", "FAILED", "CREATING", "REQUESTING_CERTIFICATE", "UPDATING"
1335
1381
  # resp.domain_association.status_reason #=> String
1336
1382
  # resp.domain_association.certificate_verification_dns_record #=> String
@@ -1349,16 +1395,16 @@ module Aws::Amplify
1349
1395
  req.send_request(options)
1350
1396
  end
1351
1397
 
1352
- # Get a job for a branch, part of an Amplify App.
1398
+ # Returns a job for a branch of an Amplify app.
1353
1399
  #
1354
1400
  # @option params [required, String] :app_id
1355
- # Unique Id for an Amplify App.
1401
+ # The unique ID for an Amplify app.
1356
1402
  #
1357
1403
  # @option params [required, String] :branch_name
1358
- # Name for the branch, for the Job.
1404
+ # The branch name for the job.
1359
1405
  #
1360
1406
  # @option params [required, String] :job_id
1361
- # Unique Id for the Job.
1407
+ # The unique ID for the job.
1362
1408
  #
1363
1409
  # @return [Types::GetJobResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1364
1410
  #
@@ -1406,10 +1452,11 @@ module Aws::Amplify
1406
1452
  req.send_request(options)
1407
1453
  end
1408
1454
 
1409
- # Retrieves webhook info that corresponds to a webhookId.
1455
+ # Returns the webhook information that corresponds to a specified
1456
+ # webhook ID.
1410
1457
  #
1411
1458
  # @option params [required, String] :webhook_id
1412
- # Unique Id for a webhook.
1459
+ # The unique ID for a webhook.
1413
1460
  #
1414
1461
  # @return [Types::GetWebhookResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1415
1462
  #
@@ -1440,14 +1487,14 @@ module Aws::Amplify
1440
1487
  req.send_request(options)
1441
1488
  end
1442
1489
 
1443
- # Lists existing Amplify Apps.
1490
+ # Returns a list of the existing Amplify apps.
1444
1491
  #
1445
1492
  # @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.
1493
+ # A pagination token. If non-null, the pagination token is returned in a
1494
+ # result. Pass its value in another request to retrieve more entries.
1448
1495
  #
1449
1496
  # @option params [Integer] :max_results
1450
- # Maximum number of records to list in a single response.
1497
+ # The maximum number of records to list in a single response.
1451
1498
  #
1452
1499
  # @return [Types::ListAppsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1453
1500
  #
@@ -1479,6 +1526,7 @@ module Aws::Amplify
1479
1526
  # resp.apps[0].environment_variables["EnvKey"] #=> String
1480
1527
  # resp.apps[0].default_domain #=> String
1481
1528
  # resp.apps[0].enable_branch_auto_build #=> Boolean
1529
+ # resp.apps[0].enable_branch_auto_deletion #=> Boolean
1482
1530
  # resp.apps[0].enable_basic_auth #=> Boolean
1483
1531
  # resp.apps[0].basic_auth_credentials #=> String
1484
1532
  # resp.apps[0].custom_rules #=> Array
@@ -1515,24 +1563,24 @@ module Aws::Amplify
1515
1563
  req.send_request(options)
1516
1564
  end
1517
1565
 
1518
- # List artifacts with an app, a branch, a job and an artifact type.
1566
+ # Returns a list of artifacts for a specified app, branch, and job.
1519
1567
  #
1520
1568
  # @option params [required, String] :app_id
1521
- # Unique Id for an Amplify App.
1569
+ # The unique ID for an Amplify app.
1522
1570
  #
1523
1571
  # @option params [required, String] :branch_name
1524
- # Name for a branch, part of an Amplify App.
1572
+ # The name of a branch that is part of an Amplify app.
1525
1573
  #
1526
1574
  # @option params [required, String] :job_id
1527
- # Unique Id for an Job.
1575
+ # The unique ID for a job.
1528
1576
  #
1529
1577
  # @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.
1578
+ # A pagination token. Set to null to start listing artifacts from start.
1579
+ # If a non-null pagination token is returned in a result, pass its value
1580
+ # in here to list more artifacts.
1533
1581
  #
1534
1582
  # @option params [Integer] :max_results
1535
- # Maximum number of records to list in a single response.
1583
+ # The maximum number of records to list in a single response.
1536
1584
  #
1537
1585
  # @return [Types::ListArtifactsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1538
1586
  #
@@ -1565,21 +1613,21 @@ module Aws::Amplify
1565
1613
  req.send_request(options)
1566
1614
  end
1567
1615
 
1568
- # Lists backend environments for an Amplify App.
1616
+ # Lists the backend environments for an Amplify app.
1569
1617
  #
1570
1618
  # @option params [required, String] :app_id
1571
- # Unique Id for an amplify App.
1619
+ # The unique ID for an Amplify app.
1572
1620
  #
1573
1621
  # @option params [String] :environment_name
1574
- # Name of the backend environment
1622
+ # The name of the backend environment
1575
1623
  #
1576
1624
  # @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.
1625
+ # A pagination token. Set to null to start listing backend environments
1626
+ # from the start. If a non-null pagination token is returned in a
1627
+ # result, pass its value in here to list more backend environments.
1580
1628
  #
1581
1629
  # @option params [Integer] :max_results
1582
- # Maximum number of records to list in a single response.
1630
+ # The maximum number of records to list in a single response.
1583
1631
  #
1584
1632
  # @return [Types::ListBackendEnvironmentsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1585
1633
  #
@@ -1615,18 +1663,18 @@ module Aws::Amplify
1615
1663
  req.send_request(options)
1616
1664
  end
1617
1665
 
1618
- # Lists branches for an Amplify App.
1666
+ # Lists the branches of an Amplify app.
1619
1667
  #
1620
1668
  # @option params [required, String] :app_id
1621
- # Unique Id for an Amplify App.
1669
+ # The unique ID for an Amplify app.
1622
1670
  #
1623
1671
  # @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.
1672
+ # A pagination token. Set to null to start listing branches from the
1673
+ # start. If a non-null pagination token is returned in a result, pass
1674
+ # its value in here to list more branches.
1627
1675
  #
1628
1676
  # @option params [Integer] :max_results
1629
- # Maximum number of records to list in a single response.
1677
+ # The maximum number of records to list in a single response.
1630
1678
  #
1631
1679
  # @return [Types::ListBranchesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1632
1680
  #
@@ -1685,18 +1733,18 @@ module Aws::Amplify
1685
1733
  req.send_request(options)
1686
1734
  end
1687
1735
 
1688
- # List domains with an app
1736
+ # Returns the domain associations for an Amplify app.
1689
1737
  #
1690
1738
  # @option params [required, String] :app_id
1691
- # Unique Id for an Amplify App.
1739
+ # The unique ID for an Amplify app.
1692
1740
  #
1693
1741
  # @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.
1742
+ # A pagination token. Set to null to start listing apps from the start.
1743
+ # If non-null, a pagination token is returned in a result. Pass its
1744
+ # value in here to list more projects.
1697
1745
  #
1698
1746
  # @option params [Integer] :max_results
1699
- # Maximum number of records to list in a single response.
1747
+ # The maximum number of records to list in a single response.
1700
1748
  #
1701
1749
  # @return [Types::ListDomainAssociationsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1702
1750
  #
@@ -1717,6 +1765,9 @@ module Aws::Amplify
1717
1765
  # resp.domain_associations[0].domain_association_arn #=> String
1718
1766
  # resp.domain_associations[0].domain_name #=> String
1719
1767
  # resp.domain_associations[0].enable_auto_sub_domain #=> Boolean
1768
+ # resp.domain_associations[0].auto_sub_domain_creation_patterns #=> Array
1769
+ # resp.domain_associations[0].auto_sub_domain_creation_patterns[0] #=> String
1770
+ # resp.domain_associations[0].auto_sub_domain_iam_role #=> String
1720
1771
  # resp.domain_associations[0].domain_status #=> String, one of "PENDING_VERIFICATION", "IN_PROGRESS", "AVAILABLE", "PENDING_DEPLOYMENT", "FAILED", "CREATING", "REQUESTING_CERTIFICATE", "UPDATING"
1721
1772
  # resp.domain_associations[0].status_reason #=> String
1722
1773
  # resp.domain_associations[0].certificate_verification_dns_record #=> String
@@ -1736,21 +1787,21 @@ module Aws::Amplify
1736
1787
  req.send_request(options)
1737
1788
  end
1738
1789
 
1739
- # List Jobs for a branch, part of an Amplify App.
1790
+ # Lists the jobs for a branch of an Amplify app.
1740
1791
  #
1741
1792
  # @option params [required, String] :app_id
1742
- # Unique Id for an Amplify App.
1793
+ # The unique ID for an Amplify app.
1743
1794
  #
1744
1795
  # @option params [required, String] :branch_name
1745
- # Name for a branch.
1796
+ # The name for a branch.
1746
1797
  #
1747
1798
  # @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
1799
+ # A pagination token. Set to null to start listing steps from the start.
1800
+ # If a non-null pagination token is returned in a result, pass its value
1750
1801
  # in here to list more steps.
1751
1802
  #
1752
1803
  # @option params [Integer] :max_results
1753
- # Maximum number of records to list in a single response.
1804
+ # The maximum number of records to list in a single response.
1754
1805
  #
1755
1806
  # @return [Types::ListJobsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1756
1807
  #
@@ -1789,10 +1840,10 @@ module Aws::Amplify
1789
1840
  req.send_request(options)
1790
1841
  end
1791
1842
 
1792
- # List tags for resource.
1843
+ # Returns a list of tags for a specified Amazon Resource Name (ARN).
1793
1844
  #
1794
1845
  # @option params [required, String] :resource_arn
1795
- # Resource arn used to list tags.
1846
+ # The Amazon Resource Name (ARN) to use to list tags.
1796
1847
  #
1797
1848
  # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1798
1849
  #
@@ -1818,18 +1869,18 @@ module Aws::Amplify
1818
1869
  req.send_request(options)
1819
1870
  end
1820
1871
 
1821
- # List webhooks with an app.
1872
+ # Returns a list of webhooks for an Amplify app.
1822
1873
  #
1823
1874
  # @option params [required, String] :app_id
1824
- # Unique Id for an Amplify App.
1875
+ # The unique ID for an Amplify app.
1825
1876
  #
1826
1877
  # @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.
1878
+ # A pagination token. Set to null to start listing webhooks from the
1879
+ # start. If non-null,the pagination token is returned in a result. Pass
1880
+ # its value in here to list more webhooks.
1830
1881
  #
1831
1882
  # @option params [Integer] :max_results
1832
- # Maximum number of records to list in a single response.
1883
+ # The maximum number of records to list in a single response.
1833
1884
  #
1834
1885
  # @return [Types::ListWebhooksResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1835
1886
  #
@@ -1865,23 +1916,23 @@ module Aws::Amplify
1865
1916
  req.send_request(options)
1866
1917
  end
1867
1918
 
1868
- # Start a deployment for manual deploy apps. (Apps are not connected to
1869
- # repository)
1919
+ # Starts a deployment for a manually deployed app. Manually deployed
1920
+ # apps are not connected to a repository.
1870
1921
  #
1871
1922
  # @option params [required, String] :app_id
1872
- # Unique Id for an Amplify App.
1923
+ # The unique ID for an Amplify app.
1873
1924
  #
1874
1925
  # @option params [required, String] :branch_name
1875
- # Name for the branch, for the Job.
1926
+ # The name for the branch, for the job.
1876
1927
  #
1877
1928
  # @option params [String] :job_id
1878
- # The job id for this deployment, generated by create deployment
1929
+ # The job ID for this deployment, generated by the create deployment
1879
1930
  # request.
1880
1931
  #
1881
1932
  # @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.
1933
+ # The source URL for this deployment, used when calling start deployment
1934
+ # without create deployment. The source URL can be any HTTP GET URL that
1935
+ # is publicly accessible and downloads a single .zip file.
1885
1936
  #
1886
1937
  # @return [Types::StartDeploymentResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1887
1938
  #
@@ -1917,34 +1968,36 @@ module Aws::Amplify
1917
1968
  req.send_request(options)
1918
1969
  end
1919
1970
 
1920
- # Starts a new job for a branch, part of an Amplify App.
1971
+ # Starts a new job for a branch of an Amplify app.
1921
1972
  #
1922
1973
  # @option params [required, String] :app_id
1923
- # Unique Id for an Amplify App.
1974
+ # The unique ID for an Amplify app.
1924
1975
  #
1925
1976
  # @option params [required, String] :branch_name
1926
- # Name for the branch, for the Job.
1977
+ # The branch name for the job.
1927
1978
  #
1928
1979
  # @option params [String] :job_id
1929
- # Unique Id for an existing job. Required for "RETRY" JobType.
1980
+ # The unique ID for an existing job. This is required if the value of
1981
+ # `jobType` is `RETRY`.
1930
1982
  #
1931
1983
  # @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.
1984
+ # Describes the type for the job. The job type `RELEASE` starts a new
1985
+ # job with the latest change from the specified branch. This value is
1986
+ # available only for apps that are connected to a repository. The job
1987
+ # type `RETRY` retries an existing job. If the job type value is
1988
+ # `RETRY`, the `jobId` is also required.
1936
1989
  #
1937
1990
  # @option params [String] :job_reason
1938
- # Descriptive reason for starting this job.
1991
+ # A descriptive reason for starting this job.
1939
1992
  #
1940
1993
  # @option params [String] :commit_id
1941
- # Commit Id from 3rd party repository provider for the Job.
1994
+ # The commit ID from a third-party repository provider for the job.
1942
1995
  #
1943
1996
  # @option params [String] :commit_message
1944
- # Commit message from 3rd party repository provider for the Job.
1997
+ # The commit message from a third-party repository provider for the job.
1945
1998
  #
1946
1999
  # @option params [Time,DateTime,Date,Integer,String] :commit_time
1947
- # Commit date / time for the Job.
2000
+ # The commit date and time for the job.
1948
2001
  #
1949
2002
  # @return [Types::StartJobResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1950
2003
  #
@@ -1984,17 +2037,16 @@ module Aws::Amplify
1984
2037
  req.send_request(options)
1985
2038
  end
1986
2039
 
1987
- # Stop a job that is in progress, for an Amplify branch, part of Amplify
1988
- # App.
2040
+ # Stops a job that is in progress for a branch of an Amplify app.
1989
2041
  #
1990
2042
  # @option params [required, String] :app_id
1991
- # Unique Id for an Amplify App.
2043
+ # The unique ID for an Amplify app.
1992
2044
  #
1993
2045
  # @option params [required, String] :branch_name
1994
- # Name for the branch, for the Job.
2046
+ # The name for the branch, for the job.
1995
2047
  #
1996
2048
  # @option params [required, String] :job_id
1997
- # Unique Id for the Job.
2049
+ # The unique id for the job.
1998
2050
  #
1999
2051
  # @return [Types::StopJobResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2000
2052
  #
@@ -2029,13 +2081,13 @@ module Aws::Amplify
2029
2081
  req.send_request(options)
2030
2082
  end
2031
2083
 
2032
- # Tag resource with tag key and value.
2084
+ # Tags the resource with a tag key and value.
2033
2085
  #
2034
2086
  # @option params [required, String] :resource_arn
2035
- # Resource arn used to tag resource.
2087
+ # The Amazon Resource Name (ARN) to use to tag a resource.
2036
2088
  #
2037
2089
  # @option params [required, Hash<String,String>] :tags
2038
- # Tags used to tag resource.
2090
+ # The tags used to tag the resource.
2039
2091
  #
2040
2092
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2041
2093
  #
@@ -2057,13 +2109,13 @@ module Aws::Amplify
2057
2109
  req.send_request(options)
2058
2110
  end
2059
2111
 
2060
- # Untag resource with resourceArn.
2112
+ # Untags a resource with a specified Amazon Resource Name (ARN).
2061
2113
  #
2062
2114
  # @option params [required, String] :resource_arn
2063
- # Resource arn used to untag resource.
2115
+ # The Amazon Resource Name (ARN) to use to untag a resource.
2064
2116
  #
2065
2117
  # @option params [required, Array<String>] :tag_keys
2066
- # Tag keys used to untag resource.
2118
+ # The tag keys to use to untag a resource.
2067
2119
  #
2068
2120
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2069
2121
  #
@@ -2083,62 +2135,68 @@ module Aws::Amplify
2083
2135
  req.send_request(options)
2084
2136
  end
2085
2137
 
2086
- # Updates an existing Amplify App.
2138
+ # Updates an existing Amplify app.
2087
2139
  #
2088
2140
  # @option params [required, String] :app_id
2089
- # Unique Id for an Amplify App.
2141
+ # The unique ID for an Amplify app.
2090
2142
  #
2091
2143
  # @option params [String] :name
2092
- # Name for an Amplify App.
2144
+ # The name for an Amplify app.
2093
2145
  #
2094
2146
  # @option params [String] :description
2095
- # Description for an Amplify App.
2147
+ # The description for an Amplify app.
2096
2148
  #
2097
2149
  # @option params [String] :platform
2098
- # Platform for an Amplify App.
2150
+ # The platform for an Amplify app.
2099
2151
  #
2100
2152
  # @option params [String] :iam_service_role_arn
2101
- # IAM service role for an Amplify App.
2153
+ # The AWS Identity and Access Management (IAM) service role for an
2154
+ # Amplify app.
2102
2155
  #
2103
2156
  # @option params [Hash<String,String>] :environment_variables
2104
- # Environment Variables for an Amplify App.
2157
+ # The environment variables for an Amplify app.
2105
2158
  #
2106
2159
  # @option params [Boolean] :enable_branch_auto_build
2107
- # Enables branch auto-building for an Amplify App.
2160
+ # Enables branch auto-building for an Amplify app.
2161
+ #
2162
+ # @option params [Boolean] :enable_branch_auto_deletion
2163
+ # Automatically disconnects a branch in the Amplify Console when you
2164
+ # delete a branch from your Git repository.
2108
2165
  #
2109
2166
  # @option params [Boolean] :enable_basic_auth
2110
- # Enables Basic Authorization for an Amplify App.
2167
+ # Enables basic authorization for an Amplify app.
2111
2168
  #
2112
2169
  # @option params [String] :basic_auth_credentials
2113
- # Basic Authorization credentials for an Amplify App.
2170
+ # The basic authorization credentials for an Amplify app.
2114
2171
  #
2115
2172
  # @option params [Array<Types::CustomRule>] :custom_rules
2116
- # Custom redirect / rewrite rules for an Amplify App.
2173
+ # The custom redirect and rewrite rules for an Amplify app.
2117
2174
  #
2118
2175
  # @option params [String] :build_spec
2119
- # BuildSpec for an Amplify App.
2176
+ # The build specification (build spec) for an Amplify app.
2120
2177
  #
2121
2178
  # @option params [Boolean] :enable_auto_branch_creation
2122
- # Enables automated branch creation for the Amplify App.
2179
+ # Enables automated branch creation for the Amplify app.
2123
2180
  #
2124
2181
  # @option params [Array<String>] :auto_branch_creation_patterns
2125
- # Automated branch creation glob patterns for the Amplify App.
2182
+ # Describes the automated branch creation glob patterns for the Amplify
2183
+ # app.
2126
2184
  #
2127
2185
  # @option params [Types::AutoBranchCreationConfig] :auto_branch_creation_config
2128
- # Automated branch creation branchConfig for the Amplify App.
2186
+ # The automated branch creation configuration for the Amplify app.
2129
2187
  #
2130
2188
  # @option params [String] :repository
2131
- # Repository for an Amplify App
2189
+ # The name of the repository for an Amplify app
2132
2190
  #
2133
2191
  # @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.
2192
+ # The OAuth token for a third-party source control system for an Amplify
2193
+ # app. The token is used to create a webhook and a read-only deploy key.
2194
+ # The OAuth token is not stored.
2137
2195
  #
2138
2196
  # @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.
2197
+ # The personal access token for a third-party source control system for
2198
+ # an Amplify app. The token is used to create webhook and a read-only
2199
+ # deploy key. The token is not stored.
2142
2200
  #
2143
2201
  # @return [Types::UpdateAppResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2144
2202
  #
@@ -2156,6 +2214,7 @@ module Aws::Amplify
2156
2214
  # "EnvKey" => "EnvValue",
2157
2215
  # },
2158
2216
  # enable_branch_auto_build: false,
2217
+ # enable_branch_auto_deletion: false,
2159
2218
  # enable_basic_auth: false,
2160
2219
  # basic_auth_credentials: "BasicAuthCredentials",
2161
2220
  # custom_rules: [
@@ -2204,6 +2263,7 @@ module Aws::Amplify
2204
2263
  # resp.app.environment_variables["EnvKey"] #=> String
2205
2264
  # resp.app.default_domain #=> String
2206
2265
  # resp.app.enable_branch_auto_build #=> Boolean
2266
+ # resp.app.enable_branch_auto_deletion #=> Boolean
2207
2267
  # resp.app.enable_basic_auth #=> Boolean
2208
2268
  # resp.app.basic_auth_credentials #=> String
2209
2269
  # resp.app.custom_rules #=> Array
@@ -2239,22 +2299,22 @@ module Aws::Amplify
2239
2299
  req.send_request(options)
2240
2300
  end
2241
2301
 
2242
- # Updates a branch for an Amplify App.
2302
+ # Updates a branch for an Amplify app.
2243
2303
  #
2244
2304
  # @option params [required, String] :app_id
2245
- # Unique Id for an Amplify App.
2305
+ # The unique ID for an Amplify app.
2246
2306
  #
2247
2307
  # @option params [required, String] :branch_name
2248
- # Name for the branch.
2308
+ # The name for the branch.
2249
2309
  #
2250
2310
  # @option params [String] :description
2251
- # Description for the branch.
2311
+ # The description for the branch.
2252
2312
  #
2253
2313
  # @option params [String] :framework
2254
- # Framework for the branch.
2314
+ # The framework for the branch.
2255
2315
  #
2256
2316
  # @option params [String] :stage
2257
- # Stage for the branch.
2317
+ # Describes the current stage for the branch.
2258
2318
  #
2259
2319
  # @option params [Boolean] :enable_notification
2260
2320
  # Enables notifications for the branch.
@@ -2263,31 +2323,33 @@ module Aws::Amplify
2263
2323
  # Enables auto building for the branch.
2264
2324
  #
2265
2325
  # @option params [Hash<String,String>] :environment_variables
2266
- # Environment Variables for the branch.
2326
+ # The environment variables for the branch.
2267
2327
  #
2268
2328
  # @option params [String] :basic_auth_credentials
2269
- # Basic Authorization credentials for the branch.
2329
+ # The basic authorization credentials for the branch.
2270
2330
  #
2271
2331
  # @option params [Boolean] :enable_basic_auth
2272
- # Enables Basic Auth for the branch.
2332
+ # Enables basic authorization for the branch.
2273
2333
  #
2274
2334
  # @option params [String] :build_spec
2275
- # BuildSpec for the branch.
2335
+ # The build specification (build spec) for the branch.
2276
2336
  #
2277
2337
  # @option params [String] :ttl
2278
- # The content TTL for the website in seconds.
2338
+ # The content Time to Live (TTL) for the website in seconds.
2279
2339
  #
2280
2340
  # @option params [String] :display_name
2281
- # Display name for a branch, will use as the default domain prefix.
2341
+ # The display name for a branch. This is used as the default domain
2342
+ # prefix.
2282
2343
  #
2283
2344
  # @option params [Boolean] :enable_pull_request_preview
2284
- # Enables Pull Request Preview for this branch.
2345
+ # Enables pull request preview for this branch.
2285
2346
  #
2286
2347
  # @option params [String] :pull_request_environment_name
2287
- # The Amplify Environment name for the pull request.
2348
+ # The Amplify environment name for the pull request.
2288
2349
  #
2289
2350
  # @option params [String] :backend_environment_arn
2290
- # ARN for a Backend Environment, part of an Amplify App.
2351
+ # The Amazon Resource Name (ARN) for a backend environment that is part
2352
+ # of an Amplify app.
2291
2353
  #
2292
2354
  # @return [Types::UpdateBranchResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2293
2355
  #
@@ -2358,20 +2420,26 @@ module Aws::Amplify
2358
2420
  req.send_request(options)
2359
2421
  end
2360
2422
 
2361
- # Create a new DomainAssociation on an App
2423
+ # Creates a new domain association for an Amplify app.
2362
2424
  #
2363
2425
  # @option params [required, String] :app_id
2364
- # Unique Id for an Amplify App.
2426
+ # The unique ID for an Amplify app.
2365
2427
  #
2366
2428
  # @option params [required, String] :domain_name
2367
- # Name of the domain.
2429
+ # The name of the domain.
2368
2430
  #
2369
2431
  # @option params [Boolean] :enable_auto_sub_domain
2370
- # Enables automated creation of Subdomains for branches. (Currently not
2371
- # supported)
2432
+ # Enables the automated creation of subdomains for branches.
2372
2433
  #
2373
2434
  # @option params [required, Array<Types::SubDomainSetting>] :sub_domain_settings
2374
- # Setting structure for the Subdomain.
2435
+ # Describes the settings for the subdomain.
2436
+ #
2437
+ # @option params [Array<String>] :auto_sub_domain_creation_patterns
2438
+ # Sets the branch patterns for automatic subdomain creation.
2439
+ #
2440
+ # @option params [String] :auto_sub_domain_iam_role
2441
+ # The required AWS Identity and Access Management (IAM) service role for
2442
+ # the Amazon Resource Name (ARN) for automatically creating subdomains.
2375
2443
  #
2376
2444
  # @return [Types::UpdateDomainAssociationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2377
2445
  #
@@ -2389,6 +2457,8 @@ module Aws::Amplify
2389
2457
  # branch_name: "BranchName", # required
2390
2458
  # },
2391
2459
  # ],
2460
+ # auto_sub_domain_creation_patterns: ["AutoSubDomainCreationPattern"],
2461
+ # auto_sub_domain_iam_role: "AutoSubDomainIAMRole",
2392
2462
  # })
2393
2463
  #
2394
2464
  # @example Response structure
@@ -2396,6 +2466,9 @@ module Aws::Amplify
2396
2466
  # resp.domain_association.domain_association_arn #=> String
2397
2467
  # resp.domain_association.domain_name #=> String
2398
2468
  # resp.domain_association.enable_auto_sub_domain #=> Boolean
2469
+ # resp.domain_association.auto_sub_domain_creation_patterns #=> Array
2470
+ # resp.domain_association.auto_sub_domain_creation_patterns[0] #=> String
2471
+ # resp.domain_association.auto_sub_domain_iam_role #=> String
2399
2472
  # resp.domain_association.domain_status #=> String, one of "PENDING_VERIFICATION", "IN_PROGRESS", "AVAILABLE", "PENDING_DEPLOYMENT", "FAILED", "CREATING", "REQUESTING_CERTIFICATE", "UPDATING"
2400
2473
  # resp.domain_association.status_reason #=> String
2401
2474
  # resp.domain_association.certificate_verification_dns_record #=> String
@@ -2414,16 +2487,16 @@ module Aws::Amplify
2414
2487
  req.send_request(options)
2415
2488
  end
2416
2489
 
2417
- # Update a webhook.
2490
+ # Updates a webhook.
2418
2491
  #
2419
2492
  # @option params [required, String] :webhook_id
2420
- # Unique Id for a webhook.
2493
+ # The unique ID for a webhook.
2421
2494
  #
2422
2495
  # @option params [String] :branch_name
2423
- # Name for a branch, part of an Amplify App.
2496
+ # The name for a branch that is part of an Amplify app.
2424
2497
  #
2425
2498
  # @option params [String] :description
2426
- # Description for a webhook.
2499
+ # The description for a webhook.
2427
2500
  #
2428
2501
  # @return [Types::UpdateWebhookResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2429
2502
  #
@@ -2469,7 +2542,7 @@ module Aws::Amplify
2469
2542
  params: params,
2470
2543
  config: config)
2471
2544
  context[:gem_name] = 'aws-sdk-amplify'
2472
- context[:gem_version] = '1.19.0'
2545
+ context[:gem_version] = '1.24.0'
2473
2546
  Seahorse::Client::Request.new(handlers, context)
2474
2547
  end
2475
2548