aws-sdk-appconfigdata 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.
@@ -0,0 +1,122 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ module Aws::AppConfigData
11
+
12
+ # When AppConfigData returns an error response, the Ruby SDK constructs and raises an error.
13
+ # These errors all extend Aws::AppConfigData::Errors::ServiceError < {Aws::Errors::ServiceError}
14
+ #
15
+ # You can rescue all AppConfigData errors using ServiceError:
16
+ #
17
+ # begin
18
+ # # do stuff
19
+ # rescue Aws::AppConfigData::Errors::ServiceError
20
+ # # rescues all AppConfigData API errors
21
+ # end
22
+ #
23
+ #
24
+ # ## Request Context
25
+ # ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
26
+ # information about the request that generated the error.
27
+ # See {Seahorse::Client::RequestContext} for more information.
28
+ #
29
+ # ## Error Classes
30
+ # * {BadRequestException}
31
+ # * {InternalServerException}
32
+ # * {ResourceNotFoundException}
33
+ # * {ThrottlingException}
34
+ #
35
+ # Additionally, error classes are dynamically generated for service errors based on the error code
36
+ # if they are not defined above.
37
+ module Errors
38
+
39
+ extend Aws::Errors::DynamicErrors
40
+
41
+ class BadRequestException < ServiceError
42
+
43
+ # @param [Seahorse::Client::RequestContext] context
44
+ # @param [String] message
45
+ # @param [Aws::AppConfigData::Types::BadRequestException] data
46
+ def initialize(context, message, data = Aws::EmptyStructure.new)
47
+ super(context, message, data)
48
+ end
49
+
50
+ # @return [String]
51
+ def details
52
+ @data[:details]
53
+ end
54
+
55
+ # @return [String]
56
+ def message
57
+ @message || @data[:message]
58
+ end
59
+
60
+ # @return [String]
61
+ def reason
62
+ @data[:reason]
63
+ end
64
+ end
65
+
66
+ class InternalServerException < ServiceError
67
+
68
+ # @param [Seahorse::Client::RequestContext] context
69
+ # @param [String] message
70
+ # @param [Aws::AppConfigData::Types::InternalServerException] data
71
+ def initialize(context, message, data = Aws::EmptyStructure.new)
72
+ super(context, message, data)
73
+ end
74
+
75
+ # @return [String]
76
+ def message
77
+ @message || @data[:message]
78
+ end
79
+ end
80
+
81
+ class ResourceNotFoundException < ServiceError
82
+
83
+ # @param [Seahorse::Client::RequestContext] context
84
+ # @param [String] message
85
+ # @param [Aws::AppConfigData::Types::ResourceNotFoundException] data
86
+ def initialize(context, message, data = Aws::EmptyStructure.new)
87
+ super(context, message, data)
88
+ end
89
+
90
+ # @return [String]
91
+ def message
92
+ @message || @data[:message]
93
+ end
94
+
95
+ # @return [String]
96
+ def referenced_by
97
+ @data[:referenced_by]
98
+ end
99
+
100
+ # @return [String]
101
+ def resource_type
102
+ @data[:resource_type]
103
+ end
104
+ end
105
+
106
+ class ThrottlingException < ServiceError
107
+
108
+ # @param [Seahorse::Client::RequestContext] context
109
+ # @param [String] message
110
+ # @param [Aws::AppConfigData::Types::ThrottlingException] data
111
+ def initialize(context, message, data = Aws::EmptyStructure.new)
112
+ super(context, message, data)
113
+ end
114
+
115
+ # @return [String]
116
+ def message
117
+ @message || @data[:message]
118
+ end
119
+ end
120
+
121
+ end
122
+ end
@@ -0,0 +1,26 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ module Aws::AppConfigData
11
+
12
+ class Resource
13
+
14
+ # @param options ({})
15
+ # @option options [Client] :client
16
+ def initialize(options = {})
17
+ @client = options[:client] || Client.new(options)
18
+ end
19
+
20
+ # @return [Client]
21
+ def client
22
+ @client
23
+ end
24
+
25
+ end
26
+ end
@@ -0,0 +1,245 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ module Aws::AppConfigData
11
+ module Types
12
+
13
+ # Details describing why the request was invalid
14
+ #
15
+ # @!attribute [rw] invalid_parameters
16
+ # Present if the Reason for the bad request was 'InvalidParameters'
17
+ # @return [Hash<String,Types::InvalidParameterDetail>]
18
+ #
19
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appconfigdata-2021-11-11/BadRequestDetails AWS API Documentation
20
+ #
21
+ class BadRequestDetails < Struct.new(
22
+ :invalid_parameters,
23
+ :unknown)
24
+ SENSITIVE = []
25
+ include Aws::Structure
26
+ include Aws::Structure::Union
27
+
28
+ class InvalidParameters < BadRequestDetails; end
29
+ class Unknown < BadRequestDetails; end
30
+ end
31
+
32
+ # The input fails to satisfy the constraints specified by the service.
33
+ #
34
+ # @!attribute [rw] details
35
+ # Details describing why the request was invalid
36
+ # @return [Types::BadRequestDetails]
37
+ #
38
+ # @!attribute [rw] message
39
+ # @return [String]
40
+ #
41
+ # @!attribute [rw] reason
42
+ # Code indicating the reason the request was invalid.
43
+ # @return [String]
44
+ #
45
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appconfigdata-2021-11-11/BadRequestException AWS API Documentation
46
+ #
47
+ class BadRequestException < Struct.new(
48
+ :details,
49
+ :message,
50
+ :reason)
51
+ SENSITIVE = []
52
+ include Aws::Structure
53
+ end
54
+
55
+ # Request parameters for the GetLatestConfiguration API
56
+ #
57
+ # @note When making an API call, you may pass GetLatestConfigurationRequest
58
+ # data as a hash:
59
+ #
60
+ # {
61
+ # configuration_token: "Token", # required
62
+ # }
63
+ #
64
+ # @!attribute [rw] configuration_token
65
+ # Token describing the current state of the configuration session. To
66
+ # obtain a token, first call the StartConfigurationSession API. Note
67
+ # that every call to GetLatestConfiguration will return a new
68
+ # ConfigurationToken (NextPollConfigurationToken in the response) and
69
+ # MUST be provided to subsequent GetLatestConfiguration API calls.
70
+ # @return [String]
71
+ #
72
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appconfigdata-2021-11-11/GetLatestConfigurationRequest AWS API Documentation
73
+ #
74
+ class GetLatestConfigurationRequest < Struct.new(
75
+ :configuration_token)
76
+ SENSITIVE = []
77
+ include Aws::Structure
78
+ end
79
+
80
+ # Response parameters for the GetLatestConfiguration API
81
+ #
82
+ # @!attribute [rw] configuration
83
+ # The data of the configuration. Note that this may be empty if the
84
+ # client already has the latest version of configuration.
85
+ # @return [String]
86
+ #
87
+ # @!attribute [rw] content_type
88
+ # A standard MIME type describing the format of the configuration
89
+ # content.
90
+ # @return [String]
91
+ #
92
+ # @!attribute [rw] next_poll_configuration_token
93
+ # The latest token describing the current state of the configuration
94
+ # session. This MUST be provided to the next call to
95
+ # GetLatestConfiguration.
96
+ # @return [String]
97
+ #
98
+ # @!attribute [rw] next_poll_interval_in_seconds
99
+ # The amount of time the client should wait before polling for
100
+ # configuration updates again. See
101
+ # RequiredMinimumPollIntervalInSeconds to set the desired poll
102
+ # interval.
103
+ # @return [Integer]
104
+ #
105
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appconfigdata-2021-11-11/GetLatestConfigurationResponse AWS API Documentation
106
+ #
107
+ class GetLatestConfigurationResponse < Struct.new(
108
+ :configuration,
109
+ :content_type,
110
+ :next_poll_configuration_token,
111
+ :next_poll_interval_in_seconds)
112
+ SENSITIVE = [:configuration]
113
+ include Aws::Structure
114
+ end
115
+
116
+ # There was an internal failure in the service.
117
+ #
118
+ # @!attribute [rw] message
119
+ # @return [String]
120
+ #
121
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appconfigdata-2021-11-11/InternalServerException AWS API Documentation
122
+ #
123
+ class InternalServerException < Struct.new(
124
+ :message)
125
+ SENSITIVE = []
126
+ include Aws::Structure
127
+ end
128
+
129
+ # Contains details about an invalid parameter.
130
+ #
131
+ # @!attribute [rw] problem
132
+ # Detail describing why an individual parameter did not satisfy the
133
+ # constraints specified by the service
134
+ # @return [String]
135
+ #
136
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appconfigdata-2021-11-11/InvalidParameterDetail AWS API Documentation
137
+ #
138
+ class InvalidParameterDetail < Struct.new(
139
+ :problem)
140
+ SENSITIVE = []
141
+ include Aws::Structure
142
+ end
143
+
144
+ # The requested resource could not be found.
145
+ #
146
+ # @!attribute [rw] message
147
+ # @return [String]
148
+ #
149
+ # @!attribute [rw] referenced_by
150
+ # A map indicating which parameters in the request reference the
151
+ # resource that was not found.
152
+ # @return [Hash<String,String>]
153
+ #
154
+ # @!attribute [rw] resource_type
155
+ # The type of resource that was not found.
156
+ # @return [String]
157
+ #
158
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appconfigdata-2021-11-11/ResourceNotFoundException AWS API Documentation
159
+ #
160
+ class ResourceNotFoundException < Struct.new(
161
+ :message,
162
+ :referenced_by,
163
+ :resource_type)
164
+ SENSITIVE = []
165
+ include Aws::Structure
166
+ end
167
+
168
+ # Request parameters for the StartConfigurationSession API.
169
+ #
170
+ # @note When making an API call, you may pass StartConfigurationSessionRequest
171
+ # data as a hash:
172
+ #
173
+ # {
174
+ # application_identifier: "Identifier", # required
175
+ # configuration_profile_identifier: "Identifier", # required
176
+ # environment_identifier: "Identifier", # required
177
+ # required_minimum_poll_interval_in_seconds: 1,
178
+ # }
179
+ #
180
+ # @!attribute [rw] application_identifier
181
+ # The application ID or the application name.
182
+ # @return [String]
183
+ #
184
+ # @!attribute [rw] configuration_profile_identifier
185
+ # The configuration profile ID or the configuration profile name.
186
+ # @return [String]
187
+ #
188
+ # @!attribute [rw] environment_identifier
189
+ # The environment ID or the environment name.
190
+ # @return [String]
191
+ #
192
+ # @!attribute [rw] required_minimum_poll_interval_in_seconds
193
+ # The interval at which your client will poll for configuration. If
194
+ # provided, the service will throw a BadRequestException if the client
195
+ # polls before the specified poll interval. By default, client poll
196
+ # intervals are not enforced.
197
+ # @return [Integer]
198
+ #
199
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appconfigdata-2021-11-11/StartConfigurationSessionRequest AWS API Documentation
200
+ #
201
+ class StartConfigurationSessionRequest < Struct.new(
202
+ :application_identifier,
203
+ :configuration_profile_identifier,
204
+ :environment_identifier,
205
+ :required_minimum_poll_interval_in_seconds)
206
+ SENSITIVE = []
207
+ include Aws::Structure
208
+ end
209
+
210
+ # Response parameters for the StartConfigurationSession API.
211
+ #
212
+ # @!attribute [rw] initial_configuration_token
213
+ # Token encapsulating state about the configuration session. Provide
214
+ # this token to the GetLatestConfiguration API to retrieve
215
+ # configuration data.
216
+ #
217
+ # This token should only be used once in your first call to
218
+ # GetLatestConfiguration. You MUST use the new token in the
219
+ # GetConfiguration response (NextPollConfigurationToken) in each
220
+ # subsequent call to GetLatestConfiguration.
221
+ # @return [String]
222
+ #
223
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appconfigdata-2021-11-11/StartConfigurationSessionResponse AWS API Documentation
224
+ #
225
+ class StartConfigurationSessionResponse < Struct.new(
226
+ :initial_configuration_token)
227
+ SENSITIVE = []
228
+ include Aws::Structure
229
+ end
230
+
231
+ # The request was denied due to request throttling.
232
+ #
233
+ # @!attribute [rw] message
234
+ # @return [String]
235
+ #
236
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appconfigdata-2021-11-11/ThrottlingException AWS API Documentation
237
+ #
238
+ class ThrottlingException < Struct.new(
239
+ :message)
240
+ SENSITIVE = []
241
+ include Aws::Structure
242
+ end
243
+
244
+ end
245
+ end
@@ -0,0 +1,53 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+
11
+ require 'aws-sdk-core'
12
+ require 'aws-sigv4'
13
+
14
+ require_relative 'aws-sdk-appconfigdata/types'
15
+ require_relative 'aws-sdk-appconfigdata/client_api'
16
+ require_relative 'aws-sdk-appconfigdata/client'
17
+ require_relative 'aws-sdk-appconfigdata/errors'
18
+ require_relative 'aws-sdk-appconfigdata/resource'
19
+ require_relative 'aws-sdk-appconfigdata/customizations'
20
+
21
+ # This module provides support for AWS AppConfig Data. This module is available in the
22
+ # `aws-sdk-appconfigdata` gem.
23
+ #
24
+ # # Client
25
+ #
26
+ # The {Client} class provides one method for each API operation. Operation
27
+ # methods each accept a hash of request parameters and return a response
28
+ # structure.
29
+ #
30
+ # app_config_data = Aws::AppConfigData::Client.new
31
+ # resp = app_config_data.get_latest_configuration(params)
32
+ #
33
+ # See {Client} for more information.
34
+ #
35
+ # # Errors
36
+ #
37
+ # Errors returned from AWS AppConfig Data are defined in the
38
+ # {Errors} module and all extend {Errors::ServiceError}.
39
+ #
40
+ # begin
41
+ # # do stuff
42
+ # rescue Aws::AppConfigData::Errors::ServiceError
43
+ # # rescues all AWS AppConfig Data API errors
44
+ # end
45
+ #
46
+ # See {Errors} for more information.
47
+ #
48
+ # @!group service
49
+ module Aws::AppConfigData
50
+
51
+ GEM_VERSION = '1.0.0'
52
+
53
+ end
metadata ADDED
@@ -0,0 +1,90 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: aws-sdk-appconfigdata
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.0.0
5
+ platform: ruby
6
+ authors:
7
+ - Amazon Web Services
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2021-11-17 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: aws-sdk-core
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '3'
20
+ - - ">="
21
+ - !ruby/object:Gem::Version
22
+ version: 3.122.0
23
+ type: :runtime
24
+ prerelease: false
25
+ version_requirements: !ruby/object:Gem::Requirement
26
+ requirements:
27
+ - - "~>"
28
+ - !ruby/object:Gem::Version
29
+ version: '3'
30
+ - - ">="
31
+ - !ruby/object:Gem::Version
32
+ version: 3.122.0
33
+ - !ruby/object:Gem::Dependency
34
+ name: aws-sigv4
35
+ requirement: !ruby/object:Gem::Requirement
36
+ requirements:
37
+ - - "~>"
38
+ - !ruby/object:Gem::Version
39
+ version: '1.1'
40
+ type: :runtime
41
+ prerelease: false
42
+ version_requirements: !ruby/object:Gem::Requirement
43
+ requirements:
44
+ - - "~>"
45
+ - !ruby/object:Gem::Version
46
+ version: '1.1'
47
+ description: Official AWS Ruby gem for AWS AppConfig Data. This gem is part of the
48
+ AWS SDK for Ruby.
49
+ email:
50
+ - aws-dr-rubygems@amazon.com
51
+ executables: []
52
+ extensions: []
53
+ extra_rdoc_files: []
54
+ files:
55
+ - CHANGELOG.md
56
+ - LICENSE.txt
57
+ - VERSION
58
+ - lib/aws-sdk-appconfigdata.rb
59
+ - lib/aws-sdk-appconfigdata/client.rb
60
+ - lib/aws-sdk-appconfigdata/client_api.rb
61
+ - lib/aws-sdk-appconfigdata/customizations.rb
62
+ - lib/aws-sdk-appconfigdata/errors.rb
63
+ - lib/aws-sdk-appconfigdata/resource.rb
64
+ - lib/aws-sdk-appconfigdata/types.rb
65
+ homepage: https://github.com/aws/aws-sdk-ruby
66
+ licenses:
67
+ - Apache-2.0
68
+ metadata:
69
+ source_code_uri: https://github.com/aws/aws-sdk-ruby/tree/version-3/gems/aws-sdk-appconfigdata
70
+ changelog_uri: https://github.com/aws/aws-sdk-ruby/tree/version-3/gems/aws-sdk-appconfigdata/CHANGELOG.md
71
+ post_install_message:
72
+ rdoc_options: []
73
+ require_paths:
74
+ - lib
75
+ required_ruby_version: !ruby/object:Gem::Requirement
76
+ requirements:
77
+ - - ">="
78
+ - !ruby/object:Gem::Version
79
+ version: '2.3'
80
+ required_rubygems_version: !ruby/object:Gem::Requirement
81
+ requirements:
82
+ - - ">="
83
+ - !ruby/object:Gem::Version
84
+ version: '0'
85
+ requirements: []
86
+ rubygems_version: 3.1.6
87
+ signing_key:
88
+ specification_version: 4
89
+ summary: AWS SDK for Ruby - AWS AppConfig Data
90
+ test_files: []