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