aws_sdk_connect/client/
describe_instance.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeInstance`](crate::operation::describe_instance::builders::DescribeInstanceFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`instance_id(impl Into<String>)`](crate::operation::describe_instance::builders::DescribeInstanceFluentBuilder::instance_id) / [`set_instance_id(Option<String>)`](crate::operation::describe_instance::builders::DescribeInstanceFluentBuilder::set_instance_id):<br>required: **true**<br><p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p><br>
    /// - On success, responds with [`DescribeInstanceOutput`](crate::operation::describe_instance::DescribeInstanceOutput) with field(s):
    ///   - [`instance(Option<Instance>)`](crate::operation::describe_instance::DescribeInstanceOutput::instance): <p>The name of the instance.</p>
    ///   - [`replication_configuration(Option<ReplicationConfiguration>)`](crate::operation::describe_instance::DescribeInstanceOutput::replication_configuration): <p>Status information about the replication process. This field is included only when you are using the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_ReplicateInstance.html">ReplicateInstance</a> API to replicate an Amazon Connect instance across Amazon Web Services Regions. For information about replicating Amazon Connect instances, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/create-replica-connect-instance.html">Create a replica of your existing Amazon Connect instance</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
    /// - On failure, responds with [`SdkError<DescribeInstanceError>`](crate::operation::describe_instance::DescribeInstanceError)
    pub fn describe_instance(&self) -> crate::operation::describe_instance::builders::DescribeInstanceFluentBuilder {
        crate::operation::describe_instance::builders::DescribeInstanceFluentBuilder::new(self.handle.clone())
    }
}