aws-sdk-mq 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 0dee0923bcb9a04fd9531ee656ef04c0e096712d
4
+ data.tar.gz: 925ca3021db2327d823be431a18fccd3a5ecd48c
5
+ SHA512:
6
+ metadata.gz: 57bf998cad29ad5daf075e59ba8dddbc24ad5cec04876ed9a1a14558b37aaf01a8b7d780a3ab715fb376b1c166b6b51c12cb91f56440ffe7d2871593f63dc672
7
+ data.tar.gz: 5690a858c060899463a2d7ca6a634806799ab1d13e1219f7db739d8268af00ebda955833ada9e84c964965aa76ded576de380ff8b73cc938fdc7dbe01c905306
@@ -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-mq/types'
12
+ require_relative 'aws-sdk-mq/client_api'
13
+ require_relative 'aws-sdk-mq/client'
14
+ require_relative 'aws-sdk-mq/errors'
15
+ require_relative 'aws-sdk-mq/resource'
16
+ require_relative 'aws-sdk-mq/customizations'
17
+
18
+ # This module provides support for AmazonMQ. This module is available in the
19
+ # `aws-sdk-mq` 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 AmazonMQ all
32
+ # extend {Errors::ServiceError}.
33
+ #
34
+ # begin
35
+ # # do stuff
36
+ # rescue Aws::MQ::Errors::ServiceError
37
+ # # rescues all service API errors
38
+ # end
39
+ #
40
+ # See {Errors} for more information.
41
+ #
42
+ # @service
43
+ module Aws::MQ
44
+
45
+ GEM_VERSION = '1.0.0'
46
+
47
+ end
@@ -0,0 +1,889 @@
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/response_paging.rb'
19
+ require 'aws-sdk-core/plugins/stub_responses.rb'
20
+ require 'aws-sdk-core/plugins/idempotency_token.rb'
21
+ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
22
+ require 'aws-sdk-core/plugins/signature_v4.rb'
23
+ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
24
+
25
+ Aws::Plugins::GlobalConfiguration.add_identifier(:mq)
26
+
27
+ module Aws::MQ
28
+ class Client < Seahorse::Client::Base
29
+
30
+ include Aws::ClientStubs
31
+
32
+ @identifier = :mq
33
+
34
+ set_api(ClientApi::API)
35
+
36
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
37
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
38
+ add_plugin(Aws::Plugins::Logging)
39
+ add_plugin(Aws::Plugins::ParamConverter)
40
+ add_plugin(Aws::Plugins::ParamValidator)
41
+ add_plugin(Aws::Plugins::UserAgent)
42
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
43
+ add_plugin(Aws::Plugins::RetryErrors)
44
+ add_plugin(Aws::Plugins::GlobalConfiguration)
45
+ add_plugin(Aws::Plugins::RegionalEndpoint)
46
+ add_plugin(Aws::Plugins::ResponsePaging)
47
+ add_plugin(Aws::Plugins::StubResponses)
48
+ add_plugin(Aws::Plugins::IdempotencyToken)
49
+ add_plugin(Aws::Plugins::JsonvalueConverter)
50
+ add_plugin(Aws::Plugins::SignatureV4)
51
+ add_plugin(Aws::Plugins::Protocols::RestJson)
52
+
53
+ # @option options [required, Aws::CredentialProvider] :credentials
54
+ # Your AWS credentials. This can be an instance of any one of the
55
+ # following classes:
56
+ #
57
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
58
+ # credentials.
59
+ #
60
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
61
+ # from an EC2 IMDS on an EC2 instance.
62
+ #
63
+ # * `Aws::SharedCredentials` - Used for loading credentials from a
64
+ # shared file, such as `~/.aws/config`.
65
+ #
66
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
67
+ #
68
+ # When `:credentials` are not configured directly, the following
69
+ # locations will be searched for credentials:
70
+ #
71
+ # * `Aws.config[:credentials]`
72
+ # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
73
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
74
+ # * `~/.aws/credentials`
75
+ # * `~/.aws/config`
76
+ # * EC2 IMDS instance profile - When used by default, the timeouts are
77
+ # very aggressive. Construct and pass an instance of
78
+ # `Aws::InstanceProfileCredentails` to enable retries and extended
79
+ # timeouts.
80
+ #
81
+ # @option options [required, String] :region
82
+ # The AWS region to connect to. The configured `:region` is
83
+ # used to determine the service `:endpoint`. When not passed,
84
+ # a default `:region` is search for in the following locations:
85
+ #
86
+ # * `Aws.config[:region]`
87
+ # * `ENV['AWS_REGION']`
88
+ # * `ENV['AMAZON_REGION']`
89
+ # * `ENV['AWS_DEFAULT_REGION']`
90
+ # * `~/.aws/credentials`
91
+ # * `~/.aws/config`
92
+ #
93
+ # @option options [String] :access_key_id
94
+ #
95
+ # @option options [Boolean] :convert_params (true)
96
+ # When `true`, an attempt is made to coerce request parameters into
97
+ # the required types.
98
+ #
99
+ # @option options [String] :endpoint
100
+ # The client endpoint is normally constructed from the `:region`
101
+ # option. You should only configure an `:endpoint` when connecting
102
+ # to test endpoints. This should be avalid HTTP(S) URI.
103
+ #
104
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
105
+ # The log formatter.
106
+ #
107
+ # @option options [Symbol] :log_level (:info)
108
+ # The log level to send messages to the `:logger` at.
109
+ #
110
+ # @option options [Logger] :logger
111
+ # The Logger instance to send log messages to. If this option
112
+ # is not set, logging will be disabled.
113
+ #
114
+ # @option options [String] :profile ("default")
115
+ # Used when loading credentials from the shared credentials file
116
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
117
+ #
118
+ # @option options [Integer] :retry_limit (3)
119
+ # The maximum number of times to retry failed requests. Only
120
+ # ~ 500 level server errors and certain ~ 400 level client errors
121
+ # are retried. Generally, these are throttling errors, data
122
+ # checksum errors, networking errors, timeout errors and auth
123
+ # errors from expired credentials.
124
+ #
125
+ # @option options [String] :secret_access_key
126
+ #
127
+ # @option options [String] :session_token
128
+ #
129
+ # @option options [Boolean] :stub_responses (false)
130
+ # Causes the client to return stubbed responses. By default
131
+ # fake responses are generated and returned. You can specify
132
+ # the response data to return or errors to raise by calling
133
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
134
+ #
135
+ # ** Please note ** When response stubbing is enabled, no HTTP
136
+ # requests are made, and retries are disabled.
137
+ #
138
+ # @option options [Boolean] :validate_params (true)
139
+ # When `true`, request parameters are validated before
140
+ # sending the request.
141
+ #
142
+ def initialize(*args)
143
+ super
144
+ end
145
+
146
+ # @!group API Operations
147
+
148
+ # Creates a broker. Note: This API is asynchronous.
149
+ #
150
+ # @option params [Boolean] :auto_minor_version_upgrade
151
+ #
152
+ # @option params [String] :broker_name
153
+ #
154
+ # @option params [Types::ConfigurationId] :configuration
155
+ # A list of information about the configuration.
156
+ #
157
+ # @option params [String] :creator_request_id
158
+ # **A suitable default value is auto-generated.** You should normally
159
+ # not need to pass this option.**
160
+ #
161
+ # @option params [String] :deployment_mode
162
+ # The deployment mode of the broker. Possible values: SINGLE\_INSTANCE,
163
+ # ACTIVE\_STANDBY\_MULTI\_AZ SINGLE\_INSTANCE creates a single-instance
164
+ # broker in a single Availability Zone. ACTIVE\_STANDBY\_MULTI\_AZ
165
+ # creates an active/standby broker for high availability.
166
+ #
167
+ # @option params [String] :engine_type
168
+ # The type of broker engine. Note: Currently, Amazon MQ supports only
169
+ # ActiveMQ.
170
+ #
171
+ # @option params [String] :engine_version
172
+ #
173
+ # @option params [String] :host_instance_type
174
+ #
175
+ # @option params [Types::WeeklyStartTime] :maintenance_window_start_time
176
+ # The scheduled time period relative to UTC during which Amazon MQ
177
+ # begins to apply pending updates or patches to the broker.
178
+ #
179
+ # @option params [Boolean] :publicly_accessible
180
+ #
181
+ # @option params [Array<String>] :security_groups
182
+ #
183
+ # @option params [Array<String>] :subnet_ids
184
+ #
185
+ # @option params [Array<Types::User>] :users
186
+ #
187
+ # @return [Types::CreateBrokerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
188
+ #
189
+ # * {Types::CreateBrokerResponse#broker_arn #broker_arn} => String
190
+ # * {Types::CreateBrokerResponse#broker_id #broker_id} => String
191
+ #
192
+ # @example Request syntax with placeholder values
193
+ #
194
+ # resp = client.create_broker({
195
+ # auto_minor_version_upgrade: false,
196
+ # broker_name: "__string",
197
+ # configuration: {
198
+ # id: "__string",
199
+ # revision: 1,
200
+ # },
201
+ # creator_request_id: "__string",
202
+ # deployment_mode: "SINGLE_INSTANCE", # accepts SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ
203
+ # engine_type: "ACTIVEMQ", # accepts ACTIVEMQ
204
+ # engine_version: "__string",
205
+ # host_instance_type: "__string",
206
+ # maintenance_window_start_time: {
207
+ # day_of_week: "MONDAY", # accepts MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
208
+ # time_of_day: "__string",
209
+ # time_zone: "__string",
210
+ # },
211
+ # publicly_accessible: false,
212
+ # security_groups: ["__string"],
213
+ # subnet_ids: ["__string"],
214
+ # users: [
215
+ # {
216
+ # console_access: false,
217
+ # groups: ["__string"],
218
+ # password: "__string",
219
+ # username: "__string",
220
+ # },
221
+ # ],
222
+ # })
223
+ #
224
+ # @example Response structure
225
+ #
226
+ # resp.broker_arn #=> String
227
+ # resp.broker_id #=> String
228
+ #
229
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/CreateBroker AWS API Documentation
230
+ #
231
+ # @overload create_broker(params = {})
232
+ # @param [Hash] params ({})
233
+ def create_broker(params = {}, options = {})
234
+ req = build_request(:create_broker, params)
235
+ req.send_request(options)
236
+ end
237
+
238
+ # Creates a new configuration for the specified configuration name.
239
+ # Amazon MQ uses the default configuration (the engine type and
240
+ # version). Note: If the configuration name already exists, Amazon MQ
241
+ # doesn't create a configuration.
242
+ #
243
+ # @option params [String] :engine_type
244
+ # The type of broker engine. Note: Currently, Amazon MQ supports only
245
+ # ActiveMQ.
246
+ #
247
+ # @option params [String] :engine_version
248
+ #
249
+ # @option params [String] :name
250
+ #
251
+ # @return [Types::CreateConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
252
+ #
253
+ # * {Types::CreateConfigurationResponse#arn #arn} => String
254
+ # * {Types::CreateConfigurationResponse#id #id} => String
255
+ # * {Types::CreateConfigurationResponse#latest_revision #latest_revision} => Types::ConfigurationRevision
256
+ # * {Types::CreateConfigurationResponse#name #name} => String
257
+ #
258
+ # @example Request syntax with placeholder values
259
+ #
260
+ # resp = client.create_configuration({
261
+ # engine_type: "ACTIVEMQ", # accepts ACTIVEMQ
262
+ # engine_version: "__string",
263
+ # name: "__string",
264
+ # })
265
+ #
266
+ # @example Response structure
267
+ #
268
+ # resp.arn #=> String
269
+ # resp.id #=> String
270
+ # resp.latest_revision.description #=> String
271
+ # resp.latest_revision.revision #=> Integer
272
+ # resp.name #=> String
273
+ #
274
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/CreateConfiguration AWS API Documentation
275
+ #
276
+ # @overload create_configuration(params = {})
277
+ # @param [Hash] params ({})
278
+ def create_configuration(params = {}, options = {})
279
+ req = build_request(:create_configuration, params)
280
+ req.send_request(options)
281
+ end
282
+
283
+ # Creates an ActiveMQ user.
284
+ #
285
+ # @option params [required, String] :broker_id
286
+ #
287
+ # @option params [Boolean] :console_access
288
+ #
289
+ # @option params [Array<String>] :groups
290
+ #
291
+ # @option params [String] :password
292
+ #
293
+ # @option params [required, String] :username
294
+ #
295
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
296
+ #
297
+ # @example Request syntax with placeholder values
298
+ #
299
+ # resp = client.create_user({
300
+ # broker_id: "__string", # required
301
+ # console_access: false,
302
+ # groups: ["__string"],
303
+ # password: "__string",
304
+ # username: "__string", # required
305
+ # })
306
+ #
307
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/CreateUser AWS API Documentation
308
+ #
309
+ # @overload create_user(params = {})
310
+ # @param [Hash] params ({})
311
+ def create_user(params = {}, options = {})
312
+ req = build_request(:create_user, params)
313
+ req.send_request(options)
314
+ end
315
+
316
+ # Deletes a broker. Note: This API is asynchronous.
317
+ #
318
+ # @option params [required, String] :broker_id
319
+ #
320
+ # @return [Types::DeleteBrokerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
321
+ #
322
+ # * {Types::DeleteBrokerResponse#broker_id #broker_id} => String
323
+ #
324
+ # @example Request syntax with placeholder values
325
+ #
326
+ # resp = client.delete_broker({
327
+ # broker_id: "__string", # required
328
+ # })
329
+ #
330
+ # @example Response structure
331
+ #
332
+ # resp.broker_id #=> String
333
+ #
334
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DeleteBroker AWS API Documentation
335
+ #
336
+ # @overload delete_broker(params = {})
337
+ # @param [Hash] params ({})
338
+ def delete_broker(params = {}, options = {})
339
+ req = build_request(:delete_broker, params)
340
+ req.send_request(options)
341
+ end
342
+
343
+ # Deletes an ActiveMQ user.
344
+ #
345
+ # @option params [required, String] :broker_id
346
+ #
347
+ # @option params [required, String] :username
348
+ #
349
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
350
+ #
351
+ # @example Request syntax with placeholder values
352
+ #
353
+ # resp = client.delete_user({
354
+ # broker_id: "__string", # required
355
+ # username: "__string", # required
356
+ # })
357
+ #
358
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DeleteUser AWS API Documentation
359
+ #
360
+ # @overload delete_user(params = {})
361
+ # @param [Hash] params ({})
362
+ def delete_user(params = {}, options = {})
363
+ req = build_request(:delete_user, params)
364
+ req.send_request(options)
365
+ end
366
+
367
+ # Returns information about the specified broker.
368
+ #
369
+ # @option params [required, String] :broker_id
370
+ #
371
+ # @return [Types::DescribeBrokerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
372
+ #
373
+ # * {Types::DescribeBrokerResponse#auto_minor_version_upgrade #auto_minor_version_upgrade} => Boolean
374
+ # * {Types::DescribeBrokerResponse#broker_arn #broker_arn} => String
375
+ # * {Types::DescribeBrokerResponse#broker_id #broker_id} => String
376
+ # * {Types::DescribeBrokerResponse#broker_instances #broker_instances} => Array&lt;Types::BrokerInstance&gt;
377
+ # * {Types::DescribeBrokerResponse#broker_name #broker_name} => String
378
+ # * {Types::DescribeBrokerResponse#broker_state #broker_state} => String
379
+ # * {Types::DescribeBrokerResponse#configurations #configurations} => Types::Configurations
380
+ # * {Types::DescribeBrokerResponse#deployment_mode #deployment_mode} => String
381
+ # * {Types::DescribeBrokerResponse#engine_type #engine_type} => String
382
+ # * {Types::DescribeBrokerResponse#engine_version #engine_version} => String
383
+ # * {Types::DescribeBrokerResponse#host_instance_type #host_instance_type} => String
384
+ # * {Types::DescribeBrokerResponse#maintenance_window_start_time #maintenance_window_start_time} => Types::WeeklyStartTime
385
+ # * {Types::DescribeBrokerResponse#publicly_accessible #publicly_accessible} => Boolean
386
+ # * {Types::DescribeBrokerResponse#security_groups #security_groups} => Array&lt;String&gt;
387
+ # * {Types::DescribeBrokerResponse#subnet_ids #subnet_ids} => Array&lt;String&gt;
388
+ # * {Types::DescribeBrokerResponse#users #users} => Array&lt;Types::UserSummary&gt;
389
+ #
390
+ # @example Request syntax with placeholder values
391
+ #
392
+ # resp = client.describe_broker({
393
+ # broker_id: "__string", # required
394
+ # })
395
+ #
396
+ # @example Response structure
397
+ #
398
+ # resp.auto_minor_version_upgrade #=> Boolean
399
+ # resp.broker_arn #=> String
400
+ # resp.broker_id #=> String
401
+ # resp.broker_instances #=> Array
402
+ # resp.broker_instances[0].console_url #=> String
403
+ # resp.broker_instances[0].endpoints #=> Array
404
+ # resp.broker_instances[0].endpoints[0] #=> String
405
+ # resp.broker_name #=> String
406
+ # resp.broker_state #=> String, one of "CREATION_IN_PROGRESS", "CREATION_FAILED", "DELETION_IN_PROGRESS", "RUNNING", "REBOOT_IN_PROGRESS"
407
+ # resp.configurations.current.id #=> String
408
+ # resp.configurations.current.revision #=> Integer
409
+ # resp.configurations.history #=> Array
410
+ # resp.configurations.history[0].id #=> String
411
+ # resp.configurations.history[0].revision #=> Integer
412
+ # resp.configurations.pending.id #=> String
413
+ # resp.configurations.pending.revision #=> Integer
414
+ # resp.deployment_mode #=> String, one of "SINGLE_INSTANCE", "ACTIVE_STANDBY_MULTI_AZ"
415
+ # resp.engine_type #=> String, one of "ACTIVEMQ"
416
+ # resp.engine_version #=> String
417
+ # resp.host_instance_type #=> String
418
+ # resp.maintenance_window_start_time.day_of_week #=> String, one of "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"
419
+ # resp.maintenance_window_start_time.time_of_day #=> String
420
+ # resp.maintenance_window_start_time.time_zone #=> String
421
+ # resp.publicly_accessible #=> Boolean
422
+ # resp.security_groups #=> Array
423
+ # resp.security_groups[0] #=> String
424
+ # resp.subnet_ids #=> Array
425
+ # resp.subnet_ids[0] #=> String
426
+ # resp.users #=> Array
427
+ # resp.users[0].pending_change #=> String, one of "CREATE", "UPDATE", "DELETE"
428
+ # resp.users[0].username #=> String
429
+ #
430
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DescribeBroker AWS API Documentation
431
+ #
432
+ # @overload describe_broker(params = {})
433
+ # @param [Hash] params ({})
434
+ def describe_broker(params = {}, options = {})
435
+ req = build_request(:describe_broker, params)
436
+ req.send_request(options)
437
+ end
438
+
439
+ # Returns information about the specified configuration.
440
+ #
441
+ # @option params [required, String] :configuration_id
442
+ #
443
+ # @return [Types::DescribeConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
444
+ #
445
+ # * {Types::DescribeConfigurationResponse#arn #arn} => String
446
+ # * {Types::DescribeConfigurationResponse#description #description} => String
447
+ # * {Types::DescribeConfigurationResponse#engine_type #engine_type} => String
448
+ # * {Types::DescribeConfigurationResponse#engine_version #engine_version} => String
449
+ # * {Types::DescribeConfigurationResponse#id #id} => String
450
+ # * {Types::DescribeConfigurationResponse#latest_revision #latest_revision} => Types::ConfigurationRevision
451
+ # * {Types::DescribeConfigurationResponse#name #name} => String
452
+ #
453
+ # @example Request syntax with placeholder values
454
+ #
455
+ # resp = client.describe_configuration({
456
+ # configuration_id: "__string", # required
457
+ # })
458
+ #
459
+ # @example Response structure
460
+ #
461
+ # resp.arn #=> String
462
+ # resp.description #=> String
463
+ # resp.engine_type #=> String, one of "ACTIVEMQ"
464
+ # resp.engine_version #=> String
465
+ # resp.id #=> String
466
+ # resp.latest_revision.description #=> String
467
+ # resp.latest_revision.revision #=> Integer
468
+ # resp.name #=> String
469
+ #
470
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DescribeConfiguration AWS API Documentation
471
+ #
472
+ # @overload describe_configuration(params = {})
473
+ # @param [Hash] params ({})
474
+ def describe_configuration(params = {}, options = {})
475
+ req = build_request(:describe_configuration, params)
476
+ req.send_request(options)
477
+ end
478
+
479
+ # Returns the specified configuration revision for the specified
480
+ # configuration.
481
+ #
482
+ # @option params [required, String] :configuration_id
483
+ #
484
+ # @option params [required, String] :configuration_revision
485
+ #
486
+ # @return [Types::DescribeConfigurationRevisionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
487
+ #
488
+ # * {Types::DescribeConfigurationRevisionResponse#configuration_id #configuration_id} => String
489
+ # * {Types::DescribeConfigurationRevisionResponse#data #data} => String
490
+ # * {Types::DescribeConfigurationRevisionResponse#description #description} => String
491
+ #
492
+ # @example Request syntax with placeholder values
493
+ #
494
+ # resp = client.describe_configuration_revision({
495
+ # configuration_id: "__string", # required
496
+ # configuration_revision: "__string", # required
497
+ # })
498
+ #
499
+ # @example Response structure
500
+ #
501
+ # resp.configuration_id #=> String
502
+ # resp.data #=> String
503
+ # resp.description #=> String
504
+ #
505
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DescribeConfigurationRevision AWS API Documentation
506
+ #
507
+ # @overload describe_configuration_revision(params = {})
508
+ # @param [Hash] params ({})
509
+ def describe_configuration_revision(params = {}, options = {})
510
+ req = build_request(:describe_configuration_revision, params)
511
+ req.send_request(options)
512
+ end
513
+
514
+ # Returns information about an ActiveMQ user.
515
+ #
516
+ # @option params [required, String] :broker_id
517
+ #
518
+ # @option params [required, String] :username
519
+ #
520
+ # @return [Types::DescribeUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
521
+ #
522
+ # * {Types::DescribeUserResponse#broker_id #broker_id} => String
523
+ # * {Types::DescribeUserResponse#console_access #console_access} => Boolean
524
+ # * {Types::DescribeUserResponse#groups #groups} => Array&lt;String&gt;
525
+ # * {Types::DescribeUserResponse#pending #pending} => Types::UserPendingChanges
526
+ # * {Types::DescribeUserResponse#username #username} => String
527
+ #
528
+ # @example Request syntax with placeholder values
529
+ #
530
+ # resp = client.describe_user({
531
+ # broker_id: "__string", # required
532
+ # username: "__string", # required
533
+ # })
534
+ #
535
+ # @example Response structure
536
+ #
537
+ # resp.broker_id #=> String
538
+ # resp.console_access #=> Boolean
539
+ # resp.groups #=> Array
540
+ # resp.groups[0] #=> String
541
+ # resp.pending.console_access #=> Boolean
542
+ # resp.pending.groups #=> Array
543
+ # resp.pending.groups[0] #=> String
544
+ # resp.pending.pending_change #=> String, one of "CREATE", "UPDATE", "DELETE"
545
+ # resp.username #=> String
546
+ #
547
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DescribeUser AWS API Documentation
548
+ #
549
+ # @overload describe_user(params = {})
550
+ # @param [Hash] params ({})
551
+ def describe_user(params = {}, options = {})
552
+ req = build_request(:describe_user, params)
553
+ req.send_request(options)
554
+ end
555
+
556
+ # Returns a list of all brokers.
557
+ #
558
+ # @option params [Integer] :max_results
559
+ #
560
+ # @option params [String] :next_token
561
+ #
562
+ # @return [Types::ListBrokersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
563
+ #
564
+ # * {Types::ListBrokersResponse#broker_summaries #broker_summaries} => Array&lt;Types::BrokerSummary&gt;
565
+ # * {Types::ListBrokersResponse#next_token #next_token} => String
566
+ #
567
+ # @example Request syntax with placeholder values
568
+ #
569
+ # resp = client.list_brokers({
570
+ # max_results: 1,
571
+ # next_token: "__string",
572
+ # })
573
+ #
574
+ # @example Response structure
575
+ #
576
+ # resp.broker_summaries #=> Array
577
+ # resp.broker_summaries[0].broker_arn #=> String
578
+ # resp.broker_summaries[0].broker_id #=> String
579
+ # resp.broker_summaries[0].broker_name #=> String
580
+ # resp.broker_summaries[0].broker_state #=> String, one of "CREATION_IN_PROGRESS", "CREATION_FAILED", "DELETION_IN_PROGRESS", "RUNNING", "REBOOT_IN_PROGRESS"
581
+ # resp.broker_summaries[0].deployment_mode #=> String, one of "SINGLE_INSTANCE", "ACTIVE_STANDBY_MULTI_AZ"
582
+ # resp.broker_summaries[0].host_instance_type #=> String
583
+ # resp.next_token #=> String
584
+ #
585
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/ListBrokers AWS API Documentation
586
+ #
587
+ # @overload list_brokers(params = {})
588
+ # @param [Hash] params ({})
589
+ def list_brokers(params = {}, options = {})
590
+ req = build_request(:list_brokers, params)
591
+ req.send_request(options)
592
+ end
593
+
594
+ # Returns a list of all revisions for the specified configuration.
595
+ #
596
+ # @option params [required, String] :configuration_id
597
+ #
598
+ # @option params [Integer] :max_results
599
+ #
600
+ # @option params [String] :next_token
601
+ #
602
+ # @return [Types::ListConfigurationRevisionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
603
+ #
604
+ # * {Types::ListConfigurationRevisionsResponse#configuration_id #configuration_id} => String
605
+ # * {Types::ListConfigurationRevisionsResponse#max_results #max_results} => Integer
606
+ # * {Types::ListConfigurationRevisionsResponse#next_token #next_token} => String
607
+ # * {Types::ListConfigurationRevisionsResponse#revisions #revisions} => Array&lt;Types::ConfigurationRevision&gt;
608
+ #
609
+ # @example Request syntax with placeholder values
610
+ #
611
+ # resp = client.list_configuration_revisions({
612
+ # configuration_id: "__string", # required
613
+ # max_results: 1,
614
+ # next_token: "__string",
615
+ # })
616
+ #
617
+ # @example Response structure
618
+ #
619
+ # resp.configuration_id #=> String
620
+ # resp.max_results #=> Integer
621
+ # resp.next_token #=> String
622
+ # resp.revisions #=> Array
623
+ # resp.revisions[0].description #=> String
624
+ # resp.revisions[0].revision #=> Integer
625
+ #
626
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/ListConfigurationRevisions AWS API Documentation
627
+ #
628
+ # @overload list_configuration_revisions(params = {})
629
+ # @param [Hash] params ({})
630
+ def list_configuration_revisions(params = {}, options = {})
631
+ req = build_request(:list_configuration_revisions, params)
632
+ req.send_request(options)
633
+ end
634
+
635
+ # Returns a list of all configurations.
636
+ #
637
+ # @option params [Integer] :max_results
638
+ #
639
+ # @option params [String] :next_token
640
+ #
641
+ # @return [Types::ListConfigurationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
642
+ #
643
+ # * {Types::ListConfigurationsResponse#configurations #configurations} => Array&lt;Types::Configuration&gt;
644
+ # * {Types::ListConfigurationsResponse#max_results #max_results} => Integer
645
+ # * {Types::ListConfigurationsResponse#next_token #next_token} => String
646
+ #
647
+ # @example Request syntax with placeholder values
648
+ #
649
+ # resp = client.list_configurations({
650
+ # max_results: 1,
651
+ # next_token: "__string",
652
+ # })
653
+ #
654
+ # @example Response structure
655
+ #
656
+ # resp.configurations #=> Array
657
+ # resp.configurations[0].arn #=> String
658
+ # resp.configurations[0].description #=> String
659
+ # resp.configurations[0].engine_type #=> String, one of "ACTIVEMQ"
660
+ # resp.configurations[0].engine_version #=> String
661
+ # resp.configurations[0].id #=> String
662
+ # resp.configurations[0].latest_revision.description #=> String
663
+ # resp.configurations[0].latest_revision.revision #=> Integer
664
+ # resp.configurations[0].name #=> String
665
+ # resp.max_results #=> Integer
666
+ # resp.next_token #=> String
667
+ #
668
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/ListConfigurations AWS API Documentation
669
+ #
670
+ # @overload list_configurations(params = {})
671
+ # @param [Hash] params ({})
672
+ def list_configurations(params = {}, options = {})
673
+ req = build_request(:list_configurations, params)
674
+ req.send_request(options)
675
+ end
676
+
677
+ # Returns a list of all ActiveMQ users.
678
+ #
679
+ # @option params [required, String] :broker_id
680
+ #
681
+ # @option params [Integer] :max_results
682
+ #
683
+ # @option params [String] :next_token
684
+ #
685
+ # @return [Types::ListUsersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
686
+ #
687
+ # * {Types::ListUsersResponse#broker_id #broker_id} => String
688
+ # * {Types::ListUsersResponse#max_results #max_results} => Integer
689
+ # * {Types::ListUsersResponse#next_token #next_token} => String
690
+ # * {Types::ListUsersResponse#users #users} => Array&lt;Types::UserSummary&gt;
691
+ #
692
+ # @example Request syntax with placeholder values
693
+ #
694
+ # resp = client.list_users({
695
+ # broker_id: "__string", # required
696
+ # max_results: 1,
697
+ # next_token: "__string",
698
+ # })
699
+ #
700
+ # @example Response structure
701
+ #
702
+ # resp.broker_id #=> String
703
+ # resp.max_results #=> Integer
704
+ # resp.next_token #=> String
705
+ # resp.users #=> Array
706
+ # resp.users[0].pending_change #=> String, one of "CREATE", "UPDATE", "DELETE"
707
+ # resp.users[0].username #=> String
708
+ #
709
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/ListUsers AWS API Documentation
710
+ #
711
+ # @overload list_users(params = {})
712
+ # @param [Hash] params ({})
713
+ def list_users(params = {}, options = {})
714
+ req = build_request(:list_users, params)
715
+ req.send_request(options)
716
+ end
717
+
718
+ # Reboots a broker. Note: This API is asynchronous.
719
+ #
720
+ # @option params [required, String] :broker_id
721
+ #
722
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
723
+ #
724
+ # @example Request syntax with placeholder values
725
+ #
726
+ # resp = client.reboot_broker({
727
+ # broker_id: "__string", # required
728
+ # })
729
+ #
730
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/RebootBroker AWS API Documentation
731
+ #
732
+ # @overload reboot_broker(params = {})
733
+ # @param [Hash] params ({})
734
+ def reboot_broker(params = {}, options = {})
735
+ req = build_request(:reboot_broker, params)
736
+ req.send_request(options)
737
+ end
738
+
739
+ # Adds a pending configuration change to a broker.
740
+ #
741
+ # @option params [required, String] :broker_id
742
+ #
743
+ # @option params [Types::ConfigurationId] :configuration
744
+ # A list of information about the configuration.
745
+ #
746
+ # @return [Types::UpdateBrokerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
747
+ #
748
+ # * {Types::UpdateBrokerResponse#broker_id #broker_id} => String
749
+ # * {Types::UpdateBrokerResponse#configuration #configuration} => Types::ConfigurationId
750
+ #
751
+ # @example Request syntax with placeholder values
752
+ #
753
+ # resp = client.update_broker({
754
+ # broker_id: "__string", # required
755
+ # configuration: {
756
+ # id: "__string",
757
+ # revision: 1,
758
+ # },
759
+ # })
760
+ #
761
+ # @example Response structure
762
+ #
763
+ # resp.broker_id #=> String
764
+ # resp.configuration.id #=> String
765
+ # resp.configuration.revision #=> Integer
766
+ #
767
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/UpdateBroker AWS API Documentation
768
+ #
769
+ # @overload update_broker(params = {})
770
+ # @param [Hash] params ({})
771
+ def update_broker(params = {}, options = {})
772
+ req = build_request(:update_broker, params)
773
+ req.send_request(options)
774
+ end
775
+
776
+ # Updates the specified configuration.
777
+ #
778
+ # @option params [required, String] :configuration_id
779
+ #
780
+ # @option params [String] :data
781
+ #
782
+ # @option params [String] :description
783
+ #
784
+ # @return [Types::UpdateConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
785
+ #
786
+ # * {Types::UpdateConfigurationResponse#arn #arn} => String
787
+ # * {Types::UpdateConfigurationResponse#id #id} => String
788
+ # * {Types::UpdateConfigurationResponse#latest_revision #latest_revision} => Types::ConfigurationRevision
789
+ # * {Types::UpdateConfigurationResponse#name #name} => String
790
+ # * {Types::UpdateConfigurationResponse#warnings #warnings} => Array&lt;Types::SanitizationWarning&gt;
791
+ #
792
+ # @example Request syntax with placeholder values
793
+ #
794
+ # resp = client.update_configuration({
795
+ # configuration_id: "__string", # required
796
+ # data: "__string",
797
+ # description: "__string",
798
+ # })
799
+ #
800
+ # @example Response structure
801
+ #
802
+ # resp.arn #=> String
803
+ # resp.id #=> String
804
+ # resp.latest_revision.description #=> String
805
+ # resp.latest_revision.revision #=> Integer
806
+ # resp.name #=> String
807
+ # resp.warnings #=> Array
808
+ # resp.warnings[0].attribute_name #=> String
809
+ # resp.warnings[0].element_name #=> String
810
+ # resp.warnings[0].reason #=> String, one of "DISALLOWED_ELEMENT_REMOVED", "DISALLOWED_ATTRIBUTE_REMOVED", "INVALID_ATTRIBUTE_VALUE_REMOVED"
811
+ #
812
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/UpdateConfiguration AWS API Documentation
813
+ #
814
+ # @overload update_configuration(params = {})
815
+ # @param [Hash] params ({})
816
+ def update_configuration(params = {}, options = {})
817
+ req = build_request(:update_configuration, params)
818
+ req.send_request(options)
819
+ end
820
+
821
+ # Updates the information for an ActiveMQ user.
822
+ #
823
+ # @option params [required, String] :broker_id
824
+ #
825
+ # @option params [Boolean] :console_access
826
+ #
827
+ # @option params [Array<String>] :groups
828
+ #
829
+ # @option params [String] :password
830
+ #
831
+ # @option params [required, String] :username
832
+ #
833
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
834
+ #
835
+ # @example Request syntax with placeholder values
836
+ #
837
+ # resp = client.update_user({
838
+ # broker_id: "__string", # required
839
+ # console_access: false,
840
+ # groups: ["__string"],
841
+ # password: "__string",
842
+ # username: "__string", # required
843
+ # })
844
+ #
845
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/UpdateUser AWS API Documentation
846
+ #
847
+ # @overload update_user(params = {})
848
+ # @param [Hash] params ({})
849
+ def update_user(params = {}, options = {})
850
+ req = build_request(:update_user, params)
851
+ req.send_request(options)
852
+ end
853
+
854
+ # @!endgroup
855
+
856
+ # @param params ({})
857
+ # @api private
858
+ def build_request(operation_name, params = {})
859
+ handlers = @handlers.for(operation_name)
860
+ context = Seahorse::Client::RequestContext.new(
861
+ operation_name: operation_name,
862
+ operation: config.api.operation(operation_name),
863
+ client: self,
864
+ params: params,
865
+ config: config)
866
+ context[:gem_name] = 'aws-sdk-mq'
867
+ context[:gem_version] = '1.0.0'
868
+ Seahorse::Client::Request.new(handlers, context)
869
+ end
870
+
871
+ # @api private
872
+ # @deprecated
873
+ def waiter_names
874
+ []
875
+ end
876
+
877
+ class << self
878
+
879
+ # @api private
880
+ attr_reader :identifier
881
+
882
+ # @api private
883
+ def errors_module
884
+ Errors
885
+ end
886
+
887
+ end
888
+ end
889
+ end