aws_sdk_datasync/client/
describe_location_smb.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 [`DescribeLocationSmb`](crate::operation::describe_location_smb::builders::DescribeLocationSmbFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`location_arn(impl Into<String>)`](crate::operation::describe_location_smb::builders::DescribeLocationSmbFluentBuilder::location_arn) / [`set_location_arn(Option<String>)`](crate::operation::describe_location_smb::builders::DescribeLocationSmbFluentBuilder::set_location_arn):<br>required: **true**<br><p>Specifies the Amazon Resource Name (ARN) of the SMB location that you want information about.</p><br>
7    /// - On success, responds with [`DescribeLocationSmbOutput`](crate::operation::describe_location_smb::DescribeLocationSmbOutput) with field(s):
8    ///   - [`location_arn(Option<String>)`](crate::operation::describe_location_smb::DescribeLocationSmbOutput::location_arn): <p>The ARN of the SMB location.</p>
9    ///   - [`location_uri(Option<String>)`](crate::operation::describe_location_smb::DescribeLocationSmbOutput::location_uri): <p>The URI of the SMB location.</p>
10    ///   - [`agent_arns(Option<Vec::<String>>)`](crate::operation::describe_location_smb::DescribeLocationSmbOutput::agent_arns): <p>The ARNs of the DataSync agents that can connect with your SMB file server.</p>
11    ///   - [`user(Option<String>)`](crate::operation::describe_location_smb::DescribeLocationSmbOutput::user): <p>The user that can mount and access the files, folders, and file metadata in your SMB file server. This element applies only if <code>AuthenticationType</code> is set to <code>NTLM</code>.</p>
12    ///   - [`domain(Option<String>)`](crate::operation::describe_location_smb::DescribeLocationSmbOutput::domain): <p>The name of the Windows domain that the SMB file server belongs to. This element applies only if <code>AuthenticationType</code> is set to <code>NTLM</code>.</p>
13    ///   - [`mount_options(Option<SmbMountOptions>)`](crate::operation::describe_location_smb::DescribeLocationSmbOutput::mount_options): <p>The SMB protocol version that DataSync uses to access your SMB file server.</p>
14    ///   - [`creation_time(Option<DateTime>)`](crate::operation::describe_location_smb::DescribeLocationSmbOutput::creation_time): <p>The time that the SMB location was created.</p>
15    ///   - [`dns_ip_addresses(Option<Vec::<String>>)`](crate::operation::describe_location_smb::DescribeLocationSmbOutput::dns_ip_addresses): <p>The IPv4 or IPv6 addresses for the DNS servers that your SMB file server belongs to. This element applies only if <code>AuthenticationType</code> is set to <code>KERBEROS</code>.</p>
16    ///   - [`kerberos_principal(Option<String>)`](crate::operation::describe_location_smb::DescribeLocationSmbOutput::kerberos_principal): <p>The Kerberos principal that has permission to access the files, folders, and file metadata in your SMB file server.</p>
17    ///   - [`authentication_type(Option<SmbAuthenticationType>)`](crate::operation::describe_location_smb::DescribeLocationSmbOutput::authentication_type): <p>The authentication protocol that DataSync uses to connect to your SMB file server.</p>
18    /// - On failure, responds with [`SdkError<DescribeLocationSmbError>`](crate::operation::describe_location_smb::DescribeLocationSmbError)
19    pub fn describe_location_smb(&self) -> crate::operation::describe_location_smb::builders::DescribeLocationSmbFluentBuilder {
20        crate::operation::describe_location_smb::builders::DescribeLocationSmbFluentBuilder::new(self.handle.clone())
21    }
22}