aws-sdk-appconfig 1.1.0 → 1.3.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 1d4dde6721b7652ecb40216186bd633a72072d70
4
- data.tar.gz: 7c886af1a7e7f982936620893d2e1f0499082dad
2
+ SHA256:
3
+ metadata.gz: 445fadad25678fadc693fb5d4f31a0ad0de699a1e23b0f528e811f21b08932b0
4
+ data.tar.gz: c22fe42dac5814331491f2cf13befef70e2d6163ed8d10fe7a53954fed2eec9b
5
5
  SHA512:
6
- metadata.gz: c1f48b8f966b6e304f073922181c6d6c13fc72ed93701e1b96894ea1f4c6240be699af06c3ad58c6a56b4aedaa5c3a9c72e9168978b98e28edbc6f3dbfc251a1
7
- data.tar.gz: ea28dcf0311ce81ca71e1cc284fa3a970822d97e11e1b305b103cb2db6f0901ebaae86ecf2f4a221d7a3da5a1af2aed35057a9e81b1121c64a0544a628b4d219
6
+ metadata.gz: a7d3e9a99eaeacf136cc8a42e3236dcf3e9833dbf38a2d92864b11c603d296527e265be2110e19a871eb8f9340866908baf510fab0201a746d9b719c864ec443
7
+ data.tar.gz: cfacd6d6f30c80e300b6695366c3dd8b36b1caab62042e8313296db2ed68b2cc58ec22ba437c151dcced2a0e92e86e44c3fe89eb6779d3d3d58b0129b505edf8
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-appconfig/customizations'
24
24
  # methods each accept a hash of request parameters and return a response
25
25
  # structure.
26
26
  #
27
+ # app_config = Aws::AppConfig::Client.new
28
+ # resp = app_config.create_application(params)
29
+ #
27
30
  # See {Client} for more information.
28
31
  #
29
32
  # # Errors
30
33
  #
31
- # Errors returned from Amazon AppConfig all
32
- # extend {Errors::ServiceError}.
34
+ # Errors returned from Amazon AppConfig are defined in the
35
+ # {Errors} module and all extend {Errors::ServiceError}.
33
36
  #
34
37
  # begin
35
38
  # # do stuff
36
39
  # rescue Aws::AppConfig::Errors::ServiceError
37
- # # rescues all service API errors
40
+ # # rescues all Amazon AppConfig API errors
38
41
  # end
39
42
  #
40
43
  # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-appconfig/customizations'
42
45
  # @service
43
46
  module Aws::AppConfig
44
47
 
45
- GEM_VERSION = '1.1.0'
48
+ GEM_VERSION = '1.3.0'
46
49
 
47
50
  end
@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
30
30
  Aws::Plugins::GlobalConfiguration.add_identifier(:appconfig)
31
31
 
32
32
  module Aws::AppConfig
33
+ # An API client for AppConfig. To construct a client, you need to configure a `:region` and `:credentials`.
34
+ #
35
+ # client = Aws::AppConfig::Client.new(
36
+ # region: region_name,
37
+ # credentials: credentials,
38
+ # # ...
39
+ # )
40
+ #
41
+ # For details on configuring region and credentials see
42
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
43
+ #
44
+ # See {#initialize} for a full list of supported configuration options.
33
45
  class Client < Seahorse::Client::Base
34
46
 
35
47
  include Aws::ClientStubs
@@ -108,6 +120,12 @@ module Aws::AppConfig
108
120
  # When set to `true`, a thread polling for endpoints will be running in
109
121
  # the background every 60 secs (default). Defaults to `false`.
110
122
  #
123
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
124
+ # Used only in `adaptive` retry mode. When true, the request will sleep
125
+ # until there is sufficent client side capacity to retry the request.
126
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
127
+ # not retry instead of sleeping.
128
+ #
111
129
  # @option options [Boolean] :client_side_monitoring (false)
112
130
  # When `true`, client-side metrics will be collected for all API requests from
113
131
  # this client.
@@ -132,6 +150,10 @@ module Aws::AppConfig
132
150
  # When `true`, an attempt is made to coerce request parameters into
133
151
  # the required types.
134
152
  #
153
+ # @option options [Boolean] :correct_clock_skew (true)
154
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
155
+ # a clock skew correction and retry requests with skewed client clocks.
156
+ #
135
157
  # @option options [Boolean] :disable_host_prefix_injection (false)
136
158
  # Set to true to disable SDK automatically adding host prefix
137
159
  # to default service endpoint when available.
@@ -166,15 +188,29 @@ module Aws::AppConfig
166
188
  # The Logger instance to send log messages to. If this option
167
189
  # is not set, logging will be disabled.
168
190
  #
191
+ # @option options [Integer] :max_attempts (3)
192
+ # An integer representing the maximum number attempts that will be made for
193
+ # a single request, including the initial attempt. For example,
194
+ # setting this value to 5 will result in a request being retried up to
195
+ # 4 times. Used in `standard` and `adaptive` retry modes.
196
+ #
169
197
  # @option options [String] :profile ("default")
170
198
  # Used when loading credentials from the shared credentials file
171
199
  # at HOME/.aws/credentials. When not specified, 'default' is used.
172
200
  #
201
+ # @option options [Proc] :retry_backoff
202
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
203
+ # This option is only used in the `legacy` retry mode.
204
+ #
173
205
  # @option options [Float] :retry_base_delay (0.3)
174
- # The base delay in seconds used by the default backoff function.
206
+ # The base delay in seconds used by the default backoff function. This option
207
+ # is only used in the `legacy` retry mode.
175
208
  #
176
209
  # @option options [Symbol] :retry_jitter (:none)
177
- # A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
210
+ # A delay randomiser function used by the default backoff function.
211
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
212
+ # otherwise a Proc that takes and returns a number. This option is only used
213
+ # in the `legacy` retry mode.
178
214
  #
179
215
  # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
180
216
  #
@@ -182,11 +218,30 @@ module Aws::AppConfig
182
218
  # The maximum number of times to retry failed requests. Only
183
219
  # ~ 500 level server errors and certain ~ 400 level client errors
184
220
  # are retried. Generally, these are throttling errors, data
185
- # checksum errors, networking errors, timeout errors and auth
186
- # errors from expired credentials.
221
+ # checksum errors, networking errors, timeout errors, auth errors,
222
+ # endpoint discovery, and errors from expired credentials.
223
+ # This option is only used in the `legacy` retry mode.
187
224
  #
188
225
  # @option options [Integer] :retry_max_delay (0)
189
- # The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
226
+ # The maximum number of seconds to delay between retries (0 for no limit)
227
+ # used by the default backoff function. This option is only used in the
228
+ # `legacy` retry mode.
229
+ #
230
+ # @option options [String] :retry_mode ("legacy")
231
+ # Specifies which retry algorithm to use. Values are:
232
+ #
233
+ # * `legacy` - The pre-existing retry behavior. This is default value if
234
+ # no retry mode is provided.
235
+ #
236
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
237
+ # This includes support for retry quotas, which limit the number of
238
+ # unsuccessful retries a client can make.
239
+ #
240
+ # * `adaptive` - An experimental retry mode that includes all the
241
+ # functionality of `standard` mode along with automatic client side
242
+ # throttling. This is a provisional mode that may change behavior
243
+ # in the future.
244
+ #
190
245
  #
191
246
  # @option options [String] :secret_access_key
192
247
  #
@@ -209,16 +264,16 @@ module Aws::AppConfig
209
264
  # requests through. Formatted like 'http://proxy.com:123'.
210
265
  #
211
266
  # @option options [Float] :http_open_timeout (15) The number of
212
- # seconds to wait when opening a HTTP session before rasing a
267
+ # seconds to wait when opening a HTTP session before raising a
213
268
  # `Timeout::Error`.
214
269
  #
215
270
  # @option options [Integer] :http_read_timeout (60) The default
216
271
  # number of seconds to wait for response data. This value can
217
272
  # safely be set
218
- # per-request on the session yeidled by {#session_for}.
273
+ # per-request on the session yielded by {#session_for}.
219
274
  #
220
275
  # @option options [Float] :http_idle_timeout (5) The number of
221
- # seconds a connection is allowed to sit idble before it is
276
+ # seconds a connection is allowed to sit idle before it is
222
277
  # considered stale. Stale connections are closed and removed
223
278
  # from the pool before making a request.
224
279
  #
@@ -227,7 +282,7 @@ module Aws::AppConfig
227
282
  # request body. This option has no effect unless the request has
228
283
  # "Expect" header set to "100-continue". Defaults to `nil` which
229
284
  # disables this behaviour. This value can safely be set per
230
- # request on the session yeidled by {#session_for}.
285
+ # request on the session yielded by {#session_for}.
231
286
  #
232
287
  # @option options [Boolean] :http_wire_trace (false) When `true`,
233
288
  # HTTP debug output will be sent to the `:logger`.
@@ -303,9 +358,9 @@ module Aws::AppConfig
303
358
  end
304
359
 
305
360
  # 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.
361
+ # Valid configuration sources include Systems Manager (SSM) documents,
362
+ # SSM Parameter Store parameters, and Amazon S3 objects. A configuration
363
+ # profile includes the following information.
309
364
  #
310
365
  # * The Uri location of the configuration data.
311
366
  #
@@ -315,6 +370,13 @@ module Aws::AppConfig
315
370
  # * A validator for the configuration data. Available validators include
316
371
  # either a JSON Schema or an AWS Lambda function.
317
372
  #
373
+ # For more information, see [Create a Configuration and a Configuration
374
+ # Profile][1] in the *AWS AppConfig User Guide*.
375
+ #
376
+ #
377
+ #
378
+ # [1]: http://docs.aws.amazon.com/systems-manager/latest/userguide/appconfig-creating-configuration-and-profile.html
379
+ #
318
380
  # @option params [required, String] :application_id
319
381
  # The application ID.
320
382
  #
@@ -325,12 +387,15 @@ module Aws::AppConfig
325
387
  # A description of the configuration profile.
326
388
  #
327
389
  # @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.
390
+ # A URI to locate the configuration. You can specify a Systems Manager
391
+ # (SSM) document, an SSM Parameter Store parameter, or an Amazon S3
392
+ # object. For an SSM document, specify either the document name in the
393
+ # format `ssm-document://<Document_name>` or the Amazon Resource Name
394
+ # (ARN). For a parameter, specify either the parameter name in the
395
+ # format `ssm-parameter://<Parameter_name>` or the ARN. For an Amazon S3
396
+ # object, specify the URI in the following format:
397
+ # `s3://<bucket>/<objectKey> `. Here is an example:
398
+ # s3://my-bucket/my-app/us-east-1/my-config.json
334
399
  #
335
400
  # @option params [required, String] :retrieval_role_arn
336
401
  # The ARN of an IAM role with permission to access the configuration at
@@ -709,13 +774,16 @@ module Aws::AppConfig
709
774
  # Retrieve information about a configuration.
710
775
  #
711
776
  # @option params [required, String] :application
712
- # The application to get.
777
+ # The application to get. Specify either the application name or the
778
+ # application ID.
713
779
  #
714
780
  # @option params [required, String] :environment
715
- # The environment to get.
781
+ # The environment to get. Specify either the environment name or the
782
+ # environment ID.
716
783
  #
717
784
  # @option params [required, String] :configuration
718
- # The configuration to get.
785
+ # The configuration to get. Specify either the configuration name or the
786
+ # configuration ID.
719
787
  #
720
788
  # @option params [required, String] :client_id
721
789
  # A unique ID to identify the client for the configuration. This ID
@@ -1758,7 +1826,7 @@ module Aws::AppConfig
1758
1826
  params: params,
1759
1827
  config: config)
1760
1828
  context[:gem_name] = 'aws-sdk-appconfig'
1761
- context[:gem_version] = '1.1.0'
1829
+ context[:gem_version] = '1.3.0'
1762
1830
  Seahorse::Client::Request.new(handlers, context)
1763
1831
  end
1764
1832
 
@@ -6,6 +6,32 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::AppConfig
9
+
10
+ # When AppConfig returns an error response, the Ruby SDK constructs and raises an error.
11
+ # These errors all extend Aws::AppConfig::Errors::ServiceError < {Aws::Errors::ServiceError}
12
+ #
13
+ # You can rescue all AppConfig errors using ServiceError:
14
+ #
15
+ # begin
16
+ # # do stuff
17
+ # rescue Aws::AppConfig::Errors::ServiceError
18
+ # # rescues all AppConfig API errors
19
+ # end
20
+ #
21
+ #
22
+ # ## Request Context
23
+ # ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
24
+ # information about the request that generated the error.
25
+ # See {Seahorse::Client::RequestContext} for more information.
26
+ #
27
+ # ## Error Classes
28
+ # * {BadRequestException}
29
+ # * {ConflictException}
30
+ # * {InternalServerException}
31
+ # * {ResourceNotFoundException}
32
+ #
33
+ # Additionally, error classes are dynamically generated for service errors based on the error code
34
+ # if they are not defined above.
9
35
  module Errors
10
36
 
11
37
  extend Aws::Errors::DynamicErrors
@@ -23,7 +49,6 @@ module Aws::AppConfig
23
49
  def message
24
50
  @message || @data[:message]
25
51
  end
26
-
27
52
  end
28
53
 
29
54
  class ConflictException < ServiceError
@@ -39,7 +64,6 @@ module Aws::AppConfig
39
64
  def message
40
65
  @message || @data[:message]
41
66
  end
42
-
43
67
  end
44
68
 
45
69
  class InternalServerException < ServiceError
@@ -55,7 +79,6 @@ module Aws::AppConfig
55
79
  def message
56
80
  @message || @data[:message]
57
81
  end
58
-
59
82
  end
60
83
 
61
84
  class ResourceNotFoundException < ServiceError
@@ -76,7 +99,6 @@ module Aws::AppConfig
76
99
  def resource_name
77
100
  @data[:resource_name]
78
101
  end
79
-
80
102
  end
81
103
 
82
104
  end
@@ -6,6 +6,13 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::AppConfig
9
+ # This class provides a resource oriented interface for AppConfig.
10
+ # To create a resource object:
11
+ # resource = Aws::AppConfig::Resource.new(region: 'us-west-2')
12
+ # You can supply a client object with custom configuration that will be used for all resource operations.
13
+ # If you do not pass +:client+, a default client will be constructed.
14
+ # client = Aws::AppConfig::Client.new(region: 'us-west-2')
15
+ # resource = Aws::AppConfig::Resource.new(client: client)
9
16
  class Resource
10
17
 
11
18
  # @param options ({})
@@ -257,12 +257,15 @@ module Aws::AppConfig
257
257
  # @return [String]
258
258
  #
259
259
  # @!attribute [rw] location_uri
260
- # A URI to locate the configuration. You can specify either a Systems
261
- # Manager (SSM) document or an SSM Parameter Store parameter. For an
262
- # SSM document, specify either the document name in the format
263
- # `ssm-document://<Document name>` or the Amazon Resource Name (ARN).
264
- # For a parameter, specify either the parameter name in the format
265
- # `ssm-parameter://<Parameter name>` or the ARN.
260
+ # A URI to locate the configuration. You can specify a Systems Manager
261
+ # (SSM) document, an SSM Parameter Store parameter, or an Amazon S3
262
+ # object. For an SSM document, specify either the document name in the
263
+ # format `ssm-document://<Document_name>` or the Amazon Resource Name
264
+ # (ARN). For a parameter, specify either the parameter name in the
265
+ # format `ssm-parameter://<Parameter_name>` or the ARN. For an Amazon
266
+ # S3 object, specify the URI in the following format:
267
+ # `s3://<bucket>/<objectKey> `. Here is an example:
268
+ # s3://my-bucket/my-app/us-east-1/my-config.json
266
269
  # @return [String]
267
270
  #
268
271
  # @!attribute [rw] retrieval_role_arn
@@ -875,15 +878,18 @@ module Aws::AppConfig
875
878
  # }
876
879
  #
877
880
  # @!attribute [rw] application
878
- # The application to get.
881
+ # The application to get. Specify either the application name or the
882
+ # application ID.
879
883
  # @return [String]
880
884
  #
881
885
  # @!attribute [rw] environment
882
- # The environment to get.
886
+ # The environment to get. Specify either the environment name or the
887
+ # environment ID.
883
888
  # @return [String]
884
889
  #
885
890
  # @!attribute [rw] configuration
886
- # The configuration to get.
891
+ # The configuration to get. Specify either the configuration name or
892
+ # the configuration ID.
887
893
  # @return [String]
888
894
  #
889
895
  # @!attribute [rw] client_id
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-appconfig
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.1.0
4
+ version: 1.3.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-02-20 00:00:00.000000000 Z
11
+ date: 2020-03-16 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -80,8 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
80
80
  - !ruby/object:Gem::Version
81
81
  version: '0'
82
82
  requirements: []
83
- rubyforge_project:
84
- rubygems_version: 2.5.2.3
83
+ rubygems_version: 3.0.3
85
84
  signing_key:
86
85
  specification_version: 4
87
86
  summary: AWS SDK for Ruby - AppConfig