aws_sdk_ssoadmin/client/describe_region.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 [`DescribeRegion`](crate::operation::describe_region::builders::DescribeRegionFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`instance_arn(impl Into<String>)`](crate::operation::describe_region::builders::DescribeRegionFluentBuilder::instance_arn) / [`set_instance_arn(Option<String>)`](crate::operation::describe_region::builders::DescribeRegionFluentBuilder::set_instance_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the IAM Identity Center instance.</p><br>
7 /// - [`region_name(impl Into<String>)`](crate::operation::describe_region::builders::DescribeRegionFluentBuilder::region_name) / [`set_region_name(Option<String>)`](crate::operation::describe_region::builders::DescribeRegionFluentBuilder::set_region_name):<br>required: **true**<br><p>The name of the Amazon Web Services Region to retrieve information about. The Region name must be 1-32 characters long and follow the pattern of Amazon Web Services Region names (for example, us-east-1).</p><br>
8 /// - On success, responds with [`DescribeRegionOutput`](crate::operation::describe_region::DescribeRegionOutput) with field(s):
9 /// - [`region_name(Option<String>)`](crate::operation::describe_region::DescribeRegionOutput::region_name): <p>The Amazon Web Services Region name.</p>
10 /// - [`status(Option<RegionStatus>)`](crate::operation::describe_region::DescribeRegionOutput::status): <p>The current status of the Region. Valid values are ACTIVE (Region is operational), ADDING (Region replication workflow is in progress), or REMOVING (Region removal workflow is in progress).</p>
11 /// - [`added_date(Option<DateTime>)`](crate::operation::describe_region::DescribeRegionOutput::added_date): <p>The timestamp when the Region was added to the IAM Identity Center instance. For the primary Region, this is the IAM Identity Center instance creation time.</p>
12 /// - [`is_primary_region(bool)`](crate::operation::describe_region::DescribeRegionOutput::is_primary_region): <p>Indicates whether this is the primary Region where the IAM Identity Center instance was originally enabled. For more information on the difference between the primary Region and additional Regions, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/multi-region-iam-identity-center.html">IAM Identity Center User Guide</a></p>
13 /// - On failure, responds with [`SdkError<DescribeRegionError>`](crate::operation::describe_region::DescribeRegionError)
14 pub fn describe_region(&self) -> crate::operation::describe_region::builders::DescribeRegionFluentBuilder {
15 crate::operation::describe_region::builders::DescribeRegionFluentBuilder::new(self.handle.clone())
16 }
17}