aws_sdk_transfer/client/
list_users.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 [`ListUsers`](crate::operation::list_users::builders::ListUsersFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_users::builders::ListUsersFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`max_results(i32)`](crate::operation::list_users::builders::ListUsersFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_users::builders::ListUsersFluentBuilder::set_max_results):<br>required: **false**<br><p>Specifies the number of users to return as a response to the <code>ListUsers</code> request.</p><br>
8    ///   - [`next_token(impl Into<String>)`](crate::operation::list_users::builders::ListUsersFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_users::builders::ListUsersFluentBuilder::set_next_token):<br>required: **false**<br><p>If there are additional results from the <code>ListUsers</code> call, a <code>NextToken</code> parameter is returned in the output. You can then pass the <code>NextToken</code> to a subsequent <code>ListUsers</code> command, to continue listing additional users.</p><br>
9    ///   - [`server_id(impl Into<String>)`](crate::operation::list_users::builders::ListUsersFluentBuilder::server_id) / [`set_server_id(Option<String>)`](crate::operation::list_users::builders::ListUsersFluentBuilder::set_server_id):<br>required: **true**<br><p>A system-assigned unique identifier for a server that has users assigned to it.</p><br>
10    /// - On success, responds with [`ListUsersOutput`](crate::operation::list_users::ListUsersOutput) with field(s):
11    ///   - [`next_token(Option<String>)`](crate::operation::list_users::ListUsersOutput::next_token): <p>When you can get additional results from the <code>ListUsers</code> call, a <code>NextToken</code> parameter is returned in the output. You can then pass in a subsequent command to the <code>NextToken</code> parameter to continue listing additional users.</p>
12    ///   - [`server_id(String)`](crate::operation::list_users::ListUsersOutput::server_id): <p>A system-assigned unique identifier for a server that the users are assigned to.</p>
13    ///   - [`users(Vec::<ListedUser>)`](crate::operation::list_users::ListUsersOutput::users): <p>Returns the Transfer Family users and their properties for the <code>ServerId</code> value that you specify.</p>
14    /// - On failure, responds with [`SdkError<ListUsersError>`](crate::operation::list_users::ListUsersError)
15    pub fn list_users(&self) -> crate::operation::list_users::builders::ListUsersFluentBuilder {
16        crate::operation::list_users::builders::ListUsersFluentBuilder::new(self.handle.clone())
17    }
18}
aws_sdk_transfer/client/list_users.rs

aws_sdk_transfer/client/
list_users.rs
