aws-sdk-appconfig 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/lib/aws-sdk-appconfig.rb +47 -0
- data/lib/aws-sdk-appconfig/client.rb +1731 -0
- data/lib/aws-sdk-appconfig/client_api.rb +765 -0
- data/lib/aws-sdk-appconfig/customizations.rb +0 -0
- data/lib/aws-sdk-appconfig/errors.rb +83 -0
- data/lib/aws-sdk-appconfig/resource.rb +23 -0
- data/lib/aws-sdk-appconfig/types.rb +1588 -0
- metadata +88 -0
checksums.yaml
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
---
|
|
2
|
+
SHA1:
|
|
3
|
+
metadata.gz: ca85ac98a2c788816fc630799be3ed292e474ab3
|
|
4
|
+
data.tar.gz: 468a4e589743c44b926ca0af6b2c914e3216f9d5
|
|
5
|
+
SHA512:
|
|
6
|
+
metadata.gz: 2397bbd6c13b2450753ce16eececec8aa55dcc750c12009c505f4f073cf286ded523189b50a35b2e34eb8bffb3ededaf7912408fbd4e28163c9c6d58f29b013d
|
|
7
|
+
data.tar.gz: f6d13286b283792bf52d30f652d81783c6a6dd333727c76165cf196fe433deadbe0aa7c2f4646f38ec20249fcad3b87805bf875f62d33f499f33a75aca32cd26
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
|
2
|
+
#
|
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
|
5
|
+
#
|
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
|
7
|
+
|
|
8
|
+
require 'aws-sdk-core'
|
|
9
|
+
require 'aws-sigv4'
|
|
10
|
+
|
|
11
|
+
require_relative 'aws-sdk-appconfig/types'
|
|
12
|
+
require_relative 'aws-sdk-appconfig/client_api'
|
|
13
|
+
require_relative 'aws-sdk-appconfig/client'
|
|
14
|
+
require_relative 'aws-sdk-appconfig/errors'
|
|
15
|
+
require_relative 'aws-sdk-appconfig/resource'
|
|
16
|
+
require_relative 'aws-sdk-appconfig/customizations'
|
|
17
|
+
|
|
18
|
+
# This module provides support for Amazon AppConfig. This module is available in the
|
|
19
|
+
# `aws-sdk-appconfig` 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 Amazon AppConfig all
|
|
32
|
+
# extend {Errors::ServiceError}.
|
|
33
|
+
#
|
|
34
|
+
# begin
|
|
35
|
+
# # do stuff
|
|
36
|
+
# rescue Aws::AppConfig::Errors::ServiceError
|
|
37
|
+
# # rescues all service API errors
|
|
38
|
+
# end
|
|
39
|
+
#
|
|
40
|
+
# See {Errors} for more information.
|
|
41
|
+
#
|
|
42
|
+
# @service
|
|
43
|
+
module Aws::AppConfig
|
|
44
|
+
|
|
45
|
+
GEM_VERSION = '1.0.0'
|
|
46
|
+
|
|
47
|
+
end
|
|
@@ -0,0 +1,1731 @@
|
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
|
2
|
+
#
|
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
|
5
|
+
#
|
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
|
7
|
+
|
|
8
|
+
require 'seahorse/client/plugins/content_length.rb'
|
|
9
|
+
require 'aws-sdk-core/plugins/credentials_configuration.rb'
|
|
10
|
+
require 'aws-sdk-core/plugins/logging.rb'
|
|
11
|
+
require 'aws-sdk-core/plugins/param_converter.rb'
|
|
12
|
+
require 'aws-sdk-core/plugins/param_validator.rb'
|
|
13
|
+
require 'aws-sdk-core/plugins/user_agent.rb'
|
|
14
|
+
require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
|
|
15
|
+
require 'aws-sdk-core/plugins/retry_errors.rb'
|
|
16
|
+
require 'aws-sdk-core/plugins/global_configuration.rb'
|
|
17
|
+
require 'aws-sdk-core/plugins/regional_endpoint.rb'
|
|
18
|
+
require 'aws-sdk-core/plugins/endpoint_discovery.rb'
|
|
19
|
+
require 'aws-sdk-core/plugins/endpoint_pattern.rb'
|
|
20
|
+
require 'aws-sdk-core/plugins/response_paging.rb'
|
|
21
|
+
require 'aws-sdk-core/plugins/stub_responses.rb'
|
|
22
|
+
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
|
23
|
+
require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
|
24
|
+
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
|
25
|
+
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
|
26
|
+
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
|
27
|
+
require 'aws-sdk-core/plugins/signature_v4.rb'
|
|
28
|
+
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
|
29
|
+
|
|
30
|
+
Aws::Plugins::GlobalConfiguration.add_identifier(:appconfig)
|
|
31
|
+
|
|
32
|
+
module Aws::AppConfig
|
|
33
|
+
class Client < Seahorse::Client::Base
|
|
34
|
+
|
|
35
|
+
include Aws::ClientStubs
|
|
36
|
+
|
|
37
|
+
@identifier = :appconfig
|
|
38
|
+
|
|
39
|
+
set_api(ClientApi::API)
|
|
40
|
+
|
|
41
|
+
add_plugin(Seahorse::Client::Plugins::ContentLength)
|
|
42
|
+
add_plugin(Aws::Plugins::CredentialsConfiguration)
|
|
43
|
+
add_plugin(Aws::Plugins::Logging)
|
|
44
|
+
add_plugin(Aws::Plugins::ParamConverter)
|
|
45
|
+
add_plugin(Aws::Plugins::ParamValidator)
|
|
46
|
+
add_plugin(Aws::Plugins::UserAgent)
|
|
47
|
+
add_plugin(Aws::Plugins::HelpfulSocketErrors)
|
|
48
|
+
add_plugin(Aws::Plugins::RetryErrors)
|
|
49
|
+
add_plugin(Aws::Plugins::GlobalConfiguration)
|
|
50
|
+
add_plugin(Aws::Plugins::RegionalEndpoint)
|
|
51
|
+
add_plugin(Aws::Plugins::EndpointDiscovery)
|
|
52
|
+
add_plugin(Aws::Plugins::EndpointPattern)
|
|
53
|
+
add_plugin(Aws::Plugins::ResponsePaging)
|
|
54
|
+
add_plugin(Aws::Plugins::StubResponses)
|
|
55
|
+
add_plugin(Aws::Plugins::IdempotencyToken)
|
|
56
|
+
add_plugin(Aws::Plugins::JsonvalueConverter)
|
|
57
|
+
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
|
58
|
+
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
|
59
|
+
add_plugin(Aws::Plugins::TransferEncoding)
|
|
60
|
+
add_plugin(Aws::Plugins::SignatureV4)
|
|
61
|
+
add_plugin(Aws::Plugins::Protocols::RestJson)
|
|
62
|
+
|
|
63
|
+
# @overload initialize(options)
|
|
64
|
+
# @param [Hash] options
|
|
65
|
+
# @option options [required, Aws::CredentialProvider] :credentials
|
|
66
|
+
# Your AWS credentials. This can be an instance of any one of the
|
|
67
|
+
# following classes:
|
|
68
|
+
#
|
|
69
|
+
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
|
70
|
+
# credentials.
|
|
71
|
+
#
|
|
72
|
+
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
|
73
|
+
# from an EC2 IMDS on an EC2 instance.
|
|
74
|
+
#
|
|
75
|
+
# * `Aws::SharedCredentials` - Used for loading credentials from a
|
|
76
|
+
# shared file, such as `~/.aws/config`.
|
|
77
|
+
#
|
|
78
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
|
79
|
+
#
|
|
80
|
+
# When `:credentials` are not configured directly, the following
|
|
81
|
+
# locations will be searched for credentials:
|
|
82
|
+
#
|
|
83
|
+
# * `Aws.config[:credentials]`
|
|
84
|
+
# * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
|
|
85
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
|
86
|
+
# * `~/.aws/credentials`
|
|
87
|
+
# * `~/.aws/config`
|
|
88
|
+
# * EC2 IMDS instance profile - When used by default, the timeouts are
|
|
89
|
+
# very aggressive. Construct and pass an instance of
|
|
90
|
+
# `Aws::InstanceProfileCredentails` to enable retries and extended
|
|
91
|
+
# timeouts.
|
|
92
|
+
#
|
|
93
|
+
# @option options [required, String] :region
|
|
94
|
+
# The AWS region to connect to. The configured `:region` is
|
|
95
|
+
# used to determine the service `:endpoint`. When not passed,
|
|
96
|
+
# a default `:region` is search for in the following locations:
|
|
97
|
+
#
|
|
98
|
+
# * `Aws.config[:region]`
|
|
99
|
+
# * `ENV['AWS_REGION']`
|
|
100
|
+
# * `ENV['AMAZON_REGION']`
|
|
101
|
+
# * `ENV['AWS_DEFAULT_REGION']`
|
|
102
|
+
# * `~/.aws/credentials`
|
|
103
|
+
# * `~/.aws/config`
|
|
104
|
+
#
|
|
105
|
+
# @option options [String] :access_key_id
|
|
106
|
+
#
|
|
107
|
+
# @option options [Boolean] :active_endpoint_cache (false)
|
|
108
|
+
# When set to `true`, a thread polling for endpoints will be running in
|
|
109
|
+
# the background every 60 secs (default). Defaults to `false`.
|
|
110
|
+
#
|
|
111
|
+
# @option options [Boolean] :client_side_monitoring (false)
|
|
112
|
+
# When `true`, client-side metrics will be collected for all API requests from
|
|
113
|
+
# this client.
|
|
114
|
+
#
|
|
115
|
+
# @option options [String] :client_side_monitoring_client_id ("")
|
|
116
|
+
# Allows you to provide an identifier for this client which will be attached to
|
|
117
|
+
# all generated client side metrics. Defaults to an empty string.
|
|
118
|
+
#
|
|
119
|
+
# @option options [String] :client_side_monitoring_host ("127.0.0.1")
|
|
120
|
+
# Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
|
|
121
|
+
# side monitoring agent is running on, where client metrics will be published via UDP.
|
|
122
|
+
#
|
|
123
|
+
# @option options [Integer] :client_side_monitoring_port (31000)
|
|
124
|
+
# Required for publishing client metrics. The port that the client side monitoring
|
|
125
|
+
# agent is running on, where client metrics will be published via UDP.
|
|
126
|
+
#
|
|
127
|
+
# @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
|
|
128
|
+
# Allows you to provide a custom client-side monitoring publisher class. By default,
|
|
129
|
+
# will use the Client Side Monitoring Agent Publisher.
|
|
130
|
+
#
|
|
131
|
+
# @option options [Boolean] :convert_params (true)
|
|
132
|
+
# When `true`, an attempt is made to coerce request parameters into
|
|
133
|
+
# the required types.
|
|
134
|
+
#
|
|
135
|
+
# @option options [Boolean] :disable_host_prefix_injection (false)
|
|
136
|
+
# Set to true to disable SDK automatically adding host prefix
|
|
137
|
+
# to default service endpoint when available.
|
|
138
|
+
#
|
|
139
|
+
# @option options [String] :endpoint
|
|
140
|
+
# The client endpoint is normally constructed from the `:region`
|
|
141
|
+
# option. You should only configure an `:endpoint` when connecting
|
|
142
|
+
# to test endpoints. This should be avalid HTTP(S) URI.
|
|
143
|
+
#
|
|
144
|
+
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
|
145
|
+
# Used for the maximum size limit of the LRU cache storing endpoints data
|
|
146
|
+
# for endpoint discovery enabled operations. Defaults to 1000.
|
|
147
|
+
#
|
|
148
|
+
# @option options [Integer] :endpoint_cache_max_threads (10)
|
|
149
|
+
# Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
|
|
150
|
+
#
|
|
151
|
+
# @option options [Integer] :endpoint_cache_poll_interval (60)
|
|
152
|
+
# When :endpoint_discovery and :active_endpoint_cache is enabled,
|
|
153
|
+
# Use this option to config the time interval in seconds for making
|
|
154
|
+
# requests fetching endpoints information. Defaults to 60 sec.
|
|
155
|
+
#
|
|
156
|
+
# @option options [Boolean] :endpoint_discovery (false)
|
|
157
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
|
|
158
|
+
#
|
|
159
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
|
160
|
+
# The log formatter.
|
|
161
|
+
#
|
|
162
|
+
# @option options [Symbol] :log_level (:info)
|
|
163
|
+
# The log level to send messages to the `:logger` at.
|
|
164
|
+
#
|
|
165
|
+
# @option options [Logger] :logger
|
|
166
|
+
# The Logger instance to send log messages to. If this option
|
|
167
|
+
# is not set, logging will be disabled.
|
|
168
|
+
#
|
|
169
|
+
# @option options [String] :profile ("default")
|
|
170
|
+
# Used when loading credentials from the shared credentials file
|
|
171
|
+
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
|
172
|
+
#
|
|
173
|
+
# @option options [Float] :retry_base_delay (0.3)
|
|
174
|
+
# The base delay in seconds used by the default backoff function.
|
|
175
|
+
#
|
|
176
|
+
# @option options [Symbol] :retry_jitter (:none)
|
|
177
|
+
# A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
|
|
178
|
+
#
|
|
179
|
+
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
|
180
|
+
#
|
|
181
|
+
# @option options [Integer] :retry_limit (3)
|
|
182
|
+
# The maximum number of times to retry failed requests. Only
|
|
183
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
|
184
|
+
# are retried. Generally, these are throttling errors, data
|
|
185
|
+
# checksum errors, networking errors, timeout errors and auth
|
|
186
|
+
# errors from expired credentials.
|
|
187
|
+
#
|
|
188
|
+
# @option options [Integer] :retry_max_delay (0)
|
|
189
|
+
# The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
|
|
190
|
+
#
|
|
191
|
+
# @option options [String] :secret_access_key
|
|
192
|
+
#
|
|
193
|
+
# @option options [String] :session_token
|
|
194
|
+
#
|
|
195
|
+
# @option options [Boolean] :stub_responses (false)
|
|
196
|
+
# Causes the client to return stubbed responses. By default
|
|
197
|
+
# fake responses are generated and returned. You can specify
|
|
198
|
+
# the response data to return or errors to raise by calling
|
|
199
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
|
200
|
+
#
|
|
201
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
|
202
|
+
# requests are made, and retries are disabled.
|
|
203
|
+
#
|
|
204
|
+
# @option options [Boolean] :validate_params (true)
|
|
205
|
+
# When `true`, request parameters are validated before
|
|
206
|
+
# sending the request.
|
|
207
|
+
#
|
|
208
|
+
# @option options [URI::HTTP,String] :http_proxy A proxy to send
|
|
209
|
+
# requests through. Formatted like 'http://proxy.com:123'.
|
|
210
|
+
#
|
|
211
|
+
# @option options [Float] :http_open_timeout (15) The number of
|
|
212
|
+
# seconds to wait when opening a HTTP session before rasing a
|
|
213
|
+
# `Timeout::Error`.
|
|
214
|
+
#
|
|
215
|
+
# @option options [Integer] :http_read_timeout (60) The default
|
|
216
|
+
# number of seconds to wait for response data. This value can
|
|
217
|
+
# safely be set
|
|
218
|
+
# per-request on the session yeidled by {#session_for}.
|
|
219
|
+
#
|
|
220
|
+
# @option options [Float] :http_idle_timeout (5) The number of
|
|
221
|
+
# seconds a connection is allowed to sit idble before it is
|
|
222
|
+
# considered stale. Stale connections are closed and removed
|
|
223
|
+
# from the pool before making a request.
|
|
224
|
+
#
|
|
225
|
+
# @option options [Float] :http_continue_timeout (1) The number of
|
|
226
|
+
# seconds to wait for a 100-continue response before sending the
|
|
227
|
+
# request body. This option has no effect unless the request has
|
|
228
|
+
# "Expect" header set to "100-continue". Defaults to `nil` which
|
|
229
|
+
# disables this behaviour. This value can safely be set per
|
|
230
|
+
# request on the session yeidled by {#session_for}.
|
|
231
|
+
#
|
|
232
|
+
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
|
233
|
+
# HTTP debug output will be sent to the `:logger`.
|
|
234
|
+
#
|
|
235
|
+
# @option options [Boolean] :ssl_verify_peer (true) When `true`,
|
|
236
|
+
# SSL peer certificates are verified when establishing a
|
|
237
|
+
# connection.
|
|
238
|
+
#
|
|
239
|
+
# @option options [String] :ssl_ca_bundle Full path to the SSL
|
|
240
|
+
# certificate authority bundle file that should be used when
|
|
241
|
+
# verifying peer certificates. If you do not pass
|
|
242
|
+
# `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
|
|
243
|
+
# will be used if available.
|
|
244
|
+
#
|
|
245
|
+
# @option options [String] :ssl_ca_directory Full path of the
|
|
246
|
+
# directory that contains the unbundled SSL certificate
|
|
247
|
+
# authority files for verifying peer certificates. If you do
|
|
248
|
+
# not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
|
|
249
|
+
# system default will be used if available.
|
|
250
|
+
#
|
|
251
|
+
def initialize(*args)
|
|
252
|
+
super
|
|
253
|
+
end
|
|
254
|
+
|
|
255
|
+
# @!group API Operations
|
|
256
|
+
|
|
257
|
+
# An application in AppConfig is a logical unit of code that provides
|
|
258
|
+
# capabilities for your customers. For example, an application can be a
|
|
259
|
+
# microservice that runs on Amazon EC2 instances, a mobile application
|
|
260
|
+
# installed by your users, a serverless application using Amazon API
|
|
261
|
+
# Gateway and AWS Lambda, or any system you run on behalf of others.
|
|
262
|
+
#
|
|
263
|
+
# @option params [required, String] :name
|
|
264
|
+
# A name for the application.
|
|
265
|
+
#
|
|
266
|
+
# @option params [String] :description
|
|
267
|
+
# A description of the application.
|
|
268
|
+
#
|
|
269
|
+
# @option params [Hash<String,String>] :tags
|
|
270
|
+
# Metadata to assign to the application. Tags help organize and
|
|
271
|
+
# categorize your AppConfig resources. Each tag consists of a key and an
|
|
272
|
+
# optional value, both of which you define.
|
|
273
|
+
#
|
|
274
|
+
# @return [Types::Application] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
275
|
+
#
|
|
276
|
+
# * {Types::Application#id #id} => String
|
|
277
|
+
# * {Types::Application#name #name} => String
|
|
278
|
+
# * {Types::Application#description #description} => String
|
|
279
|
+
#
|
|
280
|
+
# @example Request syntax with placeholder values
|
|
281
|
+
#
|
|
282
|
+
# resp = client.create_application({
|
|
283
|
+
# name: "Name", # required
|
|
284
|
+
# description: "Description",
|
|
285
|
+
# tags: {
|
|
286
|
+
# "TagKey" => "TagValue",
|
|
287
|
+
# },
|
|
288
|
+
# })
|
|
289
|
+
#
|
|
290
|
+
# @example Response structure
|
|
291
|
+
#
|
|
292
|
+
# resp.id #=> String
|
|
293
|
+
# resp.name #=> String
|
|
294
|
+
# resp.description #=> String
|
|
295
|
+
#
|
|
296
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/CreateApplication AWS API Documentation
|
|
297
|
+
#
|
|
298
|
+
# @overload create_application(params = {})
|
|
299
|
+
# @param [Hash] params ({})
|
|
300
|
+
def create_application(params = {}, options = {})
|
|
301
|
+
req = build_request(:create_application, params)
|
|
302
|
+
req.send_request(options)
|
|
303
|
+
end
|
|
304
|
+
|
|
305
|
+
# Information that enables AppConfig to access the configuration source.
|
|
306
|
+
# Valid configuration sources include Systems Manager (SSM) documents
|
|
307
|
+
# and SSM Parameter Store parameters. A configuration profile includes
|
|
308
|
+
# the following information.
|
|
309
|
+
#
|
|
310
|
+
# * The Uri location of the configuration data.
|
|
311
|
+
#
|
|
312
|
+
# * The AWS Identity and Access Management (IAM) role that provides
|
|
313
|
+
# access to the configuration data.
|
|
314
|
+
#
|
|
315
|
+
# * A validator for the configuration data. Available validators include
|
|
316
|
+
# either a JSON Schema or an AWS Lambda function.
|
|
317
|
+
#
|
|
318
|
+
# @option params [required, String] :application_id
|
|
319
|
+
# The application ID.
|
|
320
|
+
#
|
|
321
|
+
# @option params [required, String] :name
|
|
322
|
+
# A name for the configuration profile.
|
|
323
|
+
#
|
|
324
|
+
# @option params [String] :description
|
|
325
|
+
# A description of the configuration profile.
|
|
326
|
+
#
|
|
327
|
+
# @option params [required, String] :location_uri
|
|
328
|
+
# A URI to locate the configuration. You can specify either a Systems
|
|
329
|
+
# Manager (SSM) document or an SSM Parameter Store parameter. For an SSM
|
|
330
|
+
# document, specify either the document name in the format
|
|
331
|
+
# `ssm-document://<Document name>` or the Amazon Resource Name (ARN).
|
|
332
|
+
# For a parameter, specify either the parameter name in the format
|
|
333
|
+
# `ssm-parameter://<Parameter name>` or the ARN.
|
|
334
|
+
#
|
|
335
|
+
# @option params [required, String] :retrieval_role_arn
|
|
336
|
+
# The ARN of an IAM role with permission to access the configuration at
|
|
337
|
+
# the specified LocationUri.
|
|
338
|
+
#
|
|
339
|
+
# @option params [Array<Types::Validator>] :validators
|
|
340
|
+
# A list of methods for validating the configuration.
|
|
341
|
+
#
|
|
342
|
+
# @option params [Hash<String,String>] :tags
|
|
343
|
+
# Metadata to assign to the configuration profile. Tags help organize
|
|
344
|
+
# and categorize your AppConfig resources. Each tag consists of a key
|
|
345
|
+
# and an optional value, both of which you define.
|
|
346
|
+
#
|
|
347
|
+
# @return [Types::ConfigurationProfile] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
348
|
+
#
|
|
349
|
+
# * {Types::ConfigurationProfile#application_id #application_id} => String
|
|
350
|
+
# * {Types::ConfigurationProfile#id #id} => String
|
|
351
|
+
# * {Types::ConfigurationProfile#name #name} => String
|
|
352
|
+
# * {Types::ConfigurationProfile#description #description} => String
|
|
353
|
+
# * {Types::ConfigurationProfile#location_uri #location_uri} => String
|
|
354
|
+
# * {Types::ConfigurationProfile#retrieval_role_arn #retrieval_role_arn} => String
|
|
355
|
+
# * {Types::ConfigurationProfile#validators #validators} => Array<Types::Validator>
|
|
356
|
+
#
|
|
357
|
+
# @example Request syntax with placeholder values
|
|
358
|
+
#
|
|
359
|
+
# resp = client.create_configuration_profile({
|
|
360
|
+
# application_id: "Id", # required
|
|
361
|
+
# name: "Name", # required
|
|
362
|
+
# description: "Description",
|
|
363
|
+
# location_uri: "Uri", # required
|
|
364
|
+
# retrieval_role_arn: "Arn", # required
|
|
365
|
+
# validators: [
|
|
366
|
+
# {
|
|
367
|
+
# type: "JSON_SCHEMA", # required, accepts JSON_SCHEMA, LAMBDA
|
|
368
|
+
# content: "StringWithLengthBetween0And32768", # required
|
|
369
|
+
# },
|
|
370
|
+
# ],
|
|
371
|
+
# tags: {
|
|
372
|
+
# "TagKey" => "TagValue",
|
|
373
|
+
# },
|
|
374
|
+
# })
|
|
375
|
+
#
|
|
376
|
+
# @example Response structure
|
|
377
|
+
#
|
|
378
|
+
# resp.application_id #=> String
|
|
379
|
+
# resp.id #=> String
|
|
380
|
+
# resp.name #=> String
|
|
381
|
+
# resp.description #=> String
|
|
382
|
+
# resp.location_uri #=> String
|
|
383
|
+
# resp.retrieval_role_arn #=> String
|
|
384
|
+
# resp.validators #=> Array
|
|
385
|
+
# resp.validators[0].type #=> String, one of "JSON_SCHEMA", "LAMBDA"
|
|
386
|
+
# resp.validators[0].content #=> String
|
|
387
|
+
#
|
|
388
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/CreateConfigurationProfile AWS API Documentation
|
|
389
|
+
#
|
|
390
|
+
# @overload create_configuration_profile(params = {})
|
|
391
|
+
# @param [Hash] params ({})
|
|
392
|
+
def create_configuration_profile(params = {}, options = {})
|
|
393
|
+
req = build_request(:create_configuration_profile, params)
|
|
394
|
+
req.send_request(options)
|
|
395
|
+
end
|
|
396
|
+
|
|
397
|
+
# A deployment strategy defines important criteria for rolling out your
|
|
398
|
+
# configuration to the designated targets. A deployment strategy
|
|
399
|
+
# includes: the overall duration required, a percentage of targets to
|
|
400
|
+
# receive the deployment during each interval, an algorithm that defines
|
|
401
|
+
# how percentage grows, and bake time.
|
|
402
|
+
#
|
|
403
|
+
# @option params [required, String] :name
|
|
404
|
+
# A name for the deployment strategy.
|
|
405
|
+
#
|
|
406
|
+
# @option params [String] :description
|
|
407
|
+
# A description of the deployment strategy.
|
|
408
|
+
#
|
|
409
|
+
# @option params [required, Integer] :deployment_duration_in_minutes
|
|
410
|
+
# Total amount of time for a deployment to last.
|
|
411
|
+
#
|
|
412
|
+
# @option params [Integer] :final_bake_time_in_minutes
|
|
413
|
+
# The amount of time AppConfig monitors for alarms before considering
|
|
414
|
+
# the deployment to be complete and no longer eligible for automatic
|
|
415
|
+
# roll back.
|
|
416
|
+
#
|
|
417
|
+
# @option params [required, Float] :growth_factor
|
|
418
|
+
# The percentage of targets to receive a deployed configuration during
|
|
419
|
+
# each interval.
|
|
420
|
+
#
|
|
421
|
+
# @option params [String] :growth_type
|
|
422
|
+
# The algorithm used to define how percentage grows over time.
|
|
423
|
+
#
|
|
424
|
+
# @option params [required, String] :replicate_to
|
|
425
|
+
# Save the deployment strategy to a Systems Manager (SSM) document.
|
|
426
|
+
#
|
|
427
|
+
# @option params [Hash<String,String>] :tags
|
|
428
|
+
# Metadata to assign to the deployment strategy. Tags help organize and
|
|
429
|
+
# categorize your AppConfig resources. Each tag consists of a key and an
|
|
430
|
+
# optional value, both of which you define.
|
|
431
|
+
#
|
|
432
|
+
# @return [Types::DeploymentStrategy] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
433
|
+
#
|
|
434
|
+
# * {Types::DeploymentStrategy#id #id} => String
|
|
435
|
+
# * {Types::DeploymentStrategy#name #name} => String
|
|
436
|
+
# * {Types::DeploymentStrategy#description #description} => String
|
|
437
|
+
# * {Types::DeploymentStrategy#deployment_duration_in_minutes #deployment_duration_in_minutes} => Integer
|
|
438
|
+
# * {Types::DeploymentStrategy#growth_type #growth_type} => String
|
|
439
|
+
# * {Types::DeploymentStrategy#growth_factor #growth_factor} => Float
|
|
440
|
+
# * {Types::DeploymentStrategy#final_bake_time_in_minutes #final_bake_time_in_minutes} => Integer
|
|
441
|
+
# * {Types::DeploymentStrategy#replicate_to #replicate_to} => String
|
|
442
|
+
#
|
|
443
|
+
# @example Request syntax with placeholder values
|
|
444
|
+
#
|
|
445
|
+
# resp = client.create_deployment_strategy({
|
|
446
|
+
# name: "Name", # required
|
|
447
|
+
# description: "Description",
|
|
448
|
+
# deployment_duration_in_minutes: 1, # required
|
|
449
|
+
# final_bake_time_in_minutes: 1,
|
|
450
|
+
# growth_factor: 1.0, # required
|
|
451
|
+
# growth_type: "LINEAR", # accepts LINEAR
|
|
452
|
+
# replicate_to: "NONE", # required, accepts NONE, SSM_DOCUMENT
|
|
453
|
+
# tags: {
|
|
454
|
+
# "TagKey" => "TagValue",
|
|
455
|
+
# },
|
|
456
|
+
# })
|
|
457
|
+
#
|
|
458
|
+
# @example Response structure
|
|
459
|
+
#
|
|
460
|
+
# resp.id #=> String
|
|
461
|
+
# resp.name #=> String
|
|
462
|
+
# resp.description #=> String
|
|
463
|
+
# resp.deployment_duration_in_minutes #=> Integer
|
|
464
|
+
# resp.growth_type #=> String, one of "LINEAR"
|
|
465
|
+
# resp.growth_factor #=> Float
|
|
466
|
+
# resp.final_bake_time_in_minutes #=> Integer
|
|
467
|
+
# resp.replicate_to #=> String, one of "NONE", "SSM_DOCUMENT"
|
|
468
|
+
#
|
|
469
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/CreateDeploymentStrategy AWS API Documentation
|
|
470
|
+
#
|
|
471
|
+
# @overload create_deployment_strategy(params = {})
|
|
472
|
+
# @param [Hash] params ({})
|
|
473
|
+
def create_deployment_strategy(params = {}, options = {})
|
|
474
|
+
req = build_request(:create_deployment_strategy, params)
|
|
475
|
+
req.send_request(options)
|
|
476
|
+
end
|
|
477
|
+
|
|
478
|
+
# For each application, you define one or more environments. An
|
|
479
|
+
# environment is a logical deployment group of AppConfig targets, such
|
|
480
|
+
# as applications in a `Beta` or `Production` environment. You can also
|
|
481
|
+
# define environments for application subcomponents such as the `Web`,
|
|
482
|
+
# `Mobile` and `Back-end` components for your application. You can
|
|
483
|
+
# configure Amazon CloudWatch alarms for each environment. The system
|
|
484
|
+
# monitors alarms during a configuration deployment. If an alarm is
|
|
485
|
+
# triggered, the system rolls back the configuration.
|
|
486
|
+
#
|
|
487
|
+
# @option params [required, String] :application_id
|
|
488
|
+
# The application ID.
|
|
489
|
+
#
|
|
490
|
+
# @option params [required, String] :name
|
|
491
|
+
# A name for the environment.
|
|
492
|
+
#
|
|
493
|
+
# @option params [String] :description
|
|
494
|
+
# A description of the environment.
|
|
495
|
+
#
|
|
496
|
+
# @option params [Array<Types::Monitor>] :monitors
|
|
497
|
+
# Amazon CloudWatch alarms to monitor during the deployment process.
|
|
498
|
+
#
|
|
499
|
+
# @option params [Hash<String,String>] :tags
|
|
500
|
+
# Metadata to assign to the environment. Tags help organize and
|
|
501
|
+
# categorize your AppConfig resources. Each tag consists of a key and an
|
|
502
|
+
# optional value, both of which you define.
|
|
503
|
+
#
|
|
504
|
+
# @return [Types::Environment] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
505
|
+
#
|
|
506
|
+
# * {Types::Environment#application_id #application_id} => String
|
|
507
|
+
# * {Types::Environment#id #id} => String
|
|
508
|
+
# * {Types::Environment#name #name} => String
|
|
509
|
+
# * {Types::Environment#description #description} => String
|
|
510
|
+
# * {Types::Environment#state #state} => String
|
|
511
|
+
# * {Types::Environment#monitors #monitors} => Array<Types::Monitor>
|
|
512
|
+
#
|
|
513
|
+
# @example Request syntax with placeholder values
|
|
514
|
+
#
|
|
515
|
+
# resp = client.create_environment({
|
|
516
|
+
# application_id: "Id", # required
|
|
517
|
+
# name: "Name", # required
|
|
518
|
+
# description: "Description",
|
|
519
|
+
# monitors: [
|
|
520
|
+
# {
|
|
521
|
+
# alarm_arn: "Arn",
|
|
522
|
+
# alarm_role_arn: "Arn",
|
|
523
|
+
# },
|
|
524
|
+
# ],
|
|
525
|
+
# tags: {
|
|
526
|
+
# "TagKey" => "TagValue",
|
|
527
|
+
# },
|
|
528
|
+
# })
|
|
529
|
+
#
|
|
530
|
+
# @example Response structure
|
|
531
|
+
#
|
|
532
|
+
# resp.application_id #=> String
|
|
533
|
+
# resp.id #=> String
|
|
534
|
+
# resp.name #=> String
|
|
535
|
+
# resp.description #=> String
|
|
536
|
+
# resp.state #=> String, one of "READY_FOR_DEPLOYMENT", "DEPLOYING", "ROLLING_BACK", "ROLLED_BACK"
|
|
537
|
+
# resp.monitors #=> Array
|
|
538
|
+
# resp.monitors[0].alarm_arn #=> String
|
|
539
|
+
# resp.monitors[0].alarm_role_arn #=> String
|
|
540
|
+
#
|
|
541
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/CreateEnvironment AWS API Documentation
|
|
542
|
+
#
|
|
543
|
+
# @overload create_environment(params = {})
|
|
544
|
+
# @param [Hash] params ({})
|
|
545
|
+
def create_environment(params = {}, options = {})
|
|
546
|
+
req = build_request(:create_environment, params)
|
|
547
|
+
req.send_request(options)
|
|
548
|
+
end
|
|
549
|
+
|
|
550
|
+
# Delete an application. Deleting an application does not delete a
|
|
551
|
+
# configuration from a host.
|
|
552
|
+
#
|
|
553
|
+
# @option params [required, String] :application_id
|
|
554
|
+
# The ID of the application to delete.
|
|
555
|
+
#
|
|
556
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
557
|
+
#
|
|
558
|
+
# @example Request syntax with placeholder values
|
|
559
|
+
#
|
|
560
|
+
# resp = client.delete_application({
|
|
561
|
+
# application_id: "Id", # required
|
|
562
|
+
# })
|
|
563
|
+
#
|
|
564
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/DeleteApplication AWS API Documentation
|
|
565
|
+
#
|
|
566
|
+
# @overload delete_application(params = {})
|
|
567
|
+
# @param [Hash] params ({})
|
|
568
|
+
def delete_application(params = {}, options = {})
|
|
569
|
+
req = build_request(:delete_application, params)
|
|
570
|
+
req.send_request(options)
|
|
571
|
+
end
|
|
572
|
+
|
|
573
|
+
# Delete a configuration profile. Deleting a configuration profile does
|
|
574
|
+
# not delete a configuration from a host.
|
|
575
|
+
#
|
|
576
|
+
# @option params [required, String] :application_id
|
|
577
|
+
# The application ID that includes the configuration profile you want to
|
|
578
|
+
# delete.
|
|
579
|
+
#
|
|
580
|
+
# @option params [required, String] :configuration_profile_id
|
|
581
|
+
# The ID of the configuration profile you want to delete.
|
|
582
|
+
#
|
|
583
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
584
|
+
#
|
|
585
|
+
# @example Request syntax with placeholder values
|
|
586
|
+
#
|
|
587
|
+
# resp = client.delete_configuration_profile({
|
|
588
|
+
# application_id: "Id", # required
|
|
589
|
+
# configuration_profile_id: "Id", # required
|
|
590
|
+
# })
|
|
591
|
+
#
|
|
592
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/DeleteConfigurationProfile AWS API Documentation
|
|
593
|
+
#
|
|
594
|
+
# @overload delete_configuration_profile(params = {})
|
|
595
|
+
# @param [Hash] params ({})
|
|
596
|
+
def delete_configuration_profile(params = {}, options = {})
|
|
597
|
+
req = build_request(:delete_configuration_profile, params)
|
|
598
|
+
req.send_request(options)
|
|
599
|
+
end
|
|
600
|
+
|
|
601
|
+
# Delete a deployment strategy. Deleting a deployment strategy does not
|
|
602
|
+
# delete a configuration from a host.
|
|
603
|
+
#
|
|
604
|
+
# @option params [required, String] :deployment_strategy_id
|
|
605
|
+
# The ID of the deployment strategy you want to delete.
|
|
606
|
+
#
|
|
607
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
608
|
+
#
|
|
609
|
+
# @example Request syntax with placeholder values
|
|
610
|
+
#
|
|
611
|
+
# resp = client.delete_deployment_strategy({
|
|
612
|
+
# deployment_strategy_id: "DeploymentStrategyId", # required
|
|
613
|
+
# })
|
|
614
|
+
#
|
|
615
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/DeleteDeploymentStrategy AWS API Documentation
|
|
616
|
+
#
|
|
617
|
+
# @overload delete_deployment_strategy(params = {})
|
|
618
|
+
# @param [Hash] params ({})
|
|
619
|
+
def delete_deployment_strategy(params = {}, options = {})
|
|
620
|
+
req = build_request(:delete_deployment_strategy, params)
|
|
621
|
+
req.send_request(options)
|
|
622
|
+
end
|
|
623
|
+
|
|
624
|
+
# Delete an environment. Deleting an environment does not delete a
|
|
625
|
+
# configuration from a host.
|
|
626
|
+
#
|
|
627
|
+
# @option params [required, String] :application_id
|
|
628
|
+
# The application ID that includes the environment you want to delete.
|
|
629
|
+
#
|
|
630
|
+
# @option params [required, String] :environment_id
|
|
631
|
+
# The ID of the environment you want to delete.
|
|
632
|
+
#
|
|
633
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
634
|
+
#
|
|
635
|
+
# @example Request syntax with placeholder values
|
|
636
|
+
#
|
|
637
|
+
# resp = client.delete_environment({
|
|
638
|
+
# application_id: "Id", # required
|
|
639
|
+
# environment_id: "Id", # required
|
|
640
|
+
# })
|
|
641
|
+
#
|
|
642
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/DeleteEnvironment AWS API Documentation
|
|
643
|
+
#
|
|
644
|
+
# @overload delete_environment(params = {})
|
|
645
|
+
# @param [Hash] params ({})
|
|
646
|
+
def delete_environment(params = {}, options = {})
|
|
647
|
+
req = build_request(:delete_environment, params)
|
|
648
|
+
req.send_request(options)
|
|
649
|
+
end
|
|
650
|
+
|
|
651
|
+
# Retrieve information about an application.
|
|
652
|
+
#
|
|
653
|
+
# @option params [required, String] :application_id
|
|
654
|
+
# The ID of the application you want to get.
|
|
655
|
+
#
|
|
656
|
+
# @return [Types::Application] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
657
|
+
#
|
|
658
|
+
# * {Types::Application#id #id} => String
|
|
659
|
+
# * {Types::Application#name #name} => String
|
|
660
|
+
# * {Types::Application#description #description} => String
|
|
661
|
+
#
|
|
662
|
+
# @example Request syntax with placeholder values
|
|
663
|
+
#
|
|
664
|
+
# resp = client.get_application({
|
|
665
|
+
# application_id: "Id", # required
|
|
666
|
+
# })
|
|
667
|
+
#
|
|
668
|
+
# @example Response structure
|
|
669
|
+
#
|
|
670
|
+
# resp.id #=> String
|
|
671
|
+
# resp.name #=> String
|
|
672
|
+
# resp.description #=> String
|
|
673
|
+
#
|
|
674
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/GetApplication AWS API Documentation
|
|
675
|
+
#
|
|
676
|
+
# @overload get_application(params = {})
|
|
677
|
+
# @param [Hash] params ({})
|
|
678
|
+
def get_application(params = {}, options = {})
|
|
679
|
+
req = build_request(:get_application, params)
|
|
680
|
+
req.send_request(options)
|
|
681
|
+
end
|
|
682
|
+
|
|
683
|
+
# Retrieve information about a configuration.
|
|
684
|
+
#
|
|
685
|
+
# @option params [required, String] :application
|
|
686
|
+
# The application to get.
|
|
687
|
+
#
|
|
688
|
+
# @option params [required, String] :environment
|
|
689
|
+
# The environment to get.
|
|
690
|
+
#
|
|
691
|
+
# @option params [required, String] :configuration
|
|
692
|
+
# The configuration to get.
|
|
693
|
+
#
|
|
694
|
+
# @option params [required, String] :client_id
|
|
695
|
+
# A unique ID to identify the client for the configuration. This ID
|
|
696
|
+
# enables AppConfig to deploy the configuration in intervals, as defined
|
|
697
|
+
# in the deployment strategy.
|
|
698
|
+
#
|
|
699
|
+
# @option params [String] :client_configuration_version
|
|
700
|
+
# The configuration version returned in the most recent GetConfiguration
|
|
701
|
+
# response.
|
|
702
|
+
#
|
|
703
|
+
# @return [Types::Configuration] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
704
|
+
#
|
|
705
|
+
# * {Types::Configuration#content #content} => String
|
|
706
|
+
# * {Types::Configuration#configuration_version #configuration_version} => String
|
|
707
|
+
# * {Types::Configuration#content_type #content_type} => String
|
|
708
|
+
#
|
|
709
|
+
# @example Request syntax with placeholder values
|
|
710
|
+
#
|
|
711
|
+
# resp = client.get_configuration({
|
|
712
|
+
# application: "StringWithLengthBetween1And64", # required
|
|
713
|
+
# environment: "StringWithLengthBetween1And64", # required
|
|
714
|
+
# configuration: "StringWithLengthBetween1And64", # required
|
|
715
|
+
# client_id: "StringWithLengthBetween1And64", # required
|
|
716
|
+
# client_configuration_version: "Version",
|
|
717
|
+
# })
|
|
718
|
+
#
|
|
719
|
+
# @example Response structure
|
|
720
|
+
#
|
|
721
|
+
# resp.content #=> String
|
|
722
|
+
# resp.configuration_version #=> String
|
|
723
|
+
# resp.content_type #=> String
|
|
724
|
+
#
|
|
725
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/GetConfiguration AWS API Documentation
|
|
726
|
+
#
|
|
727
|
+
# @overload get_configuration(params = {})
|
|
728
|
+
# @param [Hash] params ({})
|
|
729
|
+
def get_configuration(params = {}, options = {})
|
|
730
|
+
req = build_request(:get_configuration, params)
|
|
731
|
+
req.send_request(options)
|
|
732
|
+
end
|
|
733
|
+
|
|
734
|
+
# Retrieve information about a configuration profile.
|
|
735
|
+
#
|
|
736
|
+
# @option params [required, String] :application_id
|
|
737
|
+
# The ID of the application that includes the configuration profile you
|
|
738
|
+
# want to get.
|
|
739
|
+
#
|
|
740
|
+
# @option params [required, String] :configuration_profile_id
|
|
741
|
+
# The ID of the configuration profile you want to get.
|
|
742
|
+
#
|
|
743
|
+
# @return [Types::ConfigurationProfile] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
744
|
+
#
|
|
745
|
+
# * {Types::ConfigurationProfile#application_id #application_id} => String
|
|
746
|
+
# * {Types::ConfigurationProfile#id #id} => String
|
|
747
|
+
# * {Types::ConfigurationProfile#name #name} => String
|
|
748
|
+
# * {Types::ConfigurationProfile#description #description} => String
|
|
749
|
+
# * {Types::ConfigurationProfile#location_uri #location_uri} => String
|
|
750
|
+
# * {Types::ConfigurationProfile#retrieval_role_arn #retrieval_role_arn} => String
|
|
751
|
+
# * {Types::ConfigurationProfile#validators #validators} => Array<Types::Validator>
|
|
752
|
+
#
|
|
753
|
+
# @example Request syntax with placeholder values
|
|
754
|
+
#
|
|
755
|
+
# resp = client.get_configuration_profile({
|
|
756
|
+
# application_id: "Id", # required
|
|
757
|
+
# configuration_profile_id: "Id", # required
|
|
758
|
+
# })
|
|
759
|
+
#
|
|
760
|
+
# @example Response structure
|
|
761
|
+
#
|
|
762
|
+
# resp.application_id #=> String
|
|
763
|
+
# resp.id #=> String
|
|
764
|
+
# resp.name #=> String
|
|
765
|
+
# resp.description #=> String
|
|
766
|
+
# resp.location_uri #=> String
|
|
767
|
+
# resp.retrieval_role_arn #=> String
|
|
768
|
+
# resp.validators #=> Array
|
|
769
|
+
# resp.validators[0].type #=> String, one of "JSON_SCHEMA", "LAMBDA"
|
|
770
|
+
# resp.validators[0].content #=> String
|
|
771
|
+
#
|
|
772
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/GetConfigurationProfile AWS API Documentation
|
|
773
|
+
#
|
|
774
|
+
# @overload get_configuration_profile(params = {})
|
|
775
|
+
# @param [Hash] params ({})
|
|
776
|
+
def get_configuration_profile(params = {}, options = {})
|
|
777
|
+
req = build_request(:get_configuration_profile, params)
|
|
778
|
+
req.send_request(options)
|
|
779
|
+
end
|
|
780
|
+
|
|
781
|
+
# Retrieve information about a configuration deployment.
|
|
782
|
+
#
|
|
783
|
+
# @option params [required, String] :application_id
|
|
784
|
+
# The ID of the application that includes the deployment you want to
|
|
785
|
+
# get.
|
|
786
|
+
#
|
|
787
|
+
# @option params [required, String] :environment_id
|
|
788
|
+
# The ID of the environment that includes the deployment you want to
|
|
789
|
+
# get.
|
|
790
|
+
#
|
|
791
|
+
# @option params [required, Integer] :deployment_number
|
|
792
|
+
# The sequence number of the deployment.
|
|
793
|
+
#
|
|
794
|
+
# @return [Types::Deployment] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
795
|
+
#
|
|
796
|
+
# * {Types::Deployment#application_id #application_id} => String
|
|
797
|
+
# * {Types::Deployment#environment_id #environment_id} => String
|
|
798
|
+
# * {Types::Deployment#deployment_strategy_id #deployment_strategy_id} => String
|
|
799
|
+
# * {Types::Deployment#configuration_profile_id #configuration_profile_id} => String
|
|
800
|
+
# * {Types::Deployment#deployment_number #deployment_number} => Integer
|
|
801
|
+
# * {Types::Deployment#configuration_name #configuration_name} => String
|
|
802
|
+
# * {Types::Deployment#configuration_location_uri #configuration_location_uri} => String
|
|
803
|
+
# * {Types::Deployment#configuration_version #configuration_version} => String
|
|
804
|
+
# * {Types::Deployment#description #description} => String
|
|
805
|
+
# * {Types::Deployment#deployment_duration_in_minutes #deployment_duration_in_minutes} => Integer
|
|
806
|
+
# * {Types::Deployment#growth_type #growth_type} => String
|
|
807
|
+
# * {Types::Deployment#growth_factor #growth_factor} => Float
|
|
808
|
+
# * {Types::Deployment#final_bake_time_in_minutes #final_bake_time_in_minutes} => Integer
|
|
809
|
+
# * {Types::Deployment#state #state} => String
|
|
810
|
+
# * {Types::Deployment#percentage_complete #percentage_complete} => Float
|
|
811
|
+
# * {Types::Deployment#started_at #started_at} => Time
|
|
812
|
+
# * {Types::Deployment#completed_at #completed_at} => Time
|
|
813
|
+
#
|
|
814
|
+
# @example Request syntax with placeholder values
|
|
815
|
+
#
|
|
816
|
+
# resp = client.get_deployment({
|
|
817
|
+
# application_id: "Id", # required
|
|
818
|
+
# environment_id: "Id", # required
|
|
819
|
+
# deployment_number: 1, # required
|
|
820
|
+
# })
|
|
821
|
+
#
|
|
822
|
+
# @example Response structure
|
|
823
|
+
#
|
|
824
|
+
# resp.application_id #=> String
|
|
825
|
+
# resp.environment_id #=> String
|
|
826
|
+
# resp.deployment_strategy_id #=> String
|
|
827
|
+
# resp.configuration_profile_id #=> String
|
|
828
|
+
# resp.deployment_number #=> Integer
|
|
829
|
+
# resp.configuration_name #=> String
|
|
830
|
+
# resp.configuration_location_uri #=> String
|
|
831
|
+
# resp.configuration_version #=> String
|
|
832
|
+
# resp.description #=> String
|
|
833
|
+
# resp.deployment_duration_in_minutes #=> Integer
|
|
834
|
+
# resp.growth_type #=> String, one of "LINEAR"
|
|
835
|
+
# resp.growth_factor #=> Float
|
|
836
|
+
# resp.final_bake_time_in_minutes #=> Integer
|
|
837
|
+
# resp.state #=> String, one of "BAKING", "VALIDATING", "DEPLOYING", "COMPLETE", "ROLLING_BACK", "ROLLED_BACK"
|
|
838
|
+
# resp.percentage_complete #=> Float
|
|
839
|
+
# resp.started_at #=> Time
|
|
840
|
+
# resp.completed_at #=> Time
|
|
841
|
+
#
|
|
842
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/GetDeployment AWS API Documentation
|
|
843
|
+
#
|
|
844
|
+
# @overload get_deployment(params = {})
|
|
845
|
+
# @param [Hash] params ({})
|
|
846
|
+
def get_deployment(params = {}, options = {})
|
|
847
|
+
req = build_request(:get_deployment, params)
|
|
848
|
+
req.send_request(options)
|
|
849
|
+
end
|
|
850
|
+
|
|
851
|
+
# Retrieve information about a deployment strategy. A deployment
|
|
852
|
+
# strategy defines important criteria for rolling out your configuration
|
|
853
|
+
# to the designated targets. A deployment strategy includes: the overall
|
|
854
|
+
# duration required, a percentage of targets to receive the deployment
|
|
855
|
+
# during each interval, an algorithm that defines how percentage grows,
|
|
856
|
+
# and bake time.
|
|
857
|
+
#
|
|
858
|
+
# @option params [required, String] :deployment_strategy_id
|
|
859
|
+
# The ID of the deployment strategy to get.
|
|
860
|
+
#
|
|
861
|
+
# @return [Types::DeploymentStrategy] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
862
|
+
#
|
|
863
|
+
# * {Types::DeploymentStrategy#id #id} => String
|
|
864
|
+
# * {Types::DeploymentStrategy#name #name} => String
|
|
865
|
+
# * {Types::DeploymentStrategy#description #description} => String
|
|
866
|
+
# * {Types::DeploymentStrategy#deployment_duration_in_minutes #deployment_duration_in_minutes} => Integer
|
|
867
|
+
# * {Types::DeploymentStrategy#growth_type #growth_type} => String
|
|
868
|
+
# * {Types::DeploymentStrategy#growth_factor #growth_factor} => Float
|
|
869
|
+
# * {Types::DeploymentStrategy#final_bake_time_in_minutes #final_bake_time_in_minutes} => Integer
|
|
870
|
+
# * {Types::DeploymentStrategy#replicate_to #replicate_to} => String
|
|
871
|
+
#
|
|
872
|
+
# @example Request syntax with placeholder values
|
|
873
|
+
#
|
|
874
|
+
# resp = client.get_deployment_strategy({
|
|
875
|
+
# deployment_strategy_id: "DeploymentStrategyId", # required
|
|
876
|
+
# })
|
|
877
|
+
#
|
|
878
|
+
# @example Response structure
|
|
879
|
+
#
|
|
880
|
+
# resp.id #=> String
|
|
881
|
+
# resp.name #=> String
|
|
882
|
+
# resp.description #=> String
|
|
883
|
+
# resp.deployment_duration_in_minutes #=> Integer
|
|
884
|
+
# resp.growth_type #=> String, one of "LINEAR"
|
|
885
|
+
# resp.growth_factor #=> Float
|
|
886
|
+
# resp.final_bake_time_in_minutes #=> Integer
|
|
887
|
+
# resp.replicate_to #=> String, one of "NONE", "SSM_DOCUMENT"
|
|
888
|
+
#
|
|
889
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/GetDeploymentStrategy AWS API Documentation
|
|
890
|
+
#
|
|
891
|
+
# @overload get_deployment_strategy(params = {})
|
|
892
|
+
# @param [Hash] params ({})
|
|
893
|
+
def get_deployment_strategy(params = {}, options = {})
|
|
894
|
+
req = build_request(:get_deployment_strategy, params)
|
|
895
|
+
req.send_request(options)
|
|
896
|
+
end
|
|
897
|
+
|
|
898
|
+
# Retrieve information about an environment. An environment is a logical
|
|
899
|
+
# deployment group of AppConfig applications, such as applications in a
|
|
900
|
+
# `Production` environment or in an `EU_Region` environment. Each
|
|
901
|
+
# configuration deployment targets an environment. You can enable one or
|
|
902
|
+
# more Amazon CloudWatch alarms for an environment. If an alarm is
|
|
903
|
+
# triggered during a deployment, AppConfig roles back the configuration.
|
|
904
|
+
#
|
|
905
|
+
# @option params [required, String] :application_id
|
|
906
|
+
# The ID of the application that includes the environment you want to
|
|
907
|
+
# get.
|
|
908
|
+
#
|
|
909
|
+
# @option params [required, String] :environment_id
|
|
910
|
+
# The ID of the environment you wnat to get.
|
|
911
|
+
#
|
|
912
|
+
# @return [Types::Environment] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
913
|
+
#
|
|
914
|
+
# * {Types::Environment#application_id #application_id} => String
|
|
915
|
+
# * {Types::Environment#id #id} => String
|
|
916
|
+
# * {Types::Environment#name #name} => String
|
|
917
|
+
# * {Types::Environment#description #description} => String
|
|
918
|
+
# * {Types::Environment#state #state} => String
|
|
919
|
+
# * {Types::Environment#monitors #monitors} => Array<Types::Monitor>
|
|
920
|
+
#
|
|
921
|
+
# @example Request syntax with placeholder values
|
|
922
|
+
#
|
|
923
|
+
# resp = client.get_environment({
|
|
924
|
+
# application_id: "Id", # required
|
|
925
|
+
# environment_id: "Id", # required
|
|
926
|
+
# })
|
|
927
|
+
#
|
|
928
|
+
# @example Response structure
|
|
929
|
+
#
|
|
930
|
+
# resp.application_id #=> String
|
|
931
|
+
# resp.id #=> String
|
|
932
|
+
# resp.name #=> String
|
|
933
|
+
# resp.description #=> String
|
|
934
|
+
# resp.state #=> String, one of "READY_FOR_DEPLOYMENT", "DEPLOYING", "ROLLING_BACK", "ROLLED_BACK"
|
|
935
|
+
# resp.monitors #=> Array
|
|
936
|
+
# resp.monitors[0].alarm_arn #=> String
|
|
937
|
+
# resp.monitors[0].alarm_role_arn #=> String
|
|
938
|
+
#
|
|
939
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/GetEnvironment AWS API Documentation
|
|
940
|
+
#
|
|
941
|
+
# @overload get_environment(params = {})
|
|
942
|
+
# @param [Hash] params ({})
|
|
943
|
+
def get_environment(params = {}, options = {})
|
|
944
|
+
req = build_request(:get_environment, params)
|
|
945
|
+
req.send_request(options)
|
|
946
|
+
end
|
|
947
|
+
|
|
948
|
+
# List all applications in your AWS account.
|
|
949
|
+
#
|
|
950
|
+
# @option params [Integer] :max_results
|
|
951
|
+
# The maximum number of items to return for this call. The call also
|
|
952
|
+
# returns a token that you can specify in a subsequent call to get the
|
|
953
|
+
# next set of results.
|
|
954
|
+
#
|
|
955
|
+
# @option params [String] :next_token
|
|
956
|
+
# A token to start the list. Use this token to get the next set of
|
|
957
|
+
# results.
|
|
958
|
+
#
|
|
959
|
+
# @return [Types::Applications] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
960
|
+
#
|
|
961
|
+
# * {Types::Applications#items #items} => Array<Types::Application>
|
|
962
|
+
# * {Types::Applications#next_token #next_token} => String
|
|
963
|
+
#
|
|
964
|
+
# @example Request syntax with placeholder values
|
|
965
|
+
#
|
|
966
|
+
# resp = client.list_applications({
|
|
967
|
+
# max_results: 1,
|
|
968
|
+
# next_token: "NextToken",
|
|
969
|
+
# })
|
|
970
|
+
#
|
|
971
|
+
# @example Response structure
|
|
972
|
+
#
|
|
973
|
+
# resp.items #=> Array
|
|
974
|
+
# resp.items[0].id #=> String
|
|
975
|
+
# resp.items[0].name #=> String
|
|
976
|
+
# resp.items[0].description #=> String
|
|
977
|
+
# resp.next_token #=> String
|
|
978
|
+
#
|
|
979
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/ListApplications AWS API Documentation
|
|
980
|
+
#
|
|
981
|
+
# @overload list_applications(params = {})
|
|
982
|
+
# @param [Hash] params ({})
|
|
983
|
+
def list_applications(params = {}, options = {})
|
|
984
|
+
req = build_request(:list_applications, params)
|
|
985
|
+
req.send_request(options)
|
|
986
|
+
end
|
|
987
|
+
|
|
988
|
+
# Lists the configuration profiles for an application.
|
|
989
|
+
#
|
|
990
|
+
# @option params [required, String] :application_id
|
|
991
|
+
# The application ID.
|
|
992
|
+
#
|
|
993
|
+
# @option params [Integer] :max_results
|
|
994
|
+
# The maximum number of items to return for this call. The call also
|
|
995
|
+
# returns a token that you can specify in a subsequent call to get the
|
|
996
|
+
# next set of results.
|
|
997
|
+
#
|
|
998
|
+
# @option params [String] :next_token
|
|
999
|
+
# A token to start the list. Use this token to get the next set of
|
|
1000
|
+
# results.
|
|
1001
|
+
#
|
|
1002
|
+
# @return [Types::ConfigurationProfiles] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1003
|
+
#
|
|
1004
|
+
# * {Types::ConfigurationProfiles#items #items} => Array<Types::ConfigurationProfileSummary>
|
|
1005
|
+
# * {Types::ConfigurationProfiles#next_token #next_token} => String
|
|
1006
|
+
#
|
|
1007
|
+
# @example Request syntax with placeholder values
|
|
1008
|
+
#
|
|
1009
|
+
# resp = client.list_configuration_profiles({
|
|
1010
|
+
# application_id: "Id", # required
|
|
1011
|
+
# max_results: 1,
|
|
1012
|
+
# next_token: "NextToken",
|
|
1013
|
+
# })
|
|
1014
|
+
#
|
|
1015
|
+
# @example Response structure
|
|
1016
|
+
#
|
|
1017
|
+
# resp.items #=> Array
|
|
1018
|
+
# resp.items[0].application_id #=> String
|
|
1019
|
+
# resp.items[0].id #=> String
|
|
1020
|
+
# resp.items[0].name #=> String
|
|
1021
|
+
# resp.items[0].location_uri #=> String
|
|
1022
|
+
# resp.items[0].validator_types #=> Array
|
|
1023
|
+
# resp.items[0].validator_types[0] #=> String, one of "JSON_SCHEMA", "LAMBDA"
|
|
1024
|
+
# resp.next_token #=> String
|
|
1025
|
+
#
|
|
1026
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/ListConfigurationProfiles AWS API Documentation
|
|
1027
|
+
#
|
|
1028
|
+
# @overload list_configuration_profiles(params = {})
|
|
1029
|
+
# @param [Hash] params ({})
|
|
1030
|
+
def list_configuration_profiles(params = {}, options = {})
|
|
1031
|
+
req = build_request(:list_configuration_profiles, params)
|
|
1032
|
+
req.send_request(options)
|
|
1033
|
+
end
|
|
1034
|
+
|
|
1035
|
+
# List deployment strategies.
|
|
1036
|
+
#
|
|
1037
|
+
# @option params [Integer] :max_results
|
|
1038
|
+
# The maximum number of items to return for this call. The call also
|
|
1039
|
+
# returns a token that you can specify in a subsequent call to get the
|
|
1040
|
+
# next set of results.
|
|
1041
|
+
#
|
|
1042
|
+
# @option params [String] :next_token
|
|
1043
|
+
# A token to start the list. Use this token to get the next set of
|
|
1044
|
+
# results.
|
|
1045
|
+
#
|
|
1046
|
+
# @return [Types::DeploymentStrategies] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1047
|
+
#
|
|
1048
|
+
# * {Types::DeploymentStrategies#items #items} => Array<Types::DeploymentStrategy>
|
|
1049
|
+
# * {Types::DeploymentStrategies#next_token #next_token} => String
|
|
1050
|
+
#
|
|
1051
|
+
# @example Request syntax with placeholder values
|
|
1052
|
+
#
|
|
1053
|
+
# resp = client.list_deployment_strategies({
|
|
1054
|
+
# max_results: 1,
|
|
1055
|
+
# next_token: "NextToken",
|
|
1056
|
+
# })
|
|
1057
|
+
#
|
|
1058
|
+
# @example Response structure
|
|
1059
|
+
#
|
|
1060
|
+
# resp.items #=> Array
|
|
1061
|
+
# resp.items[0].id #=> String
|
|
1062
|
+
# resp.items[0].name #=> String
|
|
1063
|
+
# resp.items[0].description #=> String
|
|
1064
|
+
# resp.items[0].deployment_duration_in_minutes #=> Integer
|
|
1065
|
+
# resp.items[0].growth_type #=> String, one of "LINEAR"
|
|
1066
|
+
# resp.items[0].growth_factor #=> Float
|
|
1067
|
+
# resp.items[0].final_bake_time_in_minutes #=> Integer
|
|
1068
|
+
# resp.items[0].replicate_to #=> String, one of "NONE", "SSM_DOCUMENT"
|
|
1069
|
+
# resp.next_token #=> String
|
|
1070
|
+
#
|
|
1071
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/ListDeploymentStrategies AWS API Documentation
|
|
1072
|
+
#
|
|
1073
|
+
# @overload list_deployment_strategies(params = {})
|
|
1074
|
+
# @param [Hash] params ({})
|
|
1075
|
+
def list_deployment_strategies(params = {}, options = {})
|
|
1076
|
+
req = build_request(:list_deployment_strategies, params)
|
|
1077
|
+
req.send_request(options)
|
|
1078
|
+
end
|
|
1079
|
+
|
|
1080
|
+
# Lists the deployments for an environment.
|
|
1081
|
+
#
|
|
1082
|
+
# @option params [required, String] :application_id
|
|
1083
|
+
# The application ID.
|
|
1084
|
+
#
|
|
1085
|
+
# @option params [required, String] :environment_id
|
|
1086
|
+
# The environment ID.
|
|
1087
|
+
#
|
|
1088
|
+
# @option params [Integer] :max_results
|
|
1089
|
+
# The maximum number of items to return for this call. The call also
|
|
1090
|
+
# returns a token that you can specify in a subsequent call to get the
|
|
1091
|
+
# next set of results.
|
|
1092
|
+
#
|
|
1093
|
+
# @option params [String] :next_token
|
|
1094
|
+
# A token to start the list. Use this token to get the next set of
|
|
1095
|
+
# results.
|
|
1096
|
+
#
|
|
1097
|
+
# @return [Types::Deployments] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1098
|
+
#
|
|
1099
|
+
# * {Types::Deployments#items #items} => Array<Types::DeploymentSummary>
|
|
1100
|
+
# * {Types::Deployments#next_token #next_token} => String
|
|
1101
|
+
#
|
|
1102
|
+
# @example Request syntax with placeholder values
|
|
1103
|
+
#
|
|
1104
|
+
# resp = client.list_deployments({
|
|
1105
|
+
# application_id: "Id", # required
|
|
1106
|
+
# environment_id: "Id", # required
|
|
1107
|
+
# max_results: 1,
|
|
1108
|
+
# next_token: "NextToken",
|
|
1109
|
+
# })
|
|
1110
|
+
#
|
|
1111
|
+
# @example Response structure
|
|
1112
|
+
#
|
|
1113
|
+
# resp.items #=> Array
|
|
1114
|
+
# resp.items[0].deployment_number #=> Integer
|
|
1115
|
+
# resp.items[0].configuration_name #=> String
|
|
1116
|
+
# resp.items[0].configuration_version #=> String
|
|
1117
|
+
# resp.items[0].deployment_duration_in_minutes #=> Integer
|
|
1118
|
+
# resp.items[0].growth_type #=> String, one of "LINEAR"
|
|
1119
|
+
# resp.items[0].growth_factor #=> Float
|
|
1120
|
+
# resp.items[0].final_bake_time_in_minutes #=> Integer
|
|
1121
|
+
# resp.items[0].state #=> String, one of "BAKING", "VALIDATING", "DEPLOYING", "COMPLETE", "ROLLING_BACK", "ROLLED_BACK"
|
|
1122
|
+
# resp.items[0].percentage_complete #=> Float
|
|
1123
|
+
# resp.items[0].started_at #=> Time
|
|
1124
|
+
# resp.items[0].completed_at #=> Time
|
|
1125
|
+
# resp.next_token #=> String
|
|
1126
|
+
#
|
|
1127
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/ListDeployments AWS API Documentation
|
|
1128
|
+
#
|
|
1129
|
+
# @overload list_deployments(params = {})
|
|
1130
|
+
# @param [Hash] params ({})
|
|
1131
|
+
def list_deployments(params = {}, options = {})
|
|
1132
|
+
req = build_request(:list_deployments, params)
|
|
1133
|
+
req.send_request(options)
|
|
1134
|
+
end
|
|
1135
|
+
|
|
1136
|
+
# List the environments for an application.
|
|
1137
|
+
#
|
|
1138
|
+
# @option params [required, String] :application_id
|
|
1139
|
+
# The application ID.
|
|
1140
|
+
#
|
|
1141
|
+
# @option params [Integer] :max_results
|
|
1142
|
+
# The maximum number of items to return for this call. The call also
|
|
1143
|
+
# returns a token that you can specify in a subsequent call to get the
|
|
1144
|
+
# next set of results.
|
|
1145
|
+
#
|
|
1146
|
+
# @option params [String] :next_token
|
|
1147
|
+
# A token to start the list. Use this token to get the next set of
|
|
1148
|
+
# results.
|
|
1149
|
+
#
|
|
1150
|
+
# @return [Types::Environments] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1151
|
+
#
|
|
1152
|
+
# * {Types::Environments#items #items} => Array<Types::Environment>
|
|
1153
|
+
# * {Types::Environments#next_token #next_token} => String
|
|
1154
|
+
#
|
|
1155
|
+
# @example Request syntax with placeholder values
|
|
1156
|
+
#
|
|
1157
|
+
# resp = client.list_environments({
|
|
1158
|
+
# application_id: "Id", # required
|
|
1159
|
+
# max_results: 1,
|
|
1160
|
+
# next_token: "NextToken",
|
|
1161
|
+
# })
|
|
1162
|
+
#
|
|
1163
|
+
# @example Response structure
|
|
1164
|
+
#
|
|
1165
|
+
# resp.items #=> Array
|
|
1166
|
+
# resp.items[0].application_id #=> String
|
|
1167
|
+
# resp.items[0].id #=> String
|
|
1168
|
+
# resp.items[0].name #=> String
|
|
1169
|
+
# resp.items[0].description #=> String
|
|
1170
|
+
# resp.items[0].state #=> String, one of "READY_FOR_DEPLOYMENT", "DEPLOYING", "ROLLING_BACK", "ROLLED_BACK"
|
|
1171
|
+
# resp.items[0].monitors #=> Array
|
|
1172
|
+
# resp.items[0].monitors[0].alarm_arn #=> String
|
|
1173
|
+
# resp.items[0].monitors[0].alarm_role_arn #=> String
|
|
1174
|
+
# resp.next_token #=> String
|
|
1175
|
+
#
|
|
1176
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/ListEnvironments AWS API Documentation
|
|
1177
|
+
#
|
|
1178
|
+
# @overload list_environments(params = {})
|
|
1179
|
+
# @param [Hash] params ({})
|
|
1180
|
+
def list_environments(params = {}, options = {})
|
|
1181
|
+
req = build_request(:list_environments, params)
|
|
1182
|
+
req.send_request(options)
|
|
1183
|
+
end
|
|
1184
|
+
|
|
1185
|
+
# Retrieves the list of key-value tags assigned to the resource.
|
|
1186
|
+
#
|
|
1187
|
+
# @option params [required, String] :resource_arn
|
|
1188
|
+
# The resource ARN.
|
|
1189
|
+
#
|
|
1190
|
+
# @return [Types::ResourceTags] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1191
|
+
#
|
|
1192
|
+
# * {Types::ResourceTags#tags #tags} => Hash<String,String>
|
|
1193
|
+
#
|
|
1194
|
+
# @example Request syntax with placeholder values
|
|
1195
|
+
#
|
|
1196
|
+
# resp = client.list_tags_for_resource({
|
|
1197
|
+
# resource_arn: "Arn", # required
|
|
1198
|
+
# })
|
|
1199
|
+
#
|
|
1200
|
+
# @example Response structure
|
|
1201
|
+
#
|
|
1202
|
+
# resp.tags #=> Hash
|
|
1203
|
+
# resp.tags["TagKey"] #=> String
|
|
1204
|
+
#
|
|
1205
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/ListTagsForResource AWS API Documentation
|
|
1206
|
+
#
|
|
1207
|
+
# @overload list_tags_for_resource(params = {})
|
|
1208
|
+
# @param [Hash] params ({})
|
|
1209
|
+
def list_tags_for_resource(params = {}, options = {})
|
|
1210
|
+
req = build_request(:list_tags_for_resource, params)
|
|
1211
|
+
req.send_request(options)
|
|
1212
|
+
end
|
|
1213
|
+
|
|
1214
|
+
# Starts a deployment.
|
|
1215
|
+
#
|
|
1216
|
+
# @option params [required, String] :application_id
|
|
1217
|
+
# The application ID.
|
|
1218
|
+
#
|
|
1219
|
+
# @option params [required, String] :environment_id
|
|
1220
|
+
# The environment ID.
|
|
1221
|
+
#
|
|
1222
|
+
# @option params [required, String] :deployment_strategy_id
|
|
1223
|
+
# The deployment strategy ID.
|
|
1224
|
+
#
|
|
1225
|
+
# @option params [required, String] :configuration_profile_id
|
|
1226
|
+
# The configuration profile ID.
|
|
1227
|
+
#
|
|
1228
|
+
# @option params [required, String] :configuration_version
|
|
1229
|
+
# The configuration version to deploy.
|
|
1230
|
+
#
|
|
1231
|
+
# @option params [String] :description
|
|
1232
|
+
# A description of the deployment.
|
|
1233
|
+
#
|
|
1234
|
+
# @option params [Hash<String,String>] :tags
|
|
1235
|
+
# Metadata to assign to the deployment. Tags help organize and
|
|
1236
|
+
# categorize your AppConfig resources. Each tag consists of a key and an
|
|
1237
|
+
# optional value, both of which you define.
|
|
1238
|
+
#
|
|
1239
|
+
# @return [Types::Deployment] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1240
|
+
#
|
|
1241
|
+
# * {Types::Deployment#application_id #application_id} => String
|
|
1242
|
+
# * {Types::Deployment#environment_id #environment_id} => String
|
|
1243
|
+
# * {Types::Deployment#deployment_strategy_id #deployment_strategy_id} => String
|
|
1244
|
+
# * {Types::Deployment#configuration_profile_id #configuration_profile_id} => String
|
|
1245
|
+
# * {Types::Deployment#deployment_number #deployment_number} => Integer
|
|
1246
|
+
# * {Types::Deployment#configuration_name #configuration_name} => String
|
|
1247
|
+
# * {Types::Deployment#configuration_location_uri #configuration_location_uri} => String
|
|
1248
|
+
# * {Types::Deployment#configuration_version #configuration_version} => String
|
|
1249
|
+
# * {Types::Deployment#description #description} => String
|
|
1250
|
+
# * {Types::Deployment#deployment_duration_in_minutes #deployment_duration_in_minutes} => Integer
|
|
1251
|
+
# * {Types::Deployment#growth_type #growth_type} => String
|
|
1252
|
+
# * {Types::Deployment#growth_factor #growth_factor} => Float
|
|
1253
|
+
# * {Types::Deployment#final_bake_time_in_minutes #final_bake_time_in_minutes} => Integer
|
|
1254
|
+
# * {Types::Deployment#state #state} => String
|
|
1255
|
+
# * {Types::Deployment#percentage_complete #percentage_complete} => Float
|
|
1256
|
+
# * {Types::Deployment#started_at #started_at} => Time
|
|
1257
|
+
# * {Types::Deployment#completed_at #completed_at} => Time
|
|
1258
|
+
#
|
|
1259
|
+
# @example Request syntax with placeholder values
|
|
1260
|
+
#
|
|
1261
|
+
# resp = client.start_deployment({
|
|
1262
|
+
# application_id: "Id", # required
|
|
1263
|
+
# environment_id: "Id", # required
|
|
1264
|
+
# deployment_strategy_id: "DeploymentStrategyId", # required
|
|
1265
|
+
# configuration_profile_id: "Id", # required
|
|
1266
|
+
# configuration_version: "Version", # required
|
|
1267
|
+
# description: "Description",
|
|
1268
|
+
# tags: {
|
|
1269
|
+
# "TagKey" => "TagValue",
|
|
1270
|
+
# },
|
|
1271
|
+
# })
|
|
1272
|
+
#
|
|
1273
|
+
# @example Response structure
|
|
1274
|
+
#
|
|
1275
|
+
# resp.application_id #=> String
|
|
1276
|
+
# resp.environment_id #=> String
|
|
1277
|
+
# resp.deployment_strategy_id #=> String
|
|
1278
|
+
# resp.configuration_profile_id #=> String
|
|
1279
|
+
# resp.deployment_number #=> Integer
|
|
1280
|
+
# resp.configuration_name #=> String
|
|
1281
|
+
# resp.configuration_location_uri #=> String
|
|
1282
|
+
# resp.configuration_version #=> String
|
|
1283
|
+
# resp.description #=> String
|
|
1284
|
+
# resp.deployment_duration_in_minutes #=> Integer
|
|
1285
|
+
# resp.growth_type #=> String, one of "LINEAR"
|
|
1286
|
+
# resp.growth_factor #=> Float
|
|
1287
|
+
# resp.final_bake_time_in_minutes #=> Integer
|
|
1288
|
+
# resp.state #=> String, one of "BAKING", "VALIDATING", "DEPLOYING", "COMPLETE", "ROLLING_BACK", "ROLLED_BACK"
|
|
1289
|
+
# resp.percentage_complete #=> Float
|
|
1290
|
+
# resp.started_at #=> Time
|
|
1291
|
+
# resp.completed_at #=> Time
|
|
1292
|
+
#
|
|
1293
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/StartDeployment AWS API Documentation
|
|
1294
|
+
#
|
|
1295
|
+
# @overload start_deployment(params = {})
|
|
1296
|
+
# @param [Hash] params ({})
|
|
1297
|
+
def start_deployment(params = {}, options = {})
|
|
1298
|
+
req = build_request(:start_deployment, params)
|
|
1299
|
+
req.send_request(options)
|
|
1300
|
+
end
|
|
1301
|
+
|
|
1302
|
+
# Stops a deployment. This API action works only on deployments that
|
|
1303
|
+
# have a status of `DEPLOYING`. This action moves the deployment to a
|
|
1304
|
+
# status of `ROLLED_BACK`.
|
|
1305
|
+
#
|
|
1306
|
+
# @option params [required, String] :application_id
|
|
1307
|
+
# The application ID.
|
|
1308
|
+
#
|
|
1309
|
+
# @option params [required, String] :environment_id
|
|
1310
|
+
# The environment ID.
|
|
1311
|
+
#
|
|
1312
|
+
# @option params [required, Integer] :deployment_number
|
|
1313
|
+
# The sequence number of the deployment.
|
|
1314
|
+
#
|
|
1315
|
+
# @return [Types::Deployment] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1316
|
+
#
|
|
1317
|
+
# * {Types::Deployment#application_id #application_id} => String
|
|
1318
|
+
# * {Types::Deployment#environment_id #environment_id} => String
|
|
1319
|
+
# * {Types::Deployment#deployment_strategy_id #deployment_strategy_id} => String
|
|
1320
|
+
# * {Types::Deployment#configuration_profile_id #configuration_profile_id} => String
|
|
1321
|
+
# * {Types::Deployment#deployment_number #deployment_number} => Integer
|
|
1322
|
+
# * {Types::Deployment#configuration_name #configuration_name} => String
|
|
1323
|
+
# * {Types::Deployment#configuration_location_uri #configuration_location_uri} => String
|
|
1324
|
+
# * {Types::Deployment#configuration_version #configuration_version} => String
|
|
1325
|
+
# * {Types::Deployment#description #description} => String
|
|
1326
|
+
# * {Types::Deployment#deployment_duration_in_minutes #deployment_duration_in_minutes} => Integer
|
|
1327
|
+
# * {Types::Deployment#growth_type #growth_type} => String
|
|
1328
|
+
# * {Types::Deployment#growth_factor #growth_factor} => Float
|
|
1329
|
+
# * {Types::Deployment#final_bake_time_in_minutes #final_bake_time_in_minutes} => Integer
|
|
1330
|
+
# * {Types::Deployment#state #state} => String
|
|
1331
|
+
# * {Types::Deployment#percentage_complete #percentage_complete} => Float
|
|
1332
|
+
# * {Types::Deployment#started_at #started_at} => Time
|
|
1333
|
+
# * {Types::Deployment#completed_at #completed_at} => Time
|
|
1334
|
+
#
|
|
1335
|
+
# @example Request syntax with placeholder values
|
|
1336
|
+
#
|
|
1337
|
+
# resp = client.stop_deployment({
|
|
1338
|
+
# application_id: "Id", # required
|
|
1339
|
+
# environment_id: "Id", # required
|
|
1340
|
+
# deployment_number: 1, # required
|
|
1341
|
+
# })
|
|
1342
|
+
#
|
|
1343
|
+
# @example Response structure
|
|
1344
|
+
#
|
|
1345
|
+
# resp.application_id #=> String
|
|
1346
|
+
# resp.environment_id #=> String
|
|
1347
|
+
# resp.deployment_strategy_id #=> String
|
|
1348
|
+
# resp.configuration_profile_id #=> String
|
|
1349
|
+
# resp.deployment_number #=> Integer
|
|
1350
|
+
# resp.configuration_name #=> String
|
|
1351
|
+
# resp.configuration_location_uri #=> String
|
|
1352
|
+
# resp.configuration_version #=> String
|
|
1353
|
+
# resp.description #=> String
|
|
1354
|
+
# resp.deployment_duration_in_minutes #=> Integer
|
|
1355
|
+
# resp.growth_type #=> String, one of "LINEAR"
|
|
1356
|
+
# resp.growth_factor #=> Float
|
|
1357
|
+
# resp.final_bake_time_in_minutes #=> Integer
|
|
1358
|
+
# resp.state #=> String, one of "BAKING", "VALIDATING", "DEPLOYING", "COMPLETE", "ROLLING_BACK", "ROLLED_BACK"
|
|
1359
|
+
# resp.percentage_complete #=> Float
|
|
1360
|
+
# resp.started_at #=> Time
|
|
1361
|
+
# resp.completed_at #=> Time
|
|
1362
|
+
#
|
|
1363
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/StopDeployment AWS API Documentation
|
|
1364
|
+
#
|
|
1365
|
+
# @overload stop_deployment(params = {})
|
|
1366
|
+
# @param [Hash] params ({})
|
|
1367
|
+
def stop_deployment(params = {}, options = {})
|
|
1368
|
+
req = build_request(:stop_deployment, params)
|
|
1369
|
+
req.send_request(options)
|
|
1370
|
+
end
|
|
1371
|
+
|
|
1372
|
+
# Metadata to assign to an AppConfig resource. Tags help organize and
|
|
1373
|
+
# categorize your AppConfig resources. Each tag consists of a key and an
|
|
1374
|
+
# optional value, both of which you define. You can specify a maximum of
|
|
1375
|
+
# 50 tags for a resource.
|
|
1376
|
+
#
|
|
1377
|
+
# @option params [required, String] :resource_arn
|
|
1378
|
+
# The ARN of the resource for which to retrieve tags.
|
|
1379
|
+
#
|
|
1380
|
+
# @option params [required, Hash<String,String>] :tags
|
|
1381
|
+
# The key-value string map. The valid character set is
|
|
1382
|
+
# \[a-zA-Z+-=.\_:/\]. The tag key can be up to 128 characters and must
|
|
1383
|
+
# not start with `aws:`. The tag value can be up to 256 characters.
|
|
1384
|
+
#
|
|
1385
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
1386
|
+
#
|
|
1387
|
+
# @example Request syntax with placeholder values
|
|
1388
|
+
#
|
|
1389
|
+
# resp = client.tag_resource({
|
|
1390
|
+
# resource_arn: "Arn", # required
|
|
1391
|
+
# tags: { # required
|
|
1392
|
+
# "TagKey" => "TagValue",
|
|
1393
|
+
# },
|
|
1394
|
+
# })
|
|
1395
|
+
#
|
|
1396
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/TagResource AWS API Documentation
|
|
1397
|
+
#
|
|
1398
|
+
# @overload tag_resource(params = {})
|
|
1399
|
+
# @param [Hash] params ({})
|
|
1400
|
+
def tag_resource(params = {}, options = {})
|
|
1401
|
+
req = build_request(:tag_resource, params)
|
|
1402
|
+
req.send_request(options)
|
|
1403
|
+
end
|
|
1404
|
+
|
|
1405
|
+
# Deletes a tag key and value from an AppConfig resource.
|
|
1406
|
+
#
|
|
1407
|
+
# @option params [required, String] :resource_arn
|
|
1408
|
+
# The ARN of the resource for which to remove tags.
|
|
1409
|
+
#
|
|
1410
|
+
# @option params [required, Array<String>] :tag_keys
|
|
1411
|
+
# The tag keys to delete.
|
|
1412
|
+
#
|
|
1413
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
1414
|
+
#
|
|
1415
|
+
# @example Request syntax with placeholder values
|
|
1416
|
+
#
|
|
1417
|
+
# resp = client.untag_resource({
|
|
1418
|
+
# resource_arn: "Arn", # required
|
|
1419
|
+
# tag_keys: ["TagKey"], # required
|
|
1420
|
+
# })
|
|
1421
|
+
#
|
|
1422
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/UntagResource AWS API Documentation
|
|
1423
|
+
#
|
|
1424
|
+
# @overload untag_resource(params = {})
|
|
1425
|
+
# @param [Hash] params ({})
|
|
1426
|
+
def untag_resource(params = {}, options = {})
|
|
1427
|
+
req = build_request(:untag_resource, params)
|
|
1428
|
+
req.send_request(options)
|
|
1429
|
+
end
|
|
1430
|
+
|
|
1431
|
+
# Updates an application.
|
|
1432
|
+
#
|
|
1433
|
+
# @option params [required, String] :application_id
|
|
1434
|
+
# The application ID.
|
|
1435
|
+
#
|
|
1436
|
+
# @option params [String] :name
|
|
1437
|
+
# The name of the application.
|
|
1438
|
+
#
|
|
1439
|
+
# @option params [String] :description
|
|
1440
|
+
# A description of the application.
|
|
1441
|
+
#
|
|
1442
|
+
# @return [Types::Application] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1443
|
+
#
|
|
1444
|
+
# * {Types::Application#id #id} => String
|
|
1445
|
+
# * {Types::Application#name #name} => String
|
|
1446
|
+
# * {Types::Application#description #description} => String
|
|
1447
|
+
#
|
|
1448
|
+
# @example Request syntax with placeholder values
|
|
1449
|
+
#
|
|
1450
|
+
# resp = client.update_application({
|
|
1451
|
+
# application_id: "Id", # required
|
|
1452
|
+
# name: "Name",
|
|
1453
|
+
# description: "Description",
|
|
1454
|
+
# })
|
|
1455
|
+
#
|
|
1456
|
+
# @example Response structure
|
|
1457
|
+
#
|
|
1458
|
+
# resp.id #=> String
|
|
1459
|
+
# resp.name #=> String
|
|
1460
|
+
# resp.description #=> String
|
|
1461
|
+
#
|
|
1462
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/UpdateApplication AWS API Documentation
|
|
1463
|
+
#
|
|
1464
|
+
# @overload update_application(params = {})
|
|
1465
|
+
# @param [Hash] params ({})
|
|
1466
|
+
def update_application(params = {}, options = {})
|
|
1467
|
+
req = build_request(:update_application, params)
|
|
1468
|
+
req.send_request(options)
|
|
1469
|
+
end
|
|
1470
|
+
|
|
1471
|
+
# Updates a configuration profile.
|
|
1472
|
+
#
|
|
1473
|
+
# @option params [required, String] :application_id
|
|
1474
|
+
# The application ID.
|
|
1475
|
+
#
|
|
1476
|
+
# @option params [required, String] :configuration_profile_id
|
|
1477
|
+
# The ID of the configuration profile.
|
|
1478
|
+
#
|
|
1479
|
+
# @option params [String] :name
|
|
1480
|
+
# The name of the configuration profile.
|
|
1481
|
+
#
|
|
1482
|
+
# @option params [String] :description
|
|
1483
|
+
# A description of the configuration profile.
|
|
1484
|
+
#
|
|
1485
|
+
# @option params [String] :retrieval_role_arn
|
|
1486
|
+
# The ARN of an IAM role with permission to access the configuration at
|
|
1487
|
+
# the specified LocationUri.
|
|
1488
|
+
#
|
|
1489
|
+
# @option params [Array<Types::Validator>] :validators
|
|
1490
|
+
# A list of methods for validating the configuration.
|
|
1491
|
+
#
|
|
1492
|
+
# @return [Types::ConfigurationProfile] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1493
|
+
#
|
|
1494
|
+
# * {Types::ConfigurationProfile#application_id #application_id} => String
|
|
1495
|
+
# * {Types::ConfigurationProfile#id #id} => String
|
|
1496
|
+
# * {Types::ConfigurationProfile#name #name} => String
|
|
1497
|
+
# * {Types::ConfigurationProfile#description #description} => String
|
|
1498
|
+
# * {Types::ConfigurationProfile#location_uri #location_uri} => String
|
|
1499
|
+
# * {Types::ConfigurationProfile#retrieval_role_arn #retrieval_role_arn} => String
|
|
1500
|
+
# * {Types::ConfigurationProfile#validators #validators} => Array<Types::Validator>
|
|
1501
|
+
#
|
|
1502
|
+
# @example Request syntax with placeholder values
|
|
1503
|
+
#
|
|
1504
|
+
# resp = client.update_configuration_profile({
|
|
1505
|
+
# application_id: "Id", # required
|
|
1506
|
+
# configuration_profile_id: "Id", # required
|
|
1507
|
+
# name: "Name",
|
|
1508
|
+
# description: "Description",
|
|
1509
|
+
# retrieval_role_arn: "Arn",
|
|
1510
|
+
# validators: [
|
|
1511
|
+
# {
|
|
1512
|
+
# type: "JSON_SCHEMA", # required, accepts JSON_SCHEMA, LAMBDA
|
|
1513
|
+
# content: "StringWithLengthBetween0And32768", # required
|
|
1514
|
+
# },
|
|
1515
|
+
# ],
|
|
1516
|
+
# })
|
|
1517
|
+
#
|
|
1518
|
+
# @example Response structure
|
|
1519
|
+
#
|
|
1520
|
+
# resp.application_id #=> String
|
|
1521
|
+
# resp.id #=> String
|
|
1522
|
+
# resp.name #=> String
|
|
1523
|
+
# resp.description #=> String
|
|
1524
|
+
# resp.location_uri #=> String
|
|
1525
|
+
# resp.retrieval_role_arn #=> String
|
|
1526
|
+
# resp.validators #=> Array
|
|
1527
|
+
# resp.validators[0].type #=> String, one of "JSON_SCHEMA", "LAMBDA"
|
|
1528
|
+
# resp.validators[0].content #=> String
|
|
1529
|
+
#
|
|
1530
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/UpdateConfigurationProfile AWS API Documentation
|
|
1531
|
+
#
|
|
1532
|
+
# @overload update_configuration_profile(params = {})
|
|
1533
|
+
# @param [Hash] params ({})
|
|
1534
|
+
def update_configuration_profile(params = {}, options = {})
|
|
1535
|
+
req = build_request(:update_configuration_profile, params)
|
|
1536
|
+
req.send_request(options)
|
|
1537
|
+
end
|
|
1538
|
+
|
|
1539
|
+
# Updates a deployment strategy.
|
|
1540
|
+
#
|
|
1541
|
+
# @option params [required, String] :deployment_strategy_id
|
|
1542
|
+
# The deployment strategy ID.
|
|
1543
|
+
#
|
|
1544
|
+
# @option params [String] :description
|
|
1545
|
+
# A description of the deployment strategy.
|
|
1546
|
+
#
|
|
1547
|
+
# @option params [Integer] :deployment_duration_in_minutes
|
|
1548
|
+
# Total amount of time for a deployment to last.
|
|
1549
|
+
#
|
|
1550
|
+
# @option params [Integer] :final_bake_time_in_minutes
|
|
1551
|
+
# The amount of time AppConfig monitors for alarms before considering
|
|
1552
|
+
# the deployment to be complete and no longer eligible for automatic
|
|
1553
|
+
# roll back.
|
|
1554
|
+
#
|
|
1555
|
+
# @option params [Float] :growth_factor
|
|
1556
|
+
# The percentage of targets to receive a deployed configuration during
|
|
1557
|
+
# each interval.
|
|
1558
|
+
#
|
|
1559
|
+
# @option params [String] :growth_type
|
|
1560
|
+
# The algorithm used to define how percentage grows over time.
|
|
1561
|
+
#
|
|
1562
|
+
# @return [Types::DeploymentStrategy] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1563
|
+
#
|
|
1564
|
+
# * {Types::DeploymentStrategy#id #id} => String
|
|
1565
|
+
# * {Types::DeploymentStrategy#name #name} => String
|
|
1566
|
+
# * {Types::DeploymentStrategy#description #description} => String
|
|
1567
|
+
# * {Types::DeploymentStrategy#deployment_duration_in_minutes #deployment_duration_in_minutes} => Integer
|
|
1568
|
+
# * {Types::DeploymentStrategy#growth_type #growth_type} => String
|
|
1569
|
+
# * {Types::DeploymentStrategy#growth_factor #growth_factor} => Float
|
|
1570
|
+
# * {Types::DeploymentStrategy#final_bake_time_in_minutes #final_bake_time_in_minutes} => Integer
|
|
1571
|
+
# * {Types::DeploymentStrategy#replicate_to #replicate_to} => String
|
|
1572
|
+
#
|
|
1573
|
+
# @example Request syntax with placeholder values
|
|
1574
|
+
#
|
|
1575
|
+
# resp = client.update_deployment_strategy({
|
|
1576
|
+
# deployment_strategy_id: "DeploymentStrategyId", # required
|
|
1577
|
+
# description: "Description",
|
|
1578
|
+
# deployment_duration_in_minutes: 1,
|
|
1579
|
+
# final_bake_time_in_minutes: 1,
|
|
1580
|
+
# growth_factor: 1.0,
|
|
1581
|
+
# growth_type: "LINEAR", # accepts LINEAR
|
|
1582
|
+
# })
|
|
1583
|
+
#
|
|
1584
|
+
# @example Response structure
|
|
1585
|
+
#
|
|
1586
|
+
# resp.id #=> String
|
|
1587
|
+
# resp.name #=> String
|
|
1588
|
+
# resp.description #=> String
|
|
1589
|
+
# resp.deployment_duration_in_minutes #=> Integer
|
|
1590
|
+
# resp.growth_type #=> String, one of "LINEAR"
|
|
1591
|
+
# resp.growth_factor #=> Float
|
|
1592
|
+
# resp.final_bake_time_in_minutes #=> Integer
|
|
1593
|
+
# resp.replicate_to #=> String, one of "NONE", "SSM_DOCUMENT"
|
|
1594
|
+
#
|
|
1595
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/UpdateDeploymentStrategy AWS API Documentation
|
|
1596
|
+
#
|
|
1597
|
+
# @overload update_deployment_strategy(params = {})
|
|
1598
|
+
# @param [Hash] params ({})
|
|
1599
|
+
def update_deployment_strategy(params = {}, options = {})
|
|
1600
|
+
req = build_request(:update_deployment_strategy, params)
|
|
1601
|
+
req.send_request(options)
|
|
1602
|
+
end
|
|
1603
|
+
|
|
1604
|
+
# Updates an environment.
|
|
1605
|
+
#
|
|
1606
|
+
# @option params [required, String] :application_id
|
|
1607
|
+
# The application ID.
|
|
1608
|
+
#
|
|
1609
|
+
# @option params [required, String] :environment_id
|
|
1610
|
+
# The environment ID.
|
|
1611
|
+
#
|
|
1612
|
+
# @option params [String] :name
|
|
1613
|
+
# The name of the environment.
|
|
1614
|
+
#
|
|
1615
|
+
# @option params [String] :description
|
|
1616
|
+
# A description of the environment.
|
|
1617
|
+
#
|
|
1618
|
+
# @option params [Array<Types::Monitor>] :monitors
|
|
1619
|
+
# Amazon CloudWatch alarms to monitor during the deployment process.
|
|
1620
|
+
#
|
|
1621
|
+
# @return [Types::Environment] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1622
|
+
#
|
|
1623
|
+
# * {Types::Environment#application_id #application_id} => String
|
|
1624
|
+
# * {Types::Environment#id #id} => String
|
|
1625
|
+
# * {Types::Environment#name #name} => String
|
|
1626
|
+
# * {Types::Environment#description #description} => String
|
|
1627
|
+
# * {Types::Environment#state #state} => String
|
|
1628
|
+
# * {Types::Environment#monitors #monitors} => Array<Types::Monitor>
|
|
1629
|
+
#
|
|
1630
|
+
# @example Request syntax with placeholder values
|
|
1631
|
+
#
|
|
1632
|
+
# resp = client.update_environment({
|
|
1633
|
+
# application_id: "Id", # required
|
|
1634
|
+
# environment_id: "Id", # required
|
|
1635
|
+
# name: "Name",
|
|
1636
|
+
# description: "Description",
|
|
1637
|
+
# monitors: [
|
|
1638
|
+
# {
|
|
1639
|
+
# alarm_arn: "Arn",
|
|
1640
|
+
# alarm_role_arn: "Arn",
|
|
1641
|
+
# },
|
|
1642
|
+
# ],
|
|
1643
|
+
# })
|
|
1644
|
+
#
|
|
1645
|
+
# @example Response structure
|
|
1646
|
+
#
|
|
1647
|
+
# resp.application_id #=> String
|
|
1648
|
+
# resp.id #=> String
|
|
1649
|
+
# resp.name #=> String
|
|
1650
|
+
# resp.description #=> String
|
|
1651
|
+
# resp.state #=> String, one of "READY_FOR_DEPLOYMENT", "DEPLOYING", "ROLLING_BACK", "ROLLED_BACK"
|
|
1652
|
+
# resp.monitors #=> Array
|
|
1653
|
+
# resp.monitors[0].alarm_arn #=> String
|
|
1654
|
+
# resp.monitors[0].alarm_role_arn #=> String
|
|
1655
|
+
#
|
|
1656
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/UpdateEnvironment AWS API Documentation
|
|
1657
|
+
#
|
|
1658
|
+
# @overload update_environment(params = {})
|
|
1659
|
+
# @param [Hash] params ({})
|
|
1660
|
+
def update_environment(params = {}, options = {})
|
|
1661
|
+
req = build_request(:update_environment, params)
|
|
1662
|
+
req.send_request(options)
|
|
1663
|
+
end
|
|
1664
|
+
|
|
1665
|
+
# Uses the validators in a configuration profile to validate a
|
|
1666
|
+
# configuration.
|
|
1667
|
+
#
|
|
1668
|
+
# @option params [required, String] :application_id
|
|
1669
|
+
# The application ID.
|
|
1670
|
+
#
|
|
1671
|
+
# @option params [required, String] :configuration_profile_id
|
|
1672
|
+
# The configuration profile ID.
|
|
1673
|
+
#
|
|
1674
|
+
# @option params [required, String] :configuration_version
|
|
1675
|
+
# The version of the configuration to validate.
|
|
1676
|
+
#
|
|
1677
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
1678
|
+
#
|
|
1679
|
+
# @example Request syntax with placeholder values
|
|
1680
|
+
#
|
|
1681
|
+
# resp = client.validate_configuration({
|
|
1682
|
+
# application_id: "Id", # required
|
|
1683
|
+
# configuration_profile_id: "Id", # required
|
|
1684
|
+
# configuration_version: "Version", # required
|
|
1685
|
+
# })
|
|
1686
|
+
#
|
|
1687
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/ValidateConfiguration AWS API Documentation
|
|
1688
|
+
#
|
|
1689
|
+
# @overload validate_configuration(params = {})
|
|
1690
|
+
# @param [Hash] params ({})
|
|
1691
|
+
def validate_configuration(params = {}, options = {})
|
|
1692
|
+
req = build_request(:validate_configuration, params)
|
|
1693
|
+
req.send_request(options)
|
|
1694
|
+
end
|
|
1695
|
+
|
|
1696
|
+
# @!endgroup
|
|
1697
|
+
|
|
1698
|
+
# @param params ({})
|
|
1699
|
+
# @api private
|
|
1700
|
+
def build_request(operation_name, params = {})
|
|
1701
|
+
handlers = @handlers.for(operation_name)
|
|
1702
|
+
context = Seahorse::Client::RequestContext.new(
|
|
1703
|
+
operation_name: operation_name,
|
|
1704
|
+
operation: config.api.operation(operation_name),
|
|
1705
|
+
client: self,
|
|
1706
|
+
params: params,
|
|
1707
|
+
config: config)
|
|
1708
|
+
context[:gem_name] = 'aws-sdk-appconfig'
|
|
1709
|
+
context[:gem_version] = '1.0.0'
|
|
1710
|
+
Seahorse::Client::Request.new(handlers, context)
|
|
1711
|
+
end
|
|
1712
|
+
|
|
1713
|
+
# @api private
|
|
1714
|
+
# @deprecated
|
|
1715
|
+
def waiter_names
|
|
1716
|
+
[]
|
|
1717
|
+
end
|
|
1718
|
+
|
|
1719
|
+
class << self
|
|
1720
|
+
|
|
1721
|
+
# @api private
|
|
1722
|
+
attr_reader :identifier
|
|
1723
|
+
|
|
1724
|
+
# @api private
|
|
1725
|
+
def errors_module
|
|
1726
|
+
Errors
|
|
1727
|
+
end
|
|
1728
|
+
|
|
1729
|
+
end
|
|
1730
|
+
end
|
|
1731
|
+
end
|