Class: Aws::MQ::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::MQ::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb
Overview
An API client for MQ. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::MQ::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#create_broker(params = {}) ⇒ Types::CreateBrokerResponse
Creates a broker.
-
#create_configuration(params = {}) ⇒ Types::CreateConfigurationResponse
Creates a new configuration for the specified configuration name.
-
#create_tags(params = {}) ⇒ Struct
Add a tag to a resource.
-
#create_user(params = {}) ⇒ Struct
Creates an ActiveMQ user.
-
#delete_broker(params = {}) ⇒ Types::DeleteBrokerResponse
Deletes a broker.
-
#delete_tags(params = {}) ⇒ Struct
Removes a tag from a resource.
-
#delete_user(params = {}) ⇒ Struct
Deletes an ActiveMQ user.
-
#describe_broker(params = {}) ⇒ Types::DescribeBrokerResponse
Returns information about the specified broker.
-
#describe_broker_engine_types(params = {}) ⇒ Types::DescribeBrokerEngineTypesResponse
Describe available engine types and versions.
-
#describe_broker_instance_options(params = {}) ⇒ Types::DescribeBrokerInstanceOptionsResponse
Describe available broker instance options.
-
#describe_configuration(params = {}) ⇒ Types::DescribeConfigurationResponse
Returns information about the specified configuration.
-
#describe_configuration_revision(params = {}) ⇒ Types::DescribeConfigurationRevisionResponse
Returns the specified configuration revision for the specified configuration.
-
#describe_user(params = {}) ⇒ Types::DescribeUserResponse
Returns information about an ActiveMQ user.
-
#list_brokers(params = {}) ⇒ Types::ListBrokersResponse
Returns a list of all brokers.
-
#list_configuration_revisions(params = {}) ⇒ Types::ListConfigurationRevisionsResponse
Returns a list of all revisions for the specified configuration.
-
#list_configurations(params = {}) ⇒ Types::ListConfigurationsResponse
Returns a list of all configurations.
-
#list_tags(params = {}) ⇒ Types::ListTagsResponse
Lists tags for a resource.
-
#list_users(params = {}) ⇒ Types::ListUsersResponse
Returns a list of all ActiveMQ users.
-
#reboot_broker(params = {}) ⇒ Struct
Reboots a broker.
-
#update_broker(params = {}) ⇒ Types::UpdateBrokerResponse
Adds a pending configuration change to a broker.
-
#update_configuration(params = {}) ⇒ Types::UpdateConfigurationResponse
Updates the specified configuration.
-
#update_user(params = {}) ⇒ Struct
Updates the information for an ActiveMQ user.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
324 325 326 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 324 def initialize(*args) super end |
Instance Method Details
#create_broker(params = {}) ⇒ Types::CreateBrokerResponse
Creates a broker. Note: This API is asynchronous.
456 457 458 459 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 456 def create_broker(params = {}, = {}) req = build_request(:create_broker, params) req.send_request() end |
#create_configuration(params = {}) ⇒ Types::CreateConfigurationResponse
Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version).
514 515 516 517 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 514 def create_configuration(params = {}, = {}) req = build_request(:create_configuration, params) req.send_request() end |
#create_tags(params = {}) ⇒ Struct
Add a tag to a resource.
540 541 542 543 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 540 def (params = {}, = {}) req = build_request(:create_tags, params) req.send_request() end |
#create_user(params = {}) ⇒ Struct
Creates an ActiveMQ user.
573 574 575 576 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 573 def create_user(params = {}, = {}) req = build_request(:create_user, params) req.send_request() end |
#delete_broker(params = {}) ⇒ Types::DeleteBrokerResponse
Deletes a broker. Note: This API is asynchronous.
600 601 602 603 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 600 def delete_broker(params = {}, = {}) req = build_request(:delete_broker, params) req.send_request() end |
#delete_tags(params = {}) ⇒ Struct
Removes a tag from a resource.
624 625 626 627 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 624 def (params = {}, = {}) req = build_request(:delete_tags, params) req.send_request() end |
#delete_user(params = {}) ⇒ Struct
Deletes an ActiveMQ user.
648 649 650 651 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 648 def delete_user(params = {}, = {}) req = build_request(:delete_user, params) req.send_request() end |
#describe_broker(params = {}) ⇒ Types::DescribeBrokerResponse
Returns information about the specified broker.
773 774 775 776 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 773 def describe_broker(params = {}, = {}) req = build_request(:describe_broker, params) req.send_request() end |
#describe_broker_engine_types(params = {}) ⇒ Types::DescribeBrokerEngineTypesResponse
Describe available engine types and versions.
813 814 815 816 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 813 def describe_broker_engine_types(params = {}, = {}) req = build_request(:describe_broker_engine_types, params) req.send_request() end |
#describe_broker_instance_options(params = {}) ⇒ Types::DescribeBrokerInstanceOptionsResponse
Describe available broker instance options.
865 866 867 868 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 865 def (params = {}, = {}) req = build_request(:describe_broker_instance_options, params) req.send_request() end |
#describe_configuration(params = {}) ⇒ Types::DescribeConfigurationResponse
Returns information about the specified configuration.
913 914 915 916 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 913 def describe_configuration(params = {}, = {}) req = build_request(:describe_configuration, params) req.send_request() end |
#describe_configuration_revision(params = {}) ⇒ Types::DescribeConfigurationRevisionResponse
Returns the specified configuration revision for the specified configuration.
950 951 952 953 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 950 def describe_configuration_revision(params = {}, = {}) req = build_request(:describe_configuration_revision, params) req.send_request() end |
#describe_user(params = {}) ⇒ Types::DescribeUserResponse
Returns information about an ActiveMQ user.
992 993 994 995 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 992 def describe_user(params = {}, = {}) req = build_request(:describe_user, params) req.send_request() end |
#list_brokers(params = {}) ⇒ Types::ListBrokersResponse
Returns a list of all brokers.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1034 1035 1036 1037 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 1034 def list_brokers(params = {}, = {}) req = build_request(:list_brokers, params) req.send_request() end |
#list_configuration_revisions(params = {}) ⇒ Types::ListConfigurationRevisionsResponse
Returns a list of all revisions for the specified configuration.
1076 1077 1078 1079 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 1076 def list_configuration_revisions(params = {}, = {}) req = build_request(:list_configuration_revisions, params) req.send_request() end |
#list_configurations(params = {}) ⇒ Types::ListConfigurationsResponse
Returns a list of all configurations.
1123 1124 1125 1126 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 1123 def list_configurations(params = {}, = {}) req = build_request(:list_configurations, params) req.send_request() end |
#list_tags(params = {}) ⇒ Types::ListTagsResponse
Lists tags for a resource.
1151 1152 1153 1154 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 1151 def (params = {}, = {}) req = build_request(:list_tags, params) req.send_request() end |
#list_users(params = {}) ⇒ Types::ListUsersResponse
Returns a list of all ActiveMQ users.
1192 1193 1194 1195 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 1192 def list_users(params = {}, = {}) req = build_request(:list_users, params) req.send_request() end |
#reboot_broker(params = {}) ⇒ Struct
Reboots a broker. Note: This API is asynchronous.
1213 1214 1215 1216 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 1213 def reboot_broker(params = {}, = {}) req = build_request(:reboot_broker, params) req.send_request() end |
#update_broker(params = {}) ⇒ Types::UpdateBrokerResponse
Adds a pending configuration change to a broker.
1316 1317 1318 1319 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 1316 def update_broker(params = {}, = {}) req = build_request(:update_broker, params) req.send_request() end |
#update_configuration(params = {}) ⇒ Types::UpdateConfigurationResponse
Updates the specified configuration.
1364 1365 1366 1367 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 1364 def update_configuration(params = {}, = {}) req = build_request(:update_configuration, params) req.send_request() end |
#update_user(params = {}) ⇒ Struct
Updates the information for an ActiveMQ user.
1397 1398 1399 1400 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 1397 def update_user(params = {}, = {}) req = build_request(:update_user, params) req.send_request() end |