aws_sdk_appstream/operation/describe_users/
_describe_users_input.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2#[allow(missing_docs)] // documentation missing in model
3#[non_exhaustive]
4#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
5pub struct DescribeUsersInput {
6    /// <p>The authentication type for the users in the user pool to describe. You must specify USERPOOL.</p>
7    pub authentication_type: ::std::option::Option<crate::types::AuthenticationType>,
8    /// <p>The maximum size of each page of results.</p>
9    pub max_results: ::std::option::Option<i32>,
10    /// <p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>
11    pub next_token: ::std::option::Option<::std::string::String>,
12}
13impl DescribeUsersInput {
14    /// <p>The authentication type for the users in the user pool to describe. You must specify USERPOOL.</p>
15    pub fn authentication_type(&self) -> ::std::option::Option<&crate::types::AuthenticationType> {
16        self.authentication_type.as_ref()
17    }
18    /// <p>The maximum size of each page of results.</p>
19    pub fn max_results(&self) -> ::std::option::Option<i32> {
20        self.max_results
21    }
22    /// <p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>
23    pub fn next_token(&self) -> ::std::option::Option<&str> {
24        self.next_token.as_deref()
25    }
26}
27impl DescribeUsersInput {
28    /// Creates a new builder-style object to manufacture [`DescribeUsersInput`](crate::operation::describe_users::DescribeUsersInput).
29    pub fn builder() -> crate::operation::describe_users::builders::DescribeUsersInputBuilder {
30        crate::operation::describe_users::builders::DescribeUsersInputBuilder::default()
31    }
32}
33
34/// A builder for [`DescribeUsersInput`](crate::operation::describe_users::DescribeUsersInput).
35#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
36#[non_exhaustive]
37pub struct DescribeUsersInputBuilder {
38    pub(crate) authentication_type: ::std::option::Option<crate::types::AuthenticationType>,
39    pub(crate) max_results: ::std::option::Option<i32>,
40    pub(crate) next_token: ::std::option::Option<::std::string::String>,
41}
42impl DescribeUsersInputBuilder {
43    /// <p>The authentication type for the users in the user pool to describe. You must specify USERPOOL.</p>
44    /// This field is required.
45    pub fn authentication_type(mut self, input: crate::types::AuthenticationType) -> Self {
46        self.authentication_type = ::std::option::Option::Some(input);
47        self
48    }
49    /// <p>The authentication type for the users in the user pool to describe. You must specify USERPOOL.</p>
50    pub fn set_authentication_type(mut self, input: ::std::option::Option<crate::types::AuthenticationType>) -> Self {
51        self.authentication_type = input;
52        self
53    }
54    /// <p>The authentication type for the users in the user pool to describe. You must specify USERPOOL.</p>
55    pub fn get_authentication_type(&self) -> &::std::option::Option<crate::types::AuthenticationType> {
56        &self.authentication_type
57    }
58    /// <p>The maximum size of each page of results.</p>
59    pub fn max_results(mut self, input: i32) -> Self {
60        self.max_results = ::std::option::Option::Some(input);
61        self
62    }
63    /// <p>The maximum size of each page of results.</p>
64    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
65        self.max_results = input;
66        self
67    }
68    /// <p>The maximum size of each page of results.</p>
69    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
70        &self.max_results
71    }
72    /// <p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>
73    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
74        self.next_token = ::std::option::Option::Some(input.into());
75        self
76    }
77    /// <p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>
78    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
79        self.next_token = input;
80        self
81    }
82    /// <p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>
83    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
84        &self.next_token
85    }
86    /// Consumes the builder and constructs a [`DescribeUsersInput`](crate::operation::describe_users::DescribeUsersInput).
87    pub fn build(
88        self,
89    ) -> ::std::result::Result<crate::operation::describe_users::DescribeUsersInput, ::aws_smithy_types::error::operation::BuildError> {
90        ::std::result::Result::Ok(crate::operation::describe_users::DescribeUsersInput {
91            authentication_type: self.authentication_type,
92            max_results: self.max_results,
93            next_token: self.next_token,
94        })
95    }
96}