AWS SDK for C++  1.8.153
AWS SDK for C++
ListUsersRequest.h
Go to the documentation of this file.
1 
6 #pragma once
11 #include <utility>
12 
13 namespace Aws
14 {
15 namespace CognitoIdentityProvider
16 {
17 namespace Model
18 {
19 
26  {
27  public:
29 
30  // Service request name is the Operation name which will send this request out,
31  // each operation should has unique request name, so that we can get operation's name from this request.
32  // Note: this is not true for response, multiple operations may have the same response name,
33  // so we can not get operation's name from response.
34  inline virtual const char* GetServiceRequestName() const override { return "ListUsers"; }
35 
36  Aws::String SerializePayload() const override;
37 
39 
40 
45  inline const Aws::String& GetUserPoolId() const{ return m_userPoolId; }
46 
51  inline bool UserPoolIdHasBeenSet() const { return m_userPoolIdHasBeenSet; }
52 
57  inline void SetUserPoolId(const Aws::String& value) { m_userPoolIdHasBeenSet = true; m_userPoolId = value; }
58 
63  inline void SetUserPoolId(Aws::String&& value) { m_userPoolIdHasBeenSet = true; m_userPoolId = std::move(value); }
64 
69  inline void SetUserPoolId(const char* value) { m_userPoolIdHasBeenSet = true; m_userPoolId.assign(value); }
70 
75  inline ListUsersRequest& WithUserPoolId(const Aws::String& value) { SetUserPoolId(value); return *this;}
76 
81  inline ListUsersRequest& WithUserPoolId(Aws::String&& value) { SetUserPoolId(std::move(value)); return *this;}
82 
87  inline ListUsersRequest& WithUserPoolId(const char* value) { SetUserPoolId(value); return *this;}
88 
89 
95  inline const Aws::Vector<Aws::String>& GetAttributesToGet() const{ return m_attributesToGet; }
96 
102  inline bool AttributesToGetHasBeenSet() const { return m_attributesToGetHasBeenSet; }
103 
109  inline void SetAttributesToGet(const Aws::Vector<Aws::String>& value) { m_attributesToGetHasBeenSet = true; m_attributesToGet = value; }
110 
116  inline void SetAttributesToGet(Aws::Vector<Aws::String>&& value) { m_attributesToGetHasBeenSet = true; m_attributesToGet = std::move(value); }
117 
123  inline ListUsersRequest& WithAttributesToGet(const Aws::Vector<Aws::String>& value) { SetAttributesToGet(value); return *this;}
124 
130  inline ListUsersRequest& WithAttributesToGet(Aws::Vector<Aws::String>&& value) { SetAttributesToGet(std::move(value)); return *this;}
131 
137  inline ListUsersRequest& AddAttributesToGet(const Aws::String& value) { m_attributesToGetHasBeenSet = true; m_attributesToGet.push_back(value); return *this; }
138 
144  inline ListUsersRequest& AddAttributesToGet(Aws::String&& value) { m_attributesToGetHasBeenSet = true; m_attributesToGet.push_back(std::move(value)); return *this; }
145 
151  inline ListUsersRequest& AddAttributesToGet(const char* value) { m_attributesToGetHasBeenSet = true; m_attributesToGet.push_back(value); return *this; }
152 
153 
157  inline int GetLimit() const{ return m_limit; }
158 
162  inline bool LimitHasBeenSet() const { return m_limitHasBeenSet; }
163 
167  inline void SetLimit(int value) { m_limitHasBeenSet = true; m_limit = value; }
168 
172  inline ListUsersRequest& WithLimit(int value) { SetLimit(value); return *this;}
173 
174 
179  inline const Aws::String& GetPaginationToken() const{ return m_paginationToken; }
180 
185  inline bool PaginationTokenHasBeenSet() const { return m_paginationTokenHasBeenSet; }
186 
191  inline void SetPaginationToken(const Aws::String& value) { m_paginationTokenHasBeenSet = true; m_paginationToken = value; }
192 
197  inline void SetPaginationToken(Aws::String&& value) { m_paginationTokenHasBeenSet = true; m_paginationToken = std::move(value); }
198 
203  inline void SetPaginationToken(const char* value) { m_paginationTokenHasBeenSet = true; m_paginationToken.assign(value); }
204 
209  inline ListUsersRequest& WithPaginationToken(const Aws::String& value) { SetPaginationToken(value); return *this;}
210 
215  inline ListUsersRequest& WithPaginationToken(Aws::String&& value) { SetPaginationToken(std::move(value)); return *this;}
216 
221  inline ListUsersRequest& WithPaginationToken(const char* value) { SetPaginationToken(value); return *this;}
222 
223 
251  inline const Aws::String& GetFilter() const{ return m_filter; }
252 
280  inline bool FilterHasBeenSet() const { return m_filterHasBeenSet; }
281 
309  inline void SetFilter(const Aws::String& value) { m_filterHasBeenSet = true; m_filter = value; }
310 
338  inline void SetFilter(Aws::String&& value) { m_filterHasBeenSet = true; m_filter = std::move(value); }
339 
367  inline void SetFilter(const char* value) { m_filterHasBeenSet = true; m_filter.assign(value); }
368 
396  inline ListUsersRequest& WithFilter(const Aws::String& value) { SetFilter(value); return *this;}
397 
425  inline ListUsersRequest& WithFilter(Aws::String&& value) { SetFilter(std::move(value)); return *this;}
426 
454  inline ListUsersRequest& WithFilter(const char* value) { SetFilter(value); return *this;}
455 
456  private:
457 
458  Aws::String m_userPoolId;
459  bool m_userPoolIdHasBeenSet;
460 
461  Aws::Vector<Aws::String> m_attributesToGet;
462  bool m_attributesToGetHasBeenSet;
463 
464  int m_limit;
465  bool m_limitHasBeenSet;
466 
467  Aws::String m_paginationToken;
468  bool m_paginationTokenHasBeenSet;
469 
470  Aws::String m_filter;
471  bool m_filterHasBeenSet;
472  };
473 
474 } // namespace Model
475 } // namespace CognitoIdentityProvider
476 } // namespace Aws
Aws::CognitoIdentityProvider::Model::ListUsersRequest::SerializePayload
Aws::String SerializePayload() const override
Aws::CognitoIdentityProvider::Model::ListUsersRequest::SetPaginationToken
void SetPaginationToken(const Aws::String &value)
Definition: ListUsersRequest.h:191
Aws::CognitoIdentityProvider::Model::ListUsersRequest::WithPaginationToken
ListUsersRequest & WithPaginationToken(const char *value)
Definition: ListUsersRequest.h:221
Aws::CognitoIdentityProvider::Model::ListUsersRequest::GetServiceRequestName
virtual const char * GetServiceRequestName() const override
Definition: ListUsersRequest.h:34
Aws::Http::HeaderValueCollection
Aws::Map< Aws::String, Aws::String > HeaderValueCollection
Definition: HttpTypes.h:53
CognitoIdentityProvider_EXPORTS.h
Aws::CognitoIdentityProvider::Model::ListUsersRequest::AddAttributesToGet
ListUsersRequest & AddAttributesToGet(Aws::String &&value)
Definition: ListUsersRequest.h:144
Aws::CognitoIdentityProvider::Model::ListUsersRequest::WithLimit
ListUsersRequest & WithLimit(int value)
Definition: ListUsersRequest.h:172
Aws::CognitoIdentityProvider::Model::ListUsersRequest::SetUserPoolId
void SetUserPoolId(Aws::String &&value)
Definition: ListUsersRequest.h:63
Aws::CognitoIdentityProvider::CognitoIdentityProviderRequest
Definition: CognitoIdentityProviderRequest.h:17
Aws::CognitoIdentityProvider::Model::ListUsersRequest::GetRequestSpecificHeaders
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
Aws::CognitoIdentityProvider::Model::ListUsersRequest::SetLimit
void SetLimit(int value)
Definition: ListUsersRequest.h:167
Aws::CognitoIdentityProvider::Model::ListUsersRequest::SetUserPoolId
void SetUserPoolId(const char *value)
Definition: ListUsersRequest.h:69
Aws::CognitoIdentityProvider::Model::ListUsersRequest::WithUserPoolId
ListUsersRequest & WithUserPoolId(const char *value)
Definition: ListUsersRequest.h:87
Aws::CognitoIdentityProvider::Model::ListUsersRequest::SetFilter
void SetFilter(Aws::String &&value)
Definition: ListUsersRequest.h:338
Aws::Vector
std::vector< T, Aws::Allocator< T > > Vector
Definition: AWSVector.h:17
Aws::CognitoIdentityProvider::Model::ListUsersRequest::WithUserPoolId
ListUsersRequest & WithUserPoolId(const Aws::String &value)
Definition: ListUsersRequest.h:75
Aws::CognitoIdentityProvider::Model::ListUsersRequest::WithAttributesToGet
ListUsersRequest & WithAttributesToGet(const Aws::Vector< Aws::String > &value)
Definition: ListUsersRequest.h:123
AWSVector.h
Aws::CognitoIdentityProvider::Model::ListUsersRequest::WithAttributesToGet
ListUsersRequest & WithAttributesToGet(Aws::Vector< Aws::String > &&value)
Definition: ListUsersRequest.h:130
Aws::CognitoIdentityProvider::Model::ListUsersRequest::SetAttributesToGet
void SetAttributesToGet(Aws::Vector< Aws::String > &&value)
Definition: ListUsersRequest.h:116
Aws::CognitoIdentityProvider::Model::ListUsersRequest::WithFilter
ListUsersRequest & WithFilter(const Aws::String &value)
Definition: ListUsersRequest.h:396
AWS_COGNITOIDENTITYPROVIDER_API
#define AWS_COGNITOIDENTITYPROVIDER_API
Definition: CognitoIdentityProvider_EXPORTS.h:28
Aws::CognitoIdentityProvider::Model::ListUsersRequest::AddAttributesToGet
ListUsersRequest & AddAttributesToGet(const Aws::String &value)
Definition: ListUsersRequest.h:137
Aws::CognitoIdentityProvider::Model::ListUsersRequest::SetPaginationToken
void SetPaginationToken(const char *value)
Definition: ListUsersRequest.h:203
Aws::CognitoIdentityProvider::Model::ListUsersRequest::GetUserPoolId
const Aws::String & GetUserPoolId() const
Definition: ListUsersRequest.h:45
Aws::CognitoIdentityProvider::Model::ListUsersRequest::GetLimit
int GetLimit() const
Definition: ListUsersRequest.h:157
Aws::CognitoIdentityProvider::Model::ListUsersRequest::AddAttributesToGet
ListUsersRequest & AddAttributesToGet(const char *value)
Definition: ListUsersRequest.h:151
Aws::CognitoIdentityProvider::Model::ListUsersRequest::ListUsersRequest
ListUsersRequest()
Aws::CognitoIdentityProvider::Model::ListUsersRequest::SetFilter
void SetFilter(const Aws::String &value)
Definition: ListUsersRequest.h:309
Aws::CognitoIdentityProvider::Model::ListUsersRequest::SetUserPoolId
void SetUserPoolId(const Aws::String &value)
Definition: ListUsersRequest.h:57
AWSString.h
Aws::CognitoIdentityProvider::Model::ListUsersRequest::LimitHasBeenSet
bool LimitHasBeenSet() const
Definition: ListUsersRequest.h:162
Aws::CognitoIdentityProvider::Model::ListUsersRequest::WithUserPoolId
ListUsersRequest & WithUserPoolId(Aws::String &&value)
Definition: ListUsersRequest.h:81
Aws::CognitoIdentityProvider::Model::ListUsersRequest::WithFilter
ListUsersRequest & WithFilter(const char *value)
Definition: ListUsersRequest.h:454
Aws::CognitoIdentityProvider::Model::ListUsersRequest::SetFilter
void SetFilter(const char *value)
Definition: ListUsersRequest.h:367
Aws::CognitoIdentityProvider::Model::ListUsersRequest::GetAttributesToGet
const Aws::Vector< Aws::String > & GetAttributesToGet() const
Definition: ListUsersRequest.h:95
Aws::CognitoIdentityProvider::Model::ListUsersRequest::WithPaginationToken
ListUsersRequest & WithPaginationToken(const Aws::String &value)
Definition: ListUsersRequest.h:209
Aws
Definition: AccessManagementClient.h:15
Aws::CognitoIdentityProvider::Model::ListUsersRequest::SetPaginationToken
void SetPaginationToken(Aws::String &&value)
Definition: ListUsersRequest.h:197
Aws::CognitoIdentityProvider::Model::ListUsersRequest::GetPaginationToken
const Aws::String & GetPaginationToken() const
Definition: ListUsersRequest.h:179
Aws::CognitoIdentityProvider::Model::ListUsersRequest::WithPaginationToken
ListUsersRequest & WithPaginationToken(Aws::String &&value)
Definition: ListUsersRequest.h:215
Aws::String
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
Definition: AWSString.h:97
Aws::CognitoIdentityProvider::Model::ListUsersRequest::GetFilter
const Aws::String & GetFilter() const
Definition: ListUsersRequest.h:251
CognitoIdentityProviderRequest.h
Aws::CognitoIdentityProvider::Model::ListUsersRequest
Definition: ListUsersRequest.h:26
Aws::CognitoIdentityProvider::Model::ListUsersRequest::FilterHasBeenSet
bool FilterHasBeenSet() const
Definition: ListUsersRequest.h:280
Aws::CognitoIdentityProvider::Model::ListUsersRequest::SetAttributesToGet
void SetAttributesToGet(const Aws::Vector< Aws::String > &value)
Definition: ListUsersRequest.h:109
Aws::CognitoIdentityProvider::Model::ListUsersRequest::WithFilter
ListUsersRequest & WithFilter(Aws::String &&value)
Definition: ListUsersRequest.h:425
Aws::CognitoIdentityProvider::Model::ListUsersRequest::AttributesToGetHasBeenSet
bool AttributesToGetHasBeenSet() const
Definition: ListUsersRequest.h:102
Aws::CognitoIdentityProvider::Model::ListUsersRequest::UserPoolIdHasBeenSet
bool UserPoolIdHasBeenSet() const
Definition: ListUsersRequest.h:51
Aws::CognitoIdentityProvider::Model::ListUsersRequest::PaginationTokenHasBeenSet
bool PaginationTokenHasBeenSet() const
Definition: ListUsersRequest.h:185