aws-sdk-amplify 1.0.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 +7 -0
- data/lib/aws-sdk-amplify.rb +47 -0
- data/lib/aws-sdk-amplify/client.rb +1505 -0
- data/lib/aws-sdk-amplify/client_api.rb +740 -0
- data/lib/aws-sdk-amplify/customizations.rb +0 -0
- data/lib/aws-sdk-amplify/errors.rb +14 -0
- data/lib/aws-sdk-amplify/resource.rb +23 -0
- data/lib/aws-sdk-amplify/types.rb +1681 -0
- metadata +88 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 1a734a02eee04e79ae26c42b1ad9e5fca9cc4ac2
|
4
|
+
data.tar.gz: 5fe3921ae63ff11a8ec96d107d929d43758c6e20
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 5dd1567d65714d2c56288825c762f0ed2314fd1d58219fb408b3df48f8804fbbe98d370abb7ec8fb10eca4a2df6b7f1bdf92c292dc8450684e6ccc403e7eed46
|
7
|
+
data.tar.gz: 648d03db7a03502036d5596f63f3b8843b5dec71a2efc2b79bb3beb338da5dae4cacb94c95e960dc9d13defbac1d41c012b0b98c9a6f12a34c77de64325e0b57
|
@@ -0,0 +1,47 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
require 'aws-sdk-core'
|
9
|
+
require 'aws-sigv4'
|
10
|
+
|
11
|
+
require_relative 'aws-sdk-amplify/types'
|
12
|
+
require_relative 'aws-sdk-amplify/client_api'
|
13
|
+
require_relative 'aws-sdk-amplify/client'
|
14
|
+
require_relative 'aws-sdk-amplify/errors'
|
15
|
+
require_relative 'aws-sdk-amplify/resource'
|
16
|
+
require_relative 'aws-sdk-amplify/customizations'
|
17
|
+
|
18
|
+
# This module provides support for AWS Amplify. This module is available in the
|
19
|
+
# `aws-sdk-amplify` gem.
|
20
|
+
#
|
21
|
+
# # Client
|
22
|
+
#
|
23
|
+
# The {Client} class provides one method for each API operation. Operation
|
24
|
+
# methods each accept a hash of request parameters and return a response
|
25
|
+
# structure.
|
26
|
+
#
|
27
|
+
# See {Client} for more information.
|
28
|
+
#
|
29
|
+
# # Errors
|
30
|
+
#
|
31
|
+
# Errors returned from AWS Amplify all
|
32
|
+
# extend {Errors::ServiceError}.
|
33
|
+
#
|
34
|
+
# begin
|
35
|
+
# # do stuff
|
36
|
+
# rescue Aws::Amplify::Errors::ServiceError
|
37
|
+
# # rescues all service API errors
|
38
|
+
# end
|
39
|
+
#
|
40
|
+
# See {Errors} for more information.
|
41
|
+
#
|
42
|
+
# @service
|
43
|
+
module Aws::Amplify
|
44
|
+
|
45
|
+
GEM_VERSION = '1.0.0'
|
46
|
+
|
47
|
+
end
|
@@ -0,0 +1,1505 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
require 'seahorse/client/plugins/content_length.rb'
|
9
|
+
require 'aws-sdk-core/plugins/credentials_configuration.rb'
|
10
|
+
require 'aws-sdk-core/plugins/logging.rb'
|
11
|
+
require 'aws-sdk-core/plugins/param_converter.rb'
|
12
|
+
require 'aws-sdk-core/plugins/param_validator.rb'
|
13
|
+
require 'aws-sdk-core/plugins/user_agent.rb'
|
14
|
+
require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
|
15
|
+
require 'aws-sdk-core/plugins/retry_errors.rb'
|
16
|
+
require 'aws-sdk-core/plugins/global_configuration.rb'
|
17
|
+
require 'aws-sdk-core/plugins/regional_endpoint.rb'
|
18
|
+
require 'aws-sdk-core/plugins/endpoint_discovery.rb'
|
19
|
+
require 'aws-sdk-core/plugins/endpoint_pattern.rb'
|
20
|
+
require 'aws-sdk-core/plugins/response_paging.rb'
|
21
|
+
require 'aws-sdk-core/plugins/stub_responses.rb'
|
22
|
+
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
23
|
+
require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
24
|
+
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
25
|
+
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
26
|
+
require 'aws-sdk-core/plugins/signature_v4.rb'
|
27
|
+
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
28
|
+
|
29
|
+
Aws::Plugins::GlobalConfiguration.add_identifier(:amplify)
|
30
|
+
|
31
|
+
module Aws::Amplify
|
32
|
+
class Client < Seahorse::Client::Base
|
33
|
+
|
34
|
+
include Aws::ClientStubs
|
35
|
+
|
36
|
+
@identifier = :amplify
|
37
|
+
|
38
|
+
set_api(ClientApi::API)
|
39
|
+
|
40
|
+
add_plugin(Seahorse::Client::Plugins::ContentLength)
|
41
|
+
add_plugin(Aws::Plugins::CredentialsConfiguration)
|
42
|
+
add_plugin(Aws::Plugins::Logging)
|
43
|
+
add_plugin(Aws::Plugins::ParamConverter)
|
44
|
+
add_plugin(Aws::Plugins::ParamValidator)
|
45
|
+
add_plugin(Aws::Plugins::UserAgent)
|
46
|
+
add_plugin(Aws::Plugins::HelpfulSocketErrors)
|
47
|
+
add_plugin(Aws::Plugins::RetryErrors)
|
48
|
+
add_plugin(Aws::Plugins::GlobalConfiguration)
|
49
|
+
add_plugin(Aws::Plugins::RegionalEndpoint)
|
50
|
+
add_plugin(Aws::Plugins::EndpointDiscovery)
|
51
|
+
add_plugin(Aws::Plugins::EndpointPattern)
|
52
|
+
add_plugin(Aws::Plugins::ResponsePaging)
|
53
|
+
add_plugin(Aws::Plugins::StubResponses)
|
54
|
+
add_plugin(Aws::Plugins::IdempotencyToken)
|
55
|
+
add_plugin(Aws::Plugins::JsonvalueConverter)
|
56
|
+
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
57
|
+
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
58
|
+
add_plugin(Aws::Plugins::SignatureV4)
|
59
|
+
add_plugin(Aws::Plugins::Protocols::RestJson)
|
60
|
+
|
61
|
+
# @overload initialize(options)
|
62
|
+
# @param [Hash] options
|
63
|
+
# @option options [required, Aws::CredentialProvider] :credentials
|
64
|
+
# Your AWS credentials. This can be an instance of any one of the
|
65
|
+
# following classes:
|
66
|
+
#
|
67
|
+
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
68
|
+
# credentials.
|
69
|
+
#
|
70
|
+
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
71
|
+
# from an EC2 IMDS on an EC2 instance.
|
72
|
+
#
|
73
|
+
# * `Aws::SharedCredentials` - Used for loading credentials from a
|
74
|
+
# shared file, such as `~/.aws/config`.
|
75
|
+
#
|
76
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
77
|
+
#
|
78
|
+
# When `:credentials` are not configured directly, the following
|
79
|
+
# locations will be searched for credentials:
|
80
|
+
#
|
81
|
+
# * `Aws.config[:credentials]`
|
82
|
+
# * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
|
83
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
84
|
+
# * `~/.aws/credentials`
|
85
|
+
# * `~/.aws/config`
|
86
|
+
# * EC2 IMDS instance profile - When used by default, the timeouts are
|
87
|
+
# very aggressive. Construct and pass an instance of
|
88
|
+
# `Aws::InstanceProfileCredentails` to enable retries and extended
|
89
|
+
# timeouts.
|
90
|
+
#
|
91
|
+
# @option options [required, String] :region
|
92
|
+
# The AWS region to connect to. The configured `:region` is
|
93
|
+
# used to determine the service `:endpoint`. When not passed,
|
94
|
+
# a default `:region` is search for in the following locations:
|
95
|
+
#
|
96
|
+
# * `Aws.config[:region]`
|
97
|
+
# * `ENV['AWS_REGION']`
|
98
|
+
# * `ENV['AMAZON_REGION']`
|
99
|
+
# * `ENV['AWS_DEFAULT_REGION']`
|
100
|
+
# * `~/.aws/credentials`
|
101
|
+
# * `~/.aws/config`
|
102
|
+
#
|
103
|
+
# @option options [String] :access_key_id
|
104
|
+
#
|
105
|
+
# @option options [Boolean] :active_endpoint_cache (false)
|
106
|
+
# When set to `true`, a thread polling for endpoints will be running in
|
107
|
+
# the background every 60 secs (default). Defaults to `false`.
|
108
|
+
#
|
109
|
+
# @option options [Boolean] :client_side_monitoring (false)
|
110
|
+
# When `true`, client-side metrics will be collected for all API requests from
|
111
|
+
# this client.
|
112
|
+
#
|
113
|
+
# @option options [String] :client_side_monitoring_client_id ("")
|
114
|
+
# Allows you to provide an identifier for this client which will be attached to
|
115
|
+
# all generated client side metrics. Defaults to an empty string.
|
116
|
+
#
|
117
|
+
# @option options [Integer] :client_side_monitoring_port (31000)
|
118
|
+
# Required for publishing client metrics. The port that the client side monitoring
|
119
|
+
# agent is running on, where client metrics will be published via UDP.
|
120
|
+
#
|
121
|
+
# @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
|
122
|
+
# Allows you to provide a custom client-side monitoring publisher class. By default,
|
123
|
+
# will use the Client Side Monitoring Agent Publisher.
|
124
|
+
#
|
125
|
+
# @option options [Boolean] :convert_params (true)
|
126
|
+
# When `true`, an attempt is made to coerce request parameters into
|
127
|
+
# the required types.
|
128
|
+
#
|
129
|
+
# @option options [Boolean] :disable_host_prefix_injection (false)
|
130
|
+
# Set to true to disable SDK automatically adding host prefix
|
131
|
+
# to default service endpoint when available.
|
132
|
+
#
|
133
|
+
# @option options [String] :endpoint
|
134
|
+
# The client endpoint is normally constructed from the `:region`
|
135
|
+
# option. You should only configure an `:endpoint` when connecting
|
136
|
+
# to test endpoints. This should be avalid HTTP(S) URI.
|
137
|
+
#
|
138
|
+
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
139
|
+
# Used for the maximum size limit of the LRU cache storing endpoints data
|
140
|
+
# for endpoint discovery enabled operations. Defaults to 1000.
|
141
|
+
#
|
142
|
+
# @option options [Integer] :endpoint_cache_max_threads (10)
|
143
|
+
# Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
|
144
|
+
#
|
145
|
+
# @option options [Integer] :endpoint_cache_poll_interval (60)
|
146
|
+
# When :endpoint_discovery and :active_endpoint_cache is enabled,
|
147
|
+
# Use this option to config the time interval in seconds for making
|
148
|
+
# requests fetching endpoints information. Defaults to 60 sec.
|
149
|
+
#
|
150
|
+
# @option options [Boolean] :endpoint_discovery (false)
|
151
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
|
152
|
+
#
|
153
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
154
|
+
# The log formatter.
|
155
|
+
#
|
156
|
+
# @option options [Symbol] :log_level (:info)
|
157
|
+
# The log level to send messages to the `:logger` at.
|
158
|
+
#
|
159
|
+
# @option options [Logger] :logger
|
160
|
+
# The Logger instance to send log messages to. If this option
|
161
|
+
# is not set, logging will be disabled.
|
162
|
+
#
|
163
|
+
# @option options [String] :profile ("default")
|
164
|
+
# Used when loading credentials from the shared credentials file
|
165
|
+
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
166
|
+
#
|
167
|
+
# @option options [Float] :retry_base_delay (0.3)
|
168
|
+
# The base delay in seconds used by the default backoff function.
|
169
|
+
#
|
170
|
+
# @option options [Symbol] :retry_jitter (:none)
|
171
|
+
# A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
|
172
|
+
#
|
173
|
+
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
174
|
+
#
|
175
|
+
# @option options [Integer] :retry_limit (3)
|
176
|
+
# The maximum number of times to retry failed requests. Only
|
177
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
178
|
+
# are retried. Generally, these are throttling errors, data
|
179
|
+
# checksum errors, networking errors, timeout errors and auth
|
180
|
+
# errors from expired credentials.
|
181
|
+
#
|
182
|
+
# @option options [Integer] :retry_max_delay (0)
|
183
|
+
# The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
|
184
|
+
#
|
185
|
+
# @option options [String] :secret_access_key
|
186
|
+
#
|
187
|
+
# @option options [String] :session_token
|
188
|
+
#
|
189
|
+
# @option options [Boolean] :stub_responses (false)
|
190
|
+
# Causes the client to return stubbed responses. By default
|
191
|
+
# fake responses are generated and returned. You can specify
|
192
|
+
# the response data to return or errors to raise by calling
|
193
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
194
|
+
#
|
195
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
196
|
+
# requests are made, and retries are disabled.
|
197
|
+
#
|
198
|
+
# @option options [Boolean] :validate_params (true)
|
199
|
+
# When `true`, request parameters are validated before
|
200
|
+
# sending the request.
|
201
|
+
#
|
202
|
+
def initialize(*args)
|
203
|
+
super
|
204
|
+
end
|
205
|
+
|
206
|
+
# @!group API Operations
|
207
|
+
|
208
|
+
# Creates a new Amplify App.
|
209
|
+
#
|
210
|
+
# @option params [required, String] :name
|
211
|
+
# Name for the Amplify App
|
212
|
+
#
|
213
|
+
# @option params [String] :description
|
214
|
+
# Description for an Amplify App
|
215
|
+
#
|
216
|
+
# @option params [required, String] :repository
|
217
|
+
# Repository for an Amplify App
|
218
|
+
#
|
219
|
+
# @option params [required, String] :platform
|
220
|
+
# Platform / framework for an Amplify App
|
221
|
+
#
|
222
|
+
# @option params [String] :iam_service_role_arn
|
223
|
+
# AWS IAM service role for an Amplify App
|
224
|
+
#
|
225
|
+
# @option params [required, String] :oauth_token
|
226
|
+
# OAuth token for 3rd party source control system for an Amplify App,
|
227
|
+
# used to create webhook and read-only deploy key. OAuth token is not
|
228
|
+
# stored.
|
229
|
+
#
|
230
|
+
# @option params [Hash<String,String>] :environment_variables
|
231
|
+
# Environment variables map for an Amplify App.
|
232
|
+
#
|
233
|
+
# @option params [Boolean] :enable_branch_auto_build
|
234
|
+
# Enable the auto building of branches for an Amplify App.
|
235
|
+
#
|
236
|
+
# @option params [Boolean] :enable_basic_auth
|
237
|
+
# Enable Basic Authorization for an Amplify App, this will apply to all
|
238
|
+
# branches part of this App.
|
239
|
+
#
|
240
|
+
# @option params [String] :basic_auth_credentials
|
241
|
+
# Credentials for Basic Authorization for an Amplify App.
|
242
|
+
#
|
243
|
+
# @option params [Array<Types::CustomRule>] :custom_rules
|
244
|
+
# Custom rewrite / redirect rules for an Amplify App.
|
245
|
+
#
|
246
|
+
# @option params [Hash<String,String>] :tags
|
247
|
+
# Tag for an Amplify App
|
248
|
+
#
|
249
|
+
# @option params [String] :build_spec
|
250
|
+
# BuildSpec for an Amplify App
|
251
|
+
#
|
252
|
+
# @return [Types::CreateAppResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
253
|
+
#
|
254
|
+
# * {Types::CreateAppResult#app #app} => Types::App
|
255
|
+
#
|
256
|
+
# @example Request syntax with placeholder values
|
257
|
+
#
|
258
|
+
# resp = client.create_app({
|
259
|
+
# name: "Name", # required
|
260
|
+
# description: "Description",
|
261
|
+
# repository: "Repository", # required
|
262
|
+
# platform: "IOS", # required, accepts IOS, ANDROID, WEB, REACT_NATIVE
|
263
|
+
# iam_service_role_arn: "ServiceRoleArn",
|
264
|
+
# oauth_token: "OauthToken", # required
|
265
|
+
# environment_variables: {
|
266
|
+
# "EnvKey" => "EnvValue",
|
267
|
+
# },
|
268
|
+
# enable_branch_auto_build: false,
|
269
|
+
# enable_basic_auth: false,
|
270
|
+
# basic_auth_credentials: "BasicAuthCredentials",
|
271
|
+
# custom_rules: [
|
272
|
+
# {
|
273
|
+
# source: "Source", # required
|
274
|
+
# target: "Target", # required
|
275
|
+
# status: "Status",
|
276
|
+
# condition: "Condition",
|
277
|
+
# },
|
278
|
+
# ],
|
279
|
+
# tags: {
|
280
|
+
# "TagKey" => "TagValue",
|
281
|
+
# },
|
282
|
+
# build_spec: "BuildSpec",
|
283
|
+
# })
|
284
|
+
#
|
285
|
+
# @example Response structure
|
286
|
+
#
|
287
|
+
# resp.app.app_id #=> String
|
288
|
+
# resp.app.app_arn #=> String
|
289
|
+
# resp.app.name #=> String
|
290
|
+
# resp.app.tags #=> Hash
|
291
|
+
# resp.app.tags["TagKey"] #=> String
|
292
|
+
# resp.app.description #=> String
|
293
|
+
# resp.app.repository #=> String
|
294
|
+
# resp.app.platform #=> String, one of "IOS", "ANDROID", "WEB", "REACT_NATIVE"
|
295
|
+
# resp.app.create_time #=> Time
|
296
|
+
# resp.app.update_time #=> Time
|
297
|
+
# resp.app.iam_service_role_arn #=> String
|
298
|
+
# resp.app.environment_variables #=> Hash
|
299
|
+
# resp.app.environment_variables["EnvKey"] #=> String
|
300
|
+
# resp.app.default_domain #=> String
|
301
|
+
# resp.app.enable_branch_auto_build #=> Boolean
|
302
|
+
# resp.app.enable_basic_auth #=> Boolean
|
303
|
+
# resp.app.basic_auth_credentials #=> String
|
304
|
+
# resp.app.custom_rules #=> Array
|
305
|
+
# resp.app.custom_rules[0].source #=> String
|
306
|
+
# resp.app.custom_rules[0].target #=> String
|
307
|
+
# resp.app.custom_rules[0].status #=> String
|
308
|
+
# resp.app.custom_rules[0].condition #=> String
|
309
|
+
# resp.app.production_branch.last_deploy_time #=> Time
|
310
|
+
# resp.app.production_branch.status #=> String
|
311
|
+
# resp.app.production_branch.thumbnail_url #=> String
|
312
|
+
# resp.app.production_branch.branch_name #=> String
|
313
|
+
# resp.app.build_spec #=> String
|
314
|
+
#
|
315
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/CreateApp AWS API Documentation
|
316
|
+
#
|
317
|
+
# @overload create_app(params = {})
|
318
|
+
# @param [Hash] params ({})
|
319
|
+
def create_app(params = {}, options = {})
|
320
|
+
req = build_request(:create_app, params)
|
321
|
+
req.send_request(options)
|
322
|
+
end
|
323
|
+
|
324
|
+
# Creates a new Branch for an Amplify App.
|
325
|
+
#
|
326
|
+
# @option params [required, String] :app_id
|
327
|
+
# Unique Id for an Amplify App.
|
328
|
+
#
|
329
|
+
# @option params [required, String] :branch_name
|
330
|
+
# Name for the branch.
|
331
|
+
#
|
332
|
+
# @option params [String] :description
|
333
|
+
# Description for the branch.
|
334
|
+
#
|
335
|
+
# @option params [String] :stage
|
336
|
+
# Stage for the branch.
|
337
|
+
#
|
338
|
+
# @option params [String] :framework
|
339
|
+
# Framework for the branch.
|
340
|
+
#
|
341
|
+
# @option params [Boolean] :enable_notification
|
342
|
+
# Enables notifications for the branch.
|
343
|
+
#
|
344
|
+
# @option params [Boolean] :enable_auto_build
|
345
|
+
# Enables auto building for the branch.
|
346
|
+
#
|
347
|
+
# @option params [Hash<String,String>] :environment_variables
|
348
|
+
# Environment Variables for the branch.
|
349
|
+
#
|
350
|
+
# @option params [String] :basic_auth_credentials
|
351
|
+
# Basic Authorization credentials for the branch.
|
352
|
+
#
|
353
|
+
# @option params [Boolean] :enable_basic_auth
|
354
|
+
# Enables Basic Auth for the branch.
|
355
|
+
#
|
356
|
+
# @option params [Hash<String,String>] :tags
|
357
|
+
# Tag for the branch.
|
358
|
+
#
|
359
|
+
# @option params [String] :build_spec
|
360
|
+
# BuildSpec for the branch.
|
361
|
+
#
|
362
|
+
# @option params [String] :ttl
|
363
|
+
# The content TTL for the website in seconds.
|
364
|
+
#
|
365
|
+
# @return [Types::CreateBranchResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
366
|
+
#
|
367
|
+
# * {Types::CreateBranchResult#branch #branch} => Types::Branch
|
368
|
+
#
|
369
|
+
# @example Request syntax with placeholder values
|
370
|
+
#
|
371
|
+
# resp = client.create_branch({
|
372
|
+
# app_id: "AppId", # required
|
373
|
+
# branch_name: "BranchName", # required
|
374
|
+
# description: "Description",
|
375
|
+
# stage: "PRODUCTION", # accepts PRODUCTION, BETA, DEVELOPMENT, EXPERIMENTAL
|
376
|
+
# framework: "Framework",
|
377
|
+
# enable_notification: false,
|
378
|
+
# enable_auto_build: false,
|
379
|
+
# environment_variables: {
|
380
|
+
# "EnvKey" => "EnvValue",
|
381
|
+
# },
|
382
|
+
# basic_auth_credentials: "BasicAuthCredentials",
|
383
|
+
# enable_basic_auth: false,
|
384
|
+
# tags: {
|
385
|
+
# "TagKey" => "TagValue",
|
386
|
+
# },
|
387
|
+
# build_spec: "BuildSpec",
|
388
|
+
# ttl: "TTL",
|
389
|
+
# })
|
390
|
+
#
|
391
|
+
# @example Response structure
|
392
|
+
#
|
393
|
+
# resp.branch.branch_arn #=> String
|
394
|
+
# resp.branch.branch_name #=> String
|
395
|
+
# resp.branch.description #=> String
|
396
|
+
# resp.branch.tags #=> Hash
|
397
|
+
# resp.branch.tags["TagKey"] #=> String
|
398
|
+
# resp.branch.stage #=> String, one of "PRODUCTION", "BETA", "DEVELOPMENT", "EXPERIMENTAL"
|
399
|
+
# resp.branch.display_name #=> String
|
400
|
+
# resp.branch.enable_notification #=> Boolean
|
401
|
+
# resp.branch.create_time #=> Time
|
402
|
+
# resp.branch.update_time #=> Time
|
403
|
+
# resp.branch.environment_variables #=> Hash
|
404
|
+
# resp.branch.environment_variables["EnvKey"] #=> String
|
405
|
+
# resp.branch.enable_auto_build #=> Boolean
|
406
|
+
# resp.branch.custom_domains #=> Array
|
407
|
+
# resp.branch.custom_domains[0] #=> String
|
408
|
+
# resp.branch.framework #=> String
|
409
|
+
# resp.branch.active_job_id #=> String
|
410
|
+
# resp.branch.total_number_of_jobs #=> String
|
411
|
+
# resp.branch.enable_basic_auth #=> Boolean
|
412
|
+
# resp.branch.thumbnail_url #=> String
|
413
|
+
# resp.branch.basic_auth_credentials #=> String
|
414
|
+
# resp.branch.build_spec #=> String
|
415
|
+
# resp.branch.ttl #=> String
|
416
|
+
#
|
417
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/CreateBranch AWS API Documentation
|
418
|
+
#
|
419
|
+
# @overload create_branch(params = {})
|
420
|
+
# @param [Hash] params ({})
|
421
|
+
def create_branch(params = {}, options = {})
|
422
|
+
req = build_request(:create_branch, params)
|
423
|
+
req.send_request(options)
|
424
|
+
end
|
425
|
+
|
426
|
+
# Create a new DomainAssociation on an App
|
427
|
+
#
|
428
|
+
# @option params [required, String] :app_id
|
429
|
+
# Unique Id for an Amplify App.
|
430
|
+
#
|
431
|
+
# @option params [required, String] :domain_name
|
432
|
+
# Domain name for the Domain Association.
|
433
|
+
#
|
434
|
+
# @option params [Boolean] :enable_auto_sub_domain
|
435
|
+
# Enables automated creation of Subdomains for branches.
|
436
|
+
#
|
437
|
+
# @option params [required, Array<Types::SubDomainSetting>] :sub_domain_settings
|
438
|
+
# Setting structure for the Subdomain.
|
439
|
+
#
|
440
|
+
# @return [Types::CreateDomainAssociationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
441
|
+
#
|
442
|
+
# * {Types::CreateDomainAssociationResult#domain_association #domain_association} => Types::DomainAssociation
|
443
|
+
#
|
444
|
+
# @example Request syntax with placeholder values
|
445
|
+
#
|
446
|
+
# resp = client.create_domain_association({
|
447
|
+
# app_id: "AppId", # required
|
448
|
+
# domain_name: "DomainName", # required
|
449
|
+
# enable_auto_sub_domain: false,
|
450
|
+
# sub_domain_settings: [ # required
|
451
|
+
# {
|
452
|
+
# prefix: "DomainPrefix", # required
|
453
|
+
# branch_name: "BranchName", # required
|
454
|
+
# },
|
455
|
+
# ],
|
456
|
+
# })
|
457
|
+
#
|
458
|
+
# @example Response structure
|
459
|
+
#
|
460
|
+
# resp.domain_association.domain_association_arn #=> String
|
461
|
+
# resp.domain_association.domain_name #=> String
|
462
|
+
# resp.domain_association.enable_auto_sub_domain #=> Boolean
|
463
|
+
# resp.domain_association.domain_status #=> String, one of "PENDING_VERIFICATION", "IN_PROGRESS", "AVAILABLE", "PENDING_DEPLOYMENT", "FAILED"
|
464
|
+
# resp.domain_association.status_reason #=> String
|
465
|
+
# resp.domain_association.certificate_verification_dns_record #=> String
|
466
|
+
# resp.domain_association.sub_domains #=> Array
|
467
|
+
# resp.domain_association.sub_domains[0].sub_domain_setting.prefix #=> String
|
468
|
+
# resp.domain_association.sub_domains[0].sub_domain_setting.branch_name #=> String
|
469
|
+
# resp.domain_association.sub_domains[0].verified #=> Boolean
|
470
|
+
# resp.domain_association.sub_domains[0].dns_record #=> String
|
471
|
+
#
|
472
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/CreateDomainAssociation AWS API Documentation
|
473
|
+
#
|
474
|
+
# @overload create_domain_association(params = {})
|
475
|
+
# @param [Hash] params ({})
|
476
|
+
def create_domain_association(params = {}, options = {})
|
477
|
+
req = build_request(:create_domain_association, params)
|
478
|
+
req.send_request(options)
|
479
|
+
end
|
480
|
+
|
481
|
+
# Delete an existing Amplify App by appId.
|
482
|
+
#
|
483
|
+
# @option params [required, String] :app_id
|
484
|
+
# Unique Id for an Amplify App.
|
485
|
+
#
|
486
|
+
# @return [Types::DeleteAppResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
487
|
+
#
|
488
|
+
# * {Types::DeleteAppResult#app #app} => Types::App
|
489
|
+
#
|
490
|
+
# @example Request syntax with placeholder values
|
491
|
+
#
|
492
|
+
# resp = client.delete_app({
|
493
|
+
# app_id: "AppId", # required
|
494
|
+
# })
|
495
|
+
#
|
496
|
+
# @example Response structure
|
497
|
+
#
|
498
|
+
# resp.app.app_id #=> String
|
499
|
+
# resp.app.app_arn #=> String
|
500
|
+
# resp.app.name #=> String
|
501
|
+
# resp.app.tags #=> Hash
|
502
|
+
# resp.app.tags["TagKey"] #=> String
|
503
|
+
# resp.app.description #=> String
|
504
|
+
# resp.app.repository #=> String
|
505
|
+
# resp.app.platform #=> String, one of "IOS", "ANDROID", "WEB", "REACT_NATIVE"
|
506
|
+
# resp.app.create_time #=> Time
|
507
|
+
# resp.app.update_time #=> Time
|
508
|
+
# resp.app.iam_service_role_arn #=> String
|
509
|
+
# resp.app.environment_variables #=> Hash
|
510
|
+
# resp.app.environment_variables["EnvKey"] #=> String
|
511
|
+
# resp.app.default_domain #=> String
|
512
|
+
# resp.app.enable_branch_auto_build #=> Boolean
|
513
|
+
# resp.app.enable_basic_auth #=> Boolean
|
514
|
+
# resp.app.basic_auth_credentials #=> String
|
515
|
+
# resp.app.custom_rules #=> Array
|
516
|
+
# resp.app.custom_rules[0].source #=> String
|
517
|
+
# resp.app.custom_rules[0].target #=> String
|
518
|
+
# resp.app.custom_rules[0].status #=> String
|
519
|
+
# resp.app.custom_rules[0].condition #=> String
|
520
|
+
# resp.app.production_branch.last_deploy_time #=> Time
|
521
|
+
# resp.app.production_branch.status #=> String
|
522
|
+
# resp.app.production_branch.thumbnail_url #=> String
|
523
|
+
# resp.app.production_branch.branch_name #=> String
|
524
|
+
# resp.app.build_spec #=> String
|
525
|
+
#
|
526
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/DeleteApp AWS API Documentation
|
527
|
+
#
|
528
|
+
# @overload delete_app(params = {})
|
529
|
+
# @param [Hash] params ({})
|
530
|
+
def delete_app(params = {}, options = {})
|
531
|
+
req = build_request(:delete_app, params)
|
532
|
+
req.send_request(options)
|
533
|
+
end
|
534
|
+
|
535
|
+
# Deletes a branch for an Amplify App.
|
536
|
+
#
|
537
|
+
# @option params [required, String] :app_id
|
538
|
+
# Unique Id for an Amplify App.
|
539
|
+
#
|
540
|
+
# @option params [required, String] :branch_name
|
541
|
+
# Name for the branch.
|
542
|
+
#
|
543
|
+
# @return [Types::DeleteBranchResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
544
|
+
#
|
545
|
+
# * {Types::DeleteBranchResult#branch #branch} => Types::Branch
|
546
|
+
#
|
547
|
+
# @example Request syntax with placeholder values
|
548
|
+
#
|
549
|
+
# resp = client.delete_branch({
|
550
|
+
# app_id: "AppId", # required
|
551
|
+
# branch_name: "BranchName", # required
|
552
|
+
# })
|
553
|
+
#
|
554
|
+
# @example Response structure
|
555
|
+
#
|
556
|
+
# resp.branch.branch_arn #=> String
|
557
|
+
# resp.branch.branch_name #=> String
|
558
|
+
# resp.branch.description #=> String
|
559
|
+
# resp.branch.tags #=> Hash
|
560
|
+
# resp.branch.tags["TagKey"] #=> String
|
561
|
+
# resp.branch.stage #=> String, one of "PRODUCTION", "BETA", "DEVELOPMENT", "EXPERIMENTAL"
|
562
|
+
# resp.branch.display_name #=> String
|
563
|
+
# resp.branch.enable_notification #=> Boolean
|
564
|
+
# resp.branch.create_time #=> Time
|
565
|
+
# resp.branch.update_time #=> Time
|
566
|
+
# resp.branch.environment_variables #=> Hash
|
567
|
+
# resp.branch.environment_variables["EnvKey"] #=> String
|
568
|
+
# resp.branch.enable_auto_build #=> Boolean
|
569
|
+
# resp.branch.custom_domains #=> Array
|
570
|
+
# resp.branch.custom_domains[0] #=> String
|
571
|
+
# resp.branch.framework #=> String
|
572
|
+
# resp.branch.active_job_id #=> String
|
573
|
+
# resp.branch.total_number_of_jobs #=> String
|
574
|
+
# resp.branch.enable_basic_auth #=> Boolean
|
575
|
+
# resp.branch.thumbnail_url #=> String
|
576
|
+
# resp.branch.basic_auth_credentials #=> String
|
577
|
+
# resp.branch.build_spec #=> String
|
578
|
+
# resp.branch.ttl #=> String
|
579
|
+
#
|
580
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/DeleteBranch AWS API Documentation
|
581
|
+
#
|
582
|
+
# @overload delete_branch(params = {})
|
583
|
+
# @param [Hash] params ({})
|
584
|
+
def delete_branch(params = {}, options = {})
|
585
|
+
req = build_request(:delete_branch, params)
|
586
|
+
req.send_request(options)
|
587
|
+
end
|
588
|
+
|
589
|
+
# Deletes a DomainAssociation.
|
590
|
+
#
|
591
|
+
# @option params [required, String] :app_id
|
592
|
+
# Unique Id for an Amplify App.
|
593
|
+
#
|
594
|
+
# @option params [required, String] :domain_name
|
595
|
+
# Name of the domain.
|
596
|
+
#
|
597
|
+
# @return [Types::DeleteDomainAssociationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
598
|
+
#
|
599
|
+
# * {Types::DeleteDomainAssociationResult#domain_association #domain_association} => Types::DomainAssociation
|
600
|
+
#
|
601
|
+
# @example Request syntax with placeholder values
|
602
|
+
#
|
603
|
+
# resp = client.delete_domain_association({
|
604
|
+
# app_id: "AppId", # required
|
605
|
+
# domain_name: "DomainName", # required
|
606
|
+
# })
|
607
|
+
#
|
608
|
+
# @example Response structure
|
609
|
+
#
|
610
|
+
# resp.domain_association.domain_association_arn #=> String
|
611
|
+
# resp.domain_association.domain_name #=> String
|
612
|
+
# resp.domain_association.enable_auto_sub_domain #=> Boolean
|
613
|
+
# resp.domain_association.domain_status #=> String, one of "PENDING_VERIFICATION", "IN_PROGRESS", "AVAILABLE", "PENDING_DEPLOYMENT", "FAILED"
|
614
|
+
# resp.domain_association.status_reason #=> String
|
615
|
+
# resp.domain_association.certificate_verification_dns_record #=> String
|
616
|
+
# resp.domain_association.sub_domains #=> Array
|
617
|
+
# resp.domain_association.sub_domains[0].sub_domain_setting.prefix #=> String
|
618
|
+
# resp.domain_association.sub_domains[0].sub_domain_setting.branch_name #=> String
|
619
|
+
# resp.domain_association.sub_domains[0].verified #=> Boolean
|
620
|
+
# resp.domain_association.sub_domains[0].dns_record #=> String
|
621
|
+
#
|
622
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/DeleteDomainAssociation AWS API Documentation
|
623
|
+
#
|
624
|
+
# @overload delete_domain_association(params = {})
|
625
|
+
# @param [Hash] params ({})
|
626
|
+
def delete_domain_association(params = {}, options = {})
|
627
|
+
req = build_request(:delete_domain_association, params)
|
628
|
+
req.send_request(options)
|
629
|
+
end
|
630
|
+
|
631
|
+
# Delete a job, for an Amplify branch, part of Amplify App.
|
632
|
+
#
|
633
|
+
# @option params [required, String] :app_id
|
634
|
+
# Unique Id for an Amplify App.
|
635
|
+
#
|
636
|
+
# @option params [required, String] :branch_name
|
637
|
+
# Name for the branch, for the Job.
|
638
|
+
#
|
639
|
+
# @option params [required, String] :job_id
|
640
|
+
# Unique Id for the Job.
|
641
|
+
#
|
642
|
+
# @return [Types::DeleteJobResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
643
|
+
#
|
644
|
+
# * {Types::DeleteJobResult#job_summary #job_summary} => Types::JobSummary
|
645
|
+
#
|
646
|
+
# @example Request syntax with placeholder values
|
647
|
+
#
|
648
|
+
# resp = client.delete_job({
|
649
|
+
# app_id: "AppId", # required
|
650
|
+
# branch_name: "BranchName", # required
|
651
|
+
# job_id: "JobId", # required
|
652
|
+
# })
|
653
|
+
#
|
654
|
+
# @example Response structure
|
655
|
+
#
|
656
|
+
# resp.job_summary.job_arn #=> String
|
657
|
+
# resp.job_summary.job_id #=> String
|
658
|
+
# resp.job_summary.commit_id #=> String
|
659
|
+
# resp.job_summary.commit_message #=> String
|
660
|
+
# resp.job_summary.commit_time #=> Time
|
661
|
+
# resp.job_summary.start_time #=> Time
|
662
|
+
# resp.job_summary.status #=> String, one of "PENDING", "PROVISIONING", "RUNNING", "FAILED", "SUCCEED", "CANCELLING", "CANCELLED"
|
663
|
+
# resp.job_summary.end_time #=> Time
|
664
|
+
# resp.job_summary.job_type #=> String, one of "RELEASE", "RETRY", "WEB_HOOK"
|
665
|
+
#
|
666
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/DeleteJob AWS API Documentation
|
667
|
+
#
|
668
|
+
# @overload delete_job(params = {})
|
669
|
+
# @param [Hash] params ({})
|
670
|
+
def delete_job(params = {}, options = {})
|
671
|
+
req = build_request(:delete_job, params)
|
672
|
+
req.send_request(options)
|
673
|
+
end
|
674
|
+
|
675
|
+
# Retrieves an existing Amplify App by appId.
|
676
|
+
#
|
677
|
+
# @option params [required, String] :app_id
|
678
|
+
# Unique Id for an Amplify App.
|
679
|
+
#
|
680
|
+
# @return [Types::GetAppResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
681
|
+
#
|
682
|
+
# * {Types::GetAppResult#app #app} => Types::App
|
683
|
+
#
|
684
|
+
# @example Request syntax with placeholder values
|
685
|
+
#
|
686
|
+
# resp = client.get_app({
|
687
|
+
# app_id: "AppId", # required
|
688
|
+
# })
|
689
|
+
#
|
690
|
+
# @example Response structure
|
691
|
+
#
|
692
|
+
# resp.app.app_id #=> String
|
693
|
+
# resp.app.app_arn #=> String
|
694
|
+
# resp.app.name #=> String
|
695
|
+
# resp.app.tags #=> Hash
|
696
|
+
# resp.app.tags["TagKey"] #=> String
|
697
|
+
# resp.app.description #=> String
|
698
|
+
# resp.app.repository #=> String
|
699
|
+
# resp.app.platform #=> String, one of "IOS", "ANDROID", "WEB", "REACT_NATIVE"
|
700
|
+
# resp.app.create_time #=> Time
|
701
|
+
# resp.app.update_time #=> Time
|
702
|
+
# resp.app.iam_service_role_arn #=> String
|
703
|
+
# resp.app.environment_variables #=> Hash
|
704
|
+
# resp.app.environment_variables["EnvKey"] #=> String
|
705
|
+
# resp.app.default_domain #=> String
|
706
|
+
# resp.app.enable_branch_auto_build #=> Boolean
|
707
|
+
# resp.app.enable_basic_auth #=> Boolean
|
708
|
+
# resp.app.basic_auth_credentials #=> String
|
709
|
+
# resp.app.custom_rules #=> Array
|
710
|
+
# resp.app.custom_rules[0].source #=> String
|
711
|
+
# resp.app.custom_rules[0].target #=> String
|
712
|
+
# resp.app.custom_rules[0].status #=> String
|
713
|
+
# resp.app.custom_rules[0].condition #=> String
|
714
|
+
# resp.app.production_branch.last_deploy_time #=> Time
|
715
|
+
# resp.app.production_branch.status #=> String
|
716
|
+
# resp.app.production_branch.thumbnail_url #=> String
|
717
|
+
# resp.app.production_branch.branch_name #=> String
|
718
|
+
# resp.app.build_spec #=> String
|
719
|
+
#
|
720
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GetApp AWS API Documentation
|
721
|
+
#
|
722
|
+
# @overload get_app(params = {})
|
723
|
+
# @param [Hash] params ({})
|
724
|
+
def get_app(params = {}, options = {})
|
725
|
+
req = build_request(:get_app, params)
|
726
|
+
req.send_request(options)
|
727
|
+
end
|
728
|
+
|
729
|
+
# Retrieves a branch for an Amplify App.
|
730
|
+
#
|
731
|
+
# @option params [required, String] :app_id
|
732
|
+
# Unique Id for an Amplify App.
|
733
|
+
#
|
734
|
+
# @option params [required, String] :branch_name
|
735
|
+
# Name for the branch.
|
736
|
+
#
|
737
|
+
# @return [Types::GetBranchResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
738
|
+
#
|
739
|
+
# * {Types::GetBranchResult#branch #branch} => Types::Branch
|
740
|
+
#
|
741
|
+
# @example Request syntax with placeholder values
|
742
|
+
#
|
743
|
+
# resp = client.get_branch({
|
744
|
+
# app_id: "AppId", # required
|
745
|
+
# branch_name: "BranchName", # required
|
746
|
+
# })
|
747
|
+
#
|
748
|
+
# @example Response structure
|
749
|
+
#
|
750
|
+
# resp.branch.branch_arn #=> String
|
751
|
+
# resp.branch.branch_name #=> String
|
752
|
+
# resp.branch.description #=> String
|
753
|
+
# resp.branch.tags #=> Hash
|
754
|
+
# resp.branch.tags["TagKey"] #=> String
|
755
|
+
# resp.branch.stage #=> String, one of "PRODUCTION", "BETA", "DEVELOPMENT", "EXPERIMENTAL"
|
756
|
+
# resp.branch.display_name #=> String
|
757
|
+
# resp.branch.enable_notification #=> Boolean
|
758
|
+
# resp.branch.create_time #=> Time
|
759
|
+
# resp.branch.update_time #=> Time
|
760
|
+
# resp.branch.environment_variables #=> Hash
|
761
|
+
# resp.branch.environment_variables["EnvKey"] #=> String
|
762
|
+
# resp.branch.enable_auto_build #=> Boolean
|
763
|
+
# resp.branch.custom_domains #=> Array
|
764
|
+
# resp.branch.custom_domains[0] #=> String
|
765
|
+
# resp.branch.framework #=> String
|
766
|
+
# resp.branch.active_job_id #=> String
|
767
|
+
# resp.branch.total_number_of_jobs #=> String
|
768
|
+
# resp.branch.enable_basic_auth #=> Boolean
|
769
|
+
# resp.branch.thumbnail_url #=> String
|
770
|
+
# resp.branch.basic_auth_credentials #=> String
|
771
|
+
# resp.branch.build_spec #=> String
|
772
|
+
# resp.branch.ttl #=> String
|
773
|
+
#
|
774
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GetBranch AWS API Documentation
|
775
|
+
#
|
776
|
+
# @overload get_branch(params = {})
|
777
|
+
# @param [Hash] params ({})
|
778
|
+
def get_branch(params = {}, options = {})
|
779
|
+
req = build_request(:get_branch, params)
|
780
|
+
req.send_request(options)
|
781
|
+
end
|
782
|
+
|
783
|
+
# Retrieves domain info that corresponds to an appId and domainName.
|
784
|
+
#
|
785
|
+
# @option params [required, String] :app_id
|
786
|
+
# Unique Id for an Amplify App.
|
787
|
+
#
|
788
|
+
# @option params [required, String] :domain_name
|
789
|
+
# Name of the domain.
|
790
|
+
#
|
791
|
+
# @return [Types::GetDomainAssociationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
792
|
+
#
|
793
|
+
# * {Types::GetDomainAssociationResult#domain_association #domain_association} => Types::DomainAssociation
|
794
|
+
#
|
795
|
+
# @example Request syntax with placeholder values
|
796
|
+
#
|
797
|
+
# resp = client.get_domain_association({
|
798
|
+
# app_id: "AppId", # required
|
799
|
+
# domain_name: "DomainName", # required
|
800
|
+
# })
|
801
|
+
#
|
802
|
+
# @example Response structure
|
803
|
+
#
|
804
|
+
# resp.domain_association.domain_association_arn #=> String
|
805
|
+
# resp.domain_association.domain_name #=> String
|
806
|
+
# resp.domain_association.enable_auto_sub_domain #=> Boolean
|
807
|
+
# resp.domain_association.domain_status #=> String, one of "PENDING_VERIFICATION", "IN_PROGRESS", "AVAILABLE", "PENDING_DEPLOYMENT", "FAILED"
|
808
|
+
# resp.domain_association.status_reason #=> String
|
809
|
+
# resp.domain_association.certificate_verification_dns_record #=> String
|
810
|
+
# resp.domain_association.sub_domains #=> Array
|
811
|
+
# resp.domain_association.sub_domains[0].sub_domain_setting.prefix #=> String
|
812
|
+
# resp.domain_association.sub_domains[0].sub_domain_setting.branch_name #=> String
|
813
|
+
# resp.domain_association.sub_domains[0].verified #=> Boolean
|
814
|
+
# resp.domain_association.sub_domains[0].dns_record #=> String
|
815
|
+
#
|
816
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GetDomainAssociation AWS API Documentation
|
817
|
+
#
|
818
|
+
# @overload get_domain_association(params = {})
|
819
|
+
# @param [Hash] params ({})
|
820
|
+
def get_domain_association(params = {}, options = {})
|
821
|
+
req = build_request(:get_domain_association, params)
|
822
|
+
req.send_request(options)
|
823
|
+
end
|
824
|
+
|
825
|
+
# Get a job for a branch, part of an Amplify App.
|
826
|
+
#
|
827
|
+
# @option params [required, String] :app_id
|
828
|
+
# Unique Id for an Amplify App.
|
829
|
+
#
|
830
|
+
# @option params [required, String] :branch_name
|
831
|
+
# Name for the branch, for the Job.
|
832
|
+
#
|
833
|
+
# @option params [required, String] :job_id
|
834
|
+
# Unique Id for the Job.
|
835
|
+
#
|
836
|
+
# @return [Types::GetJobResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
837
|
+
#
|
838
|
+
# * {Types::GetJobResult#job #job} => Types::Job
|
839
|
+
#
|
840
|
+
# @example Request syntax with placeholder values
|
841
|
+
#
|
842
|
+
# resp = client.get_job({
|
843
|
+
# app_id: "AppId", # required
|
844
|
+
# branch_name: "BranchName", # required
|
845
|
+
# job_id: "JobId", # required
|
846
|
+
# })
|
847
|
+
#
|
848
|
+
# @example Response structure
|
849
|
+
#
|
850
|
+
# resp.job.summary.job_arn #=> String
|
851
|
+
# resp.job.summary.job_id #=> String
|
852
|
+
# resp.job.summary.commit_id #=> String
|
853
|
+
# resp.job.summary.commit_message #=> String
|
854
|
+
# resp.job.summary.commit_time #=> Time
|
855
|
+
# resp.job.summary.start_time #=> Time
|
856
|
+
# resp.job.summary.status #=> String, one of "PENDING", "PROVISIONING", "RUNNING", "FAILED", "SUCCEED", "CANCELLING", "CANCELLED"
|
857
|
+
# resp.job.summary.end_time #=> Time
|
858
|
+
# resp.job.summary.job_type #=> String, one of "RELEASE", "RETRY", "WEB_HOOK"
|
859
|
+
# resp.job.steps #=> Array
|
860
|
+
# resp.job.steps[0].step_name #=> String
|
861
|
+
# resp.job.steps[0].start_time #=> Time
|
862
|
+
# resp.job.steps[0].status #=> String, one of "PENDING", "PROVISIONING", "RUNNING", "FAILED", "SUCCEED", "CANCELLING", "CANCELLED"
|
863
|
+
# resp.job.steps[0].end_time #=> Time
|
864
|
+
# resp.job.steps[0].log_url #=> String
|
865
|
+
# resp.job.steps[0].artifacts_url #=> String
|
866
|
+
# resp.job.steps[0].screenshots #=> Hash
|
867
|
+
# resp.job.steps[0].screenshots["ThumbnailName"] #=> String
|
868
|
+
#
|
869
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/GetJob AWS API Documentation
|
870
|
+
#
|
871
|
+
# @overload get_job(params = {})
|
872
|
+
# @param [Hash] params ({})
|
873
|
+
def get_job(params = {}, options = {})
|
874
|
+
req = build_request(:get_job, params)
|
875
|
+
req.send_request(options)
|
876
|
+
end
|
877
|
+
|
878
|
+
# Lists existing Amplify Apps.
|
879
|
+
#
|
880
|
+
# @option params [String] :next_token
|
881
|
+
# Pagination token. If non-null pagination token is returned in a
|
882
|
+
# result, then pass its value in another request to fetch more entries.
|
883
|
+
#
|
884
|
+
# @option params [Integer] :max_results
|
885
|
+
# Maximum number of records to list in a single response.
|
886
|
+
#
|
887
|
+
# @return [Types::ListAppsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
888
|
+
#
|
889
|
+
# * {Types::ListAppsResult#apps #apps} => Array<Types::App>
|
890
|
+
# * {Types::ListAppsResult#next_token #next_token} => String
|
891
|
+
#
|
892
|
+
# @example Request syntax with placeholder values
|
893
|
+
#
|
894
|
+
# resp = client.list_apps({
|
895
|
+
# next_token: "NextToken",
|
896
|
+
# max_results: 1,
|
897
|
+
# })
|
898
|
+
#
|
899
|
+
# @example Response structure
|
900
|
+
#
|
901
|
+
# resp.apps #=> Array
|
902
|
+
# resp.apps[0].app_id #=> String
|
903
|
+
# resp.apps[0].app_arn #=> String
|
904
|
+
# resp.apps[0].name #=> String
|
905
|
+
# resp.apps[0].tags #=> Hash
|
906
|
+
# resp.apps[0].tags["TagKey"] #=> String
|
907
|
+
# resp.apps[0].description #=> String
|
908
|
+
# resp.apps[0].repository #=> String
|
909
|
+
# resp.apps[0].platform #=> String, one of "IOS", "ANDROID", "WEB", "REACT_NATIVE"
|
910
|
+
# resp.apps[0].create_time #=> Time
|
911
|
+
# resp.apps[0].update_time #=> Time
|
912
|
+
# resp.apps[0].iam_service_role_arn #=> String
|
913
|
+
# resp.apps[0].environment_variables #=> Hash
|
914
|
+
# resp.apps[0].environment_variables["EnvKey"] #=> String
|
915
|
+
# resp.apps[0].default_domain #=> String
|
916
|
+
# resp.apps[0].enable_branch_auto_build #=> Boolean
|
917
|
+
# resp.apps[0].enable_basic_auth #=> Boolean
|
918
|
+
# resp.apps[0].basic_auth_credentials #=> String
|
919
|
+
# resp.apps[0].custom_rules #=> Array
|
920
|
+
# resp.apps[0].custom_rules[0].source #=> String
|
921
|
+
# resp.apps[0].custom_rules[0].target #=> String
|
922
|
+
# resp.apps[0].custom_rules[0].status #=> String
|
923
|
+
# resp.apps[0].custom_rules[0].condition #=> String
|
924
|
+
# resp.apps[0].production_branch.last_deploy_time #=> Time
|
925
|
+
# resp.apps[0].production_branch.status #=> String
|
926
|
+
# resp.apps[0].production_branch.thumbnail_url #=> String
|
927
|
+
# resp.apps[0].production_branch.branch_name #=> String
|
928
|
+
# resp.apps[0].build_spec #=> String
|
929
|
+
# resp.next_token #=> String
|
930
|
+
#
|
931
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListApps AWS API Documentation
|
932
|
+
#
|
933
|
+
# @overload list_apps(params = {})
|
934
|
+
# @param [Hash] params ({})
|
935
|
+
def list_apps(params = {}, options = {})
|
936
|
+
req = build_request(:list_apps, params)
|
937
|
+
req.send_request(options)
|
938
|
+
end
|
939
|
+
|
940
|
+
# Lists branches for an Amplify App.
|
941
|
+
#
|
942
|
+
# @option params [required, String] :app_id
|
943
|
+
# Unique Id for an Amplify App.
|
944
|
+
#
|
945
|
+
# @option params [String] :next_token
|
946
|
+
# Pagination token. Set to null to start listing branches from start. If
|
947
|
+
# a non-null pagination token is returned in a result, then pass its
|
948
|
+
# value in here to list more branches.
|
949
|
+
#
|
950
|
+
# @option params [Integer] :max_results
|
951
|
+
# Maximum number of records to list in a single response.
|
952
|
+
#
|
953
|
+
# @return [Types::ListBranchesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
954
|
+
#
|
955
|
+
# * {Types::ListBranchesResult#branches #branches} => Array<Types::Branch>
|
956
|
+
# * {Types::ListBranchesResult#next_token #next_token} => String
|
957
|
+
#
|
958
|
+
# @example Request syntax with placeholder values
|
959
|
+
#
|
960
|
+
# resp = client.list_branches({
|
961
|
+
# app_id: "AppId", # required
|
962
|
+
# next_token: "NextToken",
|
963
|
+
# max_results: 1,
|
964
|
+
# })
|
965
|
+
#
|
966
|
+
# @example Response structure
|
967
|
+
#
|
968
|
+
# resp.branches #=> Array
|
969
|
+
# resp.branches[0].branch_arn #=> String
|
970
|
+
# resp.branches[0].branch_name #=> String
|
971
|
+
# resp.branches[0].description #=> String
|
972
|
+
# resp.branches[0].tags #=> Hash
|
973
|
+
# resp.branches[0].tags["TagKey"] #=> String
|
974
|
+
# resp.branches[0].stage #=> String, one of "PRODUCTION", "BETA", "DEVELOPMENT", "EXPERIMENTAL"
|
975
|
+
# resp.branches[0].display_name #=> String
|
976
|
+
# resp.branches[0].enable_notification #=> Boolean
|
977
|
+
# resp.branches[0].create_time #=> Time
|
978
|
+
# resp.branches[0].update_time #=> Time
|
979
|
+
# resp.branches[0].environment_variables #=> Hash
|
980
|
+
# resp.branches[0].environment_variables["EnvKey"] #=> String
|
981
|
+
# resp.branches[0].enable_auto_build #=> Boolean
|
982
|
+
# resp.branches[0].custom_domains #=> Array
|
983
|
+
# resp.branches[0].custom_domains[0] #=> String
|
984
|
+
# resp.branches[0].framework #=> String
|
985
|
+
# resp.branches[0].active_job_id #=> String
|
986
|
+
# resp.branches[0].total_number_of_jobs #=> String
|
987
|
+
# resp.branches[0].enable_basic_auth #=> Boolean
|
988
|
+
# resp.branches[0].thumbnail_url #=> String
|
989
|
+
# resp.branches[0].basic_auth_credentials #=> String
|
990
|
+
# resp.branches[0].build_spec #=> String
|
991
|
+
# resp.branches[0].ttl #=> String
|
992
|
+
# resp.next_token #=> String
|
993
|
+
#
|
994
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListBranches AWS API Documentation
|
995
|
+
#
|
996
|
+
# @overload list_branches(params = {})
|
997
|
+
# @param [Hash] params ({})
|
998
|
+
def list_branches(params = {}, options = {})
|
999
|
+
req = build_request(:list_branches, params)
|
1000
|
+
req.send_request(options)
|
1001
|
+
end
|
1002
|
+
|
1003
|
+
# List domains with an app
|
1004
|
+
#
|
1005
|
+
# @option params [required, String] :app_id
|
1006
|
+
# Unique Id for an Amplify App.
|
1007
|
+
#
|
1008
|
+
# @option params [String] :next_token
|
1009
|
+
# Pagination token. Set to null to start listing Apps from start. If
|
1010
|
+
# non-null pagination token is returned in a result, then pass its value
|
1011
|
+
# in here to list more projects.
|
1012
|
+
#
|
1013
|
+
# @option params [Integer] :max_results
|
1014
|
+
# Maximum number of records to list in a single response.
|
1015
|
+
#
|
1016
|
+
# @return [Types::ListDomainAssociationsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1017
|
+
#
|
1018
|
+
# * {Types::ListDomainAssociationsResult#domain_associations #domain_associations} => Array<Types::DomainAssociation>
|
1019
|
+
# * {Types::ListDomainAssociationsResult#next_token #next_token} => String
|
1020
|
+
#
|
1021
|
+
# @example Request syntax with placeholder values
|
1022
|
+
#
|
1023
|
+
# resp = client.list_domain_associations({
|
1024
|
+
# app_id: "AppId", # required
|
1025
|
+
# next_token: "NextToken",
|
1026
|
+
# max_results: 1,
|
1027
|
+
# })
|
1028
|
+
#
|
1029
|
+
# @example Response structure
|
1030
|
+
#
|
1031
|
+
# resp.domain_associations #=> Array
|
1032
|
+
# resp.domain_associations[0].domain_association_arn #=> String
|
1033
|
+
# resp.domain_associations[0].domain_name #=> String
|
1034
|
+
# resp.domain_associations[0].enable_auto_sub_domain #=> Boolean
|
1035
|
+
# resp.domain_associations[0].domain_status #=> String, one of "PENDING_VERIFICATION", "IN_PROGRESS", "AVAILABLE", "PENDING_DEPLOYMENT", "FAILED"
|
1036
|
+
# resp.domain_associations[0].status_reason #=> String
|
1037
|
+
# resp.domain_associations[0].certificate_verification_dns_record #=> String
|
1038
|
+
# resp.domain_associations[0].sub_domains #=> Array
|
1039
|
+
# resp.domain_associations[0].sub_domains[0].sub_domain_setting.prefix #=> String
|
1040
|
+
# resp.domain_associations[0].sub_domains[0].sub_domain_setting.branch_name #=> String
|
1041
|
+
# resp.domain_associations[0].sub_domains[0].verified #=> Boolean
|
1042
|
+
# resp.domain_associations[0].sub_domains[0].dns_record #=> String
|
1043
|
+
# resp.next_token #=> String
|
1044
|
+
#
|
1045
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListDomainAssociations AWS API Documentation
|
1046
|
+
#
|
1047
|
+
# @overload list_domain_associations(params = {})
|
1048
|
+
# @param [Hash] params ({})
|
1049
|
+
def list_domain_associations(params = {}, options = {})
|
1050
|
+
req = build_request(:list_domain_associations, params)
|
1051
|
+
req.send_request(options)
|
1052
|
+
end
|
1053
|
+
|
1054
|
+
# List Jobs for a branch, part of an Amplify App.
|
1055
|
+
#
|
1056
|
+
# @option params [required, String] :app_id
|
1057
|
+
# Unique Id for an Amplify App.
|
1058
|
+
#
|
1059
|
+
# @option params [required, String] :branch_name
|
1060
|
+
# Name for a branch.
|
1061
|
+
#
|
1062
|
+
# @option params [String] :next_token
|
1063
|
+
# Pagination token. Set to null to start listing steps from start. If a
|
1064
|
+
# non-null pagination token is returned in a result, then pass its value
|
1065
|
+
# in here to list more steps.
|
1066
|
+
#
|
1067
|
+
# @option params [Integer] :max_results
|
1068
|
+
# Maximum number of records to list in a single response.
|
1069
|
+
#
|
1070
|
+
# @return [Types::ListJobsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1071
|
+
#
|
1072
|
+
# * {Types::ListJobsResult#job_summaries #job_summaries} => Array<Types::JobSummary>
|
1073
|
+
# * {Types::ListJobsResult#next_token #next_token} => String
|
1074
|
+
#
|
1075
|
+
# @example Request syntax with placeholder values
|
1076
|
+
#
|
1077
|
+
# resp = client.list_jobs({
|
1078
|
+
# app_id: "AppId", # required
|
1079
|
+
# branch_name: "BranchName", # required
|
1080
|
+
# next_token: "NextToken",
|
1081
|
+
# max_results: 1,
|
1082
|
+
# })
|
1083
|
+
#
|
1084
|
+
# @example Response structure
|
1085
|
+
#
|
1086
|
+
# resp.job_summaries #=> Array
|
1087
|
+
# resp.job_summaries[0].job_arn #=> String
|
1088
|
+
# resp.job_summaries[0].job_id #=> String
|
1089
|
+
# resp.job_summaries[0].commit_id #=> String
|
1090
|
+
# resp.job_summaries[0].commit_message #=> String
|
1091
|
+
# resp.job_summaries[0].commit_time #=> Time
|
1092
|
+
# resp.job_summaries[0].start_time #=> Time
|
1093
|
+
# resp.job_summaries[0].status #=> String, one of "PENDING", "PROVISIONING", "RUNNING", "FAILED", "SUCCEED", "CANCELLING", "CANCELLED"
|
1094
|
+
# resp.job_summaries[0].end_time #=> Time
|
1095
|
+
# resp.job_summaries[0].job_type #=> String, one of "RELEASE", "RETRY", "WEB_HOOK"
|
1096
|
+
# resp.next_token #=> String
|
1097
|
+
#
|
1098
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/ListJobs AWS API Documentation
|
1099
|
+
#
|
1100
|
+
# @overload list_jobs(params = {})
|
1101
|
+
# @param [Hash] params ({})
|
1102
|
+
def list_jobs(params = {}, options = {})
|
1103
|
+
req = build_request(:list_jobs, params)
|
1104
|
+
req.send_request(options)
|
1105
|
+
end
|
1106
|
+
|
1107
|
+
# Starts a new job for a branch, part of an Amplify App.
|
1108
|
+
#
|
1109
|
+
# @option params [required, String] :app_id
|
1110
|
+
# Unique Id for an Amplify App.
|
1111
|
+
#
|
1112
|
+
# @option params [required, String] :branch_name
|
1113
|
+
# Name for the branch, for the Job.
|
1114
|
+
#
|
1115
|
+
# @option params [String] :job_id
|
1116
|
+
# Unique Id for the Job.
|
1117
|
+
#
|
1118
|
+
# @option params [required, String] :job_type
|
1119
|
+
# Type for the Job.
|
1120
|
+
#
|
1121
|
+
# @option params [String] :job_reason
|
1122
|
+
# Reason for the Job.
|
1123
|
+
#
|
1124
|
+
# @option params [String] :commit_id
|
1125
|
+
# Commit Id from 3rd party repository provider for the Job.
|
1126
|
+
#
|
1127
|
+
# @option params [String] :commit_message
|
1128
|
+
# Commit message from 3rd party repository provider for the Job.
|
1129
|
+
#
|
1130
|
+
# @option params [Time,DateTime,Date,Integer,String] :commit_time
|
1131
|
+
# Commit date / time for the Job.
|
1132
|
+
#
|
1133
|
+
# @return [Types::StartJobResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1134
|
+
#
|
1135
|
+
# * {Types::StartJobResult#job_summary #job_summary} => Types::JobSummary
|
1136
|
+
#
|
1137
|
+
# @example Request syntax with placeholder values
|
1138
|
+
#
|
1139
|
+
# resp = client.start_job({
|
1140
|
+
# app_id: "AppId", # required
|
1141
|
+
# branch_name: "BranchName", # required
|
1142
|
+
# job_id: "JobId",
|
1143
|
+
# job_type: "RELEASE", # required, accepts RELEASE, RETRY, WEB_HOOK
|
1144
|
+
# job_reason: "JobReason",
|
1145
|
+
# commit_id: "CommitId",
|
1146
|
+
# commit_message: "CommitMessage",
|
1147
|
+
# commit_time: Time.now,
|
1148
|
+
# })
|
1149
|
+
#
|
1150
|
+
# @example Response structure
|
1151
|
+
#
|
1152
|
+
# resp.job_summary.job_arn #=> String
|
1153
|
+
# resp.job_summary.job_id #=> String
|
1154
|
+
# resp.job_summary.commit_id #=> String
|
1155
|
+
# resp.job_summary.commit_message #=> String
|
1156
|
+
# resp.job_summary.commit_time #=> Time
|
1157
|
+
# resp.job_summary.start_time #=> Time
|
1158
|
+
# resp.job_summary.status #=> String, one of "PENDING", "PROVISIONING", "RUNNING", "FAILED", "SUCCEED", "CANCELLING", "CANCELLED"
|
1159
|
+
# resp.job_summary.end_time #=> Time
|
1160
|
+
# resp.job_summary.job_type #=> String, one of "RELEASE", "RETRY", "WEB_HOOK"
|
1161
|
+
#
|
1162
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/StartJob AWS API Documentation
|
1163
|
+
#
|
1164
|
+
# @overload start_job(params = {})
|
1165
|
+
# @param [Hash] params ({})
|
1166
|
+
def start_job(params = {}, options = {})
|
1167
|
+
req = build_request(:start_job, params)
|
1168
|
+
req.send_request(options)
|
1169
|
+
end
|
1170
|
+
|
1171
|
+
# Stop a job that is in progress, for an Amplify branch, part of Amplify
|
1172
|
+
# App.
|
1173
|
+
#
|
1174
|
+
# @option params [required, String] :app_id
|
1175
|
+
# Unique Id for an Amplify App.
|
1176
|
+
#
|
1177
|
+
# @option params [required, String] :branch_name
|
1178
|
+
# Name for the branch, for the Job.
|
1179
|
+
#
|
1180
|
+
# @option params [required, String] :job_id
|
1181
|
+
# Unique Id for the Job.
|
1182
|
+
#
|
1183
|
+
# @return [Types::StopJobResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1184
|
+
#
|
1185
|
+
# * {Types::StopJobResult#job_summary #job_summary} => Types::JobSummary
|
1186
|
+
#
|
1187
|
+
# @example Request syntax with placeholder values
|
1188
|
+
#
|
1189
|
+
# resp = client.stop_job({
|
1190
|
+
# app_id: "AppId", # required
|
1191
|
+
# branch_name: "BranchName", # required
|
1192
|
+
# job_id: "JobId", # required
|
1193
|
+
# })
|
1194
|
+
#
|
1195
|
+
# @example Response structure
|
1196
|
+
#
|
1197
|
+
# resp.job_summary.job_arn #=> String
|
1198
|
+
# resp.job_summary.job_id #=> String
|
1199
|
+
# resp.job_summary.commit_id #=> String
|
1200
|
+
# resp.job_summary.commit_message #=> String
|
1201
|
+
# resp.job_summary.commit_time #=> Time
|
1202
|
+
# resp.job_summary.start_time #=> Time
|
1203
|
+
# resp.job_summary.status #=> String, one of "PENDING", "PROVISIONING", "RUNNING", "FAILED", "SUCCEED", "CANCELLING", "CANCELLED"
|
1204
|
+
# resp.job_summary.end_time #=> Time
|
1205
|
+
# resp.job_summary.job_type #=> String, one of "RELEASE", "RETRY", "WEB_HOOK"
|
1206
|
+
#
|
1207
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/StopJob AWS API Documentation
|
1208
|
+
#
|
1209
|
+
# @overload stop_job(params = {})
|
1210
|
+
# @param [Hash] params ({})
|
1211
|
+
def stop_job(params = {}, options = {})
|
1212
|
+
req = build_request(:stop_job, params)
|
1213
|
+
req.send_request(options)
|
1214
|
+
end
|
1215
|
+
|
1216
|
+
# Updates an existing Amplify App.
|
1217
|
+
#
|
1218
|
+
# @option params [required, String] :app_id
|
1219
|
+
# Unique Id for an Amplify App.
|
1220
|
+
#
|
1221
|
+
# @option params [String] :name
|
1222
|
+
# Name for an Amplify App.
|
1223
|
+
#
|
1224
|
+
# @option params [String] :description
|
1225
|
+
# Description for an Amplify App.
|
1226
|
+
#
|
1227
|
+
# @option params [String] :platform
|
1228
|
+
# Platform for an Amplify App.
|
1229
|
+
#
|
1230
|
+
# @option params [String] :iam_service_role_arn
|
1231
|
+
# IAM service role for an Amplify App.
|
1232
|
+
#
|
1233
|
+
# @option params [Hash<String,String>] :environment_variables
|
1234
|
+
# Environment Variables for an Amplify App.
|
1235
|
+
#
|
1236
|
+
# @option params [Boolean] :enable_branch_auto_build
|
1237
|
+
# Enables branch auto-building for an Amplify App.
|
1238
|
+
#
|
1239
|
+
# @option params [Boolean] :enable_basic_auth
|
1240
|
+
# Enables Basic Authorization for an Amplify App.
|
1241
|
+
#
|
1242
|
+
# @option params [String] :basic_auth_credentials
|
1243
|
+
# Basic Authorization credentials for an Amplify App.
|
1244
|
+
#
|
1245
|
+
# @option params [Array<Types::CustomRule>] :custom_rules
|
1246
|
+
# Custom redirect / rewrite rules for an Amplify App.
|
1247
|
+
#
|
1248
|
+
# @option params [String] :build_spec
|
1249
|
+
# BuildSpec for an Amplify App.
|
1250
|
+
#
|
1251
|
+
# @return [Types::UpdateAppResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1252
|
+
#
|
1253
|
+
# * {Types::UpdateAppResult#app #app} => Types::App
|
1254
|
+
#
|
1255
|
+
# @example Request syntax with placeholder values
|
1256
|
+
#
|
1257
|
+
# resp = client.update_app({
|
1258
|
+
# app_id: "AppId", # required
|
1259
|
+
# name: "Name",
|
1260
|
+
# description: "Description",
|
1261
|
+
# platform: "IOS", # accepts IOS, ANDROID, WEB, REACT_NATIVE
|
1262
|
+
# iam_service_role_arn: "ServiceRoleArn",
|
1263
|
+
# environment_variables: {
|
1264
|
+
# "EnvKey" => "EnvValue",
|
1265
|
+
# },
|
1266
|
+
# enable_branch_auto_build: false,
|
1267
|
+
# enable_basic_auth: false,
|
1268
|
+
# basic_auth_credentials: "BasicAuthCredentials",
|
1269
|
+
# custom_rules: [
|
1270
|
+
# {
|
1271
|
+
# source: "Source", # required
|
1272
|
+
# target: "Target", # required
|
1273
|
+
# status: "Status",
|
1274
|
+
# condition: "Condition",
|
1275
|
+
# },
|
1276
|
+
# ],
|
1277
|
+
# build_spec: "BuildSpec",
|
1278
|
+
# })
|
1279
|
+
#
|
1280
|
+
# @example Response structure
|
1281
|
+
#
|
1282
|
+
# resp.app.app_id #=> String
|
1283
|
+
# resp.app.app_arn #=> String
|
1284
|
+
# resp.app.name #=> String
|
1285
|
+
# resp.app.tags #=> Hash
|
1286
|
+
# resp.app.tags["TagKey"] #=> String
|
1287
|
+
# resp.app.description #=> String
|
1288
|
+
# resp.app.repository #=> String
|
1289
|
+
# resp.app.platform #=> String, one of "IOS", "ANDROID", "WEB", "REACT_NATIVE"
|
1290
|
+
# resp.app.create_time #=> Time
|
1291
|
+
# resp.app.update_time #=> Time
|
1292
|
+
# resp.app.iam_service_role_arn #=> String
|
1293
|
+
# resp.app.environment_variables #=> Hash
|
1294
|
+
# resp.app.environment_variables["EnvKey"] #=> String
|
1295
|
+
# resp.app.default_domain #=> String
|
1296
|
+
# resp.app.enable_branch_auto_build #=> Boolean
|
1297
|
+
# resp.app.enable_basic_auth #=> Boolean
|
1298
|
+
# resp.app.basic_auth_credentials #=> String
|
1299
|
+
# resp.app.custom_rules #=> Array
|
1300
|
+
# resp.app.custom_rules[0].source #=> String
|
1301
|
+
# resp.app.custom_rules[0].target #=> String
|
1302
|
+
# resp.app.custom_rules[0].status #=> String
|
1303
|
+
# resp.app.custom_rules[0].condition #=> String
|
1304
|
+
# resp.app.production_branch.last_deploy_time #=> Time
|
1305
|
+
# resp.app.production_branch.status #=> String
|
1306
|
+
# resp.app.production_branch.thumbnail_url #=> String
|
1307
|
+
# resp.app.production_branch.branch_name #=> String
|
1308
|
+
# resp.app.build_spec #=> String
|
1309
|
+
#
|
1310
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/UpdateApp AWS API Documentation
|
1311
|
+
#
|
1312
|
+
# @overload update_app(params = {})
|
1313
|
+
# @param [Hash] params ({})
|
1314
|
+
def update_app(params = {}, options = {})
|
1315
|
+
req = build_request(:update_app, params)
|
1316
|
+
req.send_request(options)
|
1317
|
+
end
|
1318
|
+
|
1319
|
+
# Updates a branch for an Amplify App.
|
1320
|
+
#
|
1321
|
+
# @option params [required, String] :app_id
|
1322
|
+
# Unique Id for an Amplify App.
|
1323
|
+
#
|
1324
|
+
# @option params [required, String] :branch_name
|
1325
|
+
# Name for the branch.
|
1326
|
+
#
|
1327
|
+
# @option params [String] :description
|
1328
|
+
# Description for the branch.
|
1329
|
+
#
|
1330
|
+
# @option params [String] :framework
|
1331
|
+
# Framework for the branch.
|
1332
|
+
#
|
1333
|
+
# @option params [String] :stage
|
1334
|
+
# Stage for the branch.
|
1335
|
+
#
|
1336
|
+
# @option params [Boolean] :enable_notification
|
1337
|
+
# Enables notifications for the branch.
|
1338
|
+
#
|
1339
|
+
# @option params [Boolean] :enable_auto_build
|
1340
|
+
# Enables auto building for the branch.
|
1341
|
+
#
|
1342
|
+
# @option params [Hash<String,String>] :environment_variables
|
1343
|
+
# Environment Variables for the branch.
|
1344
|
+
#
|
1345
|
+
# @option params [String] :basic_auth_credentials
|
1346
|
+
# Basic Authorization credentials for the branch.
|
1347
|
+
#
|
1348
|
+
# @option params [Boolean] :enable_basic_auth
|
1349
|
+
# Enables Basic Auth for the branch.
|
1350
|
+
#
|
1351
|
+
# @option params [String] :build_spec
|
1352
|
+
# BuildSpec for the branch.
|
1353
|
+
#
|
1354
|
+
# @option params [String] :ttl
|
1355
|
+
# The content TTL for the website in seconds.
|
1356
|
+
#
|
1357
|
+
# @return [Types::UpdateBranchResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1358
|
+
#
|
1359
|
+
# * {Types::UpdateBranchResult#branch #branch} => Types::Branch
|
1360
|
+
#
|
1361
|
+
# @example Request syntax with placeholder values
|
1362
|
+
#
|
1363
|
+
# resp = client.update_branch({
|
1364
|
+
# app_id: "AppId", # required
|
1365
|
+
# branch_name: "BranchName", # required
|
1366
|
+
# description: "Description",
|
1367
|
+
# framework: "Framework",
|
1368
|
+
# stage: "PRODUCTION", # accepts PRODUCTION, BETA, DEVELOPMENT, EXPERIMENTAL
|
1369
|
+
# enable_notification: false,
|
1370
|
+
# enable_auto_build: false,
|
1371
|
+
# environment_variables: {
|
1372
|
+
# "EnvKey" => "EnvValue",
|
1373
|
+
# },
|
1374
|
+
# basic_auth_credentials: "BasicAuthCredentials",
|
1375
|
+
# enable_basic_auth: false,
|
1376
|
+
# build_spec: "BuildSpec",
|
1377
|
+
# ttl: "TTL",
|
1378
|
+
# })
|
1379
|
+
#
|
1380
|
+
# @example Response structure
|
1381
|
+
#
|
1382
|
+
# resp.branch.branch_arn #=> String
|
1383
|
+
# resp.branch.branch_name #=> String
|
1384
|
+
# resp.branch.description #=> String
|
1385
|
+
# resp.branch.tags #=> Hash
|
1386
|
+
# resp.branch.tags["TagKey"] #=> String
|
1387
|
+
# resp.branch.stage #=> String, one of "PRODUCTION", "BETA", "DEVELOPMENT", "EXPERIMENTAL"
|
1388
|
+
# resp.branch.display_name #=> String
|
1389
|
+
# resp.branch.enable_notification #=> Boolean
|
1390
|
+
# resp.branch.create_time #=> Time
|
1391
|
+
# resp.branch.update_time #=> Time
|
1392
|
+
# resp.branch.environment_variables #=> Hash
|
1393
|
+
# resp.branch.environment_variables["EnvKey"] #=> String
|
1394
|
+
# resp.branch.enable_auto_build #=> Boolean
|
1395
|
+
# resp.branch.custom_domains #=> Array
|
1396
|
+
# resp.branch.custom_domains[0] #=> String
|
1397
|
+
# resp.branch.framework #=> String
|
1398
|
+
# resp.branch.active_job_id #=> String
|
1399
|
+
# resp.branch.total_number_of_jobs #=> String
|
1400
|
+
# resp.branch.enable_basic_auth #=> Boolean
|
1401
|
+
# resp.branch.thumbnail_url #=> String
|
1402
|
+
# resp.branch.basic_auth_credentials #=> String
|
1403
|
+
# resp.branch.build_spec #=> String
|
1404
|
+
# resp.branch.ttl #=> String
|
1405
|
+
#
|
1406
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/UpdateBranch AWS API Documentation
|
1407
|
+
#
|
1408
|
+
# @overload update_branch(params = {})
|
1409
|
+
# @param [Hash] params ({})
|
1410
|
+
def update_branch(params = {}, options = {})
|
1411
|
+
req = build_request(:update_branch, params)
|
1412
|
+
req.send_request(options)
|
1413
|
+
end
|
1414
|
+
|
1415
|
+
# Create a new DomainAssociation on an App
|
1416
|
+
#
|
1417
|
+
# @option params [required, String] :app_id
|
1418
|
+
# Unique Id for an Amplify App.
|
1419
|
+
#
|
1420
|
+
# @option params [required, String] :domain_name
|
1421
|
+
# Name of the domain.
|
1422
|
+
#
|
1423
|
+
# @option params [Boolean] :enable_auto_sub_domain
|
1424
|
+
# Enables automated creation of Subdomains for branches.
|
1425
|
+
#
|
1426
|
+
# @option params [required, Array<Types::SubDomainSetting>] :sub_domain_settings
|
1427
|
+
# Setting structure for the Subdomain.
|
1428
|
+
#
|
1429
|
+
# @return [Types::UpdateDomainAssociationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1430
|
+
#
|
1431
|
+
# * {Types::UpdateDomainAssociationResult#domain_association #domain_association} => Types::DomainAssociation
|
1432
|
+
#
|
1433
|
+
# @example Request syntax with placeholder values
|
1434
|
+
#
|
1435
|
+
# resp = client.update_domain_association({
|
1436
|
+
# app_id: "AppId", # required
|
1437
|
+
# domain_name: "DomainName", # required
|
1438
|
+
# enable_auto_sub_domain: false,
|
1439
|
+
# sub_domain_settings: [ # required
|
1440
|
+
# {
|
1441
|
+
# prefix: "DomainPrefix", # required
|
1442
|
+
# branch_name: "BranchName", # required
|
1443
|
+
# },
|
1444
|
+
# ],
|
1445
|
+
# })
|
1446
|
+
#
|
1447
|
+
# @example Response structure
|
1448
|
+
#
|
1449
|
+
# resp.domain_association.domain_association_arn #=> String
|
1450
|
+
# resp.domain_association.domain_name #=> String
|
1451
|
+
# resp.domain_association.enable_auto_sub_domain #=> Boolean
|
1452
|
+
# resp.domain_association.domain_status #=> String, one of "PENDING_VERIFICATION", "IN_PROGRESS", "AVAILABLE", "PENDING_DEPLOYMENT", "FAILED"
|
1453
|
+
# resp.domain_association.status_reason #=> String
|
1454
|
+
# resp.domain_association.certificate_verification_dns_record #=> String
|
1455
|
+
# resp.domain_association.sub_domains #=> Array
|
1456
|
+
# resp.domain_association.sub_domains[0].sub_domain_setting.prefix #=> String
|
1457
|
+
# resp.domain_association.sub_domains[0].sub_domain_setting.branch_name #=> String
|
1458
|
+
# resp.domain_association.sub_domains[0].verified #=> Boolean
|
1459
|
+
# resp.domain_association.sub_domains[0].dns_record #=> String
|
1460
|
+
#
|
1461
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/UpdateDomainAssociation AWS API Documentation
|
1462
|
+
#
|
1463
|
+
# @overload update_domain_association(params = {})
|
1464
|
+
# @param [Hash] params ({})
|
1465
|
+
def update_domain_association(params = {}, options = {})
|
1466
|
+
req = build_request(:update_domain_association, params)
|
1467
|
+
req.send_request(options)
|
1468
|
+
end
|
1469
|
+
|
1470
|
+
# @!endgroup
|
1471
|
+
|
1472
|
+
# @param params ({})
|
1473
|
+
# @api private
|
1474
|
+
def build_request(operation_name, params = {})
|
1475
|
+
handlers = @handlers.for(operation_name)
|
1476
|
+
context = Seahorse::Client::RequestContext.new(
|
1477
|
+
operation_name: operation_name,
|
1478
|
+
operation: config.api.operation(operation_name),
|
1479
|
+
client: self,
|
1480
|
+
params: params,
|
1481
|
+
config: config)
|
1482
|
+
context[:gem_name] = 'aws-sdk-amplify'
|
1483
|
+
context[:gem_version] = '1.0.0'
|
1484
|
+
Seahorse::Client::Request.new(handlers, context)
|
1485
|
+
end
|
1486
|
+
|
1487
|
+
# @api private
|
1488
|
+
# @deprecated
|
1489
|
+
def waiter_names
|
1490
|
+
[]
|
1491
|
+
end
|
1492
|
+
|
1493
|
+
class << self
|
1494
|
+
|
1495
|
+
# @api private
|
1496
|
+
attr_reader :identifier
|
1497
|
+
|
1498
|
+
# @api private
|
1499
|
+
def errors_module
|
1500
|
+
Errors
|
1501
|
+
end
|
1502
|
+
|
1503
|
+
end
|
1504
|
+
end
|
1505
|
+
end
|