aws_sdk_ssoadmin/client/
describe_instance.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 [`DescribeInstance`](crate::operation::describe_instance::builders::DescribeInstanceFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`instance_arn(impl Into<String>)`](crate::operation::describe_instance::builders::DescribeInstanceFluentBuilder::instance_arn) / [`set_instance_arn(Option<String>)`](crate::operation::describe_instance::builders::DescribeInstanceFluentBuilder::set_instance_arn):<br>required: **true**<br><p>The ARN of the instance of IAM Identity Center under which the operation will run.</p><br>
7    /// - On success, responds with [`DescribeInstanceOutput`](crate::operation::describe_instance::DescribeInstanceOutput) with field(s):
8    ///   - [`instance_arn(Option<String>)`](crate::operation::describe_instance::DescribeInstanceOutput::instance_arn): <p>The ARN of the instance of IAM Identity Center under which the operation will run. For more information about ARNs, see <a href="/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>
9    ///   - [`identity_store_id(Option<String>)`](crate::operation::describe_instance::DescribeInstanceOutput::identity_store_id): <p>The identifier of the identity store that is connected to the instance of IAM Identity Center.</p>
10    ///   - [`owner_account_id(Option<String>)`](crate::operation::describe_instance::DescribeInstanceOutput::owner_account_id): <p>The identifier of the Amazon Web Services account for which the instance was created.</p>
11    ///   - [`name(Option<String>)`](crate::operation::describe_instance::DescribeInstanceOutput::name): <p>Specifies the instance name.</p>
12    ///   - [`created_date(Option<DateTime>)`](crate::operation::describe_instance::DescribeInstanceOutput::created_date): <p>The date the instance was created.</p>
13    ///   - [`status(Option<InstanceStatus>)`](crate::operation::describe_instance::DescribeInstanceOutput::status): <p>The status of the instance.</p>
14    /// - On failure, responds with [`SdkError<DescribeInstanceError>`](crate::operation::describe_instance::DescribeInstanceError)
15    pub fn describe_instance(&self) -> crate::operation::describe_instance::builders::DescribeInstanceFluentBuilder {
16        crate::operation::describe_instance::builders::DescribeInstanceFluentBuilder::new(self.handle.clone())
17    }
18}