aws-sdk-elasticbeanstalk 1.0.0.rc1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/lib/aws-sdk-elasticbeanstalk.rb +47 -0
- data/lib/aws-sdk-elasticbeanstalk/client.rb +2207 -0
- data/lib/aws-sdk-elasticbeanstalk/client_api.rb +1193 -0
- data/lib/aws-sdk-elasticbeanstalk/customizations.rb +7 -0
- data/lib/aws-sdk-elasticbeanstalk/errors.rb +23 -0
- data/lib/aws-sdk-elasticbeanstalk/resource.rb +25 -0
- data/lib/aws-sdk-elasticbeanstalk/types.rb +3164 -0
- metadata +80 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: b0ba8b7ea72e1cf9e0e48a9b773bbae343c7f239
|
4
|
+
data.tar.gz: 85260ce97e9eb35b218c472f646aff9c93ef309b
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: a4c0d63fb4f6e1da47c6e2d0fdc7f478ee5d33142bcc9b0f6f74a1bddd6c1224c57c5cf7bba03c9a9f41bfb66eaeb34fea7bafc7173fd3ccc418e76461551608
|
7
|
+
data.tar.gz: 224d9a77071d230dabc2ee34774e1afb189bbbf62a4edf39d7e0b292c553bacdb437d76dc8057b1f08ead17505c751e1e6b868f6976159559c6657af19056207
|
@@ -0,0 +1,47 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing for info on making contributions:
|
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-elasticbeanstalk/types'
|
12
|
+
require_relative 'aws-sdk-elasticbeanstalk/client_api'
|
13
|
+
require_relative 'aws-sdk-elasticbeanstalk/client'
|
14
|
+
require_relative 'aws-sdk-elasticbeanstalk/errors'
|
15
|
+
require_relative 'aws-sdk-elasticbeanstalk/resource'
|
16
|
+
require_relative 'aws-sdk-elasticbeanstalk/customizations'
|
17
|
+
|
18
|
+
# This module provides support for AWS Elastic Beanstalk. This module is available in the
|
19
|
+
# `aws-sdk-elasticbeanstalk` 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 Elastic Beanstalk all
|
32
|
+
# extend {Errors::ServiceError}.
|
33
|
+
#
|
34
|
+
# begin
|
35
|
+
# # do stuff
|
36
|
+
# rescue Aws::ElasticBeanstalk::Errors::ServiceError
|
37
|
+
# # rescues all service API errors
|
38
|
+
# end
|
39
|
+
#
|
40
|
+
# See {Errors} for more information.
|
41
|
+
#
|
42
|
+
# @service
|
43
|
+
module Aws::ElasticBeanstalk
|
44
|
+
|
45
|
+
GEM_VERSION = '1.0.0.rc1'
|
46
|
+
|
47
|
+
end
|
@@ -0,0 +1,2207 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing for info on making contributions:
|
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/response_paging.rb'
|
19
|
+
require 'aws-sdk-core/plugins/stub_responses.rb'
|
20
|
+
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
21
|
+
require 'aws-sdk-core/plugins/signature_v4.rb'
|
22
|
+
require 'aws-sdk-core/plugins/protocols/query.rb'
|
23
|
+
|
24
|
+
Aws::Plugins::GlobalConfiguration.add_identifier(:elasticbeanstalk)
|
25
|
+
|
26
|
+
module Aws
|
27
|
+
module ElasticBeanstalk
|
28
|
+
class Client < Seahorse::Client::Base
|
29
|
+
|
30
|
+
include Aws::ClientStubs
|
31
|
+
|
32
|
+
@identifier = :elasticbeanstalk
|
33
|
+
|
34
|
+
set_api(ClientApi::API)
|
35
|
+
|
36
|
+
add_plugin(Seahorse::Client::Plugins::ContentLength)
|
37
|
+
add_plugin(Aws::Plugins::CredentialsConfiguration)
|
38
|
+
add_plugin(Aws::Plugins::Logging)
|
39
|
+
add_plugin(Aws::Plugins::ParamConverter)
|
40
|
+
add_plugin(Aws::Plugins::ParamValidator)
|
41
|
+
add_plugin(Aws::Plugins::UserAgent)
|
42
|
+
add_plugin(Aws::Plugins::HelpfulSocketErrors)
|
43
|
+
add_plugin(Aws::Plugins::RetryErrors)
|
44
|
+
add_plugin(Aws::Plugins::GlobalConfiguration)
|
45
|
+
add_plugin(Aws::Plugins::RegionalEndpoint)
|
46
|
+
add_plugin(Aws::Plugins::ResponsePaging)
|
47
|
+
add_plugin(Aws::Plugins::StubResponses)
|
48
|
+
add_plugin(Aws::Plugins::IdempotencyToken)
|
49
|
+
add_plugin(Aws::Plugins::SignatureV4)
|
50
|
+
add_plugin(Aws::Plugins::Protocols::Query)
|
51
|
+
|
52
|
+
# @option options [required, Aws::CredentialProvider] :credentials
|
53
|
+
# Your AWS credentials. This can be an instance of any one of the
|
54
|
+
# following classes:
|
55
|
+
#
|
56
|
+
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
57
|
+
# credentials.
|
58
|
+
#
|
59
|
+
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
60
|
+
# from an EC2 IMDS on an EC2 instance.
|
61
|
+
#
|
62
|
+
# * `Aws::SharedCredentials` - Used for loading credentials from a
|
63
|
+
# shared file, such as `~/.aws/config`.
|
64
|
+
#
|
65
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
66
|
+
#
|
67
|
+
# When `:credentials` are not configured directly, the following
|
68
|
+
# locations will be searched for credentials:
|
69
|
+
#
|
70
|
+
# * `Aws.config[:credentials]`
|
71
|
+
# * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
|
72
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
73
|
+
# * `~/.aws/credentials`
|
74
|
+
# * `~/.aws/config`
|
75
|
+
# * EC2 IMDS instance profile - When used by default, the timeouts are
|
76
|
+
# very aggressive. Construct and pass an instance of
|
77
|
+
# `Aws::InstanceProfileCredentails` to enable retries and extended
|
78
|
+
# timeouts.
|
79
|
+
# @option options [required, String] :region
|
80
|
+
# The AWS region to connect to. The configured `:region` is
|
81
|
+
# used to determine the service `:endpoint`. When not passed,
|
82
|
+
# a default `:region` is search for in the following locations:
|
83
|
+
#
|
84
|
+
# * `Aws.config[:region]`
|
85
|
+
# * `ENV['AWS_REGION']`
|
86
|
+
# * `ENV['AMAZON_REGION']`
|
87
|
+
# * `ENV['AWS_DEFAULT_REGION']`
|
88
|
+
# * `~/.aws/credentials`
|
89
|
+
# * `~/.aws/config`
|
90
|
+
# @option options [String] :access_key_id
|
91
|
+
# @option options [Boolean] :convert_params (true)
|
92
|
+
# When `true`, an attempt is made to coerce request parameters into
|
93
|
+
# the required types.
|
94
|
+
# @option options [String] :endpoint
|
95
|
+
# The client endpoint is normally constructed from the `:region`
|
96
|
+
# option. You should only configure an `:endpoint` when connecting
|
97
|
+
# to test endpoints. This should be avalid HTTP(S) URI.
|
98
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
99
|
+
# The log formatter.
|
100
|
+
# @option options [Symbol] :log_level (:info)
|
101
|
+
# The log level to send messages to the `:logger` at.
|
102
|
+
# @option options [Logger] :logger
|
103
|
+
# The Logger instance to send log messages to. If this option
|
104
|
+
# is not set, logging will be disabled.
|
105
|
+
# @option options [String] :profile ("default")
|
106
|
+
# Used when loading credentials from the shared credentials file
|
107
|
+
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
108
|
+
# @option options [Integer] :retry_limit (3)
|
109
|
+
# The maximum number of times to retry failed requests. Only
|
110
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
111
|
+
# are retried. Generally, these are throttling errors, data
|
112
|
+
# checksum errors, networking errors, timeout errors and auth
|
113
|
+
# errors from expired credentials.
|
114
|
+
# @option options [String] :secret_access_key
|
115
|
+
# @option options [String] :session_token
|
116
|
+
# @option options [Boolean] :stub_responses (false)
|
117
|
+
# Causes the client to return stubbed responses. By default
|
118
|
+
# fake responses are generated and returned. You can specify
|
119
|
+
# the response data to return or errors to raise by calling
|
120
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
121
|
+
#
|
122
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
123
|
+
# requests are made, and retries are disabled.
|
124
|
+
# @option options [Boolean] :validate_params (true)
|
125
|
+
# When `true`, request parameters are validated before
|
126
|
+
# sending the request.
|
127
|
+
def initialize(*args)
|
128
|
+
super
|
129
|
+
end
|
130
|
+
|
131
|
+
# @!group API Operations
|
132
|
+
|
133
|
+
# Cancels in-progress environment configuration update or application
|
134
|
+
# version deployment.
|
135
|
+
# @option params [String] :environment_id
|
136
|
+
# This specifies the ID of the environment with the in-progress update
|
137
|
+
# that you want to cancel.
|
138
|
+
# @option params [String] :environment_name
|
139
|
+
# This specifies the name of the environment with the in-progress update
|
140
|
+
# that you want to cancel.
|
141
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
142
|
+
#
|
143
|
+
# @example Request syntax with placeholder values
|
144
|
+
# resp = client.abort_environment_update({
|
145
|
+
# environment_id: "EnvironmentId",
|
146
|
+
# environment_name: "EnvironmentName",
|
147
|
+
# })
|
148
|
+
# @overload abort_environment_update(params = {})
|
149
|
+
# @param [Hash] params ({})
|
150
|
+
def abort_environment_update(params = {}, options = {})
|
151
|
+
req = build_request(:abort_environment_update, params)
|
152
|
+
req.send_request(options)
|
153
|
+
end
|
154
|
+
|
155
|
+
# Applies a scheduled managed action immediately. A managed action can
|
156
|
+
# be applied only if its status is `Scheduled`. Get the status and
|
157
|
+
# action ID of a managed action with DescribeEnvironmentManagedActions.
|
158
|
+
# @option params [String] :environment_name
|
159
|
+
# The name of the target environment.
|
160
|
+
# @option params [String] :environment_id
|
161
|
+
# The environment ID of the target environment.
|
162
|
+
# @option params [required, String] :action_id
|
163
|
+
# The action ID of the scheduled managed action to execute.
|
164
|
+
# @return [Types::ApplyEnvironmentManagedActionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
165
|
+
#
|
166
|
+
# * {Types::ApplyEnvironmentManagedActionResult#action_id #ActionId} => String
|
167
|
+
# * {Types::ApplyEnvironmentManagedActionResult#action_description #ActionDescription} => String
|
168
|
+
# * {Types::ApplyEnvironmentManagedActionResult#action_type #ActionType} => String
|
169
|
+
# * {Types::ApplyEnvironmentManagedActionResult#status #Status} => String
|
170
|
+
#
|
171
|
+
# @example Request syntax with placeholder values
|
172
|
+
# resp = client.apply_environment_managed_action({
|
173
|
+
# environment_name: "String",
|
174
|
+
# environment_id: "String",
|
175
|
+
# action_id: "String", # required
|
176
|
+
# })
|
177
|
+
#
|
178
|
+
# @example Response structure
|
179
|
+
# resp.action_id #=> String
|
180
|
+
# resp.action_description #=> String
|
181
|
+
# resp.action_type #=> String, one of "InstanceRefresh", "PlatformUpdate", "Unknown"
|
182
|
+
# resp.status #=> String
|
183
|
+
# @overload apply_environment_managed_action(params = {})
|
184
|
+
# @param [Hash] params ({})
|
185
|
+
def apply_environment_managed_action(params = {}, options = {})
|
186
|
+
req = build_request(:apply_environment_managed_action, params)
|
187
|
+
req.send_request(options)
|
188
|
+
end
|
189
|
+
|
190
|
+
# Checks if the specified CNAME is available.
|
191
|
+
# @option params [required, String] :cname_prefix
|
192
|
+
# The prefix used when this CNAME is reserved.
|
193
|
+
# @return [Types::CheckDNSAvailabilityResultMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
194
|
+
#
|
195
|
+
# * {Types::CheckDNSAvailabilityResultMessage#available #Available} => Boolean
|
196
|
+
# * {Types::CheckDNSAvailabilityResultMessage#fully_qualified_cname #FullyQualifiedCNAME} => String
|
197
|
+
#
|
198
|
+
# @example Request syntax with placeholder values
|
199
|
+
# resp = client.check_dns_availability({
|
200
|
+
# cname_prefix: "DNSCnamePrefix", # required
|
201
|
+
# })
|
202
|
+
#
|
203
|
+
# @example Response structure
|
204
|
+
# resp.available #=> Boolean
|
205
|
+
# resp.fully_qualified_cname #=> String
|
206
|
+
# @overload check_dns_availability(params = {})
|
207
|
+
# @param [Hash] params ({})
|
208
|
+
def check_dns_availability(params = {}, options = {})
|
209
|
+
req = build_request(:check_dns_availability, params)
|
210
|
+
req.send_request(options)
|
211
|
+
end
|
212
|
+
|
213
|
+
# Create or update a group of environments that each run a separate
|
214
|
+
# component of a single application. Takes a list of version labels that
|
215
|
+
# specify application source bundles for each of the environments to
|
216
|
+
# create or update. The name of each environment and other required
|
217
|
+
# information must be included in the source bundles in an environment
|
218
|
+
# manifest named `env.yaml`. See [Compose Environments][1] for details.
|
219
|
+
#
|
220
|
+
#
|
221
|
+
#
|
222
|
+
# [1]: http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-mgmt-compose.html
|
223
|
+
# @option params [String] :application_name
|
224
|
+
# The name of the application to which the specified source bundles
|
225
|
+
# belong.
|
226
|
+
# @option params [String] :group_name
|
227
|
+
# The name of the group to which the target environments belong. Specify
|
228
|
+
# a group name only if the environment name defined in each target
|
229
|
+
# environment's manifest ends with a + (plus) character. See
|
230
|
+
# [Environment Manifest (env.yaml)][1] for details.
|
231
|
+
#
|
232
|
+
#
|
233
|
+
#
|
234
|
+
# [1]: http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html
|
235
|
+
# @option params [Array<String>] :version_labels
|
236
|
+
# A list of version labels, specifying one or more application source
|
237
|
+
# bundles that belong to the target application. Each source bundle must
|
238
|
+
# include an environment manifest that specifies the name of the
|
239
|
+
# environment and the name of the solution stack to use, and optionally
|
240
|
+
# can specify environment links to create.
|
241
|
+
# @return [Types::EnvironmentDescriptionsMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
242
|
+
#
|
243
|
+
# * {Types::EnvironmentDescriptionsMessage#environments #Environments} => Array<Types::EnvironmentDescription>
|
244
|
+
#
|
245
|
+
# @example Request syntax with placeholder values
|
246
|
+
# resp = client.compose_environments({
|
247
|
+
# application_name: "ApplicationName",
|
248
|
+
# group_name: "GroupName",
|
249
|
+
# version_labels: ["VersionLabel"],
|
250
|
+
# })
|
251
|
+
#
|
252
|
+
# @example Response structure
|
253
|
+
# resp.environments #=> Array
|
254
|
+
# resp.environments[0].environment_name #=> String
|
255
|
+
# resp.environments[0].environment_id #=> String
|
256
|
+
# resp.environments[0].application_name #=> String
|
257
|
+
# resp.environments[0].version_label #=> String
|
258
|
+
# resp.environments[0].solution_stack_name #=> String
|
259
|
+
# resp.environments[0].template_name #=> String
|
260
|
+
# resp.environments[0].description #=> String
|
261
|
+
# resp.environments[0].endpoint_url #=> String
|
262
|
+
# resp.environments[0].cname #=> String
|
263
|
+
# resp.environments[0].date_created #=> Time
|
264
|
+
# resp.environments[0].date_updated #=> Time
|
265
|
+
# resp.environments[0].status #=> String, one of "Launching", "Updating", "Ready", "Terminating", "Terminated"
|
266
|
+
# resp.environments[0].abortable_operation_in_progress #=> Boolean
|
267
|
+
# resp.environments[0].health #=> String, one of "Green", "Yellow", "Red", "Grey"
|
268
|
+
# resp.environments[0].health_status #=> String, one of "NoData", "Unknown", "Pending", "Ok", "Info", "Warning", "Degraded", "Severe"
|
269
|
+
# resp.environments[0].resources.load_balancer.load_balancer_name #=> String
|
270
|
+
# resp.environments[0].resources.load_balancer.domain #=> String
|
271
|
+
# resp.environments[0].resources.load_balancer.listeners #=> Array
|
272
|
+
# resp.environments[0].resources.load_balancer.listeners[0].protocol #=> String
|
273
|
+
# resp.environments[0].resources.load_balancer.listeners[0].port #=> Integer
|
274
|
+
# resp.environments[0].tier.name #=> String
|
275
|
+
# resp.environments[0].tier.type #=> String
|
276
|
+
# resp.environments[0].tier.version #=> String
|
277
|
+
# resp.environments[0].environment_links #=> Array
|
278
|
+
# resp.environments[0].environment_links[0].link_name #=> String
|
279
|
+
# resp.environments[0].environment_links[0].environment_name #=> String
|
280
|
+
# @overload compose_environments(params = {})
|
281
|
+
# @param [Hash] params ({})
|
282
|
+
def compose_environments(params = {}, options = {})
|
283
|
+
req = build_request(:compose_environments, params)
|
284
|
+
req.send_request(options)
|
285
|
+
end
|
286
|
+
|
287
|
+
# Creates an application that has one configuration template named
|
288
|
+
# `default` and no application versions.
|
289
|
+
# @option params [required, String] :application_name
|
290
|
+
# The name of the application.
|
291
|
+
#
|
292
|
+
# Constraint: This name must be unique within your account. If the
|
293
|
+
# specified name already exists, the action returns an
|
294
|
+
# `InvalidParameterValue` error.
|
295
|
+
# @option params [String] :description
|
296
|
+
# Describes the application.
|
297
|
+
# @return [Types::ApplicationDescriptionMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
298
|
+
#
|
299
|
+
# * {Types::ApplicationDescriptionMessage#application #Application} => Types::ApplicationDescription
|
300
|
+
#
|
301
|
+
# @example Request syntax with placeholder values
|
302
|
+
# resp = client.create_application({
|
303
|
+
# application_name: "ApplicationName", # required
|
304
|
+
# description: "Description",
|
305
|
+
# })
|
306
|
+
#
|
307
|
+
# @example Response structure
|
308
|
+
# resp.application.application_name #=> String
|
309
|
+
# resp.application.description #=> String
|
310
|
+
# resp.application.date_created #=> Time
|
311
|
+
# resp.application.date_updated #=> Time
|
312
|
+
# resp.application.versions #=> Array
|
313
|
+
# resp.application.versions[0] #=> String
|
314
|
+
# resp.application.configuration_templates #=> Array
|
315
|
+
# resp.application.configuration_templates[0] #=> String
|
316
|
+
# @overload create_application(params = {})
|
317
|
+
# @param [Hash] params ({})
|
318
|
+
def create_application(params = {}, options = {})
|
319
|
+
req = build_request(:create_application, params)
|
320
|
+
req.send_request(options)
|
321
|
+
end
|
322
|
+
|
323
|
+
# Creates an application version for the specified application.
|
324
|
+
#
|
325
|
+
# <note markdown="1"> Once you create an application version with a specified Amazon S3
|
326
|
+
# bucket and key location, you cannot change that Amazon S3 location. If
|
327
|
+
# you change the Amazon S3 location, you receive an exception when you
|
328
|
+
# attempt to launch an environment from the application version.
|
329
|
+
#
|
330
|
+
# </note>
|
331
|
+
# @option params [required, String] :application_name
|
332
|
+
# The name of the application. If no application is found with this
|
333
|
+
# name, and `AutoCreateApplication` is `false`, returns an
|
334
|
+
# `InvalidParameterValue` error.
|
335
|
+
# @option params [required, String] :version_label
|
336
|
+
# A label identifying this version.
|
337
|
+
#
|
338
|
+
# Constraint: Must be unique per application. If an application version
|
339
|
+
# already exists with this label for the specified application, AWS
|
340
|
+
# Elastic Beanstalk returns an `InvalidParameterValue` error.
|
341
|
+
# @option params [String] :description
|
342
|
+
# Describes this version.
|
343
|
+
# @option params [Types::SourceBuildInformation] :source_build_information
|
344
|
+
# @option params [Types::S3Location] :source_bundle
|
345
|
+
# The Amazon S3 bucket and key that identify the location of the source
|
346
|
+
# bundle for this version.
|
347
|
+
#
|
348
|
+
# If data found at the Amazon S3 location exceeds the maximum allowed
|
349
|
+
# source bundle size, AWS Elastic Beanstalk returns an
|
350
|
+
# `InvalidParameterValue` error. The maximum size allowed is 512 MB.
|
351
|
+
#
|
352
|
+
# Default: If not specified, AWS Elastic Beanstalk uses a sample
|
353
|
+
# application. If only partially specified (for example, a bucket is
|
354
|
+
# provided but not the key) or if no data is found at the Amazon S3
|
355
|
+
# location, AWS Elastic Beanstalk returns an
|
356
|
+
# `InvalidParameterCombination` error.
|
357
|
+
# @option params [Boolean] :auto_create_application
|
358
|
+
# Determines how the system behaves if the specified application for
|
359
|
+
# this version does not already exist:
|
360
|
+
#
|
361
|
+
# * `true`\: Automatically creates the specified application for this
|
362
|
+
# release if it does not already exist.
|
363
|
+
#
|
364
|
+
# * `false`\: Throws an `InvalidParameterValue` if the specified
|
365
|
+
# application for this release does not already exist.
|
366
|
+
#
|
367
|
+
# Default: `false`
|
368
|
+
#
|
369
|
+
# Valid Values: `true` \| `false`
|
370
|
+
# @option params [Boolean] :process
|
371
|
+
# Preprocesses and validates the environment manifest and configuration
|
372
|
+
# files in the source bundle. Validating configuration files can
|
373
|
+
# identify issues prior to deploying the application version to an
|
374
|
+
# environment.
|
375
|
+
# @return [Types::ApplicationVersionDescriptionMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
376
|
+
#
|
377
|
+
# * {Types::ApplicationVersionDescriptionMessage#application_version #ApplicationVersion} => Types::ApplicationVersionDescription
|
378
|
+
#
|
379
|
+
# @example Request syntax with placeholder values
|
380
|
+
# resp = client.create_application_version({
|
381
|
+
# application_name: "ApplicationName", # required
|
382
|
+
# version_label: "VersionLabel", # required
|
383
|
+
# description: "Description",
|
384
|
+
# source_build_information: {
|
385
|
+
# source_type: "Git", # required, accepts Git
|
386
|
+
# source_repository: "CodeCommit", # required, accepts CodeCommit
|
387
|
+
# source_location: "SourceLocation", # required
|
388
|
+
# },
|
389
|
+
# source_bundle: {
|
390
|
+
# s3_bucket: "S3Bucket",
|
391
|
+
# s3_key: "S3Key",
|
392
|
+
# },
|
393
|
+
# auto_create_application: false,
|
394
|
+
# process: false,
|
395
|
+
# })
|
396
|
+
#
|
397
|
+
# @example Response structure
|
398
|
+
# resp.application_version.application_name #=> String
|
399
|
+
# resp.application_version.description #=> String
|
400
|
+
# resp.application_version.version_label #=> String
|
401
|
+
# resp.application_version.source_build_information.source_type #=> String, one of "Git"
|
402
|
+
# resp.application_version.source_build_information.source_repository #=> String, one of "CodeCommit"
|
403
|
+
# resp.application_version.source_build_information.source_location #=> String
|
404
|
+
# resp.application_version.source_bundle.s3_bucket #=> String
|
405
|
+
# resp.application_version.source_bundle.s3_key #=> String
|
406
|
+
# resp.application_version.date_created #=> Time
|
407
|
+
# resp.application_version.date_updated #=> Time
|
408
|
+
# resp.application_version.status #=> String, one of "Processed", "Unprocessed", "Failed", "Processing"
|
409
|
+
# @overload create_application_version(params = {})
|
410
|
+
# @param [Hash] params ({})
|
411
|
+
def create_application_version(params = {}, options = {})
|
412
|
+
req = build_request(:create_application_version, params)
|
413
|
+
req.send_request(options)
|
414
|
+
end
|
415
|
+
|
416
|
+
# Creates a configuration template. Templates are associated with a
|
417
|
+
# specific application and are used to deploy different versions of the
|
418
|
+
# application with the same configuration settings.
|
419
|
+
#
|
420
|
+
# Related Topics
|
421
|
+
#
|
422
|
+
# * DescribeConfigurationOptions
|
423
|
+
#
|
424
|
+
# * DescribeConfigurationSettings
|
425
|
+
#
|
426
|
+
# * ListAvailableSolutionStacks
|
427
|
+
# @option params [required, String] :application_name
|
428
|
+
# The name of the application to associate with this configuration
|
429
|
+
# template. If no application is found with this name, AWS Elastic
|
430
|
+
# Beanstalk returns an `InvalidParameterValue` error.
|
431
|
+
# @option params [required, String] :template_name
|
432
|
+
# The name of the configuration template.
|
433
|
+
#
|
434
|
+
# Constraint: This name must be unique per application.
|
435
|
+
#
|
436
|
+
# Default: If a configuration template already exists with this name,
|
437
|
+
# AWS Elastic Beanstalk returns an `InvalidParameterValue` error.
|
438
|
+
# @option params [String] :solution_stack_name
|
439
|
+
# The name of the solution stack used by this configuration. The
|
440
|
+
# solution stack specifies the operating system, architecture, and
|
441
|
+
# application server for a configuration template. It determines the set
|
442
|
+
# of configuration options as well as the possible and default values.
|
443
|
+
#
|
444
|
+
# Use ListAvailableSolutionStacks to obtain a list of available solution
|
445
|
+
# stacks.
|
446
|
+
#
|
447
|
+
# A solution stack name or a source configuration parameter must be
|
448
|
+
# specified, otherwise AWS Elastic Beanstalk returns an
|
449
|
+
# `InvalidParameterValue` error.
|
450
|
+
#
|
451
|
+
# If a solution stack name is not specified and the source configuration
|
452
|
+
# parameter is specified, AWS Elastic Beanstalk uses the same solution
|
453
|
+
# stack as the source configuration template.
|
454
|
+
# @option params [Types::SourceConfiguration] :source_configuration
|
455
|
+
# If specified, AWS Elastic Beanstalk uses the configuration values from
|
456
|
+
# the specified configuration template to create a new configuration.
|
457
|
+
#
|
458
|
+
# Values specified in the `OptionSettings` parameter of this call
|
459
|
+
# overrides any values obtained from the `SourceConfiguration`.
|
460
|
+
#
|
461
|
+
# If no configuration template is found, returns an
|
462
|
+
# `InvalidParameterValue` error.
|
463
|
+
#
|
464
|
+
# Constraint: If both the solution stack name parameter and the source
|
465
|
+
# configuration parameters are specified, the solution stack of the
|
466
|
+
# source configuration template must match the specified solution stack
|
467
|
+
# name or else AWS Elastic Beanstalk returns an
|
468
|
+
# `InvalidParameterCombination` error.
|
469
|
+
# @option params [String] :environment_id
|
470
|
+
# The ID of the environment used with this configuration template.
|
471
|
+
# @option params [String] :description
|
472
|
+
# Describes this configuration.
|
473
|
+
# @option params [Array<Types::ConfigurationOptionSetting>] :option_settings
|
474
|
+
# If specified, AWS Elastic Beanstalk sets the specified configuration
|
475
|
+
# option to the requested value. The new value overrides the value
|
476
|
+
# obtained from the solution stack or the source configuration template.
|
477
|
+
# @return [Types::ConfigurationSettingsDescription] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
478
|
+
#
|
479
|
+
# * {Types::ConfigurationSettingsDescription#solution_stack_name #SolutionStackName} => String
|
480
|
+
# * {Types::ConfigurationSettingsDescription#application_name #ApplicationName} => String
|
481
|
+
# * {Types::ConfigurationSettingsDescription#template_name #TemplateName} => String
|
482
|
+
# * {Types::ConfigurationSettingsDescription#description #Description} => String
|
483
|
+
# * {Types::ConfigurationSettingsDescription#environment_name #EnvironmentName} => String
|
484
|
+
# * {Types::ConfigurationSettingsDescription#deployment_status #DeploymentStatus} => String
|
485
|
+
# * {Types::ConfigurationSettingsDescription#date_created #DateCreated} => Time
|
486
|
+
# * {Types::ConfigurationSettingsDescription#date_updated #DateUpdated} => Time
|
487
|
+
# * {Types::ConfigurationSettingsDescription#option_settings #OptionSettings} => Array<Types::ConfigurationOptionSetting>
|
488
|
+
#
|
489
|
+
# @example Request syntax with placeholder values
|
490
|
+
# resp = client.create_configuration_template({
|
491
|
+
# application_name: "ApplicationName", # required
|
492
|
+
# template_name: "ConfigurationTemplateName", # required
|
493
|
+
# solution_stack_name: "SolutionStackName",
|
494
|
+
# source_configuration: {
|
495
|
+
# application_name: "ApplicationName",
|
496
|
+
# template_name: "ConfigurationTemplateName",
|
497
|
+
# },
|
498
|
+
# environment_id: "EnvironmentId",
|
499
|
+
# description: "Description",
|
500
|
+
# option_settings: [
|
501
|
+
# {
|
502
|
+
# resource_name: "ResourceName",
|
503
|
+
# namespace: "OptionNamespace",
|
504
|
+
# option_name: "ConfigurationOptionName",
|
505
|
+
# value: "ConfigurationOptionValue",
|
506
|
+
# },
|
507
|
+
# ],
|
508
|
+
# })
|
509
|
+
#
|
510
|
+
# @example Response structure
|
511
|
+
# resp.solution_stack_name #=> String
|
512
|
+
# resp.application_name #=> String
|
513
|
+
# resp.template_name #=> String
|
514
|
+
# resp.description #=> String
|
515
|
+
# resp.environment_name #=> String
|
516
|
+
# resp.deployment_status #=> String, one of "deployed", "pending", "failed"
|
517
|
+
# resp.date_created #=> Time
|
518
|
+
# resp.date_updated #=> Time
|
519
|
+
# resp.option_settings #=> Array
|
520
|
+
# resp.option_settings[0].resource_name #=> String
|
521
|
+
# resp.option_settings[0].namespace #=> String
|
522
|
+
# resp.option_settings[0].option_name #=> String
|
523
|
+
# resp.option_settings[0].value #=> String
|
524
|
+
# @overload create_configuration_template(params = {})
|
525
|
+
# @param [Hash] params ({})
|
526
|
+
def create_configuration_template(params = {}, options = {})
|
527
|
+
req = build_request(:create_configuration_template, params)
|
528
|
+
req.send_request(options)
|
529
|
+
end
|
530
|
+
|
531
|
+
# Launches an environment for the specified application using the
|
532
|
+
# specified configuration.
|
533
|
+
# @option params [required, String] :application_name
|
534
|
+
# The name of the application that contains the version to be deployed.
|
535
|
+
#
|
536
|
+
# If no application is found with this name, `CreateEnvironment` returns
|
537
|
+
# an `InvalidParameterValue` error.
|
538
|
+
# @option params [String] :environment_name
|
539
|
+
# A unique name for the deployment environment. Used in the application
|
540
|
+
# URL.
|
541
|
+
#
|
542
|
+
# Constraint: Must be from 4 to 40 characters in length. The name can
|
543
|
+
# contain only letters, numbers, and hyphens. It cannot start or end
|
544
|
+
# with a hyphen. This name must be unique in your account. If the
|
545
|
+
# specified name already exists, AWS Elastic Beanstalk returns an
|
546
|
+
# `InvalidParameterValue` error.
|
547
|
+
#
|
548
|
+
# Default: If the CNAME parameter is not specified, the environment name
|
549
|
+
# becomes part of the CNAME, and therefore part of the visible URL for
|
550
|
+
# your application.
|
551
|
+
# @option params [String] :group_name
|
552
|
+
# The name of the group to which the target environment belongs. Specify
|
553
|
+
# a group name only if the environment's name is specified in an
|
554
|
+
# environment manifest and not with the environment name parameter. See
|
555
|
+
# [Environment Manifest (env.yaml)][1] for details.
|
556
|
+
#
|
557
|
+
#
|
558
|
+
#
|
559
|
+
# [1]: http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html
|
560
|
+
# @option params [String] :description
|
561
|
+
# Describes this environment.
|
562
|
+
# @option params [String] :cname_prefix
|
563
|
+
# If specified, the environment attempts to use this value as the prefix
|
564
|
+
# for the CNAME. If not specified, the CNAME is generated automatically
|
565
|
+
# by appending a random alphanumeric string to the environment name.
|
566
|
+
# @option params [Types::EnvironmentTier] :tier
|
567
|
+
# This specifies the tier to use for creating this environment.
|
568
|
+
# @option params [Array<Types::Tag>] :tags
|
569
|
+
# This specifies the tags applied to resources in the environment.
|
570
|
+
# @option params [String] :version_label
|
571
|
+
# The name of the application version to deploy.
|
572
|
+
#
|
573
|
+
# If the specified application has no associated application versions,
|
574
|
+
# AWS Elastic Beanstalk `UpdateEnvironment` returns an
|
575
|
+
# `InvalidParameterValue` error.
|
576
|
+
#
|
577
|
+
# Default: If not specified, AWS Elastic Beanstalk attempts to launch
|
578
|
+
# the sample application in the container.
|
579
|
+
# @option params [String] :template_name
|
580
|
+
# The name of the configuration template to use in deployment. If no
|
581
|
+
# configuration template is found with this name, AWS Elastic Beanstalk
|
582
|
+
# returns an `InvalidParameterValue` error.
|
583
|
+
#
|
584
|
+
# Condition: You must specify either this parameter or a
|
585
|
+
# `SolutionStackName`, but not both. If you specify both, AWS Elastic
|
586
|
+
# Beanstalk returns an `InvalidParameterCombination` error. If you do
|
587
|
+
# not specify either, AWS Elastic Beanstalk returns a
|
588
|
+
# `MissingRequiredParameter` error.
|
589
|
+
# @option params [String] :solution_stack_name
|
590
|
+
# This is an alternative to specifying a template name. If specified,
|
591
|
+
# AWS Elastic Beanstalk sets the configuration values to the default
|
592
|
+
# values associated with the specified solution stack.
|
593
|
+
#
|
594
|
+
# Condition: You must specify either this or a `TemplateName`, but not
|
595
|
+
# both. If you specify both, AWS Elastic Beanstalk returns an
|
596
|
+
# `InvalidParameterCombination` error. If you do not specify either, AWS
|
597
|
+
# Elastic Beanstalk returns a `MissingRequiredParameter` error.
|
598
|
+
# @option params [Array<Types::ConfigurationOptionSetting>] :option_settings
|
599
|
+
# If specified, AWS Elastic Beanstalk sets the specified configuration
|
600
|
+
# options to the requested value in the configuration set for the new
|
601
|
+
# environment. These override the values obtained from the solution
|
602
|
+
# stack or the configuration template.
|
603
|
+
# @option params [Array<Types::OptionSpecification>] :options_to_remove
|
604
|
+
# A list of custom user-defined configuration options to remove from the
|
605
|
+
# configuration set for this new environment.
|
606
|
+
# @return [Types::EnvironmentDescription] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
607
|
+
#
|
608
|
+
# * {Types::EnvironmentDescription#environment_name #EnvironmentName} => String
|
609
|
+
# * {Types::EnvironmentDescription#environment_id #EnvironmentId} => String
|
610
|
+
# * {Types::EnvironmentDescription#application_name #ApplicationName} => String
|
611
|
+
# * {Types::EnvironmentDescription#version_label #VersionLabel} => String
|
612
|
+
# * {Types::EnvironmentDescription#solution_stack_name #SolutionStackName} => String
|
613
|
+
# * {Types::EnvironmentDescription#template_name #TemplateName} => String
|
614
|
+
# * {Types::EnvironmentDescription#description #Description} => String
|
615
|
+
# * {Types::EnvironmentDescription#endpoint_url #EndpointURL} => String
|
616
|
+
# * {Types::EnvironmentDescription#cname #CNAME} => String
|
617
|
+
# * {Types::EnvironmentDescription#date_created #DateCreated} => Time
|
618
|
+
# * {Types::EnvironmentDescription#date_updated #DateUpdated} => Time
|
619
|
+
# * {Types::EnvironmentDescription#status #Status} => String
|
620
|
+
# * {Types::EnvironmentDescription#abortable_operation_in_progress #AbortableOperationInProgress} => Boolean
|
621
|
+
# * {Types::EnvironmentDescription#health #Health} => String
|
622
|
+
# * {Types::EnvironmentDescription#health_status #HealthStatus} => String
|
623
|
+
# * {Types::EnvironmentDescription#resources #Resources} => Types::EnvironmentResourcesDescription
|
624
|
+
# * {Types::EnvironmentDescription#tier #Tier} => Types::EnvironmentTier
|
625
|
+
# * {Types::EnvironmentDescription#environment_links #EnvironmentLinks} => Array<Types::EnvironmentLink>
|
626
|
+
#
|
627
|
+
# @example Request syntax with placeholder values
|
628
|
+
# resp = client.create_environment({
|
629
|
+
# application_name: "ApplicationName", # required
|
630
|
+
# environment_name: "EnvironmentName",
|
631
|
+
# group_name: "GroupName",
|
632
|
+
# description: "Description",
|
633
|
+
# cname_prefix: "DNSCnamePrefix",
|
634
|
+
# tier: {
|
635
|
+
# name: "String",
|
636
|
+
# type: "String",
|
637
|
+
# version: "String",
|
638
|
+
# },
|
639
|
+
# tags: [
|
640
|
+
# {
|
641
|
+
# key: "TagKey",
|
642
|
+
# value: "TagValue",
|
643
|
+
# },
|
644
|
+
# ],
|
645
|
+
# version_label: "VersionLabel",
|
646
|
+
# template_name: "ConfigurationTemplateName",
|
647
|
+
# solution_stack_name: "SolutionStackName",
|
648
|
+
# option_settings: [
|
649
|
+
# {
|
650
|
+
# resource_name: "ResourceName",
|
651
|
+
# namespace: "OptionNamespace",
|
652
|
+
# option_name: "ConfigurationOptionName",
|
653
|
+
# value: "ConfigurationOptionValue",
|
654
|
+
# },
|
655
|
+
# ],
|
656
|
+
# options_to_remove: [
|
657
|
+
# {
|
658
|
+
# resource_name: "ResourceName",
|
659
|
+
# namespace: "OptionNamespace",
|
660
|
+
# option_name: "ConfigurationOptionName",
|
661
|
+
# },
|
662
|
+
# ],
|
663
|
+
# })
|
664
|
+
#
|
665
|
+
# @example Response structure
|
666
|
+
# resp.environment_name #=> String
|
667
|
+
# resp.environment_id #=> String
|
668
|
+
# resp.application_name #=> String
|
669
|
+
# resp.version_label #=> String
|
670
|
+
# resp.solution_stack_name #=> String
|
671
|
+
# resp.template_name #=> String
|
672
|
+
# resp.description #=> String
|
673
|
+
# resp.endpoint_url #=> String
|
674
|
+
# resp.cname #=> String
|
675
|
+
# resp.date_created #=> Time
|
676
|
+
# resp.date_updated #=> Time
|
677
|
+
# resp.status #=> String, one of "Launching", "Updating", "Ready", "Terminating", "Terminated"
|
678
|
+
# resp.abortable_operation_in_progress #=> Boolean
|
679
|
+
# resp.health #=> String, one of "Green", "Yellow", "Red", "Grey"
|
680
|
+
# resp.health_status #=> String, one of "NoData", "Unknown", "Pending", "Ok", "Info", "Warning", "Degraded", "Severe"
|
681
|
+
# resp.resources.load_balancer.load_balancer_name #=> String
|
682
|
+
# resp.resources.load_balancer.domain #=> String
|
683
|
+
# resp.resources.load_balancer.listeners #=> Array
|
684
|
+
# resp.resources.load_balancer.listeners[0].protocol #=> String
|
685
|
+
# resp.resources.load_balancer.listeners[0].port #=> Integer
|
686
|
+
# resp.tier.name #=> String
|
687
|
+
# resp.tier.type #=> String
|
688
|
+
# resp.tier.version #=> String
|
689
|
+
# resp.environment_links #=> Array
|
690
|
+
# resp.environment_links[0].link_name #=> String
|
691
|
+
# resp.environment_links[0].environment_name #=> String
|
692
|
+
# @overload create_environment(params = {})
|
693
|
+
# @param [Hash] params ({})
|
694
|
+
def create_environment(params = {}, options = {})
|
695
|
+
req = build_request(:create_environment, params)
|
696
|
+
req.send_request(options)
|
697
|
+
end
|
698
|
+
|
699
|
+
# Creates the Amazon S3 storage location for the account.
|
700
|
+
#
|
701
|
+
# This location is used to store user log files.
|
702
|
+
# @return [Types::CreateStorageLocationResultMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
703
|
+
#
|
704
|
+
# * {Types::CreateStorageLocationResultMessage#s3_bucket #S3Bucket} => String
|
705
|
+
#
|
706
|
+
# @example Response structure
|
707
|
+
# resp.s3_bucket #=> String
|
708
|
+
# @overload create_storage_location(params = {})
|
709
|
+
# @param [Hash] params ({})
|
710
|
+
def create_storage_location(params = {}, options = {})
|
711
|
+
req = build_request(:create_storage_location, params)
|
712
|
+
req.send_request(options)
|
713
|
+
end
|
714
|
+
|
715
|
+
# Deletes the specified application along with all associated versions
|
716
|
+
# and configurations. The application versions will not be deleted from
|
717
|
+
# your Amazon S3 bucket.
|
718
|
+
#
|
719
|
+
# <note markdown="1"> You cannot delete an application that has a running environment.
|
720
|
+
#
|
721
|
+
# </note>
|
722
|
+
# @option params [required, String] :application_name
|
723
|
+
# The name of the application to delete.
|
724
|
+
# @option params [Boolean] :terminate_env_by_force
|
725
|
+
# When set to true, running environments will be terminated before
|
726
|
+
# deleting the application.
|
727
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
728
|
+
#
|
729
|
+
# @example Request syntax with placeholder values
|
730
|
+
# resp = client.delete_application({
|
731
|
+
# application_name: "ApplicationName", # required
|
732
|
+
# terminate_env_by_force: false,
|
733
|
+
# })
|
734
|
+
# @overload delete_application(params = {})
|
735
|
+
# @param [Hash] params ({})
|
736
|
+
def delete_application(params = {}, options = {})
|
737
|
+
req = build_request(:delete_application, params)
|
738
|
+
req.send_request(options)
|
739
|
+
end
|
740
|
+
|
741
|
+
# Deletes the specified version from the specified application.
|
742
|
+
#
|
743
|
+
# <note markdown="1"> You cannot delete an application version that is associated with a
|
744
|
+
# running environment.
|
745
|
+
#
|
746
|
+
# </note>
|
747
|
+
# @option params [required, String] :application_name
|
748
|
+
# The name of the application to delete releases from.
|
749
|
+
# @option params [required, String] :version_label
|
750
|
+
# The label of the version to delete.
|
751
|
+
# @option params [Boolean] :delete_source_bundle
|
752
|
+
# Indicates whether to delete the associated source bundle from Amazon
|
753
|
+
# S3:
|
754
|
+
#
|
755
|
+
# * `true`\: An attempt is made to delete the associated Amazon S3
|
756
|
+
# source bundle specified at time of creation.
|
757
|
+
#
|
758
|
+
# * `false`\: No action is taken on the Amazon S3 source bundle
|
759
|
+
# specified at time of creation.
|
760
|
+
#
|
761
|
+
# Valid Values: `true` \| `false`
|
762
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
763
|
+
#
|
764
|
+
# @example Request syntax with placeholder values
|
765
|
+
# resp = client.delete_application_version({
|
766
|
+
# application_name: "ApplicationName", # required
|
767
|
+
# version_label: "VersionLabel", # required
|
768
|
+
# delete_source_bundle: false,
|
769
|
+
# })
|
770
|
+
# @overload delete_application_version(params = {})
|
771
|
+
# @param [Hash] params ({})
|
772
|
+
def delete_application_version(params = {}, options = {})
|
773
|
+
req = build_request(:delete_application_version, params)
|
774
|
+
req.send_request(options)
|
775
|
+
end
|
776
|
+
|
777
|
+
# Deletes the specified configuration template.
|
778
|
+
#
|
779
|
+
# <note markdown="1"> When you launch an environment using a configuration template, the
|
780
|
+
# environment gets a copy of the template. You can delete or modify the
|
781
|
+
# environment's copy of the template without affecting the running
|
782
|
+
# environment.
|
783
|
+
#
|
784
|
+
# </note>
|
785
|
+
# @option params [required, String] :application_name
|
786
|
+
# The name of the application to delete the configuration template from.
|
787
|
+
# @option params [required, String] :template_name
|
788
|
+
# The name of the configuration template to delete.
|
789
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
790
|
+
#
|
791
|
+
# @example Request syntax with placeholder values
|
792
|
+
# resp = client.delete_configuration_template({
|
793
|
+
# application_name: "ApplicationName", # required
|
794
|
+
# template_name: "ConfigurationTemplateName", # required
|
795
|
+
# })
|
796
|
+
# @overload delete_configuration_template(params = {})
|
797
|
+
# @param [Hash] params ({})
|
798
|
+
def delete_configuration_template(params = {}, options = {})
|
799
|
+
req = build_request(:delete_configuration_template, params)
|
800
|
+
req.send_request(options)
|
801
|
+
end
|
802
|
+
|
803
|
+
# Deletes the draft configuration associated with the running
|
804
|
+
# environment.
|
805
|
+
#
|
806
|
+
# Updating a running environment with any configuration changes creates
|
807
|
+
# a draft configuration set. You can get the draft configuration using
|
808
|
+
# DescribeConfigurationSettings while the update is in progress or if
|
809
|
+
# the update fails. The `DeploymentStatus` for the draft configuration
|
810
|
+
# indicates whether the deployment is in process or has failed. The
|
811
|
+
# draft configuration remains in existence until it is deleted with this
|
812
|
+
# action.
|
813
|
+
# @option params [required, String] :application_name
|
814
|
+
# The name of the application the environment is associated with.
|
815
|
+
# @option params [required, String] :environment_name
|
816
|
+
# The name of the environment to delete the draft configuration from.
|
817
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
818
|
+
#
|
819
|
+
# @example Request syntax with placeholder values
|
820
|
+
# resp = client.delete_environment_configuration({
|
821
|
+
# application_name: "ApplicationName", # required
|
822
|
+
# environment_name: "EnvironmentName", # required
|
823
|
+
# })
|
824
|
+
# @overload delete_environment_configuration(params = {})
|
825
|
+
# @param [Hash] params ({})
|
826
|
+
def delete_environment_configuration(params = {}, options = {})
|
827
|
+
req = build_request(:delete_environment_configuration, params)
|
828
|
+
req.send_request(options)
|
829
|
+
end
|
830
|
+
|
831
|
+
# Retrieve a list of application versions stored in your AWS Elastic
|
832
|
+
# Beanstalk storage bucket.
|
833
|
+
# @option params [String] :application_name
|
834
|
+
# If specified, AWS Elastic Beanstalk restricts the returned
|
835
|
+
# descriptions to only include ones that are associated with the
|
836
|
+
# specified application.
|
837
|
+
# @option params [Array<String>] :version_labels
|
838
|
+
# If specified, restricts the returned descriptions to only include ones
|
839
|
+
# that have the specified version labels.
|
840
|
+
# @option params [Integer] :max_records
|
841
|
+
# Specify a maximum number of application versions to paginate in the
|
842
|
+
# request.
|
843
|
+
# @option params [String] :next_token
|
844
|
+
# Specify a next token to retrieve the next page in a paginated request.
|
845
|
+
# @return [Types::ApplicationVersionDescriptionsMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
846
|
+
#
|
847
|
+
# * {Types::ApplicationVersionDescriptionsMessage#application_versions #ApplicationVersions} => Array<Types::ApplicationVersionDescription>
|
848
|
+
# * {Types::ApplicationVersionDescriptionsMessage#next_token #NextToken} => String
|
849
|
+
#
|
850
|
+
# @example Request syntax with placeholder values
|
851
|
+
# resp = client.describe_application_versions({
|
852
|
+
# application_name: "ApplicationName",
|
853
|
+
# version_labels: ["VersionLabel"],
|
854
|
+
# max_records: 1,
|
855
|
+
# next_token: "Token",
|
856
|
+
# })
|
857
|
+
#
|
858
|
+
# @example Response structure
|
859
|
+
# resp.application_versions #=> Array
|
860
|
+
# resp.application_versions[0].application_name #=> String
|
861
|
+
# resp.application_versions[0].description #=> String
|
862
|
+
# resp.application_versions[0].version_label #=> String
|
863
|
+
# resp.application_versions[0].source_build_information.source_type #=> String, one of "Git"
|
864
|
+
# resp.application_versions[0].source_build_information.source_repository #=> String, one of "CodeCommit"
|
865
|
+
# resp.application_versions[0].source_build_information.source_location #=> String
|
866
|
+
# resp.application_versions[0].source_bundle.s3_bucket #=> String
|
867
|
+
# resp.application_versions[0].source_bundle.s3_key #=> String
|
868
|
+
# resp.application_versions[0].date_created #=> Time
|
869
|
+
# resp.application_versions[0].date_updated #=> Time
|
870
|
+
# resp.application_versions[0].status #=> String, one of "Processed", "Unprocessed", "Failed", "Processing"
|
871
|
+
# resp.next_token #=> String
|
872
|
+
# @overload describe_application_versions(params = {})
|
873
|
+
# @param [Hash] params ({})
|
874
|
+
def describe_application_versions(params = {}, options = {})
|
875
|
+
req = build_request(:describe_application_versions, params)
|
876
|
+
req.send_request(options)
|
877
|
+
end
|
878
|
+
|
879
|
+
# Returns the descriptions of existing applications.
|
880
|
+
# @option params [Array<String>] :application_names
|
881
|
+
# If specified, AWS Elastic Beanstalk restricts the returned
|
882
|
+
# descriptions to only include those with the specified names.
|
883
|
+
# @return [Types::ApplicationDescriptionsMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
884
|
+
#
|
885
|
+
# * {Types::ApplicationDescriptionsMessage#applications #Applications} => Array<Types::ApplicationDescription>
|
886
|
+
#
|
887
|
+
# @example Request syntax with placeholder values
|
888
|
+
# resp = client.describe_applications({
|
889
|
+
# application_names: ["ApplicationName"],
|
890
|
+
# })
|
891
|
+
#
|
892
|
+
# @example Response structure
|
893
|
+
# resp.applications #=> Array
|
894
|
+
# resp.applications[0].application_name #=> String
|
895
|
+
# resp.applications[0].description #=> String
|
896
|
+
# resp.applications[0].date_created #=> Time
|
897
|
+
# resp.applications[0].date_updated #=> Time
|
898
|
+
# resp.applications[0].versions #=> Array
|
899
|
+
# resp.applications[0].versions[0] #=> String
|
900
|
+
# resp.applications[0].configuration_templates #=> Array
|
901
|
+
# resp.applications[0].configuration_templates[0] #=> String
|
902
|
+
# @overload describe_applications(params = {})
|
903
|
+
# @param [Hash] params ({})
|
904
|
+
def describe_applications(params = {}, options = {})
|
905
|
+
req = build_request(:describe_applications, params)
|
906
|
+
req.send_request(options)
|
907
|
+
end
|
908
|
+
|
909
|
+
# Describes the configuration options that are used in a particular
|
910
|
+
# configuration template or environment, or that a specified solution
|
911
|
+
# stack defines. The description includes the values the options, their
|
912
|
+
# default values, and an indication of the required action on a running
|
913
|
+
# environment if an option value is changed.
|
914
|
+
# @option params [String] :application_name
|
915
|
+
# The name of the application associated with the configuration template
|
916
|
+
# or environment. Only needed if you want to describe the configuration
|
917
|
+
# options associated with either the configuration template or
|
918
|
+
# environment.
|
919
|
+
# @option params [String] :template_name
|
920
|
+
# The name of the configuration template whose configuration options you
|
921
|
+
# want to describe.
|
922
|
+
# @option params [String] :environment_name
|
923
|
+
# The name of the environment whose configuration options you want to
|
924
|
+
# describe.
|
925
|
+
# @option params [String] :solution_stack_name
|
926
|
+
# The name of the solution stack whose configuration options you want to
|
927
|
+
# describe.
|
928
|
+
# @option params [Array<Types::OptionSpecification>] :options
|
929
|
+
# If specified, restricts the descriptions to only the specified
|
930
|
+
# options.
|
931
|
+
# @return [Types::ConfigurationOptionsDescription] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
932
|
+
#
|
933
|
+
# * {Types::ConfigurationOptionsDescription#solution_stack_name #SolutionStackName} => String
|
934
|
+
# * {Types::ConfigurationOptionsDescription#options #Options} => Array<Types::ConfigurationOptionDescription>
|
935
|
+
#
|
936
|
+
# @example Request syntax with placeholder values
|
937
|
+
# resp = client.describe_configuration_options({
|
938
|
+
# application_name: "ApplicationName",
|
939
|
+
# template_name: "ConfigurationTemplateName",
|
940
|
+
# environment_name: "EnvironmentName",
|
941
|
+
# solution_stack_name: "SolutionStackName",
|
942
|
+
# options: [
|
943
|
+
# {
|
944
|
+
# resource_name: "ResourceName",
|
945
|
+
# namespace: "OptionNamespace",
|
946
|
+
# option_name: "ConfigurationOptionName",
|
947
|
+
# },
|
948
|
+
# ],
|
949
|
+
# })
|
950
|
+
#
|
951
|
+
# @example Response structure
|
952
|
+
# resp.solution_stack_name #=> String
|
953
|
+
# resp.options #=> Array
|
954
|
+
# resp.options[0].namespace #=> String
|
955
|
+
# resp.options[0].name #=> String
|
956
|
+
# resp.options[0].default_value #=> String
|
957
|
+
# resp.options[0].change_severity #=> String
|
958
|
+
# resp.options[0].user_defined #=> Boolean
|
959
|
+
# resp.options[0].value_type #=> String, one of "Scalar", "List"
|
960
|
+
# resp.options[0].value_options #=> Array
|
961
|
+
# resp.options[0].value_options[0] #=> String
|
962
|
+
# resp.options[0].min_value #=> Integer
|
963
|
+
# resp.options[0].max_value #=> Integer
|
964
|
+
# resp.options[0].max_length #=> Integer
|
965
|
+
# resp.options[0].regex.pattern #=> String
|
966
|
+
# resp.options[0].regex.label #=> String
|
967
|
+
# @overload describe_configuration_options(params = {})
|
968
|
+
# @param [Hash] params ({})
|
969
|
+
def describe_configuration_options(params = {}, options = {})
|
970
|
+
req = build_request(:describe_configuration_options, params)
|
971
|
+
req.send_request(options)
|
972
|
+
end
|
973
|
+
|
974
|
+
# Returns a description of the settings for the specified configuration
|
975
|
+
# set, that is, either a configuration template or the configuration set
|
976
|
+
# associated with a running environment.
|
977
|
+
#
|
978
|
+
# When describing the settings for the configuration set associated with
|
979
|
+
# a running environment, it is possible to receive two sets of setting
|
980
|
+
# descriptions. One is the deployed configuration set, and the other is
|
981
|
+
# a draft configuration of an environment that is either in the process
|
982
|
+
# of deployment or that failed to deploy.
|
983
|
+
#
|
984
|
+
# Related Topics
|
985
|
+
#
|
986
|
+
# * DeleteEnvironmentConfiguration
|
987
|
+
#
|
988
|
+
# ^
|
989
|
+
# @option params [required, String] :application_name
|
990
|
+
# The application for the environment or configuration template.
|
991
|
+
# @option params [String] :template_name
|
992
|
+
# The name of the configuration template to describe.
|
993
|
+
#
|
994
|
+
# Conditional: You must specify either this parameter or an
|
995
|
+
# EnvironmentName, but not both. If you specify both, AWS Elastic
|
996
|
+
# Beanstalk returns an `InvalidParameterCombination` error. If you do
|
997
|
+
# not specify either, AWS Elastic Beanstalk returns a
|
998
|
+
# `MissingRequiredParameter` error.
|
999
|
+
# @option params [String] :environment_name
|
1000
|
+
# The name of the environment to describe.
|
1001
|
+
#
|
1002
|
+
# Condition: You must specify either this or a TemplateName, but not
|
1003
|
+
# both. If you specify both, AWS Elastic Beanstalk returns an
|
1004
|
+
# `InvalidParameterCombination` error. If you do not specify either, AWS
|
1005
|
+
# Elastic Beanstalk returns `MissingRequiredParameter` error.
|
1006
|
+
# @return [Types::ConfigurationSettingsDescriptions] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1007
|
+
#
|
1008
|
+
# * {Types::ConfigurationSettingsDescriptions#configuration_settings #ConfigurationSettings} => Array<Types::ConfigurationSettingsDescription>
|
1009
|
+
#
|
1010
|
+
# @example Request syntax with placeholder values
|
1011
|
+
# resp = client.describe_configuration_settings({
|
1012
|
+
# application_name: "ApplicationName", # required
|
1013
|
+
# template_name: "ConfigurationTemplateName",
|
1014
|
+
# environment_name: "EnvironmentName",
|
1015
|
+
# })
|
1016
|
+
#
|
1017
|
+
# @example Response structure
|
1018
|
+
# resp.configuration_settings #=> Array
|
1019
|
+
# resp.configuration_settings[0].solution_stack_name #=> String
|
1020
|
+
# resp.configuration_settings[0].application_name #=> String
|
1021
|
+
# resp.configuration_settings[0].template_name #=> String
|
1022
|
+
# resp.configuration_settings[0].description #=> String
|
1023
|
+
# resp.configuration_settings[0].environment_name #=> String
|
1024
|
+
# resp.configuration_settings[0].deployment_status #=> String, one of "deployed", "pending", "failed"
|
1025
|
+
# resp.configuration_settings[0].date_created #=> Time
|
1026
|
+
# resp.configuration_settings[0].date_updated #=> Time
|
1027
|
+
# resp.configuration_settings[0].option_settings #=> Array
|
1028
|
+
# resp.configuration_settings[0].option_settings[0].resource_name #=> String
|
1029
|
+
# resp.configuration_settings[0].option_settings[0].namespace #=> String
|
1030
|
+
# resp.configuration_settings[0].option_settings[0].option_name #=> String
|
1031
|
+
# resp.configuration_settings[0].option_settings[0].value #=> String
|
1032
|
+
# @overload describe_configuration_settings(params = {})
|
1033
|
+
# @param [Hash] params ({})
|
1034
|
+
def describe_configuration_settings(params = {}, options = {})
|
1035
|
+
req = build_request(:describe_configuration_settings, params)
|
1036
|
+
req.send_request(options)
|
1037
|
+
end
|
1038
|
+
|
1039
|
+
# Returns information about the overall health of the specified
|
1040
|
+
# environment. The **DescribeEnvironmentHealth** operation is only
|
1041
|
+
# available with AWS Elastic Beanstalk Enhanced Health.
|
1042
|
+
# @option params [String] :environment_name
|
1043
|
+
# Specifies the AWS Elastic Beanstalk environment name.
|
1044
|
+
#
|
1045
|
+
# Condition: You must specify either this or an EnvironmentId, or both.
|
1046
|
+
# If you do not specify either, AWS Elastic Beanstalk returns
|
1047
|
+
# `MissingRequiredParameter` error.
|
1048
|
+
# @option params [String] :environment_id
|
1049
|
+
# Specifies the AWS Elastic Beanstalk environment ID.
|
1050
|
+
#
|
1051
|
+
# Condition: You must specify either this or an EnvironmentName, or
|
1052
|
+
# both. If you do not specify either, AWS Elastic Beanstalk returns
|
1053
|
+
# `MissingRequiredParameter` error.
|
1054
|
+
# @option params [Array<String>] :attribute_names
|
1055
|
+
# Specifies the response elements you wish to receive. If no attribute
|
1056
|
+
# names are specified, AWS Elastic Beanstalk only returns the name of
|
1057
|
+
# the environment.
|
1058
|
+
# @return [Types::DescribeEnvironmentHealthResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1059
|
+
#
|
1060
|
+
# * {Types::DescribeEnvironmentHealthResult#environment_name #EnvironmentName} => String
|
1061
|
+
# * {Types::DescribeEnvironmentHealthResult#health_status #HealthStatus} => String
|
1062
|
+
# * {Types::DescribeEnvironmentHealthResult#status #Status} => String
|
1063
|
+
# * {Types::DescribeEnvironmentHealthResult#color #Color} => String
|
1064
|
+
# * {Types::DescribeEnvironmentHealthResult#causes #Causes} => Array<String>
|
1065
|
+
# * {Types::DescribeEnvironmentHealthResult#application_metrics #ApplicationMetrics} => Types::ApplicationMetrics
|
1066
|
+
# * {Types::DescribeEnvironmentHealthResult#instances_health #InstancesHealth} => Types::InstanceHealthSummary
|
1067
|
+
# * {Types::DescribeEnvironmentHealthResult#refreshed_at #RefreshedAt} => Time
|
1068
|
+
#
|
1069
|
+
# @example Request syntax with placeholder values
|
1070
|
+
# resp = client.describe_environment_health({
|
1071
|
+
# environment_name: "EnvironmentName",
|
1072
|
+
# environment_id: "EnvironmentId",
|
1073
|
+
# attribute_names: ["Status"], # accepts Status, Color, Causes, ApplicationMetrics, InstancesHealth, All, HealthStatus, RefreshedAt
|
1074
|
+
# })
|
1075
|
+
#
|
1076
|
+
# @example Response structure
|
1077
|
+
# resp.environment_name #=> String
|
1078
|
+
# resp.health_status #=> String
|
1079
|
+
# resp.status #=> String, one of "Green", "Yellow", "Red", "Grey"
|
1080
|
+
# resp.color #=> String
|
1081
|
+
# resp.causes #=> Array
|
1082
|
+
# resp.causes[0] #=> String
|
1083
|
+
# resp.application_metrics.duration #=> Integer
|
1084
|
+
# resp.application_metrics.request_count #=> Integer
|
1085
|
+
# resp.application_metrics.status_codes.status_2xx #=> Integer
|
1086
|
+
# resp.application_metrics.status_codes.status_3xx #=> Integer
|
1087
|
+
# resp.application_metrics.status_codes.status_4xx #=> Integer
|
1088
|
+
# resp.application_metrics.status_codes.status_5xx #=> Integer
|
1089
|
+
# resp.application_metrics.latency.p999 #=> Float
|
1090
|
+
# resp.application_metrics.latency.p99 #=> Float
|
1091
|
+
# resp.application_metrics.latency.p95 #=> Float
|
1092
|
+
# resp.application_metrics.latency.p90 #=> Float
|
1093
|
+
# resp.application_metrics.latency.p85 #=> Float
|
1094
|
+
# resp.application_metrics.latency.p75 #=> Float
|
1095
|
+
# resp.application_metrics.latency.p50 #=> Float
|
1096
|
+
# resp.application_metrics.latency.p10 #=> Float
|
1097
|
+
# resp.instances_health.no_data #=> Integer
|
1098
|
+
# resp.instances_health.unknown #=> Integer
|
1099
|
+
# resp.instances_health.pending #=> Integer
|
1100
|
+
# resp.instances_health.ok #=> Integer
|
1101
|
+
# resp.instances_health.info #=> Integer
|
1102
|
+
# resp.instances_health.warning #=> Integer
|
1103
|
+
# resp.instances_health.degraded #=> Integer
|
1104
|
+
# resp.instances_health.severe #=> Integer
|
1105
|
+
# resp.refreshed_at #=> Time
|
1106
|
+
# @overload describe_environment_health(params = {})
|
1107
|
+
# @param [Hash] params ({})
|
1108
|
+
def describe_environment_health(params = {}, options = {})
|
1109
|
+
req = build_request(:describe_environment_health, params)
|
1110
|
+
req.send_request(options)
|
1111
|
+
end
|
1112
|
+
|
1113
|
+
# Lists an environment's completed and failed managed actions.
|
1114
|
+
# @option params [String] :environment_id
|
1115
|
+
# The environment ID of the target environment.
|
1116
|
+
# @option params [String] :environment_name
|
1117
|
+
# The name of the target environment.
|
1118
|
+
# @option params [String] :next_token
|
1119
|
+
# The pagination token returned by a previous request.
|
1120
|
+
# @option params [Integer] :max_items
|
1121
|
+
# The maximum number of items to return for a single request.
|
1122
|
+
# @return [Types::DescribeEnvironmentManagedActionHistoryResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1123
|
+
#
|
1124
|
+
# * {Types::DescribeEnvironmentManagedActionHistoryResult#managed_action_history_items #ManagedActionHistoryItems} => Array<Types::ManagedActionHistoryItem>
|
1125
|
+
# * {Types::DescribeEnvironmentManagedActionHistoryResult#next_token #NextToken} => String
|
1126
|
+
#
|
1127
|
+
# @example Request syntax with placeholder values
|
1128
|
+
# resp = client.describe_environment_managed_action_history({
|
1129
|
+
# environment_id: "EnvironmentId",
|
1130
|
+
# environment_name: "EnvironmentName",
|
1131
|
+
# next_token: "String",
|
1132
|
+
# max_items: 1,
|
1133
|
+
# })
|
1134
|
+
#
|
1135
|
+
# @example Response structure
|
1136
|
+
# resp.managed_action_history_items #=> Array
|
1137
|
+
# resp.managed_action_history_items[0].action_id #=> String
|
1138
|
+
# resp.managed_action_history_items[0].action_type #=> String, one of "InstanceRefresh", "PlatformUpdate", "Unknown"
|
1139
|
+
# resp.managed_action_history_items[0].action_description #=> String
|
1140
|
+
# resp.managed_action_history_items[0].failure_type #=> String, one of "UpdateCancelled", "CancellationFailed", "RollbackFailed", "RollbackSuccessful", "InternalFailure", "InvalidEnvironmentState", "PermissionsError"
|
1141
|
+
# resp.managed_action_history_items[0].status #=> String, one of "Completed", "Failed", "Unknown"
|
1142
|
+
# resp.managed_action_history_items[0].failure_description #=> String
|
1143
|
+
# resp.managed_action_history_items[0].executed_time #=> Time
|
1144
|
+
# resp.managed_action_history_items[0].finished_time #=> Time
|
1145
|
+
# resp.next_token #=> String
|
1146
|
+
# @overload describe_environment_managed_action_history(params = {})
|
1147
|
+
# @param [Hash] params ({})
|
1148
|
+
def describe_environment_managed_action_history(params = {}, options = {})
|
1149
|
+
req = build_request(:describe_environment_managed_action_history, params)
|
1150
|
+
req.send_request(options)
|
1151
|
+
end
|
1152
|
+
|
1153
|
+
# Lists an environment's upcoming and in-progress managed actions.
|
1154
|
+
# @option params [String] :environment_name
|
1155
|
+
# The name of the target environment.
|
1156
|
+
# @option params [String] :environment_id
|
1157
|
+
# The environment ID of the target environment.
|
1158
|
+
# @option params [String] :status
|
1159
|
+
# To show only actions with a particular status, specify a status.
|
1160
|
+
# @return [Types::DescribeEnvironmentManagedActionsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1161
|
+
#
|
1162
|
+
# * {Types::DescribeEnvironmentManagedActionsResult#managed_actions #ManagedActions} => Array<Types::ManagedAction>
|
1163
|
+
#
|
1164
|
+
# @example Request syntax with placeholder values
|
1165
|
+
# resp = client.describe_environment_managed_actions({
|
1166
|
+
# environment_name: "String",
|
1167
|
+
# environment_id: "String",
|
1168
|
+
# status: "Scheduled", # accepts Scheduled, Pending, Running, Unknown
|
1169
|
+
# })
|
1170
|
+
#
|
1171
|
+
# @example Response structure
|
1172
|
+
# resp.managed_actions #=> Array
|
1173
|
+
# resp.managed_actions[0].action_id #=> String
|
1174
|
+
# resp.managed_actions[0].action_description #=> String
|
1175
|
+
# resp.managed_actions[0].action_type #=> String, one of "InstanceRefresh", "PlatformUpdate", "Unknown"
|
1176
|
+
# resp.managed_actions[0].status #=> String, one of "Scheduled", "Pending", "Running", "Unknown"
|
1177
|
+
# resp.managed_actions[0].window_start_time #=> Time
|
1178
|
+
# @overload describe_environment_managed_actions(params = {})
|
1179
|
+
# @param [Hash] params ({})
|
1180
|
+
def describe_environment_managed_actions(params = {}, options = {})
|
1181
|
+
req = build_request(:describe_environment_managed_actions, params)
|
1182
|
+
req.send_request(options)
|
1183
|
+
end
|
1184
|
+
|
1185
|
+
# Returns AWS resources for this environment.
|
1186
|
+
# @option params [String] :environment_id
|
1187
|
+
# The ID of the environment to retrieve AWS resource usage data.
|
1188
|
+
#
|
1189
|
+
# Condition: You must specify either this or an EnvironmentName, or
|
1190
|
+
# both. If you do not specify either, AWS Elastic Beanstalk returns
|
1191
|
+
# `MissingRequiredParameter` error.
|
1192
|
+
# @option params [String] :environment_name
|
1193
|
+
# The name of the environment to retrieve AWS resource usage data.
|
1194
|
+
#
|
1195
|
+
# Condition: You must specify either this or an EnvironmentId, or both.
|
1196
|
+
# If you do not specify either, AWS Elastic Beanstalk returns
|
1197
|
+
# `MissingRequiredParameter` error.
|
1198
|
+
# @return [Types::EnvironmentResourceDescriptionsMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1199
|
+
#
|
1200
|
+
# * {Types::EnvironmentResourceDescriptionsMessage#environment_resources #EnvironmentResources} => Types::EnvironmentResourceDescription
|
1201
|
+
#
|
1202
|
+
# @example Request syntax with placeholder values
|
1203
|
+
# resp = client.describe_environment_resources({
|
1204
|
+
# environment_id: "EnvironmentId",
|
1205
|
+
# environment_name: "EnvironmentName",
|
1206
|
+
# })
|
1207
|
+
#
|
1208
|
+
# @example Response structure
|
1209
|
+
# resp.environment_resources.environment_name #=> String
|
1210
|
+
# resp.environment_resources.auto_scaling_groups #=> Array
|
1211
|
+
# resp.environment_resources.auto_scaling_groups[0].name #=> String
|
1212
|
+
# resp.environment_resources.instances #=> Array
|
1213
|
+
# resp.environment_resources.instances[0].id #=> String
|
1214
|
+
# resp.environment_resources.launch_configurations #=> Array
|
1215
|
+
# resp.environment_resources.launch_configurations[0].name #=> String
|
1216
|
+
# resp.environment_resources.load_balancers #=> Array
|
1217
|
+
# resp.environment_resources.load_balancers[0].name #=> String
|
1218
|
+
# resp.environment_resources.triggers #=> Array
|
1219
|
+
# resp.environment_resources.triggers[0].name #=> String
|
1220
|
+
# resp.environment_resources.queues #=> Array
|
1221
|
+
# resp.environment_resources.queues[0].name #=> String
|
1222
|
+
# resp.environment_resources.queues[0].url #=> String
|
1223
|
+
# @overload describe_environment_resources(params = {})
|
1224
|
+
# @param [Hash] params ({})
|
1225
|
+
def describe_environment_resources(params = {}, options = {})
|
1226
|
+
req = build_request(:describe_environment_resources, params)
|
1227
|
+
req.send_request(options)
|
1228
|
+
end
|
1229
|
+
|
1230
|
+
# Returns descriptions for existing environments.
|
1231
|
+
# @option params [String] :application_name
|
1232
|
+
# If specified, AWS Elastic Beanstalk restricts the returned
|
1233
|
+
# descriptions to include only those that are associated with this
|
1234
|
+
# application.
|
1235
|
+
# @option params [String] :version_label
|
1236
|
+
# If specified, AWS Elastic Beanstalk restricts the returned
|
1237
|
+
# descriptions to include only those that are associated with this
|
1238
|
+
# application version.
|
1239
|
+
# @option params [Array<String>] :environment_ids
|
1240
|
+
# If specified, AWS Elastic Beanstalk restricts the returned
|
1241
|
+
# descriptions to include only those that have the specified IDs.
|
1242
|
+
# @option params [Array<String>] :environment_names
|
1243
|
+
# If specified, AWS Elastic Beanstalk restricts the returned
|
1244
|
+
# descriptions to include only those that have the specified names.
|
1245
|
+
# @option params [Boolean] :include_deleted
|
1246
|
+
# Indicates whether to include deleted environments:
|
1247
|
+
#
|
1248
|
+
# `true`\: Environments that have been deleted after
|
1249
|
+
# `IncludedDeletedBackTo` are displayed.
|
1250
|
+
#
|
1251
|
+
# `false`\: Do not include deleted environments.
|
1252
|
+
# @option params [Time,DateTime,Date,Integer,String] :included_deleted_back_to
|
1253
|
+
# If specified when `IncludeDeleted` is set to `true`, then environments
|
1254
|
+
# deleted after this date are displayed.
|
1255
|
+
# @return [Types::EnvironmentDescriptionsMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1256
|
+
#
|
1257
|
+
# * {Types::EnvironmentDescriptionsMessage#environments #Environments} => Array<Types::EnvironmentDescription>
|
1258
|
+
#
|
1259
|
+
# @example Request syntax with placeholder values
|
1260
|
+
# resp = client.describe_environments({
|
1261
|
+
# application_name: "ApplicationName",
|
1262
|
+
# version_label: "VersionLabel",
|
1263
|
+
# environment_ids: ["EnvironmentId"],
|
1264
|
+
# environment_names: ["EnvironmentName"],
|
1265
|
+
# include_deleted: false,
|
1266
|
+
# included_deleted_back_to: Time.now,
|
1267
|
+
# })
|
1268
|
+
#
|
1269
|
+
# @example Response structure
|
1270
|
+
# resp.environments #=> Array
|
1271
|
+
# resp.environments[0].environment_name #=> String
|
1272
|
+
# resp.environments[0].environment_id #=> String
|
1273
|
+
# resp.environments[0].application_name #=> String
|
1274
|
+
# resp.environments[0].version_label #=> String
|
1275
|
+
# resp.environments[0].solution_stack_name #=> String
|
1276
|
+
# resp.environments[0].template_name #=> String
|
1277
|
+
# resp.environments[0].description #=> String
|
1278
|
+
# resp.environments[0].endpoint_url #=> String
|
1279
|
+
# resp.environments[0].cname #=> String
|
1280
|
+
# resp.environments[0].date_created #=> Time
|
1281
|
+
# resp.environments[0].date_updated #=> Time
|
1282
|
+
# resp.environments[0].status #=> String, one of "Launching", "Updating", "Ready", "Terminating", "Terminated"
|
1283
|
+
# resp.environments[0].abortable_operation_in_progress #=> Boolean
|
1284
|
+
# resp.environments[0].health #=> String, one of "Green", "Yellow", "Red", "Grey"
|
1285
|
+
# resp.environments[0].health_status #=> String, one of "NoData", "Unknown", "Pending", "Ok", "Info", "Warning", "Degraded", "Severe"
|
1286
|
+
# resp.environments[0].resources.load_balancer.load_balancer_name #=> String
|
1287
|
+
# resp.environments[0].resources.load_balancer.domain #=> String
|
1288
|
+
# resp.environments[0].resources.load_balancer.listeners #=> Array
|
1289
|
+
# resp.environments[0].resources.load_balancer.listeners[0].protocol #=> String
|
1290
|
+
# resp.environments[0].resources.load_balancer.listeners[0].port #=> Integer
|
1291
|
+
# resp.environments[0].tier.name #=> String
|
1292
|
+
# resp.environments[0].tier.type #=> String
|
1293
|
+
# resp.environments[0].tier.version #=> String
|
1294
|
+
# resp.environments[0].environment_links #=> Array
|
1295
|
+
# resp.environments[0].environment_links[0].link_name #=> String
|
1296
|
+
# resp.environments[0].environment_links[0].environment_name #=> String
|
1297
|
+
# @overload describe_environments(params = {})
|
1298
|
+
# @param [Hash] params ({})
|
1299
|
+
def describe_environments(params = {}, options = {})
|
1300
|
+
req = build_request(:describe_environments, params)
|
1301
|
+
req.send_request(options)
|
1302
|
+
end
|
1303
|
+
|
1304
|
+
# Returns list of event descriptions matching criteria up to the last 6
|
1305
|
+
# weeks.
|
1306
|
+
#
|
1307
|
+
# <note markdown="1"> This action returns the most recent 1,000 events from the specified
|
1308
|
+
# `NextToken`.
|
1309
|
+
#
|
1310
|
+
# </note>
|
1311
|
+
# @option params [String] :application_name
|
1312
|
+
# If specified, AWS Elastic Beanstalk restricts the returned
|
1313
|
+
# descriptions to include only those associated with this application.
|
1314
|
+
# @option params [String] :version_label
|
1315
|
+
# If specified, AWS Elastic Beanstalk restricts the returned
|
1316
|
+
# descriptions to those associated with this application version.
|
1317
|
+
# @option params [String] :template_name
|
1318
|
+
# If specified, AWS Elastic Beanstalk restricts the returned
|
1319
|
+
# descriptions to those that are associated with this environment
|
1320
|
+
# configuration.
|
1321
|
+
# @option params [String] :environment_id
|
1322
|
+
# If specified, AWS Elastic Beanstalk restricts the returned
|
1323
|
+
# descriptions to those associated with this environment.
|
1324
|
+
# @option params [String] :environment_name
|
1325
|
+
# If specified, AWS Elastic Beanstalk restricts the returned
|
1326
|
+
# descriptions to those associated with this environment.
|
1327
|
+
# @option params [String] :request_id
|
1328
|
+
# If specified, AWS Elastic Beanstalk restricts the described events to
|
1329
|
+
# include only those associated with this request ID.
|
1330
|
+
# @option params [String] :severity
|
1331
|
+
# If specified, limits the events returned from this call to include
|
1332
|
+
# only those with the specified severity or higher.
|
1333
|
+
# @option params [Time,DateTime,Date,Integer,String] :start_time
|
1334
|
+
# If specified, AWS Elastic Beanstalk restricts the returned
|
1335
|
+
# descriptions to those that occur on or after this time.
|
1336
|
+
# @option params [Time,DateTime,Date,Integer,String] :end_time
|
1337
|
+
# If specified, AWS Elastic Beanstalk restricts the returned
|
1338
|
+
# descriptions to those that occur up to, but not including, the
|
1339
|
+
# `EndTime`.
|
1340
|
+
# @option params [Integer] :max_records
|
1341
|
+
# Specifies the maximum number of events that can be returned, beginning
|
1342
|
+
# with the most recent event.
|
1343
|
+
# @option params [String] :next_token
|
1344
|
+
# Pagination token. If specified, the events return the next batch of
|
1345
|
+
# results.
|
1346
|
+
# @return [Types::EventDescriptionsMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1347
|
+
#
|
1348
|
+
# * {Types::EventDescriptionsMessage#events #Events} => Array<Types::EventDescription>
|
1349
|
+
# * {Types::EventDescriptionsMessage#next_token #NextToken} => String
|
1350
|
+
#
|
1351
|
+
# @example Request syntax with placeholder values
|
1352
|
+
# resp = client.describe_events({
|
1353
|
+
# application_name: "ApplicationName",
|
1354
|
+
# version_label: "VersionLabel",
|
1355
|
+
# template_name: "ConfigurationTemplateName",
|
1356
|
+
# environment_id: "EnvironmentId",
|
1357
|
+
# environment_name: "EnvironmentName",
|
1358
|
+
# request_id: "RequestId",
|
1359
|
+
# severity: "TRACE", # accepts TRACE, DEBUG, INFO, WARN, ERROR, FATAL
|
1360
|
+
# start_time: Time.now,
|
1361
|
+
# end_time: Time.now,
|
1362
|
+
# max_records: 1,
|
1363
|
+
# next_token: "Token",
|
1364
|
+
# })
|
1365
|
+
#
|
1366
|
+
# @example Response structure
|
1367
|
+
# resp.events #=> Array
|
1368
|
+
# resp.events[0].event_date #=> Time
|
1369
|
+
# resp.events[0].message #=> String
|
1370
|
+
# resp.events[0].application_name #=> String
|
1371
|
+
# resp.events[0].version_label #=> String
|
1372
|
+
# resp.events[0].template_name #=> String
|
1373
|
+
# resp.events[0].environment_name #=> String
|
1374
|
+
# resp.events[0].request_id #=> String
|
1375
|
+
# resp.events[0].severity #=> String, one of "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "FATAL"
|
1376
|
+
# resp.next_token #=> String
|
1377
|
+
# @overload describe_events(params = {})
|
1378
|
+
# @param [Hash] params ({})
|
1379
|
+
def describe_events(params = {}, options = {})
|
1380
|
+
req = build_request(:describe_events, params)
|
1381
|
+
req.send_request(options)
|
1382
|
+
end
|
1383
|
+
|
1384
|
+
# Returns more detailed information about the health of the specified
|
1385
|
+
# instances (for example, CPU utilization, load average, and causes).
|
1386
|
+
# The **DescribeInstancesHealth** operation is only available with AWS
|
1387
|
+
# Elastic Beanstalk Enhanced Health.
|
1388
|
+
# @option params [String] :environment_name
|
1389
|
+
# Specifies the AWS Elastic Beanstalk environment name.
|
1390
|
+
# @option params [String] :environment_id
|
1391
|
+
# Specifies the AWS Elastic Beanstalk environment ID.
|
1392
|
+
# @option params [Array<String>] :attribute_names
|
1393
|
+
# Specifies the response elements you wish to receive. If no attribute
|
1394
|
+
# names are specified, AWS Elastic Beanstalk only returns a list of
|
1395
|
+
# instances.
|
1396
|
+
# @option params [String] :next_token
|
1397
|
+
# Specifies the next token of the request.
|
1398
|
+
# @return [Types::DescribeInstancesHealthResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1399
|
+
#
|
1400
|
+
# * {Types::DescribeInstancesHealthResult#instance_health_list #InstanceHealthList} => Array<Types::SingleInstanceHealth>
|
1401
|
+
# * {Types::DescribeInstancesHealthResult#refreshed_at #RefreshedAt} => Time
|
1402
|
+
# * {Types::DescribeInstancesHealthResult#next_token #NextToken} => String
|
1403
|
+
#
|
1404
|
+
# @example Request syntax with placeholder values
|
1405
|
+
# resp = client.describe_instances_health({
|
1406
|
+
# environment_name: "EnvironmentName",
|
1407
|
+
# environment_id: "EnvironmentId",
|
1408
|
+
# attribute_names: ["HealthStatus"], # accepts HealthStatus, Color, Causes, ApplicationMetrics, RefreshedAt, LaunchedAt, System, Deployment, AvailabilityZone, InstanceType, All
|
1409
|
+
# next_token: "NextToken",
|
1410
|
+
# })
|
1411
|
+
#
|
1412
|
+
# @example Response structure
|
1413
|
+
# resp.instance_health_list #=> Array
|
1414
|
+
# resp.instance_health_list[0].instance_id #=> String
|
1415
|
+
# resp.instance_health_list[0].health_status #=> String
|
1416
|
+
# resp.instance_health_list[0].color #=> String
|
1417
|
+
# resp.instance_health_list[0].causes #=> Array
|
1418
|
+
# resp.instance_health_list[0].causes[0] #=> String
|
1419
|
+
# resp.instance_health_list[0].launched_at #=> Time
|
1420
|
+
# resp.instance_health_list[0].application_metrics.duration #=> Integer
|
1421
|
+
# resp.instance_health_list[0].application_metrics.request_count #=> Integer
|
1422
|
+
# resp.instance_health_list[0].application_metrics.status_codes.status_2xx #=> Integer
|
1423
|
+
# resp.instance_health_list[0].application_metrics.status_codes.status_3xx #=> Integer
|
1424
|
+
# resp.instance_health_list[0].application_metrics.status_codes.status_4xx #=> Integer
|
1425
|
+
# resp.instance_health_list[0].application_metrics.status_codes.status_5xx #=> Integer
|
1426
|
+
# resp.instance_health_list[0].application_metrics.latency.p999 #=> Float
|
1427
|
+
# resp.instance_health_list[0].application_metrics.latency.p99 #=> Float
|
1428
|
+
# resp.instance_health_list[0].application_metrics.latency.p95 #=> Float
|
1429
|
+
# resp.instance_health_list[0].application_metrics.latency.p90 #=> Float
|
1430
|
+
# resp.instance_health_list[0].application_metrics.latency.p85 #=> Float
|
1431
|
+
# resp.instance_health_list[0].application_metrics.latency.p75 #=> Float
|
1432
|
+
# resp.instance_health_list[0].application_metrics.latency.p50 #=> Float
|
1433
|
+
# resp.instance_health_list[0].application_metrics.latency.p10 #=> Float
|
1434
|
+
# resp.instance_health_list[0].system.cpu_utilization.user #=> Float
|
1435
|
+
# resp.instance_health_list[0].system.cpu_utilization.nice #=> Float
|
1436
|
+
# resp.instance_health_list[0].system.cpu_utilization.system #=> Float
|
1437
|
+
# resp.instance_health_list[0].system.cpu_utilization.idle #=> Float
|
1438
|
+
# resp.instance_health_list[0].system.cpu_utilization.io_wait #=> Float
|
1439
|
+
# resp.instance_health_list[0].system.cpu_utilization.irq #=> Float
|
1440
|
+
# resp.instance_health_list[0].system.cpu_utilization.soft_irq #=> Float
|
1441
|
+
# resp.instance_health_list[0].system.load_average #=> Array
|
1442
|
+
# resp.instance_health_list[0].system.load_average[0] #=> Float
|
1443
|
+
# resp.instance_health_list[0].deployment.version_label #=> String
|
1444
|
+
# resp.instance_health_list[0].deployment.deployment_id #=> Integer
|
1445
|
+
# resp.instance_health_list[0].deployment.status #=> String
|
1446
|
+
# resp.instance_health_list[0].deployment.deployment_time #=> Time
|
1447
|
+
# resp.instance_health_list[0].availability_zone #=> String
|
1448
|
+
# resp.instance_health_list[0].instance_type #=> String
|
1449
|
+
# resp.refreshed_at #=> Time
|
1450
|
+
# resp.next_token #=> String
|
1451
|
+
# @overload describe_instances_health(params = {})
|
1452
|
+
# @param [Hash] params ({})
|
1453
|
+
def describe_instances_health(params = {}, options = {})
|
1454
|
+
req = build_request(:describe_instances_health, params)
|
1455
|
+
req.send_request(options)
|
1456
|
+
end
|
1457
|
+
|
1458
|
+
# Returns a list of the available solution stack names.
|
1459
|
+
# @return [Types::ListAvailableSolutionStacksResultMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1460
|
+
#
|
1461
|
+
# * {Types::ListAvailableSolutionStacksResultMessage#solution_stacks #SolutionStacks} => Array<String>
|
1462
|
+
# * {Types::ListAvailableSolutionStacksResultMessage#solution_stack_details #SolutionStackDetails} => Array<Types::SolutionStackDescription>
|
1463
|
+
#
|
1464
|
+
# @example Response structure
|
1465
|
+
# resp.solution_stacks #=> Array
|
1466
|
+
# resp.solution_stacks[0] #=> String
|
1467
|
+
# resp.solution_stack_details #=> Array
|
1468
|
+
# resp.solution_stack_details[0].solution_stack_name #=> String
|
1469
|
+
# resp.solution_stack_details[0].permitted_file_types #=> Array
|
1470
|
+
# resp.solution_stack_details[0].permitted_file_types[0] #=> String
|
1471
|
+
# @overload list_available_solution_stacks(params = {})
|
1472
|
+
# @param [Hash] params ({})
|
1473
|
+
def list_available_solution_stacks(params = {}, options = {})
|
1474
|
+
req = build_request(:list_available_solution_stacks, params)
|
1475
|
+
req.send_request(options)
|
1476
|
+
end
|
1477
|
+
|
1478
|
+
# Deletes and recreates all of the AWS resources (for example: the Auto
|
1479
|
+
# Scaling group, load balancer, etc.) for a specified environment and
|
1480
|
+
# forces a restart.
|
1481
|
+
# @option params [String] :environment_id
|
1482
|
+
# The ID of the environment to rebuild.
|
1483
|
+
#
|
1484
|
+
# Condition: You must specify either this or an EnvironmentName, or
|
1485
|
+
# both. If you do not specify either, AWS Elastic Beanstalk returns
|
1486
|
+
# `MissingRequiredParameter` error.
|
1487
|
+
# @option params [String] :environment_name
|
1488
|
+
# The name of the environment to rebuild.
|
1489
|
+
#
|
1490
|
+
# Condition: You must specify either this or an EnvironmentId, or both.
|
1491
|
+
# If you do not specify either, AWS Elastic Beanstalk returns
|
1492
|
+
# `MissingRequiredParameter` error.
|
1493
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1494
|
+
#
|
1495
|
+
# @example Request syntax with placeholder values
|
1496
|
+
# resp = client.rebuild_environment({
|
1497
|
+
# environment_id: "EnvironmentId",
|
1498
|
+
# environment_name: "EnvironmentName",
|
1499
|
+
# })
|
1500
|
+
# @overload rebuild_environment(params = {})
|
1501
|
+
# @param [Hash] params ({})
|
1502
|
+
def rebuild_environment(params = {}, options = {})
|
1503
|
+
req = build_request(:rebuild_environment, params)
|
1504
|
+
req.send_request(options)
|
1505
|
+
end
|
1506
|
+
|
1507
|
+
# Initiates a request to compile the specified type of information of
|
1508
|
+
# the deployed environment.
|
1509
|
+
#
|
1510
|
+
# Setting the `InfoType` to `tail` compiles the last lines from the
|
1511
|
+
# application server log files of every Amazon EC2 instance in your
|
1512
|
+
# environment.
|
1513
|
+
#
|
1514
|
+
# Setting the `InfoType` to `bundle` compresses the application server
|
1515
|
+
# log files for every Amazon EC2 instance into a `.zip` file. Legacy and
|
1516
|
+
# .NET containers do not support bundle logs.
|
1517
|
+
#
|
1518
|
+
# Use RetrieveEnvironmentInfo to obtain the set of logs.
|
1519
|
+
#
|
1520
|
+
# Related Topics
|
1521
|
+
#
|
1522
|
+
# * RetrieveEnvironmentInfo
|
1523
|
+
#
|
1524
|
+
# ^
|
1525
|
+
# @option params [String] :environment_id
|
1526
|
+
# The ID of the environment of the requested data.
|
1527
|
+
#
|
1528
|
+
# If no such environment is found, `RequestEnvironmentInfo` returns an
|
1529
|
+
# `InvalidParameterValue` error.
|
1530
|
+
#
|
1531
|
+
# Condition: You must specify either this or an EnvironmentName, or
|
1532
|
+
# both. If you do not specify either, AWS Elastic Beanstalk returns
|
1533
|
+
# `MissingRequiredParameter` error.
|
1534
|
+
# @option params [String] :environment_name
|
1535
|
+
# The name of the environment of the requested data.
|
1536
|
+
#
|
1537
|
+
# If no such environment is found, `RequestEnvironmentInfo` returns an
|
1538
|
+
# `InvalidParameterValue` error.
|
1539
|
+
#
|
1540
|
+
# Condition: You must specify either this or an EnvironmentId, or both.
|
1541
|
+
# If you do not specify either, AWS Elastic Beanstalk returns
|
1542
|
+
# `MissingRequiredParameter` error.
|
1543
|
+
# @option params [required, String] :info_type
|
1544
|
+
# The type of information to request.
|
1545
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1546
|
+
#
|
1547
|
+
# @example Request syntax with placeholder values
|
1548
|
+
# resp = client.request_environment_info({
|
1549
|
+
# environment_id: "EnvironmentId",
|
1550
|
+
# environment_name: "EnvironmentName",
|
1551
|
+
# info_type: "tail", # required, accepts tail, bundle
|
1552
|
+
# })
|
1553
|
+
# @overload request_environment_info(params = {})
|
1554
|
+
# @param [Hash] params ({})
|
1555
|
+
def request_environment_info(params = {}, options = {})
|
1556
|
+
req = build_request(:request_environment_info, params)
|
1557
|
+
req.send_request(options)
|
1558
|
+
end
|
1559
|
+
|
1560
|
+
# Causes the environment to restart the application container server
|
1561
|
+
# running on each Amazon EC2 instance.
|
1562
|
+
# @option params [String] :environment_id
|
1563
|
+
# The ID of the environment to restart the server for.
|
1564
|
+
#
|
1565
|
+
# Condition: You must specify either this or an EnvironmentName, or
|
1566
|
+
# both. If you do not specify either, AWS Elastic Beanstalk returns
|
1567
|
+
# `MissingRequiredParameter` error.
|
1568
|
+
# @option params [String] :environment_name
|
1569
|
+
# The name of the environment to restart the server for.
|
1570
|
+
#
|
1571
|
+
# Condition: You must specify either this or an EnvironmentId, or both.
|
1572
|
+
# If you do not specify either, AWS Elastic Beanstalk returns
|
1573
|
+
# `MissingRequiredParameter` error.
|
1574
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1575
|
+
#
|
1576
|
+
# @example Request syntax with placeholder values
|
1577
|
+
# resp = client.restart_app_server({
|
1578
|
+
# environment_id: "EnvironmentId",
|
1579
|
+
# environment_name: "EnvironmentName",
|
1580
|
+
# })
|
1581
|
+
# @overload restart_app_server(params = {})
|
1582
|
+
# @param [Hash] params ({})
|
1583
|
+
def restart_app_server(params = {}, options = {})
|
1584
|
+
req = build_request(:restart_app_server, params)
|
1585
|
+
req.send_request(options)
|
1586
|
+
end
|
1587
|
+
|
1588
|
+
# Retrieves the compiled information from a RequestEnvironmentInfo
|
1589
|
+
# request.
|
1590
|
+
#
|
1591
|
+
# Related Topics
|
1592
|
+
#
|
1593
|
+
# * RequestEnvironmentInfo
|
1594
|
+
#
|
1595
|
+
# ^
|
1596
|
+
# @option params [String] :environment_id
|
1597
|
+
# The ID of the data's environment.
|
1598
|
+
#
|
1599
|
+
# If no such environment is found, returns an `InvalidParameterValue`
|
1600
|
+
# error.
|
1601
|
+
#
|
1602
|
+
# Condition: You must specify either this or an EnvironmentName, or
|
1603
|
+
# both. If you do not specify either, AWS Elastic Beanstalk returns
|
1604
|
+
# `MissingRequiredParameter` error.
|
1605
|
+
# @option params [String] :environment_name
|
1606
|
+
# The name of the data's environment.
|
1607
|
+
#
|
1608
|
+
# If no such environment is found, returns an `InvalidParameterValue`
|
1609
|
+
# error.
|
1610
|
+
#
|
1611
|
+
# Condition: You must specify either this or an EnvironmentId, or both.
|
1612
|
+
# If you do not specify either, AWS Elastic Beanstalk returns
|
1613
|
+
# `MissingRequiredParameter` error.
|
1614
|
+
# @option params [required, String] :info_type
|
1615
|
+
# The type of information to retrieve.
|
1616
|
+
# @return [Types::RetrieveEnvironmentInfoResultMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1617
|
+
#
|
1618
|
+
# * {Types::RetrieveEnvironmentInfoResultMessage#environment_info #EnvironmentInfo} => Array<Types::EnvironmentInfoDescription>
|
1619
|
+
#
|
1620
|
+
# @example Request syntax with placeholder values
|
1621
|
+
# resp = client.retrieve_environment_info({
|
1622
|
+
# environment_id: "EnvironmentId",
|
1623
|
+
# environment_name: "EnvironmentName",
|
1624
|
+
# info_type: "tail", # required, accepts tail, bundle
|
1625
|
+
# })
|
1626
|
+
#
|
1627
|
+
# @example Response structure
|
1628
|
+
# resp.environment_info #=> Array
|
1629
|
+
# resp.environment_info[0].info_type #=> String, one of "tail", "bundle"
|
1630
|
+
# resp.environment_info[0].ec2_instance_id #=> String
|
1631
|
+
# resp.environment_info[0].sample_timestamp #=> Time
|
1632
|
+
# resp.environment_info[0].message #=> String
|
1633
|
+
# @overload retrieve_environment_info(params = {})
|
1634
|
+
# @param [Hash] params ({})
|
1635
|
+
def retrieve_environment_info(params = {}, options = {})
|
1636
|
+
req = build_request(:retrieve_environment_info, params)
|
1637
|
+
req.send_request(options)
|
1638
|
+
end
|
1639
|
+
|
1640
|
+
# Swaps the CNAMEs of two environments.
|
1641
|
+
# @option params [String] :source_environment_id
|
1642
|
+
# The ID of the source environment.
|
1643
|
+
#
|
1644
|
+
# Condition: You must specify at least the `SourceEnvironmentID` or the
|
1645
|
+
# `SourceEnvironmentName`. You may also specify both. If you specify the
|
1646
|
+
# `SourceEnvironmentId`, you must specify the
|
1647
|
+
# `DestinationEnvironmentId`.
|
1648
|
+
# @option params [String] :source_environment_name
|
1649
|
+
# The name of the source environment.
|
1650
|
+
#
|
1651
|
+
# Condition: You must specify at least the `SourceEnvironmentID` or the
|
1652
|
+
# `SourceEnvironmentName`. You may also specify both. If you specify the
|
1653
|
+
# `SourceEnvironmentName`, you must specify the
|
1654
|
+
# `DestinationEnvironmentName`.
|
1655
|
+
# @option params [String] :destination_environment_id
|
1656
|
+
# The ID of the destination environment.
|
1657
|
+
#
|
1658
|
+
# Condition: You must specify at least the `DestinationEnvironmentID` or
|
1659
|
+
# the `DestinationEnvironmentName`. You may also specify both. You must
|
1660
|
+
# specify the `SourceEnvironmentId` with the `DestinationEnvironmentId`.
|
1661
|
+
# @option params [String] :destination_environment_name
|
1662
|
+
# The name of the destination environment.
|
1663
|
+
#
|
1664
|
+
# Condition: You must specify at least the `DestinationEnvironmentID` or
|
1665
|
+
# the `DestinationEnvironmentName`. You may also specify both. You must
|
1666
|
+
# specify the `SourceEnvironmentName` with the
|
1667
|
+
# `DestinationEnvironmentName`.
|
1668
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1669
|
+
#
|
1670
|
+
# @example Request syntax with placeholder values
|
1671
|
+
# resp = client.swap_environment_cnames({
|
1672
|
+
# source_environment_id: "EnvironmentId",
|
1673
|
+
# source_environment_name: "EnvironmentName",
|
1674
|
+
# destination_environment_id: "EnvironmentId",
|
1675
|
+
# destination_environment_name: "EnvironmentName",
|
1676
|
+
# })
|
1677
|
+
# @overload swap_environment_cnames(params = {})
|
1678
|
+
# @param [Hash] params ({})
|
1679
|
+
def swap_environment_cnames(params = {}, options = {})
|
1680
|
+
req = build_request(:swap_environment_cnames, params)
|
1681
|
+
req.send_request(options)
|
1682
|
+
end
|
1683
|
+
|
1684
|
+
# Terminates the specified environment.
|
1685
|
+
# @option params [String] :environment_id
|
1686
|
+
# The ID of the environment to terminate.
|
1687
|
+
#
|
1688
|
+
# Condition: You must specify either this or an EnvironmentName, or
|
1689
|
+
# both. If you do not specify either, AWS Elastic Beanstalk returns
|
1690
|
+
# `MissingRequiredParameter` error.
|
1691
|
+
# @option params [String] :environment_name
|
1692
|
+
# The name of the environment to terminate.
|
1693
|
+
#
|
1694
|
+
# Condition: You must specify either this or an EnvironmentId, or both.
|
1695
|
+
# If you do not specify either, AWS Elastic Beanstalk returns
|
1696
|
+
# `MissingRequiredParameter` error.
|
1697
|
+
# @option params [Boolean] :terminate_resources
|
1698
|
+
# Indicates whether the associated AWS resources should shut down when
|
1699
|
+
# the environment is terminated:
|
1700
|
+
#
|
1701
|
+
# * `true`\: The specified environment as well as the associated AWS
|
1702
|
+
# resources, such as Auto Scaling group and LoadBalancer, are
|
1703
|
+
# terminated.
|
1704
|
+
#
|
1705
|
+
# * `false`\: AWS Elastic Beanstalk resource management is removed from
|
1706
|
+
# the environment, but the AWS resources continue to operate.
|
1707
|
+
#
|
1708
|
+
# For more information, see the [ AWS Elastic Beanstalk User Guide. ][1]
|
1709
|
+
#
|
1710
|
+
# Default: `true`
|
1711
|
+
#
|
1712
|
+
# Valid Values: `true` \| `false`
|
1713
|
+
#
|
1714
|
+
#
|
1715
|
+
#
|
1716
|
+
# [1]: http://docs.aws.amazon.com/elasticbeanstalk/latest/ug/
|
1717
|
+
# @option params [Boolean] :force_terminate
|
1718
|
+
# Terminates the target environment even if another environment in the
|
1719
|
+
# same group is dependent on it.
|
1720
|
+
# @return [Types::EnvironmentDescription] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1721
|
+
#
|
1722
|
+
# * {Types::EnvironmentDescription#environment_name #EnvironmentName} => String
|
1723
|
+
# * {Types::EnvironmentDescription#environment_id #EnvironmentId} => String
|
1724
|
+
# * {Types::EnvironmentDescription#application_name #ApplicationName} => String
|
1725
|
+
# * {Types::EnvironmentDescription#version_label #VersionLabel} => String
|
1726
|
+
# * {Types::EnvironmentDescription#solution_stack_name #SolutionStackName} => String
|
1727
|
+
# * {Types::EnvironmentDescription#template_name #TemplateName} => String
|
1728
|
+
# * {Types::EnvironmentDescription#description #Description} => String
|
1729
|
+
# * {Types::EnvironmentDescription#endpoint_url #EndpointURL} => String
|
1730
|
+
# * {Types::EnvironmentDescription#cname #CNAME} => String
|
1731
|
+
# * {Types::EnvironmentDescription#date_created #DateCreated} => Time
|
1732
|
+
# * {Types::EnvironmentDescription#date_updated #DateUpdated} => Time
|
1733
|
+
# * {Types::EnvironmentDescription#status #Status} => String
|
1734
|
+
# * {Types::EnvironmentDescription#abortable_operation_in_progress #AbortableOperationInProgress} => Boolean
|
1735
|
+
# * {Types::EnvironmentDescription#health #Health} => String
|
1736
|
+
# * {Types::EnvironmentDescription#health_status #HealthStatus} => String
|
1737
|
+
# * {Types::EnvironmentDescription#resources #Resources} => Types::EnvironmentResourcesDescription
|
1738
|
+
# * {Types::EnvironmentDescription#tier #Tier} => Types::EnvironmentTier
|
1739
|
+
# * {Types::EnvironmentDescription#environment_links #EnvironmentLinks} => Array<Types::EnvironmentLink>
|
1740
|
+
#
|
1741
|
+
# @example Request syntax with placeholder values
|
1742
|
+
# resp = client.terminate_environment({
|
1743
|
+
# environment_id: "EnvironmentId",
|
1744
|
+
# environment_name: "EnvironmentName",
|
1745
|
+
# terminate_resources: false,
|
1746
|
+
# force_terminate: false,
|
1747
|
+
# })
|
1748
|
+
#
|
1749
|
+
# @example Response structure
|
1750
|
+
# resp.environment_name #=> String
|
1751
|
+
# resp.environment_id #=> String
|
1752
|
+
# resp.application_name #=> String
|
1753
|
+
# resp.version_label #=> String
|
1754
|
+
# resp.solution_stack_name #=> String
|
1755
|
+
# resp.template_name #=> String
|
1756
|
+
# resp.description #=> String
|
1757
|
+
# resp.endpoint_url #=> String
|
1758
|
+
# resp.cname #=> String
|
1759
|
+
# resp.date_created #=> Time
|
1760
|
+
# resp.date_updated #=> Time
|
1761
|
+
# resp.status #=> String, one of "Launching", "Updating", "Ready", "Terminating", "Terminated"
|
1762
|
+
# resp.abortable_operation_in_progress #=> Boolean
|
1763
|
+
# resp.health #=> String, one of "Green", "Yellow", "Red", "Grey"
|
1764
|
+
# resp.health_status #=> String, one of "NoData", "Unknown", "Pending", "Ok", "Info", "Warning", "Degraded", "Severe"
|
1765
|
+
# resp.resources.load_balancer.load_balancer_name #=> String
|
1766
|
+
# resp.resources.load_balancer.domain #=> String
|
1767
|
+
# resp.resources.load_balancer.listeners #=> Array
|
1768
|
+
# resp.resources.load_balancer.listeners[0].protocol #=> String
|
1769
|
+
# resp.resources.load_balancer.listeners[0].port #=> Integer
|
1770
|
+
# resp.tier.name #=> String
|
1771
|
+
# resp.tier.type #=> String
|
1772
|
+
# resp.tier.version #=> String
|
1773
|
+
# resp.environment_links #=> Array
|
1774
|
+
# resp.environment_links[0].link_name #=> String
|
1775
|
+
# resp.environment_links[0].environment_name #=> String
|
1776
|
+
# @overload terminate_environment(params = {})
|
1777
|
+
# @param [Hash] params ({})
|
1778
|
+
def terminate_environment(params = {}, options = {})
|
1779
|
+
req = build_request(:terminate_environment, params)
|
1780
|
+
req.send_request(options)
|
1781
|
+
end
|
1782
|
+
|
1783
|
+
# Updates the specified application to have the specified properties.
|
1784
|
+
#
|
1785
|
+
# <note markdown="1"> If a property (for example, `description`) is not provided, the value
|
1786
|
+
# remains unchanged. To clear these properties, specify an empty string.
|
1787
|
+
#
|
1788
|
+
# </note>
|
1789
|
+
# @option params [required, String] :application_name
|
1790
|
+
# The name of the application to update. If no such application is
|
1791
|
+
# found, `UpdateApplication` returns an `InvalidParameterValue` error.
|
1792
|
+
# @option params [String] :description
|
1793
|
+
# A new description for the application.
|
1794
|
+
#
|
1795
|
+
# Default: If not specified, AWS Elastic Beanstalk does not update the
|
1796
|
+
# description.
|
1797
|
+
# @return [Types::ApplicationDescriptionMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1798
|
+
#
|
1799
|
+
# * {Types::ApplicationDescriptionMessage#application #Application} => Types::ApplicationDescription
|
1800
|
+
#
|
1801
|
+
# @example Request syntax with placeholder values
|
1802
|
+
# resp = client.update_application({
|
1803
|
+
# application_name: "ApplicationName", # required
|
1804
|
+
# description: "Description",
|
1805
|
+
# })
|
1806
|
+
#
|
1807
|
+
# @example Response structure
|
1808
|
+
# resp.application.application_name #=> String
|
1809
|
+
# resp.application.description #=> String
|
1810
|
+
# resp.application.date_created #=> Time
|
1811
|
+
# resp.application.date_updated #=> Time
|
1812
|
+
# resp.application.versions #=> Array
|
1813
|
+
# resp.application.versions[0] #=> String
|
1814
|
+
# resp.application.configuration_templates #=> Array
|
1815
|
+
# resp.application.configuration_templates[0] #=> String
|
1816
|
+
# @overload update_application(params = {})
|
1817
|
+
# @param [Hash] params ({})
|
1818
|
+
def update_application(params = {}, options = {})
|
1819
|
+
req = build_request(:update_application, params)
|
1820
|
+
req.send_request(options)
|
1821
|
+
end
|
1822
|
+
|
1823
|
+
# Updates the specified application version to have the specified
|
1824
|
+
# properties.
|
1825
|
+
#
|
1826
|
+
# <note markdown="1"> If a property (for example, `description`) is not provided, the value
|
1827
|
+
# remains unchanged. To clear properties, specify an empty string.
|
1828
|
+
#
|
1829
|
+
# </note>
|
1830
|
+
# @option params [required, String] :application_name
|
1831
|
+
# The name of the application associated with this version.
|
1832
|
+
#
|
1833
|
+
# If no application is found with this name, `UpdateApplication` returns
|
1834
|
+
# an `InvalidParameterValue` error.
|
1835
|
+
# @option params [required, String] :version_label
|
1836
|
+
# The name of the version to update.
|
1837
|
+
#
|
1838
|
+
# If no application version is found with this label,
|
1839
|
+
# `UpdateApplication` returns an `InvalidParameterValue` error.
|
1840
|
+
# @option params [String] :description
|
1841
|
+
# A new description for this release.
|
1842
|
+
# @return [Types::ApplicationVersionDescriptionMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1843
|
+
#
|
1844
|
+
# * {Types::ApplicationVersionDescriptionMessage#application_version #ApplicationVersion} => Types::ApplicationVersionDescription
|
1845
|
+
#
|
1846
|
+
# @example Request syntax with placeholder values
|
1847
|
+
# resp = client.update_application_version({
|
1848
|
+
# application_name: "ApplicationName", # required
|
1849
|
+
# version_label: "VersionLabel", # required
|
1850
|
+
# description: "Description",
|
1851
|
+
# })
|
1852
|
+
#
|
1853
|
+
# @example Response structure
|
1854
|
+
# resp.application_version.application_name #=> String
|
1855
|
+
# resp.application_version.description #=> String
|
1856
|
+
# resp.application_version.version_label #=> String
|
1857
|
+
# resp.application_version.source_build_information.source_type #=> String, one of "Git"
|
1858
|
+
# resp.application_version.source_build_information.source_repository #=> String, one of "CodeCommit"
|
1859
|
+
# resp.application_version.source_build_information.source_location #=> String
|
1860
|
+
# resp.application_version.source_bundle.s3_bucket #=> String
|
1861
|
+
# resp.application_version.source_bundle.s3_key #=> String
|
1862
|
+
# resp.application_version.date_created #=> Time
|
1863
|
+
# resp.application_version.date_updated #=> Time
|
1864
|
+
# resp.application_version.status #=> String, one of "Processed", "Unprocessed", "Failed", "Processing"
|
1865
|
+
# @overload update_application_version(params = {})
|
1866
|
+
# @param [Hash] params ({})
|
1867
|
+
def update_application_version(params = {}, options = {})
|
1868
|
+
req = build_request(:update_application_version, params)
|
1869
|
+
req.send_request(options)
|
1870
|
+
end
|
1871
|
+
|
1872
|
+
# Updates the specified configuration template to have the specified
|
1873
|
+
# properties or configuration option values.
|
1874
|
+
#
|
1875
|
+
# <note markdown="1"> If a property (for example, `ApplicationName`) is not provided, its
|
1876
|
+
# value remains unchanged. To clear such properties, specify an empty
|
1877
|
+
# string.
|
1878
|
+
#
|
1879
|
+
# </note>
|
1880
|
+
#
|
1881
|
+
# Related Topics
|
1882
|
+
#
|
1883
|
+
# * DescribeConfigurationOptions
|
1884
|
+
#
|
1885
|
+
# ^
|
1886
|
+
# @option params [required, String] :application_name
|
1887
|
+
# The name of the application associated with the configuration template
|
1888
|
+
# to update.
|
1889
|
+
#
|
1890
|
+
# If no application is found with this name,
|
1891
|
+
# `UpdateConfigurationTemplate` returns an `InvalidParameterValue`
|
1892
|
+
# error.
|
1893
|
+
# @option params [required, String] :template_name
|
1894
|
+
# The name of the configuration template to update.
|
1895
|
+
#
|
1896
|
+
# If no configuration template is found with this name,
|
1897
|
+
# `UpdateConfigurationTemplate` returns an `InvalidParameterValue`
|
1898
|
+
# error.
|
1899
|
+
# @option params [String] :description
|
1900
|
+
# A new description for the configuration.
|
1901
|
+
# @option params [Array<Types::ConfigurationOptionSetting>] :option_settings
|
1902
|
+
# A list of configuration option settings to update with the new
|
1903
|
+
# specified option value.
|
1904
|
+
# @option params [Array<Types::OptionSpecification>] :options_to_remove
|
1905
|
+
# A list of configuration options to remove from the configuration set.
|
1906
|
+
#
|
1907
|
+
# Constraint: You can remove only `UserDefined` configuration options.
|
1908
|
+
# @return [Types::ConfigurationSettingsDescription] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1909
|
+
#
|
1910
|
+
# * {Types::ConfigurationSettingsDescription#solution_stack_name #SolutionStackName} => String
|
1911
|
+
# * {Types::ConfigurationSettingsDescription#application_name #ApplicationName} => String
|
1912
|
+
# * {Types::ConfigurationSettingsDescription#template_name #TemplateName} => String
|
1913
|
+
# * {Types::ConfigurationSettingsDescription#description #Description} => String
|
1914
|
+
# * {Types::ConfigurationSettingsDescription#environment_name #EnvironmentName} => String
|
1915
|
+
# * {Types::ConfigurationSettingsDescription#deployment_status #DeploymentStatus} => String
|
1916
|
+
# * {Types::ConfigurationSettingsDescription#date_created #DateCreated} => Time
|
1917
|
+
# * {Types::ConfigurationSettingsDescription#date_updated #DateUpdated} => Time
|
1918
|
+
# * {Types::ConfigurationSettingsDescription#option_settings #OptionSettings} => Array<Types::ConfigurationOptionSetting>
|
1919
|
+
#
|
1920
|
+
# @example Request syntax with placeholder values
|
1921
|
+
# resp = client.update_configuration_template({
|
1922
|
+
# application_name: "ApplicationName", # required
|
1923
|
+
# template_name: "ConfigurationTemplateName", # required
|
1924
|
+
# description: "Description",
|
1925
|
+
# option_settings: [
|
1926
|
+
# {
|
1927
|
+
# resource_name: "ResourceName",
|
1928
|
+
# namespace: "OptionNamespace",
|
1929
|
+
# option_name: "ConfigurationOptionName",
|
1930
|
+
# value: "ConfigurationOptionValue",
|
1931
|
+
# },
|
1932
|
+
# ],
|
1933
|
+
# options_to_remove: [
|
1934
|
+
# {
|
1935
|
+
# resource_name: "ResourceName",
|
1936
|
+
# namespace: "OptionNamespace",
|
1937
|
+
# option_name: "ConfigurationOptionName",
|
1938
|
+
# },
|
1939
|
+
# ],
|
1940
|
+
# })
|
1941
|
+
#
|
1942
|
+
# @example Response structure
|
1943
|
+
# resp.solution_stack_name #=> String
|
1944
|
+
# resp.application_name #=> String
|
1945
|
+
# resp.template_name #=> String
|
1946
|
+
# resp.description #=> String
|
1947
|
+
# resp.environment_name #=> String
|
1948
|
+
# resp.deployment_status #=> String, one of "deployed", "pending", "failed"
|
1949
|
+
# resp.date_created #=> Time
|
1950
|
+
# resp.date_updated #=> Time
|
1951
|
+
# resp.option_settings #=> Array
|
1952
|
+
# resp.option_settings[0].resource_name #=> String
|
1953
|
+
# resp.option_settings[0].namespace #=> String
|
1954
|
+
# resp.option_settings[0].option_name #=> String
|
1955
|
+
# resp.option_settings[0].value #=> String
|
1956
|
+
# @overload update_configuration_template(params = {})
|
1957
|
+
# @param [Hash] params ({})
|
1958
|
+
def update_configuration_template(params = {}, options = {})
|
1959
|
+
req = build_request(:update_configuration_template, params)
|
1960
|
+
req.send_request(options)
|
1961
|
+
end
|
1962
|
+
|
1963
|
+
# Updates the environment description, deploys a new application
|
1964
|
+
# version, updates the configuration settings to an entirely new
|
1965
|
+
# configuration template, or updates select configuration option values
|
1966
|
+
# in the running environment.
|
1967
|
+
#
|
1968
|
+
# Attempting to update both the release and configuration is not allowed
|
1969
|
+
# and AWS Elastic Beanstalk returns an `InvalidParameterCombination`
|
1970
|
+
# error.
|
1971
|
+
#
|
1972
|
+
# When updating the configuration settings to a new template or
|
1973
|
+
# individual settings, a draft configuration is created and
|
1974
|
+
# DescribeConfigurationSettings for this environment returns two setting
|
1975
|
+
# descriptions with different `DeploymentStatus` values.
|
1976
|
+
# @option params [String] :application_name
|
1977
|
+
# The name of the application with which the environment is associated.
|
1978
|
+
# @option params [String] :environment_id
|
1979
|
+
# The ID of the environment to update.
|
1980
|
+
#
|
1981
|
+
# If no environment with this ID exists, AWS Elastic Beanstalk returns
|
1982
|
+
# an `InvalidParameterValue` error.
|
1983
|
+
#
|
1984
|
+
# Condition: You must specify either this or an EnvironmentName, or
|
1985
|
+
# both. If you do not specify either, AWS Elastic Beanstalk returns
|
1986
|
+
# `MissingRequiredParameter` error.
|
1987
|
+
# @option params [String] :environment_name
|
1988
|
+
# The name of the environment to update. If no environment with this
|
1989
|
+
# name exists, AWS Elastic Beanstalk returns an `InvalidParameterValue`
|
1990
|
+
# error.
|
1991
|
+
#
|
1992
|
+
# Condition: You must specify either this or an EnvironmentId, or both.
|
1993
|
+
# If you do not specify either, AWS Elastic Beanstalk returns
|
1994
|
+
# `MissingRequiredParameter` error.
|
1995
|
+
# @option params [String] :group_name
|
1996
|
+
# The name of the group to which the target environment belongs. Specify
|
1997
|
+
# a group name only if the environment's name is specified in an
|
1998
|
+
# environment manifest and not with the environment name or environment
|
1999
|
+
# ID parameters. See [Environment Manifest (env.yaml)][1] for details.
|
2000
|
+
#
|
2001
|
+
#
|
2002
|
+
#
|
2003
|
+
# [1]: http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html
|
2004
|
+
# @option params [String] :description
|
2005
|
+
# If this parameter is specified, AWS Elastic Beanstalk updates the
|
2006
|
+
# description of this environment.
|
2007
|
+
# @option params [Types::EnvironmentTier] :tier
|
2008
|
+
# This specifies the tier to use to update the environment.
|
2009
|
+
#
|
2010
|
+
# Condition: At this time, if you change the tier version, name, or
|
2011
|
+
# type, AWS Elastic Beanstalk returns `InvalidParameterValue` error.
|
2012
|
+
# @option params [String] :version_label
|
2013
|
+
# If this parameter is specified, AWS Elastic Beanstalk deploys the
|
2014
|
+
# named application version to the environment. If no such application
|
2015
|
+
# version is found, returns an `InvalidParameterValue` error.
|
2016
|
+
# @option params [String] :template_name
|
2017
|
+
# If this parameter is specified, AWS Elastic Beanstalk deploys this
|
2018
|
+
# configuration template to the environment. If no such configuration
|
2019
|
+
# template is found, AWS Elastic Beanstalk returns an
|
2020
|
+
# `InvalidParameterValue` error.
|
2021
|
+
# @option params [String] :solution_stack_name
|
2022
|
+
# This specifies the platform version that the environment will run
|
2023
|
+
# after the environment is updated.
|
2024
|
+
# @option params [Array<Types::ConfigurationOptionSetting>] :option_settings
|
2025
|
+
# If specified, AWS Elastic Beanstalk updates the configuration set
|
2026
|
+
# associated with the running environment and sets the specified
|
2027
|
+
# configuration options to the requested value.
|
2028
|
+
# @option params [Array<Types::OptionSpecification>] :options_to_remove
|
2029
|
+
# A list of custom user-defined configuration options to remove from the
|
2030
|
+
# configuration set for this environment.
|
2031
|
+
# @return [Types::EnvironmentDescription] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2032
|
+
#
|
2033
|
+
# * {Types::EnvironmentDescription#environment_name #EnvironmentName} => String
|
2034
|
+
# * {Types::EnvironmentDescription#environment_id #EnvironmentId} => String
|
2035
|
+
# * {Types::EnvironmentDescription#application_name #ApplicationName} => String
|
2036
|
+
# * {Types::EnvironmentDescription#version_label #VersionLabel} => String
|
2037
|
+
# * {Types::EnvironmentDescription#solution_stack_name #SolutionStackName} => String
|
2038
|
+
# * {Types::EnvironmentDescription#template_name #TemplateName} => String
|
2039
|
+
# * {Types::EnvironmentDescription#description #Description} => String
|
2040
|
+
# * {Types::EnvironmentDescription#endpoint_url #EndpointURL} => String
|
2041
|
+
# * {Types::EnvironmentDescription#cname #CNAME} => String
|
2042
|
+
# * {Types::EnvironmentDescription#date_created #DateCreated} => Time
|
2043
|
+
# * {Types::EnvironmentDescription#date_updated #DateUpdated} => Time
|
2044
|
+
# * {Types::EnvironmentDescription#status #Status} => String
|
2045
|
+
# * {Types::EnvironmentDescription#abortable_operation_in_progress #AbortableOperationInProgress} => Boolean
|
2046
|
+
# * {Types::EnvironmentDescription#health #Health} => String
|
2047
|
+
# * {Types::EnvironmentDescription#health_status #HealthStatus} => String
|
2048
|
+
# * {Types::EnvironmentDescription#resources #Resources} => Types::EnvironmentResourcesDescription
|
2049
|
+
# * {Types::EnvironmentDescription#tier #Tier} => Types::EnvironmentTier
|
2050
|
+
# * {Types::EnvironmentDescription#environment_links #EnvironmentLinks} => Array<Types::EnvironmentLink>
|
2051
|
+
#
|
2052
|
+
# @example Request syntax with placeholder values
|
2053
|
+
# resp = client.update_environment({
|
2054
|
+
# application_name: "ApplicationName",
|
2055
|
+
# environment_id: "EnvironmentId",
|
2056
|
+
# environment_name: "EnvironmentName",
|
2057
|
+
# group_name: "GroupName",
|
2058
|
+
# description: "Description",
|
2059
|
+
# tier: {
|
2060
|
+
# name: "String",
|
2061
|
+
# type: "String",
|
2062
|
+
# version: "String",
|
2063
|
+
# },
|
2064
|
+
# version_label: "VersionLabel",
|
2065
|
+
# template_name: "ConfigurationTemplateName",
|
2066
|
+
# solution_stack_name: "SolutionStackName",
|
2067
|
+
# option_settings: [
|
2068
|
+
# {
|
2069
|
+
# resource_name: "ResourceName",
|
2070
|
+
# namespace: "OptionNamespace",
|
2071
|
+
# option_name: "ConfigurationOptionName",
|
2072
|
+
# value: "ConfigurationOptionValue",
|
2073
|
+
# },
|
2074
|
+
# ],
|
2075
|
+
# options_to_remove: [
|
2076
|
+
# {
|
2077
|
+
# resource_name: "ResourceName",
|
2078
|
+
# namespace: "OptionNamespace",
|
2079
|
+
# option_name: "ConfigurationOptionName",
|
2080
|
+
# },
|
2081
|
+
# ],
|
2082
|
+
# })
|
2083
|
+
#
|
2084
|
+
# @example Response structure
|
2085
|
+
# resp.environment_name #=> String
|
2086
|
+
# resp.environment_id #=> String
|
2087
|
+
# resp.application_name #=> String
|
2088
|
+
# resp.version_label #=> String
|
2089
|
+
# resp.solution_stack_name #=> String
|
2090
|
+
# resp.template_name #=> String
|
2091
|
+
# resp.description #=> String
|
2092
|
+
# resp.endpoint_url #=> String
|
2093
|
+
# resp.cname #=> String
|
2094
|
+
# resp.date_created #=> Time
|
2095
|
+
# resp.date_updated #=> Time
|
2096
|
+
# resp.status #=> String, one of "Launching", "Updating", "Ready", "Terminating", "Terminated"
|
2097
|
+
# resp.abortable_operation_in_progress #=> Boolean
|
2098
|
+
# resp.health #=> String, one of "Green", "Yellow", "Red", "Grey"
|
2099
|
+
# resp.health_status #=> String, one of "NoData", "Unknown", "Pending", "Ok", "Info", "Warning", "Degraded", "Severe"
|
2100
|
+
# resp.resources.load_balancer.load_balancer_name #=> String
|
2101
|
+
# resp.resources.load_balancer.domain #=> String
|
2102
|
+
# resp.resources.load_balancer.listeners #=> Array
|
2103
|
+
# resp.resources.load_balancer.listeners[0].protocol #=> String
|
2104
|
+
# resp.resources.load_balancer.listeners[0].port #=> Integer
|
2105
|
+
# resp.tier.name #=> String
|
2106
|
+
# resp.tier.type #=> String
|
2107
|
+
# resp.tier.version #=> String
|
2108
|
+
# resp.environment_links #=> Array
|
2109
|
+
# resp.environment_links[0].link_name #=> String
|
2110
|
+
# resp.environment_links[0].environment_name #=> String
|
2111
|
+
# @overload update_environment(params = {})
|
2112
|
+
# @param [Hash] params ({})
|
2113
|
+
def update_environment(params = {}, options = {})
|
2114
|
+
req = build_request(:update_environment, params)
|
2115
|
+
req.send_request(options)
|
2116
|
+
end
|
2117
|
+
|
2118
|
+
# Takes a set of configuration settings and either a configuration
|
2119
|
+
# template or environment, and determines whether those values are
|
2120
|
+
# valid.
|
2121
|
+
#
|
2122
|
+
# This action returns a list of messages indicating any errors or
|
2123
|
+
# warnings associated with the selection of option values.
|
2124
|
+
# @option params [required, String] :application_name
|
2125
|
+
# The name of the application that the configuration template or
|
2126
|
+
# environment belongs to.
|
2127
|
+
# @option params [String] :template_name
|
2128
|
+
# The name of the configuration template to validate the settings
|
2129
|
+
# against.
|
2130
|
+
#
|
2131
|
+
# Condition: You cannot specify both this and an environment name.
|
2132
|
+
# @option params [String] :environment_name
|
2133
|
+
# The name of the environment to validate the settings against.
|
2134
|
+
#
|
2135
|
+
# Condition: You cannot specify both this and a configuration template
|
2136
|
+
# name.
|
2137
|
+
# @option params [required, Array<Types::ConfigurationOptionSetting>] :option_settings
|
2138
|
+
# A list of the options and desired values to evaluate.
|
2139
|
+
# @return [Types::ConfigurationSettingsValidationMessages] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2140
|
+
#
|
2141
|
+
# * {Types::ConfigurationSettingsValidationMessages#messages #Messages} => Array<Types::ValidationMessage>
|
2142
|
+
#
|
2143
|
+
# @example Request syntax with placeholder values
|
2144
|
+
# resp = client.validate_configuration_settings({
|
2145
|
+
# application_name: "ApplicationName", # required
|
2146
|
+
# template_name: "ConfigurationTemplateName",
|
2147
|
+
# environment_name: "EnvironmentName",
|
2148
|
+
# option_settings: [ # required
|
2149
|
+
# {
|
2150
|
+
# resource_name: "ResourceName",
|
2151
|
+
# namespace: "OptionNamespace",
|
2152
|
+
# option_name: "ConfigurationOptionName",
|
2153
|
+
# value: "ConfigurationOptionValue",
|
2154
|
+
# },
|
2155
|
+
# ],
|
2156
|
+
# })
|
2157
|
+
#
|
2158
|
+
# @example Response structure
|
2159
|
+
# resp.messages #=> Array
|
2160
|
+
# resp.messages[0].message #=> String
|
2161
|
+
# resp.messages[0].severity #=> String, one of "error", "warning"
|
2162
|
+
# resp.messages[0].namespace #=> String
|
2163
|
+
# resp.messages[0].option_name #=> String
|
2164
|
+
# @overload validate_configuration_settings(params = {})
|
2165
|
+
# @param [Hash] params ({})
|
2166
|
+
def validate_configuration_settings(params = {}, options = {})
|
2167
|
+
req = build_request(:validate_configuration_settings, params)
|
2168
|
+
req.send_request(options)
|
2169
|
+
end
|
2170
|
+
|
2171
|
+
# @!endgroup
|
2172
|
+
|
2173
|
+
# @param params ({})
|
2174
|
+
# @api private
|
2175
|
+
def build_request(operation_name, params = {})
|
2176
|
+
handlers = @handlers.for(operation_name)
|
2177
|
+
context = Seahorse::Client::RequestContext.new(
|
2178
|
+
operation_name: operation_name,
|
2179
|
+
operation: config.api.operation(operation_name),
|
2180
|
+
client: self,
|
2181
|
+
params: params,
|
2182
|
+
config: config)
|
2183
|
+
context[:gem_name] = 'aws-sdk-elasticbeanstalk'
|
2184
|
+
context[:gem_version] = '1.0.0.rc1'
|
2185
|
+
Seahorse::Client::Request.new(handlers, context)
|
2186
|
+
end
|
2187
|
+
|
2188
|
+
# @api private
|
2189
|
+
# @deprecated
|
2190
|
+
def waiter_names
|
2191
|
+
[]
|
2192
|
+
end
|
2193
|
+
|
2194
|
+
class << self
|
2195
|
+
|
2196
|
+
# @api private
|
2197
|
+
attr_reader :identifier
|
2198
|
+
|
2199
|
+
# @api private
|
2200
|
+
def errors_module
|
2201
|
+
Errors
|
2202
|
+
end
|
2203
|
+
|
2204
|
+
end
|
2205
|
+
end
|
2206
|
+
end
|
2207
|
+
end
|