aws_sdk_datasync/client/
describe_location_object_storage.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 [`DescribeLocationObjectStorage`](crate::operation::describe_location_object_storage::builders::DescribeLocationObjectStorageFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`location_arn(impl Into<String>)`](crate::operation::describe_location_object_storage::builders::DescribeLocationObjectStorageFluentBuilder::location_arn) / [`set_location_arn(Option<String>)`](crate::operation::describe_location_object_storage::builders::DescribeLocationObjectStorageFluentBuilder::set_location_arn):<br>required: **true**<br><p>Specifies the Amazon Resource Name (ARN) of the object storage system location.</p><br>
7    /// - On success, responds with [`DescribeLocationObjectStorageOutput`](crate::operation::describe_location_object_storage::DescribeLocationObjectStorageOutput) with field(s):
8    ///   - [`location_arn(Option<String>)`](crate::operation::describe_location_object_storage::DescribeLocationObjectStorageOutput::location_arn): <p>The ARN of the object storage system location.</p>
9    ///   - [`location_uri(Option<String>)`](crate::operation::describe_location_object_storage::DescribeLocationObjectStorageOutput::location_uri): <p>The URI of the object storage system location.</p>
10    ///   - [`access_key(Option<String>)`](crate::operation::describe_location_object_storage::DescribeLocationObjectStorageOutput::access_key): <p>The access key (for example, a user name) required to authenticate with the object storage system.</p>
11    ///   - [`server_port(Option<i32>)`](crate::operation::describe_location_object_storage::DescribeLocationObjectStorageOutput::server_port): <p>The port that your object storage server accepts inbound network traffic on (for example, port 443).</p>
12    ///   - [`server_protocol(Option<ObjectStorageServerProtocol>)`](crate::operation::describe_location_object_storage::DescribeLocationObjectStorageOutput::server_protocol): <p>The protocol that your object storage system uses to communicate.</p>
13    ///   - [`agent_arns(Option<Vec::<String>>)`](crate::operation::describe_location_object_storage::DescribeLocationObjectStorageOutput::agent_arns): <p>The ARNs of the DataSync agents that can connect with your object storage system.</p>
14    ///   - [`creation_time(Option<DateTime>)`](crate::operation::describe_location_object_storage::DescribeLocationObjectStorageOutput::creation_time): <p>The time that the location was created.</p>
15    ///   - [`server_certificate(Option<Blob>)`](crate::operation::describe_location_object_storage::DescribeLocationObjectStorageOutput::server_certificate): <p>The certificate chain for DataSync to authenticate with your object storage system if the system uses a private or self-signed certificate authority (CA).</p>
16    ///   - [`managed_secret_config(Option<ManagedSecretConfig>)`](crate::operation::describe_location_object_storage::DescribeLocationObjectStorageOutput::managed_secret_config): <p>Describes configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location. DataSync uses the default Amazon Web Services-managed KMS key to encrypt this secret in Secrets Manager.</p>
17    ///   - [`cmk_secret_config(Option<CmkSecretConfig>)`](crate::operation::describe_location_object_storage::DescribeLocationObjectStorageOutput::cmk_secret_config): <p>Describes configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed KMS key.</p>
18    ///   - [`custom_secret_config(Option<CustomSecretConfig>)`](crate::operation::describe_location_object_storage::DescribeLocationObjectStorageOutput::custom_secret_config): <p>Describes configuration information for a customer-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed KMS key.</p>
19    /// - On failure, responds with [`SdkError<DescribeLocationObjectStorageError>`](crate::operation::describe_location_object_storage::DescribeLocationObjectStorageError)
20    pub fn describe_location_object_storage(
21        &self,
22    ) -> crate::operation::describe_location_object_storage::builders::DescribeLocationObjectStorageFluentBuilder {
23        crate::operation::describe_location_object_storage::builders::DescribeLocationObjectStorageFluentBuilder::new(self.handle.clone())
24    }
25}