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