You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::MQ::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#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(*args) ⇒ Client

Returns a new instance of Client

Parameters:

  • options (Hash) —

    a customizable set of options



153
154
155
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 153

def initialize(*args)
  super
end

Instance Method Details

#create_broker(params = {}) ⇒ Types::CreateBrokerResponse

Creates a broker. Note: This API is asynchronous.

Examples:

Request syntax with placeholder values


resp = client.create_broker({
  auto_minor_version_upgrade: false,
  broker_name: "__string",
  configuration: {
    id: "__string",
    revision: 1,
  },
  creator_request_id: "__string",
  deployment_mode: "SINGLE_INSTANCE", # accepts SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ
  engine_type: "ACTIVEMQ", # accepts ACTIVEMQ
  engine_version: "__string",
  host_instance_type: "__string",
  maintenance_window_start_time: {
    day_of_week: "MONDAY", # accepts MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
    time_of_day: "__string",
    time_zone: "__string",
  },
  publicly_accessible: false,
  security_groups: ["__string"],
  subnet_ids: ["__string"],
  users: [
    {
      console_access: false,
      groups: ["__string"],
      password: "__string",
      username: "__string",
    },
  ],
})

Response structure


resp.broker_arn #=> String
resp.broker_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :auto_minor_version_upgrade (Boolean)
  • :broker_name (String)
  • :configuration (Types::ConfigurationId) —

    A list of information about the configuration.

  • :creator_request_id (String) —

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :deployment_mode (String) —

    The deployment mode of the broker. Possible values: SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ SINGLE_INSTANCE creates a single-instance broker in a single Availability Zone. ACTIVE_STANDBY_MULTI_AZ creates an active/standby broker for high availability.

  • :engine_type (String) —

    The type of broker engine. Note: Currently, Amazon MQ supports only ActiveMQ.

  • :engine_version (String)
  • :host_instance_type (String)
  • :maintenance_window_start_time (Types::WeeklyStartTime) —

    The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.

  • :publicly_accessible (Boolean)
  • :security_groups (Array<String>)
  • :subnet_ids (Array<String>)
  • :users (Array<Types::User>)

Returns:

See Also:



244
245
246
247
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 244

def create_broker(params = {}, options = {})
  req = build_request(:create_broker, params)
  req.send_request(options)
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). Note: If the configuration name already exists, Amazon MQ doesn't create a configuration.

Examples:

Request syntax with placeholder values


resp = client.create_configuration({
  engine_type: "ACTIVEMQ", # accepts ACTIVEMQ
  engine_version: "__string",
  name: "__string",
})

Response structure


resp.arn #=> String
resp.id #=> String
resp.latest_revision.description #=> String
resp.latest_revision.revision #=> Integer
resp.name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :engine_type (String) —

    The type of broker engine. Note: Currently, Amazon MQ supports only ActiveMQ.

  • :engine_version (String)
  • :name (String)

Returns:

See Also:



289
290
291
292
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 289

def create_configuration(params = {}, options = {})
  req = build_request(:create_configuration, params)
  req.send_request(options)
end

#create_user(params = {}) ⇒ Struct

Creates an ActiveMQ user.

Examples:

Request syntax with placeholder values


resp = client.create_user({
  broker_id: "__string", # required
  console_access: false,
  groups: ["__string"],
  password: "__string",
  username: "__string", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :broker_id (required, String)
  • :console_access (Boolean)
  • :groups (Array<String>)
  • :password (String)
  • :username (required, String)

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



322
323
324
325
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 322

def create_user(params = {}, options = {})
  req = build_request(:create_user, params)
  req.send_request(options)
end

#delete_broker(params = {}) ⇒ Types::DeleteBrokerResponse

Deletes a broker. Note: This API is asynchronous.

Examples:

Request syntax with placeholder values


resp = client.delete_broker({
  broker_id: "__string", # required
})

Response structure


resp.broker_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :broker_id (required, String)

Returns:

See Also:



349
350
351
352
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 349

def delete_broker(params = {}, options = {})
  req = build_request(:delete_broker, params)
  req.send_request(options)
end

#delete_user(params = {}) ⇒ Struct

Deletes an ActiveMQ user.

Examples:

Request syntax with placeholder values


resp = client.delete_user({
  broker_id: "__string", # required
  username: "__string", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :broker_id (required, String)
  • :username (required, String)

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



373
374
375
376
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 373

def delete_user(params = {}, options = {})
  req = build_request(:delete_user, params)
  req.send_request(options)
end

#describe_broker(params = {}) ⇒ Types::DescribeBrokerResponse

Returns information about the specified broker.

Examples:

Request syntax with placeholder values


resp = client.describe_broker({
  broker_id: "__string", # required
})

Response structure


resp.auto_minor_version_upgrade #=> Boolean
resp.broker_arn #=> String
resp.broker_id #=> String
resp.broker_instances #=> Array
resp.broker_instances[0].console_url #=> String
resp.broker_instances[0].endpoints #=> Array
resp.broker_instances[0].endpoints[0] #=> String
resp.broker_name #=> String
resp.broker_state #=> String, one of "CREATION_IN_PROGRESS", "CREATION_FAILED", "DELETION_IN_PROGRESS", "RUNNING", "REBOOT_IN_PROGRESS"
resp.configurations.current.id #=> String
resp.configurations.current.revision #=> Integer
resp.configurations.history #=> Array
resp.configurations.history[0].id #=> String
resp.configurations.history[0].revision #=> Integer
resp.configurations.pending.id #=> String
resp.configurations.pending.revision #=> Integer
resp.deployment_mode #=> String, one of "SINGLE_INSTANCE", "ACTIVE_STANDBY_MULTI_AZ"
resp.engine_type #=> String, one of "ACTIVEMQ"
resp.engine_version #=> String
resp.host_instance_type #=> String
resp.maintenance_window_start_time.day_of_week #=> String, one of "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"
resp.maintenance_window_start_time.time_of_day #=> String
resp.maintenance_window_start_time.time_zone #=> String
resp.publicly_accessible #=> Boolean
resp.security_groups #=> Array
resp.security_groups[0] #=> String
resp.subnet_ids #=> Array
resp.subnet_ids[0] #=> String
resp.users #=> Array
resp.users[0].pending_change #=> String, one of "CREATE", "UPDATE", "DELETE"
resp.users[0].username #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :broker_id (required, String)

Returns:

See Also:



445
446
447
448
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 445

def describe_broker(params = {}, options = {})
  req = build_request(:describe_broker, params)
  req.send_request(options)
end

#describe_configuration(params = {}) ⇒ Types::DescribeConfigurationResponse

Returns information about the specified configuration.

Examples:

Request syntax with placeholder values


resp = client.describe_configuration({
  configuration_id: "__string", # required
})

Response structure


resp.arn #=> String
resp.description #=> String
resp.engine_type #=> String, one of "ACTIVEMQ"
resp.engine_version #=> String
resp.id #=> String
resp.latest_revision.description #=> String
resp.latest_revision.revision #=> Integer
resp.name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :configuration_id (required, String)

Returns:

See Also:



485
486
487
488
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 485

def describe_configuration(params = {}, options = {})
  req = build_request(:describe_configuration, params)
  req.send_request(options)
end

#describe_configuration_revision(params = {}) ⇒ Types::DescribeConfigurationRevisionResponse

Returns the specified configuration revision for the specified configuration.

Examples:

Request syntax with placeholder values


resp = client.describe_configuration_revision({
  configuration_id: "__string", # required
  configuration_revision: "__string", # required
})

Response structure


resp.configuration_id #=> String
resp.data #=> String
resp.description #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :configuration_id (required, String)
  • :configuration_revision (required, String)

Returns:

See Also:



520
521
522
523
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 520

def describe_configuration_revision(params = {}, options = {})
  req = build_request(:describe_configuration_revision, params)
  req.send_request(options)
end

#describe_user(params = {}) ⇒ Types::DescribeUserResponse

Returns information about an ActiveMQ user.

Examples:

Request syntax with placeholder values


resp = client.describe_user({
  broker_id: "__string", # required
  username: "__string", # required
})

Response structure


resp.broker_id #=> String
resp.console_access #=> Boolean
resp.groups #=> Array
resp.groups[0] #=> String
resp.pending.console_access #=> Boolean
resp.pending.groups #=> Array
resp.pending.groups[0] #=> String
resp.pending.pending_change #=> String, one of "CREATE", "UPDATE", "DELETE"
resp.username #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :broker_id (required, String)
  • :username (required, String)

Returns:

See Also:



562
563
564
565
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 562

def describe_user(params = {}, options = {})
  req = build_request(:describe_user, params)
  req.send_request(options)
end

#list_brokers(params = {}) ⇒ Types::ListBrokersResponse

Returns a list of all brokers.

Examples:

Request syntax with placeholder values


resp = client.list_brokers({
  max_results: 1,
  next_token: "__string",
})

Response structure


resp.broker_summaries #=> Array
resp.broker_summaries[0].broker_arn #=> String
resp.broker_summaries[0].broker_id #=> String
resp.broker_summaries[0].broker_name #=> String
resp.broker_summaries[0].broker_state #=> String, one of "CREATION_IN_PROGRESS", "CREATION_FAILED", "DELETION_IN_PROGRESS", "RUNNING", "REBOOT_IN_PROGRESS"
resp.broker_summaries[0].deployment_mode #=> String, one of "SINGLE_INSTANCE", "ACTIVE_STANDBY_MULTI_AZ"
resp.broker_summaries[0].host_instance_type #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer)
  • :next_token (String)

Returns:

See Also:



600
601
602
603
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 600

def list_brokers(params = {}, options = {})
  req = build_request(:list_brokers, params)
  req.send_request(options)
end

#list_configuration_revisions(params = {}) ⇒ Types::ListConfigurationRevisionsResponse

Returns a list of all revisions for the specified configuration.

Examples:

Request syntax with placeholder values


resp = client.list_configuration_revisions({
  configuration_id: "__string", # required
  max_results: 1,
  next_token: "__string",
})

Response structure


resp.configuration_id #=> String
resp.max_results #=> Integer
resp.next_token #=> String
resp.revisions #=> Array
resp.revisions[0].description #=> String
resp.revisions[0].revision #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :configuration_id (required, String)
  • :max_results (Integer)
  • :next_token (String)

Returns:

See Also:



641
642
643
644
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 641

def list_configuration_revisions(params = {}, options = {})
  req = build_request(:list_configuration_revisions, params)
  req.send_request(options)
end

#list_configurations(params = {}) ⇒ Types::ListConfigurationsResponse

Returns a list of all configurations.

Examples:

Request syntax with placeholder values


resp = client.list_configurations({
  max_results: 1,
  next_token: "__string",
})

Response structure


resp.configurations #=> Array
resp.configurations[0].arn #=> String
resp.configurations[0].description #=> String
resp.configurations[0].engine_type #=> String, one of "ACTIVEMQ"
resp.configurations[0].engine_version #=> String
resp.configurations[0].id #=> String
resp.configurations[0].latest_revision.description #=> String
resp.configurations[0].latest_revision.revision #=> Integer
resp.configurations[0].name #=> String
resp.max_results #=> Integer
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer)
  • :next_token (String)

Returns:

See Also:



683
684
685
686
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 683

def list_configurations(params = {}, options = {})
  req = build_request(:list_configurations, params)
  req.send_request(options)
end

#list_users(params = {}) ⇒ Types::ListUsersResponse

Returns a list of all ActiveMQ users.

Examples:

Request syntax with placeholder values


resp = client.list_users({
  broker_id: "__string", # required
  max_results: 1,
  next_token: "__string",
})

Response structure


resp.broker_id #=> String
resp.max_results #=> Integer
resp.next_token #=> String
resp.users #=> Array
resp.users[0].pending_change #=> String, one of "CREATE", "UPDATE", "DELETE"
resp.users[0].username #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :broker_id (required, String)
  • :max_results (Integer)
  • :next_token (String)

Returns:

See Also:



724
725
726
727
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 724

def list_users(params = {}, options = {})
  req = build_request(:list_users, params)
  req.send_request(options)
end

#reboot_broker(params = {}) ⇒ Struct

Reboots a broker. Note: This API is asynchronous.

Examples:

Request syntax with placeholder values


resp = client.reboot_broker({
  broker_id: "__string", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :broker_id (required, String)

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



745
746
747
748
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 745

def reboot_broker(params = {}, options = {})
  req = build_request(:reboot_broker, params)
  req.send_request(options)
end

#update_broker(params = {}) ⇒ Types::UpdateBrokerResponse

Adds a pending configuration change to a broker.

Examples:

Request syntax with placeholder values


resp = client.update_broker({
  broker_id: "__string", # required
  configuration: {
    id: "__string",
    revision: 1,
  },
})

Response structure


resp.broker_id #=> String
resp.configuration.id #=> String
resp.configuration.revision #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :broker_id (required, String)
  • :configuration (Types::ConfigurationId) —

    A list of information about the configuration.

Returns:

See Also:



782
783
784
785
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 782

def update_broker(params = {}, options = {})
  req = build_request(:update_broker, params)
  req.send_request(options)
end

#update_configuration(params = {}) ⇒ Types::UpdateConfigurationResponse

Updates the specified configuration.

Examples:

Request syntax with placeholder values


resp = client.update_configuration({
  configuration_id: "__string", # required
  data: "__string",
  description: "__string",
})

Response structure


resp.arn #=> String
resp.id #=> String
resp.latest_revision.description #=> String
resp.latest_revision.revision #=> Integer
resp.name #=> String
resp.warnings #=> Array
resp.warnings[0].attribute_name #=> String
resp.warnings[0].element_name #=> String
resp.warnings[0].reason #=> String, one of "DISALLOWED_ELEMENT_REMOVED", "DISALLOWED_ATTRIBUTE_REMOVED", "INVALID_ATTRIBUTE_VALUE_REMOVED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :configuration_id (required, String)
  • :data (String)
  • :description (String)

Returns:

See Also:



827
828
829
830
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 827

def update_configuration(params = {}, options = {})
  req = build_request(:update_configuration, params)
  req.send_request(options)
end

#update_user(params = {}) ⇒ Struct

Updates the information for an ActiveMQ user.

Examples:

Request syntax with placeholder values


resp = client.update_user({
  broker_id: "__string", # required
  console_access: false,
  groups: ["__string"],
  password: "__string",
  username: "__string", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :broker_id (required, String)
  • :console_access (Boolean)
  • :groups (Array<String>)
  • :password (String)
  • :username (required, String)

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



860
861
862
863
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 860

def update_user(params = {}, options = {})
  req = build_request(:update_user, params)
  req.send_request(options)
end