aws-sdk-amplify 1.12.0 → 1.17.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 +5 -5
- data/lib/aws-sdk-amplify.rb +7 -4
- data/lib/aws-sdk-amplify/client.rb +275 -21
- data/lib/aws-sdk-amplify/client_api.rb +114 -2
- data/lib/aws-sdk-amplify/errors.rb +29 -7
- data/lib/aws-sdk-amplify/resource.rb +1 -0
- data/lib/aws-sdk-amplify/types.rb +282 -14
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: b04a22c6f87c1b7d137be8c1df6e8a131f5c45b6da8a6a6ebaa8a64c29fa5708
|
4
|
+
data.tar.gz: 86ee7ed80376156398a3a6c0a9999a2ae0b7931fbd9173821d0056bad941b767
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 44a1c6bc7feac4f97fb547ca3dfd4edf81130f83161c075977a35eaad78a60a4945088dc8729e913ee5c13c1ef0c7147dfce01d76a072efcdb5e0f0a917fd7f9
|
7
|
+
data.tar.gz: daa27c8e1d08b2cae53eb41e04aee488968f6d303b1880ddd5449a46c5ced87bf765340345341791597b2608bd0f435c058c944b54d462dc79c06fb099864cb6
|
data/lib/aws-sdk-amplify.rb
CHANGED
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-amplify/customizations'
|
|
24
24
|
# methods each accept a hash of request parameters and return a response
|
25
25
|
# structure.
|
26
26
|
#
|
27
|
+
# amplify = Aws::Amplify::Client.new
|
28
|
+
# resp = amplify.create_app(params)
|
29
|
+
#
|
27
30
|
# See {Client} for more information.
|
28
31
|
#
|
29
32
|
# # Errors
|
30
33
|
#
|
31
|
-
# Errors returned from AWS Amplify
|
32
|
-
# extend {Errors::ServiceError}.
|
34
|
+
# Errors returned from AWS Amplify are defined in the
|
35
|
+
# {Errors} module and all extend {Errors::ServiceError}.
|
33
36
|
#
|
34
37
|
# begin
|
35
38
|
# # do stuff
|
36
39
|
# rescue Aws::Amplify::Errors::ServiceError
|
37
|
-
# # rescues all
|
40
|
+
# # rescues all AWS Amplify API errors
|
38
41
|
# end
|
39
42
|
#
|
40
43
|
# See {Errors} for more information.
|
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-amplify/customizations'
|
|
42
45
|
# @service
|
43
46
|
module Aws::Amplify
|
44
47
|
|
45
|
-
GEM_VERSION = '1.
|
48
|
+
GEM_VERSION = '1.17.0'
|
46
49
|
|
47
50
|
end
|
@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
|
30
30
|
Aws::Plugins::GlobalConfiguration.add_identifier(:amplify)
|
31
31
|
|
32
32
|
module Aws::Amplify
|
33
|
+
# An API client for Amplify. To construct a client, you need to configure a `:region` and `:credentials`.
|
34
|
+
#
|
35
|
+
# client = Aws::Amplify::Client.new(
|
36
|
+
# region: region_name,
|
37
|
+
# credentials: credentials,
|
38
|
+
# # ...
|
39
|
+
# )
|
40
|
+
#
|
41
|
+
# For details on configuring region and credentials see
|
42
|
+
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
43
|
+
#
|
44
|
+
# See {#initialize} for a full list of supported configuration options.
|
33
45
|
class Client < Seahorse::Client::Base
|
34
46
|
|
35
47
|
include Aws::ClientStubs
|
@@ -93,7 +105,7 @@ module Aws::Amplify
|
|
93
105
|
# @option options [required, String] :region
|
94
106
|
# The AWS region to connect to. The configured `:region` is
|
95
107
|
# used to determine the service `:endpoint`. When not passed,
|
96
|
-
# a default `:region` is
|
108
|
+
# a default `:region` is searched for in the following locations:
|
97
109
|
#
|
98
110
|
# * `Aws.config[:region]`
|
99
111
|
# * `ENV['AWS_REGION']`
|
@@ -108,6 +120,12 @@ module Aws::Amplify
|
|
108
120
|
# When set to `true`, a thread polling for endpoints will be running in
|
109
121
|
# the background every 60 secs (default). Defaults to `false`.
|
110
122
|
#
|
123
|
+
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
|
124
|
+
# Used only in `adaptive` retry mode. When true, the request will sleep
|
125
|
+
# until there is sufficent client side capacity to retry the request.
|
126
|
+
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
127
|
+
# not retry instead of sleeping.
|
128
|
+
#
|
111
129
|
# @option options [Boolean] :client_side_monitoring (false)
|
112
130
|
# When `true`, client-side metrics will be collected for all API requests from
|
113
131
|
# this client.
|
@@ -132,6 +150,10 @@ module Aws::Amplify
|
|
132
150
|
# When `true`, an attempt is made to coerce request parameters into
|
133
151
|
# the required types.
|
134
152
|
#
|
153
|
+
# @option options [Boolean] :correct_clock_skew (true)
|
154
|
+
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
155
|
+
# a clock skew correction and retry requests with skewed client clocks.
|
156
|
+
#
|
135
157
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
136
158
|
# Set to true to disable SDK automatically adding host prefix
|
137
159
|
# to default service endpoint when available.
|
@@ -139,7 +161,7 @@ module Aws::Amplify
|
|
139
161
|
# @option options [String] :endpoint
|
140
162
|
# The client endpoint is normally constructed from the `:region`
|
141
163
|
# option. You should only configure an `:endpoint` when connecting
|
142
|
-
# to test endpoints. This should be
|
164
|
+
# to test endpoints. This should be a valid HTTP(S) URI.
|
143
165
|
#
|
144
166
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
145
167
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -154,7 +176,7 @@ module Aws::Amplify
|
|
154
176
|
# requests fetching endpoints information. Defaults to 60 sec.
|
155
177
|
#
|
156
178
|
# @option options [Boolean] :endpoint_discovery (false)
|
157
|
-
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
179
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
158
180
|
#
|
159
181
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
160
182
|
# The log formatter.
|
@@ -166,15 +188,29 @@ module Aws::Amplify
|
|
166
188
|
# The Logger instance to send log messages to. If this option
|
167
189
|
# is not set, logging will be disabled.
|
168
190
|
#
|
191
|
+
# @option options [Integer] :max_attempts (3)
|
192
|
+
# An integer representing the maximum number attempts that will be made for
|
193
|
+
# a single request, including the initial attempt. For example,
|
194
|
+
# setting this value to 5 will result in a request being retried up to
|
195
|
+
# 4 times. Used in `standard` and `adaptive` retry modes.
|
196
|
+
#
|
169
197
|
# @option options [String] :profile ("default")
|
170
198
|
# Used when loading credentials from the shared credentials file
|
171
199
|
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
172
200
|
#
|
201
|
+
# @option options [Proc] :retry_backoff
|
202
|
+
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
203
|
+
# This option is only used in the `legacy` retry mode.
|
204
|
+
#
|
173
205
|
# @option options [Float] :retry_base_delay (0.3)
|
174
|
-
# The base delay in seconds used by the default backoff function.
|
206
|
+
# The base delay in seconds used by the default backoff function. This option
|
207
|
+
# is only used in the `legacy` retry mode.
|
175
208
|
#
|
176
209
|
# @option options [Symbol] :retry_jitter (:none)
|
177
|
-
# A delay randomiser function used by the default backoff function.
|
210
|
+
# A delay randomiser function used by the default backoff function.
|
211
|
+
# Some predefined functions can be referenced by name - :none, :equal, :full,
|
212
|
+
# otherwise a Proc that takes and returns a number. This option is only used
|
213
|
+
# in the `legacy` retry mode.
|
178
214
|
#
|
179
215
|
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
180
216
|
#
|
@@ -182,11 +218,30 @@ module Aws::Amplify
|
|
182
218
|
# The maximum number of times to retry failed requests. Only
|
183
219
|
# ~ 500 level server errors and certain ~ 400 level client errors
|
184
220
|
# are retried. Generally, these are throttling errors, data
|
185
|
-
# checksum errors, networking errors, timeout errors
|
186
|
-
# errors from expired credentials.
|
221
|
+
# checksum errors, networking errors, timeout errors, auth errors,
|
222
|
+
# endpoint discovery, and errors from expired credentials.
|
223
|
+
# This option is only used in the `legacy` retry mode.
|
187
224
|
#
|
188
225
|
# @option options [Integer] :retry_max_delay (0)
|
189
|
-
# The maximum number of seconds to delay between retries (0 for no limit)
|
226
|
+
# The maximum number of seconds to delay between retries (0 for no limit)
|
227
|
+
# used by the default backoff function. This option is only used in the
|
228
|
+
# `legacy` retry mode.
|
229
|
+
#
|
230
|
+
# @option options [String] :retry_mode ("legacy")
|
231
|
+
# Specifies which retry algorithm to use. Values are:
|
232
|
+
#
|
233
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
234
|
+
# no retry mode is provided.
|
235
|
+
#
|
236
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
237
|
+
# This includes support for retry quotas, which limit the number of
|
238
|
+
# unsuccessful retries a client can make.
|
239
|
+
#
|
240
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
241
|
+
# functionality of `standard` mode along with automatic client side
|
242
|
+
# throttling. This is a provisional mode that may change behavior
|
243
|
+
# in the future.
|
244
|
+
#
|
190
245
|
#
|
191
246
|
# @option options [String] :secret_access_key
|
192
247
|
#
|
@@ -209,16 +264,15 @@ module Aws::Amplify
|
|
209
264
|
# requests through. Formatted like 'http://proxy.com:123'.
|
210
265
|
#
|
211
266
|
# @option options [Float] :http_open_timeout (15) The number of
|
212
|
-
# seconds to wait when opening a HTTP session before
|
267
|
+
# seconds to wait when opening a HTTP session before raising a
|
213
268
|
# `Timeout::Error`.
|
214
269
|
#
|
215
270
|
# @option options [Integer] :http_read_timeout (60) The default
|
216
271
|
# number of seconds to wait for response data. This value can
|
217
|
-
# safely be set
|
218
|
-
# per-request on the session yeidled by {#session_for}.
|
272
|
+
# safely be set per-request on the session.
|
219
273
|
#
|
220
274
|
# @option options [Float] :http_idle_timeout (5) The number of
|
221
|
-
# seconds a connection is allowed to sit
|
275
|
+
# seconds a connection is allowed to sit idle before it is
|
222
276
|
# considered stale. Stale connections are closed and removed
|
223
277
|
# from the pool before making a request.
|
224
278
|
#
|
@@ -227,7 +281,7 @@ module Aws::Amplify
|
|
227
281
|
# request body. This option has no effect unless the request has
|
228
282
|
# "Expect" header set to "100-continue". Defaults to `nil` which
|
229
283
|
# disables this behaviour. This value can safely be set per
|
230
|
-
# request on the session
|
284
|
+
# request on the session.
|
231
285
|
#
|
232
286
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
233
287
|
# HTTP debug output will be sent to the `:logger`.
|
@@ -357,6 +411,7 @@ module Aws::Amplify
|
|
357
411
|
# enable_basic_auth: false,
|
358
412
|
# build_spec: "BuildSpec",
|
359
413
|
# enable_pull_request_preview: false,
|
414
|
+
# pull_request_environment_name: "PullRequestEnvironmentName",
|
360
415
|
# },
|
361
416
|
# })
|
362
417
|
#
|
@@ -401,6 +456,7 @@ module Aws::Amplify
|
|
401
456
|
# resp.app.auto_branch_creation_config.enable_basic_auth #=> Boolean
|
402
457
|
# resp.app.auto_branch_creation_config.build_spec #=> String
|
403
458
|
# resp.app.auto_branch_creation_config.enable_pull_request_preview #=> Boolean
|
459
|
+
# resp.app.auto_branch_creation_config.pull_request_environment_name #=> String
|
404
460
|
#
|
405
461
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/CreateApp AWS API Documentation
|
406
462
|
#
|
@@ -411,6 +467,51 @@ module Aws::Amplify
|
|
411
467
|
req.send_request(options)
|
412
468
|
end
|
413
469
|
|
470
|
+
# Creates a new backend environment for an Amplify App.
|
471
|
+
#
|
472
|
+
# @option params [required, String] :app_id
|
473
|
+
# Unique Id for an Amplify App.
|
474
|
+
#
|
475
|
+
# @option params [required, String] :environment_name
|
476
|
+
# Name for the backend environment.
|
477
|
+
#
|
478
|
+
# @option params [String] :stack_name
|
479
|
+
# CloudFormation stack name of backend environment.
|
480
|
+
#
|
481
|
+
# @option params [String] :deployment_artifacts
|
482
|
+
# Name of deployment artifacts.
|
483
|
+
#
|
484
|
+
# @return [Types::CreateBackendEnvironmentResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
485
|
+
#
|
486
|
+
# * {Types::CreateBackendEnvironmentResult#backend_environment #backend_environment} => Types::BackendEnvironment
|
487
|
+
#
|
488
|
+
# @example Request syntax with placeholder values
|
489
|
+
#
|
490
|
+
# resp = client.create_backend_environment({
|
491
|
+
# app_id: "AppId", # required
|
492
|
+
# environment_name: "EnvironmentName", # required
|
493
|
+
# stack_name: "StackName",
|
494
|
+
# deployment_artifacts: "DeploymentArtifacts",
|
495
|
+
# })
|
496
|
+
#
|
497
|
+
# @example Response structure
|
498
|
+
#
|
499
|
+
# resp.backend_environment.backend_environment_arn #=> String
|
500
|
+
# resp.backend_environment.environment_name #=> String
|
501
|
+
# resp.backend_environment.stack_name #=> String
|
502
|
+
# resp.backend_environment.deployment_artifacts #=> String
|
503
|
+
# resp.backend_environment.create_time #=> Time
|
504
|
+
# resp.backend_environment.update_time #=> Time
|
505
|
+
#
|
506
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/CreateBackendEnvironment AWS API Documentation
|
507
|
+
#
|
508
|
+
# @overload create_backend_environment(params = {})
|
509
|
+
# @param [Hash] params ({})
|
510
|
+
def create_backend_environment(params = {}, options = {})
|
511
|
+
req = build_request(:create_backend_environment, params)
|
512
|
+
req.send_request(options)
|
513
|
+
end
|
514
|
+
|
414
515
|
# Creates a new Branch for an Amplify App.
|
415
516
|
#
|
416
517
|
# @option params [required, String] :app_id
|
@@ -458,6 +559,12 @@ module Aws::Amplify
|
|
458
559
|
# @option params [Boolean] :enable_pull_request_preview
|
459
560
|
# Enables Pull Request Preview for this branch.
|
460
561
|
#
|
562
|
+
# @option params [String] :pull_request_environment_name
|
563
|
+
# The Amplify Environment name for the pull request.
|
564
|
+
#
|
565
|
+
# @option params [String] :backend_environment_arn
|
566
|
+
# ARN for a Backend Environment, part of an Amplify App.
|
567
|
+
#
|
461
568
|
# @return [Types::CreateBranchResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
462
569
|
#
|
463
570
|
# * {Types::CreateBranchResult#branch #branch} => Types::Branch
|
@@ -484,6 +591,8 @@ module Aws::Amplify
|
|
484
591
|
# ttl: "TTL",
|
485
592
|
# display_name: "DisplayName",
|
486
593
|
# enable_pull_request_preview: false,
|
594
|
+
# pull_request_environment_name: "PullRequestEnvironmentName",
|
595
|
+
# backend_environment_arn: "BackendEnvironmentArn",
|
487
596
|
# })
|
488
597
|
#
|
489
598
|
# @example Response structure
|
@@ -514,8 +623,10 @@ module Aws::Amplify
|
|
514
623
|
# resp.branch.associated_resources #=> Array
|
515
624
|
# resp.branch.associated_resources[0] #=> String
|
516
625
|
# resp.branch.enable_pull_request_preview #=> Boolean
|
626
|
+
# resp.branch.pull_request_environment_name #=> String
|
517
627
|
# resp.branch.destination_branch #=> String
|
518
628
|
# resp.branch.source_branch #=> String
|
629
|
+
# resp.branch.backend_environment_arn #=> String
|
519
630
|
#
|
520
631
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/CreateBranch AWS API Documentation
|
521
632
|
#
|
@@ -582,7 +693,8 @@ module Aws::Amplify
|
|
582
693
|
# Domain name for the Domain Association.
|
583
694
|
#
|
584
695
|
# @option params [Boolean] :enable_auto_sub_domain
|
585
|
-
# Enables automated creation of Subdomains for branches.
|
696
|
+
# Enables automated creation of Subdomains for branches. (Currently not
|
697
|
+
# supported)
|
586
698
|
#
|
587
699
|
# @option params [required, Array<Types::SubDomainSetting>] :sub_domain_settings
|
588
700
|
# Setting structure for the Subdomain.
|
@@ -726,6 +838,7 @@ module Aws::Amplify
|
|
726
838
|
# resp.app.auto_branch_creation_config.enable_basic_auth #=> Boolean
|
727
839
|
# resp.app.auto_branch_creation_config.build_spec #=> String
|
728
840
|
# resp.app.auto_branch_creation_config.enable_pull_request_preview #=> Boolean
|
841
|
+
# resp.app.auto_branch_creation_config.pull_request_environment_name #=> String
|
729
842
|
#
|
730
843
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/DeleteApp AWS API Documentation
|
731
844
|
#
|
@@ -736,6 +849,43 @@ module Aws::Amplify
|
|
736
849
|
req.send_request(options)
|
737
850
|
end
|
738
851
|
|
852
|
+
# Delete backend environment for an Amplify App.
|
853
|
+
#
|
854
|
+
# @option params [required, String] :app_id
|
855
|
+
# Unique Id of an Amplify App.
|
856
|
+
#
|
857
|
+
# @option params [required, String] :environment_name
|
858
|
+
# Name of a backend environment of an Amplify App.
|
859
|
+
#
|
860
|
+
# @return [Types::DeleteBackendEnvironmentResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
861
|
+
#
|
862
|
+
# * {Types::DeleteBackendEnvironmentResult#backend_environment #backend_environment} => Types::BackendEnvironment
|
863
|
+
#
|
864
|
+
# @example Request syntax with placeholder values
|
865
|
+
#
|
866
|
+
# resp = client.delete_backend_environment({
|
867
|
+
# app_id: "AppId", # required
|
868
|
+
# environment_name: "EnvironmentName", # required
|
869
|
+
# })
|
870
|
+
#
|
871
|
+
# @example Response structure
|
872
|
+
#
|
873
|
+
# resp.backend_environment.backend_environment_arn #=> String
|
874
|
+
# resp.backend_environment.environment_name #=> String
|
875
|
+
# resp.backend_environment.stack_name #=> String
|
876
|
+
# resp.backend_environment.deployment_artifacts #=> String
|
877
|
+
# resp.backend_environment.create_time #=> Time
|
878
|
+
# resp.backend_environment.update_time #=> Time
|
879
|
+
#
|
880
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/DeleteBackendEnvironment AWS API Documentation
|
881
|
+
#
|
882
|
+
# @overload delete_backend_environment(params = {})
|
883
|
+
# @param [Hash] params ({})
|
884
|
+
def delete_backend_environment(params = {}, options = {})
|
885
|
+
req = build_request(:delete_backend_environment, params)
|
886
|
+
req.send_request(options)
|
887
|
+
end
|
888
|
+
|
739
889
|
# Deletes a branch for an Amplify App.
|
740
890
|
#
|
741
891
|
# @option params [required, String] :app_id
|
@@ -783,8 +933,10 @@ module Aws::Amplify
|
|
783
933
|
# resp.branch.associated_resources #=> Array
|
784
934
|
# resp.branch.associated_resources[0] #=> String
|
785
935
|
# resp.branch.enable_pull_request_preview #=> Boolean
|
936
|
+
# resp.branch.pull_request_environment_name #=> String
|
786
937
|
# resp.branch.destination_branch #=> String
|
787
938
|
# resp.branch.source_branch #=> String
|
939
|
+
# resp.branch.backend_environment_arn #=> String
|
788
940
|
#
|
789
941
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/DeleteBranch AWS API Documentation
|
790
942
|
#
|
@@ -916,7 +1068,7 @@ module Aws::Amplify
|
|
916
1068
|
end
|
917
1069
|
|
918
1070
|
# Retrieve website access logs for a specific time range via a
|
919
|
-
# pre-signed URL.
|
1071
|
+
# pre-signed URL.
|
920
1072
|
#
|
921
1073
|
# @option params [Time,DateTime,Date,Integer,String] :start_time
|
922
1074
|
# The time at which the logs should start, inclusive.
|
@@ -1012,6 +1164,7 @@ module Aws::Amplify
|
|
1012
1164
|
# resp.app.auto_branch_creation_config.enable_basic_auth #=> Boolean
|
1013
1165
|
# resp.app.auto_branch_creation_config.build_spec #=> String
|
1014
1166
|
# resp.app.auto_branch_creation_config.enable_pull_request_preview #=> Boolean
|
1167
|
+
# resp.app.auto_branch_creation_config.pull_request_environment_name #=> String
|
1015
1168
|
#
|
1016
1169
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GetApp AWS API Documentation
|
1017
1170
|
#
|
@@ -1052,6 +1205,43 @@ module Aws::Amplify
|
|
1052
1205
|
req.send_request(options)
|
1053
1206
|
end
|
1054
1207
|
|
1208
|
+
# Retrieves a backend environment for an Amplify App.
|
1209
|
+
#
|
1210
|
+
# @option params [required, String] :app_id
|
1211
|
+
# Unique Id for an Amplify App.
|
1212
|
+
#
|
1213
|
+
# @option params [required, String] :environment_name
|
1214
|
+
# Name for the backend environment.
|
1215
|
+
#
|
1216
|
+
# @return [Types::GetBackendEnvironmentResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1217
|
+
#
|
1218
|
+
# * {Types::GetBackendEnvironmentResult#backend_environment #backend_environment} => Types::BackendEnvironment
|
1219
|
+
#
|
1220
|
+
# @example Request syntax with placeholder values
|
1221
|
+
#
|
1222
|
+
# resp = client.get_backend_environment({
|
1223
|
+
# app_id: "AppId", # required
|
1224
|
+
# environment_name: "EnvironmentName", # required
|
1225
|
+
# })
|
1226
|
+
#
|
1227
|
+
# @example Response structure
|
1228
|
+
#
|
1229
|
+
# resp.backend_environment.backend_environment_arn #=> String
|
1230
|
+
# resp.backend_environment.environment_name #=> String
|
1231
|
+
# resp.backend_environment.stack_name #=> String
|
1232
|
+
# resp.backend_environment.deployment_artifacts #=> String
|
1233
|
+
# resp.backend_environment.create_time #=> Time
|
1234
|
+
# resp.backend_environment.update_time #=> Time
|
1235
|
+
#
|
1236
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GetBackendEnvironment AWS API Documentation
|
1237
|
+
#
|
1238
|
+
# @overload get_backend_environment(params = {})
|
1239
|
+
# @param [Hash] params ({})
|
1240
|
+
def get_backend_environment(params = {}, options = {})
|
1241
|
+
req = build_request(:get_backend_environment, params)
|
1242
|
+
req.send_request(options)
|
1243
|
+
end
|
1244
|
+
|
1055
1245
|
# Retrieves a branch for an Amplify App.
|
1056
1246
|
#
|
1057
1247
|
# @option params [required, String] :app_id
|
@@ -1099,8 +1289,10 @@ module Aws::Amplify
|
|
1099
1289
|
# resp.branch.associated_resources #=> Array
|
1100
1290
|
# resp.branch.associated_resources[0] #=> String
|
1101
1291
|
# resp.branch.enable_pull_request_preview #=> Boolean
|
1292
|
+
# resp.branch.pull_request_environment_name #=> String
|
1102
1293
|
# resp.branch.destination_branch #=> String
|
1103
1294
|
# resp.branch.source_branch #=> String
|
1295
|
+
# resp.branch.backend_environment_arn #=> String
|
1104
1296
|
#
|
1105
1297
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GetBranch AWS API Documentation
|
1106
1298
|
#
|
@@ -1307,6 +1499,7 @@ module Aws::Amplify
|
|
1307
1499
|
# resp.apps[0].auto_branch_creation_config.enable_basic_auth #=> Boolean
|
1308
1500
|
# resp.apps[0].auto_branch_creation_config.build_spec #=> String
|
1309
1501
|
# resp.apps[0].auto_branch_creation_config.enable_pull_request_preview #=> Boolean
|
1502
|
+
# resp.apps[0].auto_branch_creation_config.pull_request_environment_name #=> String
|
1310
1503
|
# resp.next_token #=> String
|
1311
1504
|
#
|
1312
1505
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListApps AWS API Documentation
|
@@ -1329,9 +1522,6 @@ module Aws::Amplify
|
|
1329
1522
|
# @option params [required, String] :job_id
|
1330
1523
|
# Unique Id for an Job.
|
1331
1524
|
#
|
1332
|
-
# @option params [String] :artifact_type
|
1333
|
-
# Type for an artifact.
|
1334
|
-
#
|
1335
1525
|
# @option params [String] :next_token
|
1336
1526
|
# Pagination token. Set to null to start listing artifacts from start.
|
1337
1527
|
# If non-null pagination token is returned in a result, then pass its
|
@@ -1351,7 +1541,6 @@ module Aws::Amplify
|
|
1351
1541
|
# app_id: "AppId", # required
|
1352
1542
|
# branch_name: "BranchName", # required
|
1353
1543
|
# job_id: "JobId", # required
|
1354
|
-
# artifact_type: "TEST", # accepts TEST
|
1355
1544
|
# next_token: "NextToken",
|
1356
1545
|
# max_results: 1,
|
1357
1546
|
# })
|
@@ -1372,6 +1561,56 @@ module Aws::Amplify
|
|
1372
1561
|
req.send_request(options)
|
1373
1562
|
end
|
1374
1563
|
|
1564
|
+
# Lists backend environments for an Amplify App.
|
1565
|
+
#
|
1566
|
+
# @option params [required, String] :app_id
|
1567
|
+
# Unique Id for an amplify App.
|
1568
|
+
#
|
1569
|
+
# @option params [String] :environment_name
|
1570
|
+
# Name of the backend environment
|
1571
|
+
#
|
1572
|
+
# @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.
|
1576
|
+
#
|
1577
|
+
# @option params [Integer] :max_results
|
1578
|
+
# Maximum number of records to list in a single response.
|
1579
|
+
#
|
1580
|
+
# @return [Types::ListBackendEnvironmentsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1581
|
+
#
|
1582
|
+
# * {Types::ListBackendEnvironmentsResult#backend_environments #backend_environments} => Array<Types::BackendEnvironment>
|
1583
|
+
# * {Types::ListBackendEnvironmentsResult#next_token #next_token} => String
|
1584
|
+
#
|
1585
|
+
# @example Request syntax with placeholder values
|
1586
|
+
#
|
1587
|
+
# resp = client.list_backend_environments({
|
1588
|
+
# app_id: "AppId", # required
|
1589
|
+
# environment_name: "EnvironmentName",
|
1590
|
+
# next_token: "NextToken",
|
1591
|
+
# max_results: 1,
|
1592
|
+
# })
|
1593
|
+
#
|
1594
|
+
# @example Response structure
|
1595
|
+
#
|
1596
|
+
# resp.backend_environments #=> Array
|
1597
|
+
# resp.backend_environments[0].backend_environment_arn #=> String
|
1598
|
+
# resp.backend_environments[0].environment_name #=> String
|
1599
|
+
# resp.backend_environments[0].stack_name #=> String
|
1600
|
+
# resp.backend_environments[0].deployment_artifacts #=> String
|
1601
|
+
# resp.backend_environments[0].create_time #=> Time
|
1602
|
+
# resp.backend_environments[0].update_time #=> Time
|
1603
|
+
# resp.next_token #=> String
|
1604
|
+
#
|
1605
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListBackendEnvironments AWS API Documentation
|
1606
|
+
#
|
1607
|
+
# @overload list_backend_environments(params = {})
|
1608
|
+
# @param [Hash] params ({})
|
1609
|
+
def list_backend_environments(params = {}, options = {})
|
1610
|
+
req = build_request(:list_backend_environments, params)
|
1611
|
+
req.send_request(options)
|
1612
|
+
end
|
1613
|
+
|
1375
1614
|
# Lists branches for an Amplify App.
|
1376
1615
|
#
|
1377
1616
|
# @option params [required, String] :app_id
|
@@ -1427,8 +1666,10 @@ module Aws::Amplify
|
|
1427
1666
|
# resp.branches[0].associated_resources #=> Array
|
1428
1667
|
# resp.branches[0].associated_resources[0] #=> String
|
1429
1668
|
# resp.branches[0].enable_pull_request_preview #=> Boolean
|
1669
|
+
# resp.branches[0].pull_request_environment_name #=> String
|
1430
1670
|
# resp.branches[0].destination_branch #=> String
|
1431
1671
|
# resp.branches[0].source_branch #=> String
|
1672
|
+
# resp.branches[0].backend_environment_arn #=> String
|
1432
1673
|
# resp.next_token #=> String
|
1433
1674
|
#
|
1434
1675
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListBranches AWS API Documentation
|
@@ -1935,6 +2176,7 @@ module Aws::Amplify
|
|
1935
2176
|
# enable_basic_auth: false,
|
1936
2177
|
# build_spec: "BuildSpec",
|
1937
2178
|
# enable_pull_request_preview: false,
|
2179
|
+
# pull_request_environment_name: "PullRequestEnvironmentName",
|
1938
2180
|
# },
|
1939
2181
|
# repository: "Repository",
|
1940
2182
|
# oauth_token: "OauthToken",
|
@@ -1982,6 +2224,7 @@ module Aws::Amplify
|
|
1982
2224
|
# resp.app.auto_branch_creation_config.enable_basic_auth #=> Boolean
|
1983
2225
|
# resp.app.auto_branch_creation_config.build_spec #=> String
|
1984
2226
|
# resp.app.auto_branch_creation_config.enable_pull_request_preview #=> Boolean
|
2227
|
+
# resp.app.auto_branch_creation_config.pull_request_environment_name #=> String
|
1985
2228
|
#
|
1986
2229
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/UpdateApp AWS API Documentation
|
1987
2230
|
#
|
@@ -2036,6 +2279,12 @@ module Aws::Amplify
|
|
2036
2279
|
# @option params [Boolean] :enable_pull_request_preview
|
2037
2280
|
# Enables Pull Request Preview for this branch.
|
2038
2281
|
#
|
2282
|
+
# @option params [String] :pull_request_environment_name
|
2283
|
+
# The Amplify Environment name for the pull request.
|
2284
|
+
#
|
2285
|
+
# @option params [String] :backend_environment_arn
|
2286
|
+
# ARN for a Backend Environment, part of an Amplify App.
|
2287
|
+
#
|
2039
2288
|
# @return [Types::UpdateBranchResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2040
2289
|
#
|
2041
2290
|
# * {Types::UpdateBranchResult#branch #branch} => Types::Branch
|
@@ -2059,6 +2308,8 @@ module Aws::Amplify
|
|
2059
2308
|
# ttl: "TTL",
|
2060
2309
|
# display_name: "DisplayName",
|
2061
2310
|
# enable_pull_request_preview: false,
|
2311
|
+
# pull_request_environment_name: "PullRequestEnvironmentName",
|
2312
|
+
# backend_environment_arn: "BackendEnvironmentArn",
|
2062
2313
|
# })
|
2063
2314
|
#
|
2064
2315
|
# @example Response structure
|
@@ -2089,8 +2340,10 @@ module Aws::Amplify
|
|
2089
2340
|
# resp.branch.associated_resources #=> Array
|
2090
2341
|
# resp.branch.associated_resources[0] #=> String
|
2091
2342
|
# resp.branch.enable_pull_request_preview #=> Boolean
|
2343
|
+
# resp.branch.pull_request_environment_name #=> String
|
2092
2344
|
# resp.branch.destination_branch #=> String
|
2093
2345
|
# resp.branch.source_branch #=> String
|
2346
|
+
# resp.branch.backend_environment_arn #=> String
|
2094
2347
|
#
|
2095
2348
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/UpdateBranch AWS API Documentation
|
2096
2349
|
#
|
@@ -2110,7 +2363,8 @@ module Aws::Amplify
|
|
2110
2363
|
# Name of the domain.
|
2111
2364
|
#
|
2112
2365
|
# @option params [Boolean] :enable_auto_sub_domain
|
2113
|
-
# Enables automated creation of Subdomains for branches.
|
2366
|
+
# Enables automated creation of Subdomains for branches. (Currently not
|
2367
|
+
# supported)
|
2114
2368
|
#
|
2115
2369
|
# @option params [required, Array<Types::SubDomainSetting>] :sub_domain_settings
|
2116
2370
|
# Setting structure for the Subdomain.
|
@@ -2211,7 +2465,7 @@ module Aws::Amplify
|
|
2211
2465
|
params: params,
|
2212
2466
|
config: config)
|
2213
2467
|
context[:gem_name] = 'aws-sdk-amplify'
|
2214
|
-
context[:gem_version] = '1.
|
2468
|
+
context[:gem_version] = '1.17.0'
|
2215
2469
|
Seahorse::Client::Request.new(handlers, context)
|
2216
2470
|
end
|
2217
2471
|
|