class Aws::MQ::Client

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](/sdk-for-ruby/v3/developer-guide/setup-config.html).

See {#initialize} for a full list of supported configuration options.

Attributes

identifier[R]

@api private

Public Class Methods

errors_module() click to toggle source

@api private

# File lib/aws-sdk-mq/client.rb, line 1501
def errors_module
  Errors
end
new(*args) click to toggle source

@overload initialize(options)

@param [Hash] options
@option options [required, Aws::CredentialProvider] :credentials
  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::SharedCredentials` - Used for loading static credentials from a
    shared file, such as `~/.aws/config`.

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

  * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
    assume a role after providing credentials via the web.

  * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
    access token generated from `aws login`.

  * `Aws::ProcessCredentials` - Used for loading credentials from a
    process that outputs to stdout.

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

  * `Aws::ECSCredentials` - Used for loading credentials from
    instances running in ECS.

  * `Aws::CognitoIdentityCredentials` - Used for loading credentials
    from the Cognito Identity service.

  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/ECS IMDS instance profile - When used by default, the timeouts
    are very aggressive. Construct and pass an instance of
    `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
    enable retries and extended timeouts.

@option options [required, String] :region
  The AWS region to connect to.  The configured `:region` is
  used to determine the service `:endpoint`. When not passed,
  a default `:region` is searched for in the following locations:

  * `Aws.config[:region]`
  * `ENV['AWS_REGION']`
  * `ENV['AMAZON_REGION']`
  * `ENV['AWS_DEFAULT_REGION']`
  * `~/.aws/credentials`
  * `~/.aws/config`

@option options [String] :access_key_id

@option options [Boolean] :active_endpoint_cache (false)
  When set to `true`, a thread polling for endpoints will be running in
  the background every 60 secs (default). Defaults to `false`.

@option options [Boolean] :adaptive_retry_wait_to_fill (true)
  Used only in `adaptive` retry mode.  When true, the request will sleep
  until there is sufficent client side capacity to retry the request.
  When false, the request will raise a `RetryCapacityNotAvailableError` and will
  not retry instead of sleeping.

@option options [Boolean] :client_side_monitoring (false)
  When `true`, client-side metrics will be collected for all API requests from
  this client.

@option options [String] :client_side_monitoring_client_id ("")
  Allows you to provide an identifier for this client which will be attached to
  all generated client side metrics. Defaults to an empty string.

@option options [String] :client_side_monitoring_host ("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.

@option options [Integer] :client_side_monitoring_port (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.

@option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
  Allows you to provide a custom client-side monitoring publisher class. By default,
  will use the Client Side Monitoring Agent Publisher.

@option options [Boolean] :convert_params (true)
  When `true`, an attempt is made to coerce request parameters into
  the required types.

@option options [Boolean] :correct_clock_skew (true)
  Used only in `standard` and adaptive retry modes. Specifies whether to apply
  a clock skew correction and retry requests with skewed client clocks.

@option options [Boolean] :disable_host_prefix_injection (false)
  Set to true to disable SDK automatically adding host prefix
  to default service endpoint when available.

@option options [String] :endpoint
  The client endpoint is normally constructed from the `:region`
  option. You should only configure an `:endpoint` when connecting
  to test or custom endpoints. This should be a valid HTTP(S) URI.

@option options [Integer] :endpoint_cache_max_entries (1000)
  Used for the maximum size limit of the LRU cache storing endpoints data
  for endpoint discovery enabled operations. Defaults to 1000.

@option options [Integer] :endpoint_cache_max_threads (10)
  Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

@option options [Integer] :endpoint_cache_poll_interval (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.

@option options [Boolean] :endpoint_discovery (false)
  When set to `true`, endpoint discovery will be enabled for operations when available.

@option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
  The log formatter.

@option options [Symbol] :log_level (:info)
  The log level to send messages to the `:logger` at.

@option options [Logger] :logger
  The Logger instance to send log messages to.  If this option
  is not set, logging will be disabled.

@option options [Integer] :max_attempts (3)
  An integer representing the maximum number attempts that will be made for
  a single request, including the initial attempt.  For example,
  setting this value to 5 will result in a request being retried up to
  4 times. Used in `standard` and `adaptive` retry modes.

@option options [String] :profile ("default")
  Used when loading credentials from the shared credentials file
  at HOME/.aws/credentials.  When not specified, 'default' is used.

@option options [Proc] :retry_backoff
  A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
  This option is only used in the `legacy` retry mode.

@option options [Float] :retry_base_delay (0.3)
  The base delay in seconds used by the default backoff function. This option
  is only used in the `legacy` retry mode.

@option options [Symbol] :retry_jitter (: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. This option is only used
  in the `legacy` retry mode.

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

@option options [Integer] :retry_limit (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, auth errors,
  endpoint discovery, and errors from expired credentials.
  This option is only used in the `legacy` retry mode.

@option options [Integer] :retry_max_delay (0)
  The maximum number of seconds to delay between retries (0 for no limit)
  used by the default backoff function. This option is only used in the
  `legacy` retry mode.

@option options [String] :retry_mode ("legacy")
  Specifies which retry algorithm to use. Values are:

  * `legacy` - The pre-existing retry behavior.  This is default value if
    no retry mode is provided.

  * `standard` - A standardized set of retry rules across the AWS SDKs.
    This includes support for retry quotas, which limit the number of
    unsuccessful retries a client can make.

  * `adaptive` - An experimental retry mode that includes all the
    functionality of `standard` mode along with automatic client side
    throttling.  This is a provisional mode that may change behavior
    in the future.

@option options [String] :secret_access_key

@option options [String] :session_token

@option options [Boolean] :stub_responses (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.

@option options [Boolean] :validate_params (true)
  When `true`, request parameters are validated before
  sending the request.

@option options [URI::HTTP,String] :http_proxy A proxy to send
  requests through.  Formatted like 'http://proxy.com:123'.

@option options [Float] :http_open_timeout (15) The number of
  seconds to wait when opening a HTTP session before raising a
  `Timeout::Error`.

@option options [Integer] :http_read_timeout (60) The default
  number of seconds to wait for response data.  This value can
  safely be set per-request on the session.

@option options [Float] :http_idle_timeout (5) The number of
  seconds a connection is allowed to sit idle before it is
  considered stale.  Stale connections are closed and removed
  from the pool before making a request.

@option options [Float] :http_continue_timeout (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.

@option options [Boolean] :http_wire_trace (false) When `true`,
  HTTP debug output will be sent to the `:logger`.

@option options [Boolean] :ssl_verify_peer (true) When `true`,
  SSL peer certificates are verified when establishing a
  connection.

@option options [String] :ssl_ca_bundle 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.

@option options [String] :ssl_ca_directory 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.
Calls superclass method
# File lib/aws-sdk-mq/client.rb, line 324
def initialize(*args)
  super
end

Public Instance Methods

build_request(operation_name, params = {}) click to toggle source

@param params ({}) @api private

# File lib/aws-sdk-mq/client.rb, line 1476
def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config)
  context[:gem_name] = 'aws-sdk-mq'
  context[:gem_version] = '1.40.0'
  Seahorse::Client::Request.new(handlers, context)
end
create_broker(params = {}, options = {}) click to toggle source

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 AWS Credentials] and [Never Modify or Delete the Amazon MQ Elastic Network Interface] in the *Amazon MQ Developer Guide*.

[1]: docs.aws.amazon.com//amazon-mq/latest/developer-guide/amazon-mq-setting-up.html#create-iam-user [2]: docs.aws.amazon.com/amazon-mq/latest/developer-guide/connecting-to-amazon-mq.html#never-modify-delete-elastic-network-interface

@option params [String] :authentication_strategy

Optional. The authentication strategy used to secure the broker. The
default is SIMPLE.

@option params [required, Boolean] :auto_minor_version_upgrade

@option params [required, String] :broker_name

@option params [Types::ConfigurationId] :configuration

A list of information about the configuration.

Does not apply to RabbitMQ brokers.

@option params [String] :creator_request_id

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

@option params [required, String] :deployment_mode

The broker's deployment mode.

@option params [Types::EncryptionOptions] :encryption_options

Does not apply to RabbitMQ brokers.

Encryption options for the broker.

@option params [required, String] :engine_type

The type of broker engine. Amazon MQ supports ActiveMQ and RabbitMQ.

@option params [required, String] :engine_version

@option params [required, String] :host_instance_type

@option params [Types::LdapServerMetadataInput] :ldap_server_metadata

Optional. The metadata of the LDAP server used to authenticate and
authorize connections to the broker.

Does not apply to RabbitMQ brokers.

@option params [Types::Logs] :logs

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

@option params [Types::WeeklyStartTime] :maintenance_window_start_time

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

@option params [required, Boolean] :publicly_accessible

@option params [Array<String>] :security_groups

@option params [String] :storage_type

The broker's storage type.

EFS is not supported for RabbitMQ engine type.

@option params [Array<String>] :subnet_ids

@option params [Hash<String,String>] :tags

@option params [required, Array<Types::User>] :users

@return [Types::CreateBrokerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::CreateBrokerResponse#broker_arn #broker_arn} => String
* {Types::CreateBrokerResponse#broker_id #broker_id} => String

@example Request syntax with placeholder values

resp = client.create_broker({
  authentication_strategy: "SIMPLE", # accepts SIMPLE, LDAP
  auto_minor_version_upgrade: false, # required
  broker_name: "__string", # required
  configuration: {
    id: "__string", # required
    revision: 1,
  },
  creator_request_id: "__string",
  deployment_mode: "SINGLE_INSTANCE", # required, accepts SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ, CLUSTER_MULTI_AZ
  encryption_options: {
    kms_key_id: "__string",
    use_aws_owned_key: false, # required
  },
  engine_type: "ACTIVEMQ", # required, accepts ACTIVEMQ, RABBITMQ
  engine_version: "__string", # required
  host_instance_type: "__string", # required
  ldap_server_metadata: {
    hosts: ["__string"], # required
    role_base: "__string", # required
    role_name: "__string",
    role_search_matching: "__string", # required
    role_search_subtree: false,
    service_account_password: "__string", # required
    service_account_username: "__string", # required
    user_base: "__string", # required
    user_role_name: "__string",
    user_search_matching: "__string", # required
    user_search_subtree: false,
  },
  logs: {
    audit: false,
    general: false,
  },
  maintenance_window_start_time: {
    day_of_week: "MONDAY", # required, accepts MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
    time_of_day: "__string", # required
    time_zone: "__string",
  },
  publicly_accessible: false, # required
  security_groups: ["__string"],
  storage_type: "EBS", # accepts EBS, EFS
  subnet_ids: ["__string"],
  tags: {
    "__string" => "__string",
  },
  users: [ # required
    {
      console_access: false,
      groups: ["__string"],
      password: "__string", # required
      username: "__string", # required
    },
  ],
})

@example Response structure

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

@see docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/CreateBroker AWS API Documentation

@overload create_broker(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-mq/client.rb, line 507
def create_broker(params = {}, options = {})
  req = build_request(:create_broker, params)
  req.send_request(options)
end
create_configuration(params = {}, options = {}) click to toggle source

Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version).

@option params [String] :authentication_strategy

Optional. The authentication strategy used to secure the broker. The
default is SIMPLE.

@option params [required, String] :engine_type

The type of broker engine. Amazon MQ supports ActiveMQ and RabbitMQ.

@option params [required, String] :engine_version

@option params [required, String] :name

@option params [Hash<String,String>] :tags

@return [Types::CreateConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::CreateConfigurationResponse#arn #arn} => String
* {Types::CreateConfigurationResponse#authentication_strategy #authentication_strategy} => String
* {Types::CreateConfigurationResponse#created #created} => Time
* {Types::CreateConfigurationResponse#id #id} => String
* {Types::CreateConfigurationResponse#latest_revision #latest_revision} => Types::ConfigurationRevision
* {Types::CreateConfigurationResponse#name #name} => String

@example Request syntax with placeholder values

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

@example Response structure

resp.arn #=> String
resp.authentication_strategy #=> String, one of "SIMPLE", "LDAP"
resp.created #=> Time
resp.id #=> String
resp.latest_revision.created #=> Time
resp.latest_revision.description #=> String
resp.latest_revision.revision #=> Integer
resp.name #=> String

@see docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/CreateConfiguration AWS API Documentation

@overload create_configuration(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-mq/client.rb, line 565
def create_configuration(params = {}, options = {})
  req = build_request(:create_configuration, params)
  req.send_request(options)
end
create_tags(params = {}, options = {}) click to toggle source

Add a tag to a resource.

@option params [required, String] :resource_arn

@option params [Hash<String,String>] :tags

@return [Struct] Returns an empty {Seahorse::Client::Response response}.

@example Request syntax with placeholder values

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

@see docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/CreateTags AWS API Documentation

@overload create_tags(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-mq/client.rb, line 591
def create_tags(params = {}, options = {})
  req = build_request(:create_tags, params)
  req.send_request(options)
end
create_user(params = {}, options = {}) click to toggle source

Creates an ActiveMQ user.

@option params [required, String] :broker_id

@option params [Boolean] :console_access

@option params [Array<String>] :groups

@option params [required, String] :password

@option params [required, String] :username

@return [Struct] Returns an empty {Seahorse::Client::Response response}.

@example Request syntax with placeholder values

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

@see docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/CreateUser AWS API Documentation

@overload create_user(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-mq/client.rb, line 624
def create_user(params = {}, options = {})
  req = build_request(:create_user, params)
  req.send_request(options)
end
delete_broker(params = {}, options = {}) click to toggle source

Deletes a broker. Note: This API is asynchronous.

@option params [required, String] :broker_id

@return [Types::DeleteBrokerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::DeleteBrokerResponse#broker_id #broker_id} => String

@example Request syntax with placeholder values

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

@example Response structure

resp.broker_id #=> String

@see docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DeleteBroker AWS API Documentation

@overload delete_broker(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-mq/client.rb, line 651
def delete_broker(params = {}, options = {})
  req = build_request(:delete_broker, params)
  req.send_request(options)
end
delete_tags(params = {}, options = {}) click to toggle source

Removes a tag from a resource.

@option params [required, String] :resource_arn

@option params [required, Array<String>] :tag_keys

@return [Struct] Returns an empty {Seahorse::Client::Response response}.

@example Request syntax with placeholder values

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

@see docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DeleteTags AWS API Documentation

@overload delete_tags(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-mq/client.rb, line 675
def delete_tags(params = {}, options = {})
  req = build_request(:delete_tags, params)
  req.send_request(options)
end
delete_user(params = {}, options = {}) click to toggle source

Deletes an ActiveMQ user.

@option params [required, String] :broker_id

@option params [required, String] :username

@return [Struct] Returns an empty {Seahorse::Client::Response response}.

@example Request syntax with placeholder values

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

@see docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DeleteUser AWS API Documentation

@overload delete_user(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-mq/client.rb, line 699
def delete_user(params = {}, options = {})
  req = build_request(:delete_user, params)
  req.send_request(options)
end
describe_broker(params = {}, options = {}) click to toggle source

Returns information about the specified broker.

@option params [required, String] :broker_id

@return [Types::DescribeBrokerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::DescribeBrokerResponse#authentication_strategy #authentication_strategy} => String
* {Types::DescribeBrokerResponse#auto_minor_version_upgrade #auto_minor_version_upgrade} => Boolean
* {Types::DescribeBrokerResponse#broker_arn #broker_arn} => String
* {Types::DescribeBrokerResponse#broker_id #broker_id} => String
* {Types::DescribeBrokerResponse#broker_instances #broker_instances} => Array&lt;Types::BrokerInstance&gt;
* {Types::DescribeBrokerResponse#broker_name #broker_name} => String
* {Types::DescribeBrokerResponse#broker_state #broker_state} => String
* {Types::DescribeBrokerResponse#configurations #configurations} => Types::Configurations
* {Types::DescribeBrokerResponse#created #created} => Time
* {Types::DescribeBrokerResponse#deployment_mode #deployment_mode} => String
* {Types::DescribeBrokerResponse#encryption_options #encryption_options} => Types::EncryptionOptions
* {Types::DescribeBrokerResponse#engine_type #engine_type} => String
* {Types::DescribeBrokerResponse#engine_version #engine_version} => String
* {Types::DescribeBrokerResponse#host_instance_type #host_instance_type} => String
* {Types::DescribeBrokerResponse#ldap_server_metadata #ldap_server_metadata} => Types::LdapServerMetadataOutput
* {Types::DescribeBrokerResponse#logs #logs} => Types::LogsSummary
* {Types::DescribeBrokerResponse#maintenance_window_start_time #maintenance_window_start_time} => Types::WeeklyStartTime
* {Types::DescribeBrokerResponse#pending_authentication_strategy #pending_authentication_strategy} => String
* {Types::DescribeBrokerResponse#pending_engine_version #pending_engine_version} => String
* {Types::DescribeBrokerResponse#pending_host_instance_type #pending_host_instance_type} => String
* {Types::DescribeBrokerResponse#pending_ldap_server_metadata #pending_ldap_server_metadata} => Types::LdapServerMetadataOutput
* {Types::DescribeBrokerResponse#pending_security_groups #pending_security_groups} => Array&lt;String&gt;
* {Types::DescribeBrokerResponse#publicly_accessible #publicly_accessible} => Boolean
* {Types::DescribeBrokerResponse#security_groups #security_groups} => Array&lt;String&gt;
* {Types::DescribeBrokerResponse#storage_type #storage_type} => String
* {Types::DescribeBrokerResponse#subnet_ids #subnet_ids} => Array&lt;String&gt;
* {Types::DescribeBrokerResponse#tags #tags} => Hash&lt;String,String&gt;
* {Types::DescribeBrokerResponse#users #users} => Array&lt;Types::UserSummary&gt;

@example Request syntax with placeholder values

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

@example Response structure

resp.authentication_strategy #=> String, one of "SIMPLE", "LDAP"
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", "CLUSTER_MULTI_AZ"
resp.encryption_options.kms_key_id #=> String
resp.encryption_options.use_aws_owned_key #=> Boolean
resp.engine_type #=> String, one of "ACTIVEMQ", "RABBITMQ"
resp.engine_version #=> String
resp.host_instance_type #=> String
resp.ldap_server_metadata.hosts #=> Array
resp.ldap_server_metadata.hosts[0] #=> String
resp.ldap_server_metadata.role_base #=> String
resp.ldap_server_metadata.role_name #=> String
resp.ldap_server_metadata.role_search_matching #=> String
resp.ldap_server_metadata.role_search_subtree #=> Boolean
resp.ldap_server_metadata.service_account_username #=> String
resp.ldap_server_metadata.user_base #=> String
resp.ldap_server_metadata.user_role_name #=> String
resp.ldap_server_metadata.user_search_matching #=> String
resp.ldap_server_metadata.user_search_subtree #=> Boolean
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_authentication_strategy #=> String, one of "SIMPLE", "LDAP"
resp.pending_engine_version #=> String
resp.pending_host_instance_type #=> String
resp.pending_ldap_server_metadata.hosts #=> Array
resp.pending_ldap_server_metadata.hosts[0] #=> String
resp.pending_ldap_server_metadata.role_base #=> String
resp.pending_ldap_server_metadata.role_name #=> String
resp.pending_ldap_server_metadata.role_search_matching #=> String
resp.pending_ldap_server_metadata.role_search_subtree #=> Boolean
resp.pending_ldap_server_metadata.service_account_username #=> String
resp.pending_ldap_server_metadata.user_base #=> String
resp.pending_ldap_server_metadata.user_role_name #=> String
resp.pending_ldap_server_metadata.user_search_matching #=> String
resp.pending_ldap_server_metadata.user_search_subtree #=> Boolean
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.storage_type #=> String, one of "EBS", "EFS"
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

@see docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DescribeBroker AWS API Documentation

@overload describe_broker(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-mq/client.rb, line 824
def describe_broker(params = {}, options = {})
  req = build_request(:describe_broker, params)
  req.send_request(options)
end
describe_broker_engine_types(params = {}, options = {}) click to toggle source

Describe available engine types and versions.

@option params [String] :engine_type

@option params [Integer] :max_results

@option params [String] :next_token

@return [Types::DescribeBrokerEngineTypesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::DescribeBrokerEngineTypesResponse#broker_engine_types #broker_engine_types} => Array&lt;Types::BrokerEngineType&gt;
* {Types::DescribeBrokerEngineTypesResponse#max_results #max_results} => Integer
* {Types::DescribeBrokerEngineTypesResponse#next_token #next_token} => String

@example Request syntax with placeholder values

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

@example Response structure

resp.broker_engine_types #=> Array
resp.broker_engine_types[0].engine_type #=> String, one of "ACTIVEMQ", "RABBITMQ"
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

@see docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DescribeBrokerEngineTypes AWS API Documentation

@overload describe_broker_engine_types(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-mq/client.rb, line 864
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 = {}, options = {}) click to toggle source

Describe available broker instance options.

@option params [String] :engine_type

@option params [String] :host_instance_type

@option params [Integer] :max_results

@option params [String] :next_token

@option params [String] :storage_type

@return [Types::DescribeBrokerInstanceOptionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::DescribeBrokerInstanceOptionsResponse#broker_instance_options #broker_instance_options} => Array&lt;Types::BrokerInstanceOption&gt;
* {Types::DescribeBrokerInstanceOptionsResponse#max_results #max_results} => Integer
* {Types::DescribeBrokerInstanceOptionsResponse#next_token #next_token} => String

@example Request syntax with placeholder values

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

@example 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", "RABBITMQ"
resp.broker_instance_options[0].host_instance_type #=> String
resp.broker_instance_options[0].storage_type #=> String, one of "EBS", "EFS"
resp.broker_instance_options[0].supported_deployment_modes #=> Array
resp.broker_instance_options[0].supported_deployment_modes[0] #=> String, one of "SINGLE_INSTANCE", "ACTIVE_STANDBY_MULTI_AZ", "CLUSTER_MULTI_AZ"
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

@see docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DescribeBrokerInstanceOptions AWS API Documentation

@overload describe_broker_instance_options(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-mq/client.rb, line 916
def describe_broker_instance_options(params = {}, options = {})
  req = build_request(:describe_broker_instance_options, params)
  req.send_request(options)
end
describe_configuration(params = {}, options = {}) click to toggle source

Returns information about the specified configuration.

@option params [required, String] :configuration_id

@return [Types::DescribeConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::DescribeConfigurationResponse#arn #arn} => String
* {Types::DescribeConfigurationResponse#authentication_strategy #authentication_strategy} => String
* {Types::DescribeConfigurationResponse#created #created} => Time
* {Types::DescribeConfigurationResponse#description #description} => String
* {Types::DescribeConfigurationResponse#engine_type #engine_type} => String
* {Types::DescribeConfigurationResponse#engine_version #engine_version} => String
* {Types::DescribeConfigurationResponse#id #id} => String
* {Types::DescribeConfigurationResponse#latest_revision #latest_revision} => Types::ConfigurationRevision
* {Types::DescribeConfigurationResponse#name #name} => String
* {Types::DescribeConfigurationResponse#tags #tags} => Hash&lt;String,String&gt;

@example Request syntax with placeholder values

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

@example Response structure

resp.arn #=> String
resp.authentication_strategy #=> String, one of "SIMPLE", "LDAP"
resp.created #=> Time
resp.description #=> String
resp.engine_type #=> String, one of "ACTIVEMQ", "RABBITMQ"
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

@see docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DescribeConfiguration AWS API Documentation

@overload describe_configuration(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-mq/client.rb, line 964
def describe_configuration(params = {}, options = {})
  req = build_request(:describe_configuration, params)
  req.send_request(options)
end
describe_configuration_revision(params = {}, options = {}) click to toggle source

Returns the specified configuration revision for the specified configuration.

@option params [required, String] :configuration_id

@option params [required, String] :configuration_revision

@return [Types::DescribeConfigurationRevisionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::DescribeConfigurationRevisionResponse#configuration_id #configuration_id} => String
* {Types::DescribeConfigurationRevisionResponse#created #created} => Time
* {Types::DescribeConfigurationRevisionResponse#data #data} => String
* {Types::DescribeConfigurationRevisionResponse#description #description} => String

@example Request syntax with placeholder values

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

@example Response structure

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

@see docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DescribeConfigurationRevision AWS API Documentation

@overload describe_configuration_revision(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-mq/client.rb, line 1001
def describe_configuration_revision(params = {}, options = {})
  req = build_request(:describe_configuration_revision, params)
  req.send_request(options)
end
describe_user(params = {}, options = {}) click to toggle source

Returns information about an ActiveMQ user.

@option params [required, String] :broker_id

@option params [required, String] :username

@return [Types::DescribeUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::DescribeUserResponse#broker_id #broker_id} => String
* {Types::DescribeUserResponse#console_access #console_access} => Boolean
* {Types::DescribeUserResponse#groups #groups} => Array&lt;String&gt;
* {Types::DescribeUserResponse#pending #pending} => Types::UserPendingChanges
* {Types::DescribeUserResponse#username #username} => String

@example Request syntax with placeholder values

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

@example 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

@see docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DescribeUser AWS API Documentation

@overload describe_user(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-mq/client.rb, line 1043
def describe_user(params = {}, options = {})
  req = build_request(:describe_user, params)
  req.send_request(options)
end
list_brokers(params = {}, options = {}) click to toggle source

Returns a list of all brokers.

@option params [Integer] :max_results

@option params [String] :next_token

@return [Types::ListBrokersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::ListBrokersResponse#broker_summaries #broker_summaries} => Array&lt;Types::BrokerSummary&gt;
* {Types::ListBrokersResponse#next_token #next_token} => String

The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.

@example Request syntax with placeholder values

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

@example 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", "CLUSTER_MULTI_AZ"
resp.broker_summaries[0].engine_type #=> String, one of "ACTIVEMQ", "RABBITMQ"
resp.broker_summaries[0].host_instance_type #=> String
resp.next_token #=> String

@see docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/ListBrokers AWS API Documentation

@overload list_brokers(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-mq/client.rb, line 1085
def list_brokers(params = {}, options = {})
  req = build_request(:list_brokers, params)
  req.send_request(options)
end
list_configuration_revisions(params = {}, options = {}) click to toggle source

Returns a list of all revisions for the specified configuration.

@option params [required, String] :configuration_id

@option params [Integer] :max_results

@option params [String] :next_token

@return [Types::ListConfigurationRevisionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::ListConfigurationRevisionsResponse#configuration_id #configuration_id} => String
* {Types::ListConfigurationRevisionsResponse#max_results #max_results} => Integer
* {Types::ListConfigurationRevisionsResponse#next_token #next_token} => String
* {Types::ListConfigurationRevisionsResponse#revisions #revisions} => Array&lt;Types::ConfigurationRevision&gt;

@example Request syntax with placeholder values

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

@example 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

@see docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/ListConfigurationRevisions AWS API Documentation

@overload list_configuration_revisions(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-mq/client.rb, line 1127
def list_configuration_revisions(params = {}, options = {})
  req = build_request(:list_configuration_revisions, params)
  req.send_request(options)
end
list_configurations(params = {}, options = {}) click to toggle source

Returns a list of all configurations.

@option params [Integer] :max_results

@option params [String] :next_token

@return [Types::ListConfigurationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::ListConfigurationsResponse#configurations #configurations} => Array&lt;Types::Configuration&gt;
* {Types::ListConfigurationsResponse#max_results #max_results} => Integer
* {Types::ListConfigurationsResponse#next_token #next_token} => String

@example Request syntax with placeholder values

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

@example Response structure

resp.configurations #=> Array
resp.configurations[0].arn #=> String
resp.configurations[0].authentication_strategy #=> String, one of "SIMPLE", "LDAP"
resp.configurations[0].created #=> Time
resp.configurations[0].description #=> String
resp.configurations[0].engine_type #=> String, one of "ACTIVEMQ", "RABBITMQ"
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

@see docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/ListConfigurations AWS API Documentation

@overload list_configurations(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-mq/client.rb, line 1174
def list_configurations(params = {}, options = {})
  req = build_request(:list_configurations, params)
  req.send_request(options)
end
list_tags(params = {}, options = {}) click to toggle source

Lists tags for a resource.

@option params [required, String] :resource_arn

@return [Types::ListTagsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::ListTagsResponse#tags #tags} => Hash&lt;String,String&gt;

@example Request syntax with placeholder values

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

@example Response structure

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

@see docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/ListTags AWS API Documentation

@overload list_tags(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-mq/client.rb, line 1202
def list_tags(params = {}, options = {})
  req = build_request(:list_tags, params)
  req.send_request(options)
end
list_users(params = {}, options = {}) click to toggle source

Returns a list of all ActiveMQ users.

@option params [required, String] :broker_id

@option params [Integer] :max_results

@option params [String] :next_token

@return [Types::ListUsersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::ListUsersResponse#broker_id #broker_id} => String
* {Types::ListUsersResponse#max_results #max_results} => Integer
* {Types::ListUsersResponse#next_token #next_token} => String
* {Types::ListUsersResponse#users #users} => Array&lt;Types::UserSummary&gt;

@example Request syntax with placeholder values

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

@example 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

@see docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/ListUsers AWS API Documentation

@overload list_users(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-mq/client.rb, line 1243
def list_users(params = {}, options = {})
  req = build_request(:list_users, params)
  req.send_request(options)
end
reboot_broker(params = {}, options = {}) click to toggle source

Reboots a broker. Note: This API is asynchronous.

@option params [required, String] :broker_id

@return [Struct] Returns an empty {Seahorse::Client::Response response}.

@example Request syntax with placeholder values

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

@see docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/RebootBroker AWS API Documentation

@overload reboot_broker(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-mq/client.rb, line 1264
def reboot_broker(params = {}, options = {})
  req = build_request(:reboot_broker, params)
  req.send_request(options)
end
update_broker(params = {}, options = {}) click to toggle source

Adds a pending configuration change to a broker.

@option params [String] :authentication_strategy

Optional. The authentication strategy used to secure the broker. The
default is SIMPLE.

@option params [Boolean] :auto_minor_version_upgrade

@option params [required, String] :broker_id

@option params [Types::ConfigurationId] :configuration

A list of information about the configuration.

Does not apply to RabbitMQ brokers.

@option params [String] :engine_version

@option params [String] :host_instance_type

@option params [Types::LdapServerMetadataInput] :ldap_server_metadata

Optional. The metadata of the LDAP server used to authenticate and
authorize connections to the broker.

Does not apply to RabbitMQ brokers.

@option params [Types::Logs] :logs

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

@option params [Types::WeeklyStartTime] :maintenance_window_start_time

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

@option params [Array<String>] :security_groups

@return [Types::UpdateBrokerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::UpdateBrokerResponse#authentication_strategy #authentication_strategy} => String
* {Types::UpdateBrokerResponse#auto_minor_version_upgrade #auto_minor_version_upgrade} => Boolean
* {Types::UpdateBrokerResponse#broker_id #broker_id} => String
* {Types::UpdateBrokerResponse#configuration #configuration} => Types::ConfigurationId
* {Types::UpdateBrokerResponse#engine_version #engine_version} => String
* {Types::UpdateBrokerResponse#host_instance_type #host_instance_type} => String
* {Types::UpdateBrokerResponse#ldap_server_metadata #ldap_server_metadata} => Types::LdapServerMetadataOutput
* {Types::UpdateBrokerResponse#logs #logs} => Types::Logs
* {Types::UpdateBrokerResponse#maintenance_window_start_time #maintenance_window_start_time} => Types::WeeklyStartTime
* {Types::UpdateBrokerResponse#security_groups #security_groups} => Array&lt;String&gt;

@example Request syntax with placeholder values

resp = client.update_broker({
  authentication_strategy: "SIMPLE", # accepts SIMPLE, LDAP
  auto_minor_version_upgrade: false,
  broker_id: "__string", # required
  configuration: {
    id: "__string", # required
    revision: 1,
  },
  engine_version: "__string",
  host_instance_type: "__string",
  ldap_server_metadata: {
    hosts: ["__string"], # required
    role_base: "__string", # required
    role_name: "__string",
    role_search_matching: "__string", # required
    role_search_subtree: false,
    service_account_password: "__string", # required
    service_account_username: "__string", # required
    user_base: "__string", # required
    user_role_name: "__string",
    user_search_matching: "__string", # required
    user_search_subtree: false,
  },
  logs: {
    audit: false,
    general: false,
  },
  maintenance_window_start_time: {
    day_of_week: "MONDAY", # required, accepts MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
    time_of_day: "__string", # required
    time_zone: "__string",
  },
  security_groups: ["__string"],
})

@example Response structure

resp.authentication_strategy #=> String, one of "SIMPLE", "LDAP"
resp.auto_minor_version_upgrade #=> Boolean
resp.broker_id #=> String
resp.configuration.id #=> String
resp.configuration.revision #=> Integer
resp.engine_version #=> String
resp.host_instance_type #=> String
resp.ldap_server_metadata.hosts #=> Array
resp.ldap_server_metadata.hosts[0] #=> String
resp.ldap_server_metadata.role_base #=> String
resp.ldap_server_metadata.role_name #=> String
resp.ldap_server_metadata.role_search_matching #=> String
resp.ldap_server_metadata.role_search_subtree #=> Boolean
resp.ldap_server_metadata.service_account_username #=> String
resp.ldap_server_metadata.user_base #=> String
resp.ldap_server_metadata.user_role_name #=> String
resp.ldap_server_metadata.user_search_matching #=> String
resp.ldap_server_metadata.user_search_subtree #=> Boolean
resp.logs.audit #=> Boolean
resp.logs.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.security_groups #=> Array
resp.security_groups[0] #=> String

@see docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/UpdateBroker AWS API Documentation

@overload update_broker(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-mq/client.rb, line 1386
def update_broker(params = {}, options = {})
  req = build_request(:update_broker, params)
  req.send_request(options)
end
update_configuration(params = {}, options = {}) click to toggle source

Updates the specified configuration.

@option params [required, String] :configuration_id

@option params [required, String] :data

@option params [String] :description

@return [Types::UpdateConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::UpdateConfigurationResponse#arn #arn} => String
* {Types::UpdateConfigurationResponse#created #created} => Time
* {Types::UpdateConfigurationResponse#id #id} => String
* {Types::UpdateConfigurationResponse#latest_revision #latest_revision} => Types::ConfigurationRevision
* {Types::UpdateConfigurationResponse#name #name} => String
* {Types::UpdateConfigurationResponse#warnings #warnings} => Array&lt;Types::SanitizationWarning&gt;

@example Request syntax with placeholder values

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

@example 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"

@see docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/UpdateConfiguration AWS API Documentation

@overload update_configuration(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-mq/client.rb, line 1434
def update_configuration(params = {}, options = {})
  req = build_request(:update_configuration, params)
  req.send_request(options)
end
update_user(params = {}, options = {}) click to toggle source

Updates the information for an ActiveMQ user.

@option params [required, String] :broker_id

@option params [Boolean] :console_access

@option params [Array<String>] :groups

@option params [String] :password

@option params [required, String] :username

@return [Struct] Returns an empty {Seahorse::Client::Response response}.

@example Request syntax with placeholder values

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

@see docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/UpdateUser AWS API Documentation

@overload update_user(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-mq/client.rb, line 1467
def update_user(params = {}, options = {})
  req = build_request(:update_user, params)
  req.send_request(options)
end
waiter_names() click to toggle source

@api private @deprecated

# File lib/aws-sdk-mq/client.rb, line 1491
def waiter_names
  []
end