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

Class: Aws::MQ::Client

Inherits:
Seahorse::Client::Base show all
Defined in:
(unknown)

Overview

An API client for AmazonMQ. To construct a client, you need to configure a :region and :credentials.

mq = Aws::MQ::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

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

Region

You can configure a default region in the following locations:

  • ENV['AWS_REGION']
  • Aws.config[:region]

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

  • ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']
  • Aws.config[:credentials]
  • The shared credentials ini file at ~/.aws/credentials (more information)
  • From an instance profile when running on EC2

You can also construct a credentials object from one of the following classes:

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

# load credentials from disk
creds = YAML.load(File.read('/path/to/secrets'))

Aws::MQ::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

Attribute Summary collapse

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

API Operations collapse

Instance Method Summary collapse

Methods inherited from Seahorse::Client::Base

add_plugin, api, #build_request, clear_plugins, define, new, #operation, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options = {}) ⇒ Aws::MQ::Client

Constructs an API client.

Options Hash (options):

  • :access_key_id (String) —

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :active_endpoint_cache (Boolean) —

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

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types. See Plugins::ParamConverter for more details.

  • :credentials (required, Credentials) —

    Your AWS credentials. The following locations will be searched in order for credentials:

    • :access_key_id, :secret_access_key, and :session_token options
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • HOME/.aws/credentials shared credentials file
    • EC2 instance profile credentials See Plugins::RequestSigner for more details.
  • :disable_host_prefix_injection (Boolean) —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available. See Plugins::EndpointPattern for more details.

  • :endpoint (String) —

    A default endpoint is constructed from the :region. See Plugins::RegionalEndpoint for more details.

  • :endpoint_cache_max_entries (Integer) —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_max_threads (Integer) —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_poll_interval (Integer) —

    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. See Plugins::EndpointDiscovery for more details.

  • :endpoint_discovery (Boolean) —

    When set to true, endpoint discovery will be enabled for operations when available. Defaults to false. See Plugins::EndpointDiscovery for more details.

  • :http_continue_timeout (Float) — default: 1 —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_idle_timeout (Integer) — default: 5 —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_open_timeout (Integer) — default: 15 —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_proxy (String) —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_read_timeout (Integer) — default: 60 —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_wire_trace (Boolean) — default: false —

    See Seahorse::Client::Plugins::NetHttp for more details.

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

    The log level to send messages to the logger at. See Plugins::Logging for more details.

  • :log_formatter (Logging::LogFormatter) —

    The log formatter. Defaults to Seahorse::Client::Logging::Formatter.default. See Plugins::Logging for more details.

  • :logger (Logger) — default: nil —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled. See Plugins::Logging for more details.

  • :profile (String) —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. See Plugins::RequestSigner for more details.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised. See Seahorse::Client::Plugins::RaiseResponseErrors for more details.

  • :region (required, String) —

    The AWS region to connect to. The region is used to construct the client endpoint. Defaults to ENV['AWS_REGION']. Also checks AMAZON_REGION and AWS_DEFAULT_REGION. See Plugins::RegionalEndpoint for more details.

  • :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. See Plugins::RetryErrors for more details.

  • :secret_access_key (String) —

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :session_token (String) —

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :ssl_ca_bundle (String) —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_directory (String) —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_store (String) —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_verify_peer (Boolean) — default: true —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :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. See Plugins::StubResponses for more details.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request. See Plugins::ParamValidator for more details.

Instance Method Details

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

Creates a broker. Note: This API is asynchronous.

Examples:

Request syntax with placeholder values


resp = client.create_broker({
  authentication_strategy: "SIMPLE", # accepts SIMPLE, LDAP
  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, CLUSTER_MULTI_AZ
  encryption_options: {
    kms_key_id: "__string",
    use_aws_owned_key: false, # required
  },
  engine_type: "ACTIVEMQ", # accepts ACTIVEMQ, RABBITMQ
  engine_version: "__string",
  host_instance_type: "__string",
  ldap_server_metadata: {
    hosts: ["__string"],
    role_base: "__string",
    role_name: "__string",
    role_search_matching: "__string",
    role_search_subtree: false,
    service_account_password: "__string",
    service_account_username: "__string",
    user_base: "__string",
    user_role_name: "__string",
    user_search_matching: "__string",
    user_search_subtree: false,
  },
  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"],
  storage_type: "EBS", # accepts EBS, EFS
  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

Options Hash (options):

  • :authentication_strategy (String) —

    The authentication strategy used to secure the broker.

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

    A list of information about the configuration. Does not apply to RabbitMQ brokers.

  • :creator_request_id (String) —

    This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided.

  • :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 ActiveMQ and RabbitMQ.

  • :engine_version (String)
  • :host_instance_type (String)
  • :ldap_server_metadata (Types::LdapServerMetadataInput) —

    The metadata of the LDAP server used to authenticate and authorize connections to the broker. Currently not supported for RabbitMQ engine type.

  • :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>)
  • :storage_type (String) —

    The storage type of the broker. EFS is currently not Supported for RabbitMQ engine type.

  • :subnet_ids (Array<String>)
  • :tags (Hash<String,String>)
  • :users (Array<Types::User>)

Returns:

See Also:

#create_configuration(options = {}) ⇒ 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({
  authentication_strategy: "SIMPLE", # accepts SIMPLE, LDAP
  engine_type: "ACTIVEMQ", # accepts ACTIVEMQ, RABBITMQ
  engine_version: "__string",
  name: "__string",
  tags: {
    "__string" => "__string",
  },
})

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

Options Hash (options):

  • :authentication_strategy (String) —

    The authentication strategy used to secure the broker.

  • :engine_type (String) —

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

  • :engine_version (String)
  • :name (String)
  • :tags (Hash<String,String>)

Returns:

See Also:

#create_tags(options = {}) ⇒ Struct

Add a tag to a resource.

Examples:

Request syntax with placeholder values


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

Options Hash (options):

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#create_user(options = {}) ⇒ 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
})

Options Hash (options):

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#delete_broker(options = {}) ⇒ 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

Options Hash (options):

  • :broker_id (required, String)

Returns:

See Also:

#delete_tags(options = {}) ⇒ 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
})

Options Hash (options):

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#delete_user(options = {}) ⇒ Struct

Deletes an ActiveMQ user.

Examples:

Request syntax with placeholder values


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

Options Hash (options):

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#describe_broker(options = {}) ⇒ 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.authentication_strategy #=> String, one of "SIMPLE", "LDAP"
resp.auto_minor_version_upgrade #=> true/false
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 #=> true/false
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 #=> true/false
resp.ldap_server_metadata. #=> 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 #=> true/false
resp.logs.audit #=> true/false
resp.logs.audit_log_group #=> String
resp.logs.general #=> true/false
resp.logs.general_log_group #=> String
resp.logs.pending.audit #=> true/false
resp.logs.pending.general #=> true/false
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 #=> true/false
resp.pending_ldap_server_metadata. #=> 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 #=> true/false
resp.pending_security_groups #=> Array
resp.pending_security_groups[0] #=> String
resp.publicly_accessible #=> true/false
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

Options Hash (options):

  • :broker_id (required, String)

Returns:

See Also:

#describe_broker_engine_types(options = {}) ⇒ 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", "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

Options Hash (options):

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

Returns:

See Also:

#describe_broker_instance_options(options = {}) ⇒ 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",
  storage_type: "__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", "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

Options Hash (options):

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

Returns:

See Also:

#describe_configuration(options = {}) ⇒ 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.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

Options Hash (options):

  • :configuration_id (required, String)

Returns:

See Also:

#describe_configuration_revision(options = {}) ⇒ 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

Options Hash (options):

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

Returns:

See Also:

#describe_user(options = {}) ⇒ 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 #=> true/false
resp.groups #=> Array
resp.groups[0] #=> String
resp.pending.console_access #=> true/false
resp.pending.groups #=> Array
resp.pending.groups[0] #=> String
resp.pending.pending_change #=> String, one of "CREATE", "UPDATE", "DELETE"
resp.username #=> String

Options Hash (options):

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

Returns:

See Also:

#list_brokers(options = {}) ⇒ 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", "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

Options Hash (options):

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

Returns:

See Also:

#list_configuration_revisions(options = {}) ⇒ 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

Options Hash (options):

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

Returns:

See Also:

#list_configurations(options = {}) ⇒ 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].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

Options Hash (options):

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

Returns:

See Also:

#list_tags(options = {}) ⇒ 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

Options Hash (options):

  • :resource_arn (required, String)

Returns:

See Also:

#list_users(options = {}) ⇒ 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

Options Hash (options):

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

Returns:

See Also:

#reboot_broker(options = {}) ⇒ Struct

Reboots a broker. Note: This API is asynchronous.

Examples:

Request syntax with placeholder values


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

Options Hash (options):

  • :broker_id (required, String)

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

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

Adds a pending configuration change to a broker.

Examples:

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",
    revision: 1,
  },
  engine_version: "__string",
  host_instance_type: "__string",
  ldap_server_metadata: {
    hosts: ["__string"],
    role_base: "__string",
    role_name: "__string",
    role_search_matching: "__string",
    role_search_subtree: false,
    service_account_password: "__string",
    service_account_username: "__string",
    user_base: "__string",
    user_role_name: "__string",
    user_search_matching: "__string",
    user_search_subtree: false,
  },
  logs: {
    audit: false,
    general: false,
  },
  security_groups: ["__string"],
})

Response structure


resp.authentication_strategy #=> String, one of "SIMPLE", "LDAP"
resp.auto_minor_version_upgrade #=> true/false
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 #=> true/false
resp.ldap_server_metadata. #=> 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 #=> true/false
resp.logs.audit #=> true/false
resp.logs.general #=> true/false
resp.security_groups #=> Array
resp.security_groups[0] #=> String

Options Hash (options):

  • :authentication_strategy (String) —

    The authentication strategy used to secure the broker.

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

    A list of information about the configuration. Does not apply to RabbitMQ brokers.

  • :engine_version (String)
  • :host_instance_type (String)
  • :ldap_server_metadata (Types::LdapServerMetadataInput) —

    The metadata of the LDAP server used to authenticate and authorize connections to the broker. Currently not supported for RabbitMQ engine type.

  • :logs (Types::Logs) —

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

  • :security_groups (Array<String>)

Returns:

See Also:

#update_configuration(options = {}) ⇒ 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"

Options Hash (options):

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

Returns:

See Also:

#update_user(options = {}) ⇒ 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
})

Options Hash (options):

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean

Waiters polls an API operation until a resource enters a desired state.

Basic Usage

Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(...) do |w|

  # disable max attempts
  w.max_attempts = nil

  # poll for 1 hour, instead of a number of attempts
  w.before_wait do |attempts, response|
    throw :failure if Time.now - started_at > 3600
  end

end

Handling Errors

When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Parameters:

  • waiter_name (Symbol) —

    The name of the waiter. See #waiter_names for a full list of supported waiters.

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

    Additional request parameters. See the #waiter_names for a list of supported waiters and what request they call. The called request determines the list of accepted parameters.

Yield Parameters:

Returns:

  • (Boolean) —

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError) —

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError) —

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError) —

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError) —

    Raised when you request to wait for an unknown state.

#waiter_names ⇒ Array<Symbol>

Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:

Waiter NameClient MethodDefault Delay:Default Max Attempts:

Returns:

  • (Array<Symbol>) —

    the list of supported waiters.