aws_sdk_transfer/client/
describe_user.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeUser`](crate::operation::describe_user::builders::DescribeUserFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`server_id(impl Into<String>)`](crate::operation::describe_user::builders::DescribeUserFluentBuilder::server_id) / [`set_server_id(Option<String>)`](crate::operation::describe_user::builders::DescribeUserFluentBuilder::set_server_id):<br>required: **true**<br><p>A system-assigned unique identifier for a server that has this user assigned.</p><br>
    ///   - [`user_name(impl Into<String>)`](crate::operation::describe_user::builders::DescribeUserFluentBuilder::user_name) / [`set_user_name(Option<String>)`](crate::operation::describe_user::builders::DescribeUserFluentBuilder::set_user_name):<br>required: **true**<br><p>The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the Transfer Family service and perform file transfer tasks.</p><br>
    /// - On success, responds with [`DescribeUserOutput`](crate::operation::describe_user::DescribeUserOutput) with field(s):
    ///   - [`server_id(String)`](crate::operation::describe_user::DescribeUserOutput::server_id): <p>A system-assigned unique identifier for a server that has this user assigned.</p>
    ///   - [`user(Option<DescribedUser>)`](crate::operation::describe_user::DescribeUserOutput::user): <p>An array containing the properties of the Transfer Family user for the <code>ServerID</code> value that you specified.</p>
    /// - On failure, responds with [`SdkError<DescribeUserError>`](crate::operation::describe_user::DescribeUserError)
    pub fn describe_user(&self) -> crate::operation::describe_user::builders::DescribeUserFluentBuilder {
        crate::operation::describe_user::builders::DescribeUserFluentBuilder::new(self.handle.clone())
    }
}