aws_sdk_migrationhubconfig/client/describe_home_region_controls.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 [`DescribeHomeRegionControls`](crate::operation::describe_home_region_controls::builders::DescribeHomeRegionControlsFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_home_region_controls::builders::DescribeHomeRegionControlsFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`control_id(impl Into<String>)`](crate::operation::describe_home_region_controls::builders::DescribeHomeRegionControlsFluentBuilder::control_id) / [`set_control_id(Option<String>)`](crate::operation::describe_home_region_controls::builders::DescribeHomeRegionControlsFluentBuilder::set_control_id):<br>required: **false**<br><p>The <code>ControlID</code> is a unique identifier string of your <code>HomeRegionControl</code> object.</p><br>
8 /// - [`home_region(impl Into<String>)`](crate::operation::describe_home_region_controls::builders::DescribeHomeRegionControlsFluentBuilder::home_region) / [`set_home_region(Option<String>)`](crate::operation::describe_home_region_controls::builders::DescribeHomeRegionControlsFluentBuilder::set_home_region):<br>required: **false**<br><p>The name of the home region you'd like to view.</p><br>
9 /// - [`target(Target)`](crate::operation::describe_home_region_controls::builders::DescribeHomeRegionControlsFluentBuilder::target) / [`set_target(Option<Target>)`](crate::operation::describe_home_region_controls::builders::DescribeHomeRegionControlsFluentBuilder::set_target):<br>required: **false**<br><p>The target parameter specifies the identifier to which the home region is applied, which is always of type <code>ACCOUNT</code>. It applies the home region to the current <code>ACCOUNT</code>.</p><br>
10 /// - [`max_results(i32)`](crate::operation::describe_home_region_controls::builders::DescribeHomeRegionControlsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_home_region_controls::builders::DescribeHomeRegionControlsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of filtering results to display per page.</p><br>
11 /// - [`next_token(impl Into<String>)`](crate::operation::describe_home_region_controls::builders::DescribeHomeRegionControlsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_home_region_controls::builders::DescribeHomeRegionControlsFluentBuilder::set_next_token):<br>required: **false**<br><p>If a <code>NextToken</code> was returned by a previous call, more results are available. To retrieve the next page of results, make the call again using the returned token in <code>NextToken</code>.</p><br>
12 /// - On success, responds with [`DescribeHomeRegionControlsOutput`](crate::operation::describe_home_region_controls::DescribeHomeRegionControlsOutput) with field(s):
13 /// - [`home_region_controls(Option<Vec::<HomeRegionControl>>)`](crate::operation::describe_home_region_controls::DescribeHomeRegionControlsOutput::home_region_controls): <p>An array that contains your <code>HomeRegionControl</code> objects.</p>
14 /// - [`next_token(Option<String>)`](crate::operation::describe_home_region_controls::DescribeHomeRegionControlsOutput::next_token): <p>If a <code>NextToken</code> was returned by a previous call, more results are available. To retrieve the next page of results, make the call again using the returned token in <code>NextToken</code>.</p>
15 /// - On failure, responds with [`SdkError<DescribeHomeRegionControlsError>`](crate::operation::describe_home_region_controls::DescribeHomeRegionControlsError)
16 pub fn describe_home_region_controls(
17 &self,
18 ) -> crate::operation::describe_home_region_controls::builders::DescribeHomeRegionControlsFluentBuilder {
19 crate::operation::describe_home_region_controls::builders::DescribeHomeRegionControlsFluentBuilder::new(self.handle.clone())
20 }
21}