Describe available broker instance options.
Parameters:
-
engine_type
(Optional[__string], default:
None
)
–
Filter response by engine type.
-
host_instance_type
(Optional[__string], default:
None
)
–
Filter response by host instance type.
-
max_results
(Optional[MaxResults], default:
None
)
–
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.
-
next_token
(Optional[__string], default:
None
)
–
The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
-
storage_type
(Optional[__string], default:
None
)
–
Filter response by storage type.
Raises:
Source code in docs_src/capo_mq/_services/mq.py
| def describe_broker_instance_options(
self,
*,
config_overrides: Optional[mqClientConfig] = None,
engine_type: Optional["capo_mq.types.__string.__string"] = None,
host_instance_type: Optional["capo_mq.types.__string.__string"] = None,
max_results: Optional["capo_mq.types.max_results.MaxResults"] = None,
next_token: Optional["capo_mq.types.__string.__string"] = None,
storage_type: Optional["capo_mq.types.__string.__string"] = None,
) -> "capo_mq.types.describe_broker_instance_options_response.DescribeBrokerInstanceOptionsResponse":
"""<p>Describe available broker instance options.</p>
Args:
engine_type: <p>Filter response by engine type.</p>
host_instance_type: <p>Filter response by host instance type.</p>
max_results: <p>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.</p>
next_token: <p>The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.</p>
storage_type: <p>Filter response by storage type.</p>
Raises:
capo_mq.errors.bad_request_exception.BadRequestException: <p>Returns information about an error.</p>
capo_mq.errors.forbidden_exception.ForbiddenException: <p>Returns information about an error.</p>
capo_mq.errors.internal_server_error_exception.InternalServerErrorException: <p>Returns information about an error.</p>
capo_mq.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_mq.types.describe_broker_instance_options_request.DescribeBrokerInstanceOptionsRequest]",
) -> OperationResponse[
"capo_mq.types.describe_broker_instance_options_response.DescribeBrokerInstanceOptionsResponse"
]:
import capo_mq._operations.mq.describe_broker_instance_options
output, http_response = (
capo_mq._operations.mq.describe_broker_instance_options.describe_broker_instance_options(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeBrokerInstanceOptions")
)
input_: capo_mq.types.describe_broker_instance_options_request.DescribeBrokerInstanceOptionsRequest = {}
if engine_type is not None:
input_["engine_type"] = engine_type
if host_instance_type is not None:
input_["host_instance_type"] = host_instance_type
if max_results is not None:
input_["max_results"] = max_results
if next_token is not None:
input_["next_token"] = next_token
if storage_type is not None:
input_["storage_type"] = storage_type
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|