aws_sdk_ssoadmin/client/list_regions.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 [`ListRegions`](crate::operation::list_regions::builders::ListRegionsFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_regions::builders::ListRegionsFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`instance_arn(impl Into<String>)`](crate::operation::list_regions::builders::ListRegionsFluentBuilder::instance_arn) / [`set_instance_arn(Option<String>)`](crate::operation::list_regions::builders::ListRegionsFluentBuilder::set_instance_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the IAM Identity Center instance.</p><br>
8 /// - [`max_results(i32)`](crate::operation::list_regions::builders::ListRegionsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_regions::builders::ListRegionsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return in a single call. Default is 100.</p><br>
9 /// - [`next_token(impl Into<String>)`](crate::operation::list_regions::builders::ListRegionsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_regions::builders::ListRegionsFluentBuilder::set_next_token):<br>required: **false**<br><p>The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.</p><br>
10 /// - On success, responds with [`ListRegionsOutput`](crate::operation::list_regions::ListRegionsOutput) with field(s):
11 /// - [`regions(Option<Vec::<RegionMetadata>>)`](crate::operation::list_regions::ListRegionsOutput::regions): <p>The list of Regions enabled in the IAM Identity Center instance, including Regions with ACTIVE, ADDING, or REMOVING status.</p>
12 /// - [`next_token(Option<String>)`](crate::operation::list_regions::ListRegionsOutput::next_token): <p>The pagination token to be used in subsequent calls. If the value is null, then there are no more entries.</p>
13 /// - On failure, responds with [`SdkError<ListRegionsError>`](crate::operation::list_regions::ListRegionsError)
14 pub fn list_regions(&self) -> crate::operation::list_regions::builders::ListRegionsFluentBuilder {
15 crate::operation::list_regions::builders::ListRegionsFluentBuilder::new(self.handle.clone())
16 }
17}