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    ///   - [`status_reason(Option<String>)`](crate::operation::describe_instance::DescribeInstanceOutput::status_reason): <p>Provides additional context about the current status of the IAM Identity Center instance. This field is particularly useful when an instance is in a non-ACTIVE state, such as CREATE_FAILED. When an instance fails to create or update, this field contains information about the cause, which may include issues with KMS key configuration, permission problems with the specified KMS key, or service-related errors.</p>
15    ///   - [`encryption_configuration_details(Option<EncryptionConfigurationDetails>)`](crate::operation::describe_instance::DescribeInstanceOutput::encryption_configuration_details): <p>Contains the encryption configuration for your IAM Identity Center instance, including the encryption status, KMS key type, and KMS key ARN.</p>
16    /// - On failure, responds with [`SdkError<DescribeInstanceError>`](crate::operation::describe_instance::DescribeInstanceError)
17    pub fn describe_instance(&self) -> crate::operation::describe_instance::builders::DescribeInstanceFluentBuilder {
18        crate::operation::describe_instance::builders::DescribeInstanceFluentBuilder::new(self.handle.clone())
19    }
20}
aws_sdk_ssoadmin/client/describe_instance.rs

aws_sdk_ssoadmin/client/
describe_instance.rs
