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.
-
#promote(params = {}) ⇒ Types::PromoteResponse
Promotes a data replication replica broker to the primary broker role.
-
#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.
409 410 411 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 409 def initialize(*args) super end |
Instance Method Details
#create_broker(params = {}) ⇒ Types::CreateBrokerResponse
Creates a broker. Note: This API is asynchronous.
To create a broker, you must either use the AmazonMQFullAccess IAM policy or include the following EC2 permissions in your IAM policy.
ec2:CreateNetworkInterface
This permission is required to allow Amazon MQ to create an elastic network interface (ENI) on behalf of your account.
ec2:CreateNetworkInterfacePermission
This permission is required to attach the ENI to the broker instance.
ec2:DeleteNetworkInterface
ec2:DeleteNetworkInterfacePermission
ec2:DetachNetworkInterface
ec2:DescribeInternetGateways
ec2:DescribeNetworkInterfaces
ec2:DescribeNetworkInterfacePermissions
ec2:DescribeRouteTables
ec2:DescribeSecurityGroups
ec2:DescribeSubnets
ec2:DescribeVpcs
For more information, see Create an IAM User and Get Your Amazon Web Services Credentials and Never Modify or Delete the Amazon MQ Elastic Network Interface in the Amazon MQ Developer Guide.
596 597 598 599 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 596 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).
654 655 656 657 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 654 def create_configuration(params = {}, = {}) req = build_request(:create_configuration, params) req.send_request() end |
#create_tags(params = {}) ⇒ Struct
Add a tag to a resource.
680 681 682 683 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 680 def (params = {}, = {}) req = build_request(:create_tags, params) req.send_request() end |
#create_user(params = {}) ⇒ Struct
Creates an ActiveMQ user.
Do not add personally identifiable information (PII) or other confidential or sensitive information in broker usernames. Broker usernames are accessible to other Amazon Web Services services, including CloudWatch Logs. Broker usernames are not intended to be used for private or sensitive data.
722 723 724 725 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 722 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.
749 750 751 752 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 749 def delete_broker(params = {}, = {}) req = build_request(:delete_broker, params) req.send_request() end |
#delete_tags(params = {}) ⇒ Struct
Removes a tag from a resource.
773 774 775 776 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 773 def (params = {}, = {}) req = build_request(:delete_tags, params) req.send_request() end |
#delete_user(params = {}) ⇒ Struct
Deletes an ActiveMQ user.
797 798 799 800 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 797 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.
938 939 940 941 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 938 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.
978 979 980 981 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 978 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.
1030 1031 1032 1033 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 1030 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.
1078 1079 1080 1081 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 1078 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.
1115 1116 1117 1118 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 1115 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.
1159 1160 1161 1162 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 1159 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.
1201 1202 1203 1204 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 1201 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.
1243 1244 1245 1246 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 1243 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.
1290 1291 1292 1293 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 1290 def list_configurations(params = {}, = {}) req = build_request(:list_configurations, params) req.send_request() end |
#list_tags(params = {}) ⇒ Types::ListTagsResponse
Lists tags for a resource.
1318 1319 1320 1321 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 1318 def (params = {}, = {}) req = build_request(:list_tags, params) req.send_request() end |
#list_users(params = {}) ⇒ Types::ListUsersResponse
Returns a list of all ActiveMQ users.
1359 1360 1361 1362 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 1359 def list_users(params = {}, = {}) req = build_request(:list_users, params) req.send_request() end |
#promote(params = {}) ⇒ Types::PromoteResponse
Promotes a data replication replica broker to the primary broker role.
1390 1391 1392 1393 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 1390 def promote(params = {}, = {}) req = build_request(:promote, params) req.send_request() end |
#reboot_broker(params = {}) ⇒ Struct
Reboots a broker. Note: This API is asynchronous.
1411 1412 1413 1414 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 1411 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.
1547 1548 1549 1550 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 1547 def update_broker(params = {}, = {}) req = build_request(:update_broker, params) req.send_request() end |
#update_configuration(params = {}) ⇒ Types::UpdateConfigurationResponse
Updates the specified configuration.
1595 1596 1597 1598 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 1595 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.
1631 1632 1633 1634 |
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 1631 def update_user(params = {}, = {}) req = build_request(:update_user, params) req.send_request() end |