aws_sdk_mq/client/describe_broker_instance_options.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`DescribeBrokerInstanceOptions`](crate::operation::describe_broker_instance_options::builders::DescribeBrokerInstanceOptionsFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`engine_type(impl Into<String>)`](crate::operation::describe_broker_instance_options::builders::DescribeBrokerInstanceOptionsFluentBuilder::engine_type) / [`set_engine_type(Option<String>)`](crate::operation::describe_broker_instance_options::builders::DescribeBrokerInstanceOptionsFluentBuilder::set_engine_type):<br>required: **false**<br><p>Filter response by engine type.</p><br>
7 /// - [`host_instance_type(impl Into<String>)`](crate::operation::describe_broker_instance_options::builders::DescribeBrokerInstanceOptionsFluentBuilder::host_instance_type) / [`set_host_instance_type(Option<String>)`](crate::operation::describe_broker_instance_options::builders::DescribeBrokerInstanceOptionsFluentBuilder::set_host_instance_type):<br>required: **false**<br><p>Filter response by host instance type.</p><br>
8 /// - [`max_results(i32)`](crate::operation::describe_broker_instance_options::builders::DescribeBrokerInstanceOptionsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_broker_instance_options::builders::DescribeBrokerInstanceOptionsFluentBuilder::set_max_results):<br>required: **false**<br><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><br>
9 /// - [`next_token(impl Into<String>)`](crate::operation::describe_broker_instance_options::builders::DescribeBrokerInstanceOptionsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_broker_instance_options::builders::DescribeBrokerInstanceOptionsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.</p><br>
10 /// - [`storage_type(impl Into<String>)`](crate::operation::describe_broker_instance_options::builders::DescribeBrokerInstanceOptionsFluentBuilder::storage_type) / [`set_storage_type(Option<String>)`](crate::operation::describe_broker_instance_options::builders::DescribeBrokerInstanceOptionsFluentBuilder::set_storage_type):<br>required: **false**<br><p>Filter response by storage type.</p><br>
11 /// - On success, responds with [`DescribeBrokerInstanceOptionsOutput`](crate::operation::describe_broker_instance_options::DescribeBrokerInstanceOptionsOutput) with field(s):
12 /// - [`broker_instance_options(Option<Vec::<BrokerInstanceOption>>)`](crate::operation::describe_broker_instance_options::DescribeBrokerInstanceOptionsOutput::broker_instance_options): <p>List of available broker instance options.</p>
13 /// - [`max_results(Option<i32>)`](crate::operation::describe_broker_instance_options::DescribeBrokerInstanceOptionsOutput::max_results): <p>Required. The maximum number of instance options that can be returned per page (20 by default). This value must be an integer from 5 to 100.</p>
14 /// - [`next_token(Option<String>)`](crate::operation::describe_broker_instance_options::DescribeBrokerInstanceOptionsOutput::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>
15 /// - On failure, responds with [`SdkError<DescribeBrokerInstanceOptionsError>`](crate::operation::describe_broker_instance_options::DescribeBrokerInstanceOptionsError)
16 pub fn describe_broker_instance_options(
17 &self,
18 ) -> crate::operation::describe_broker_instance_options::builders::DescribeBrokerInstanceOptionsFluentBuilder {
19 crate::operation::describe_broker_instance_options::builders::DescribeBrokerInstanceOptionsFluentBuilder::new(self.handle.clone())
20 }
21}