aws_sdk_elasticache/client/
describe_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 [`DescribeUsers`](crate::operation::describe_users::builders::DescribeUsersFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_users::builders::DescribeUsersFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`engine(impl Into<String>)`](crate::operation::describe_users::builders::DescribeUsersFluentBuilder::engine) / [`set_engine(Option<String>)`](crate::operation::describe_users::builders::DescribeUsersFluentBuilder::set_engine):<br>required: **false**<br><p>The engine.</p><br>
8    ///   - [`user_id(impl Into<String>)`](crate::operation::describe_users::builders::DescribeUsersFluentBuilder::user_id) / [`set_user_id(Option<String>)`](crate::operation::describe_users::builders::DescribeUsersFluentBuilder::set_user_id):<br>required: **false**<br><p>The ID of the user.</p><br>
9    ///   - [`filters(Filter)`](crate::operation::describe_users::builders::DescribeUsersFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::describe_users::builders::DescribeUsersFluentBuilder::set_filters):<br>required: **false**<br><p>Filter to determine the list of User IDs to return.</p><br>
10    ///   - [`max_records(i32)`](crate::operation::describe_users::builders::DescribeUsersFluentBuilder::max_records) / [`set_max_records(Option<i32>)`](crate::operation::describe_users::builders::DescribeUsersFluentBuilder::set_max_records):<br>required: **false**<br><p>The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.</p><br>
11    ///   - [`marker(impl Into<String>)`](crate::operation::describe_users::builders::DescribeUsersFluentBuilder::marker) / [`set_marker(Option<String>)`](crate::operation::describe_users::builders::DescribeUsersFluentBuilder::set_marker):<br>required: **false**<br><p>An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. &gt;</p><br>
12    /// - On success, responds with [`DescribeUsersOutput`](crate::operation::describe_users::DescribeUsersOutput) with field(s):
13    ///   - [`users(Option<Vec::<User>>)`](crate::operation::describe_users::DescribeUsersOutput::users): <p>A list of users.</p>
14    ///   - [`marker(Option<String>)`](crate::operation::describe_users::DescribeUsersOutput::marker): <p>An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. &gt;</p>
15    /// - On failure, responds with [`SdkError<DescribeUsersError>`](crate::operation::describe_users::DescribeUsersError)
16    pub fn describe_users(&self) -> crate::operation::describe_users::builders::DescribeUsersFluentBuilder {
17        crate::operation::describe_users::builders::DescribeUsersFluentBuilder::new(self.handle.clone())
18    }
19}
aws_sdk_elasticache/client/describe_users.rs

aws_sdk_elasticache/client/
describe_users.rs
