aws-sdk-amplify 1.18.1 → 1.23.0

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