List Brokers

mq_list_brokers

R Documentation

Returns a list of all brokers¶

Description¶

Returns a list of all brokers.

Usage¶

mq_list_brokers(MaxResults, NextToken)

Arguments¶

MaxResults: The maximum number of brokers that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.
NextToken: The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

Value¶

A list with the following syntax:

list(
  BrokerSummaries = list(
    list(
      BrokerArn = "string",
      BrokerId = "string",
      BrokerName = "string",
      BrokerState = "CREATION_IN_PROGRESS"|"CREATION_FAILED"|"DELETION_IN_PROGRESS"|"RUNNING"|"REBOOT_IN_PROGRESS"|"CRITICAL_ACTION_REQUIRED"|"REPLICA",
      Created = as.POSIXct(
        "2015-01-01"
      ),
      DeploymentMode = "SINGLE_INSTANCE"|"ACTIVE_STANDBY_MULTI_AZ"|"CLUSTER_MULTI_AZ",
      EngineType = "ACTIVEMQ"|"RABBITMQ",
      HostInstanceType = "string"
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$list_brokers(
  MaxResults = 123,
  NextToken = "string"
)