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

#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

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::SharedCredentials - Used for loading credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2 IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails to enable retries and extended timeouts.
  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is search for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String) —

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test endpoints. This should be avalid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available. Defaults to false.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors and auth errors from expired credentials.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.

  • :secret_access_key (String)
  • :session_token (String)
  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15 —

    The number of seconds to wait when opening a HTTP session before rasing a Timeout::Error.

  • :http_read_timeout (Integer) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session yeidled by #session_for.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idble before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session yeidled by #session_for.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



251
252
253
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 251

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
  encryption_options: {
    kms_key_id: "__string",
    use_aws_owned_key: false, # required
  },
  engine_type: "ACTIVEMQ", # accepts ACTIVEMQ
  engine_version: "__string",
  host_instance_type: "__string",
  logs: {
    audit: false,
    general: false,
  },
  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"],
  tags: {
    "__string" => "__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.

  • :encryption_options (Types::EncryptionOptions) —

    Encryption options for the broker.

  • :engine_type (String) —

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

  • :engine_version (String)
  • :host_instance_type (String)
  • :logs (Types::Logs) —

    The list of information about logs to be enabled for the specified broker.

  • :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>)
  • :tags (Hash<String,String>)
  • :users (Array<Types::User>)

Returns:

See Also:



359
360
361
362
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 359

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).

Examples:

Request syntax with placeholder values


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

Response structure


resp.arn #=> String
resp.created #=> Time
resp.id #=> String
resp.latest_revision.created #=> Time
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)
  • :tags (Hash<String,String>)

Returns:

See Also:



411
412
413
414
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 411

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

#create_tags(params = {}) ⇒ Struct

Add a tag to a resource.

Examples:

Request syntax with placeholder values


resp = client.create_tags({
  resource_arn: "__string", # required
  tags: {
    "__string" => "__string",
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String)
  • :tags (Hash<String,String>)

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



437
438
439
440
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 437

def create_tags(params = {}, options = {})
  req = build_request(:create_tags, 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:



470
471
472
473
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 470

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:



497
498
499
500
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 497

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

#delete_tags(params = {}) ⇒ Struct

Removes a tag from a resource.

Examples:

Request syntax with placeholder values


resp = client.delete_tags({
  resource_arn: "__string", # required
  tag_keys: ["__string"], # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String)
  • :tag_keys (required, Array<String>)

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

def delete_tags(params = {}, options = {})
  req = build_request(:delete_tags, 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:



545
546
547
548
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 545

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_instances[0].ip_address #=> 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.created #=> Time
resp.deployment_mode #=> String, one of "SINGLE_INSTANCE", "ACTIVE_STANDBY_MULTI_AZ"
resp.encryption_options.kms_key_id #=> String
resp.encryption_options.use_aws_owned_key #=> Boolean
resp.engine_type #=> String, one of "ACTIVEMQ"
resp.engine_version #=> String
resp.host_instance_type #=> String
resp.logs.audit #=> Boolean
resp.logs.audit_log_group #=> String
resp.logs.general #=> Boolean
resp.logs.general_log_group #=> String
resp.logs.pending.audit #=> Boolean
resp.logs.pending.general #=> Boolean
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.pending_engine_version #=> String
resp.pending_security_groups #=> Array
resp.pending_security_groups[0] #=> String
resp.publicly_accessible #=> Boolean
resp.security_groups #=> Array
resp.security_groups[0] #=> String
resp.subnet_ids #=> Array
resp.subnet_ids[0] #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> 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:



638
639
640
641
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 638

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

#describe_broker_engine_types(params = {}) ⇒ Types::DescribeBrokerEngineTypesResponse

Describe available engine types and versions.

Examples:

Request syntax with placeholder values


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

Response structure


resp.broker_engine_types #=> Array
resp.broker_engine_types[0].engine_type #=> String, one of "ACTIVEMQ"
resp.broker_engine_types[0].engine_versions #=> Array
resp.broker_engine_types[0].engine_versions[0].name #=> String
resp.max_results #=> Integer
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

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

Returns:

See Also:



678
679
680
681
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 678

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

#describe_broker_instance_options(params = {}) ⇒ Types::DescribeBrokerInstanceOptionsResponse

Describe available broker instance options.

Examples:

Request syntax with placeholder values


resp = client.describe_broker_instance_options({
  engine_type: "__string",
  host_instance_type: "__string",
  max_results: 1,
  next_token: "__string",
})

Response structure


resp.broker_instance_options #=> Array
resp.broker_instance_options[0].availability_zones #=> Array
resp.broker_instance_options[0].availability_zones[0].name #=> String
resp.broker_instance_options[0].engine_type #=> String, one of "ACTIVEMQ"
resp.broker_instance_options[0].host_instance_type #=> String
resp.broker_instance_options[0].supported_engine_versions #=> Array
resp.broker_instance_options[0].supported_engine_versions[0] #=> String
resp.max_results #=> Integer
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :engine_type (String)
  • :host_instance_type (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 describe_broker_instance_options(params = {}, options = {})
  req = build_request(:describe_broker_instance_options, 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.created #=> Time
resp.description #=> String
resp.engine_type #=> String, one of "ACTIVEMQ"
resp.engine_version #=> String
resp.id #=> String
resp.latest_revision.created #=> Time
resp.latest_revision.description #=> String
resp.latest_revision.revision #=> Integer
resp.name #=> String
resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :configuration_id (required, String)

Returns:

See Also:



770
771
772
773
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 770

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.created #=> Time
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:



807
808
809
810
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 807

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:



849
850
851
852
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 849

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].created #=> Time
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:



888
889
890
891
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 888

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].created #=> Time
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:



930
931
932
933
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 930

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].created #=> Time
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.created #=> Time
resp.configurations[0].latest_revision.description #=> String
resp.configurations[0].latest_revision.revision #=> Integer
resp.configurations[0].name #=> String
resp.configurations[0].tags #=> Hash
resp.configurations[0].tags["__string"] #=> 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:



976
977
978
979
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 976

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

#list_tags(params = {}) ⇒ Types::ListTagsResponse

Lists tags for a resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags({
  resource_arn: "__string", # required
})

Response structure


resp.tags #=> Hash
resp.tags["__string"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String)

Returns:

See Also:



1004
1005
1006
1007
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 1004

def list_tags(params = {}, options = {})
  req = build_request(:list_tags, 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:



1045
1046
1047
1048
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 1045

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:



1066
1067
1068
1069
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 1066

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({
  auto_minor_version_upgrade: false,
  broker_id: "__string", # required
  configuration: {
    id: "__string",
    revision: 1,
  },
  engine_version: "__string",
  logs: {
    audit: false,
    general: false,
  },
  security_groups: ["__string"],
})

Response structure


resp.auto_minor_version_upgrade #=> Boolean
resp.broker_id #=> String
resp.configuration.id #=> String
resp.configuration.revision #=> Integer
resp.engine_version #=> String
resp.logs.audit #=> Boolean
resp.logs.general #=> Boolean
resp.security_groups #=> Array
resp.security_groups[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

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

    A list of information about the configuration.

  • :engine_version (String)
  • :logs (Types::Logs) —

    The list of information about logs to be enabled for the specified broker.

  • :security_groups (Array<String>)

Returns:

See Also:



1130
1131
1132
1133
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 1130

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.created #=> Time
resp.id #=> String
resp.latest_revision.created #=> Time
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:



1178
1179
1180
1181
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 1178

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:



1211
1212
1213
1214
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/client.rb', line 1211

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