aws_sdk_datasync/client/
describe_storage_system.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeStorageSystem`](crate::operation::describe_storage_system::builders::DescribeStorageSystemFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`storage_system_arn(impl Into<String>)`](crate::operation::describe_storage_system::builders::DescribeStorageSystemFluentBuilder::storage_system_arn) / [`set_storage_system_arn(Option<String>)`](crate::operation::describe_storage_system::builders::DescribeStorageSystemFluentBuilder::set_storage_system_arn):<br>required: **true**<br><p>Specifies the Amazon Resource Name (ARN) of an on-premises storage system that you're using with DataSync Discovery.</p><br>
    /// - On success, responds with [`DescribeStorageSystemOutput`](crate::operation::describe_storage_system::DescribeStorageSystemOutput) with field(s):
    ///   - [`storage_system_arn(Option<String>)`](crate::operation::describe_storage_system::DescribeStorageSystemOutput::storage_system_arn): <p>The ARN of the on-premises storage system that the discovery job looked at.</p>
    ///   - [`server_configuration(Option<DiscoveryServerConfiguration>)`](crate::operation::describe_storage_system::DescribeStorageSystemOutput::server_configuration): <p>The server name and network port required to connect with your on-premises storage system's management interface.</p>
    ///   - [`system_type(Option<DiscoverySystemType>)`](crate::operation::describe_storage_system::DescribeStorageSystemOutput::system_type): <p>The type of on-premises storage system.</p><note>  <p>DataSync Discovery currently only supports NetApp Fabric-Attached Storage (FAS) and All Flash FAS (AFF) systems running ONTAP 9.7 or later.</p> </note>
    ///   - [`agent_arns(Option<Vec::<String>>)`](crate::operation::describe_storage_system::DescribeStorageSystemOutput::agent_arns): <p>The ARN of the DataSync agent that connects to and reads from your on-premises storage system.</p>
    ///   - [`name(Option<String>)`](crate::operation::describe_storage_system::DescribeStorageSystemOutput::name): <p>The name that you gave your on-premises storage system when adding it to DataSync Discovery.</p>
    ///   - [`error_message(Option<String>)`](crate::operation::describe_storage_system::DescribeStorageSystemOutput::error_message): <p>Describes the connectivity error that the DataSync agent is encountering with your on-premises storage system.</p>
    ///   - [`connectivity_status(Option<StorageSystemConnectivityStatus>)`](crate::operation::describe_storage_system::DescribeStorageSystemOutput::connectivity_status): <p>Indicates whether your DataSync agent can connect to your on-premises storage system.</p>
    ///   - [`cloud_watch_log_group_arn(Option<String>)`](crate::operation::describe_storage_system::DescribeStorageSystemOutput::cloud_watch_log_group_arn): <p>The ARN of the Amazon CloudWatch log group that's used to monitor and log discovery job events.</p>
    ///   - [`creation_time(Option<DateTime>)`](crate::operation::describe_storage_system::DescribeStorageSystemOutput::creation_time): <p>The time when you added the on-premises storage system to DataSync Discovery.</p>
    ///   - [`secrets_manager_arn(Option<String>)`](crate::operation::describe_storage_system::DescribeStorageSystemOutput::secrets_manager_arn): <p>The ARN of the secret that stores your on-premises storage system's credentials. DataSync Discovery stores these credentials in <a href="https://docs.aws.amazon.com/datasync/latest/userguide/discovery-configure-storage.html#discovery-add-storage">Secrets Manager</a>.</p>
    /// - On failure, responds with [`SdkError<DescribeStorageSystemError>`](crate::operation::describe_storage_system::DescribeStorageSystemError)
    pub fn describe_storage_system(&self) -> crate::operation::describe_storage_system::builders::DescribeStorageSystemFluentBuilder {
        crate::operation::describe_storage_system::builders::DescribeStorageSystemFluentBuilder::new(self.handle.clone())
    }
}