AWS SDK for C++
1.8.129
AWS SDK for C++
|
#include <ListUsersRequest.h>
Additional Inherited Members | |
![]() | |
virtual void | DumpBodyToUrl (Aws::Http::URI &uri) const |
Aws::CognitoIdentityProvider::Model::ListUsersRequest::ListUsersRequest | ( | ) |
|
inline |
An array of strings, where each string is the name of a user attribute to be returned for each user in the search results. If the array is null, all attributes are returned.
Definition at line 144 of file ListUsersRequest.h.
|
inline |
An array of strings, where each string is the name of a user attribute to be returned for each user in the search results. If the array is null, all attributes are returned.
Definition at line 137 of file ListUsersRequest.h.
|
inline |
An array of strings, where each string is the name of a user attribute to be returned for each user in the search results. If the array is null, all attributes are returned.
Definition at line 151 of file ListUsersRequest.h.
|
inline |
An array of strings, where each string is the name of a user attribute to be returned for each user in the search results. If the array is null, all attributes are returned.
Definition at line 102 of file ListUsersRequest.h.
|
inline |
A filter string of the form "<i>AttributeName</i> <i>Filter-Type</i> "AttributeValue"". Quotation marks within the filter string must be escaped using the backslash () character. For example, "<code>family_name</code> = \"Reddy"".
AttributeName: The name of the attribute to search for. You can only search for one attribute at a time.
Filter-Type: For an exact match, use =, for example, "<code>given_name</code> = \"Jon"". For a prefix ("starts with")
match, use ^=, for example, "given_name
^= "Jon"".
AttributeValue: The attribute value that must be matched for each user.
If the filter string is empty, ListUsers
returns all users in the user pool.
You can only search for the following standard attributes:
username
(case-sensitive)
email
phone_number
name
given_name
family_name
preferred_username
cognito:user_status
(called Status in the Console) (case-insensitive)
status (called Enabled in the Console) (case-sensitive)
sub
Custom attributes are not searchable.
For more information, see Searching for Users Using the ListUsers API and Examples of Using the ListUsers API in the Amazon Cognito Developer Guide.
Definition at line 280 of file ListUsersRequest.h.
|
inline |
An array of strings, where each string is the name of a user attribute to be returned for each user in the search results. If the array is null, all attributes are returned.
Definition at line 95 of file ListUsersRequest.h.
|
inline |
A filter string of the form "<i>AttributeName</i> <i>Filter-Type</i> "AttributeValue"". Quotation marks within the filter string must be escaped using the backslash () character. For example, "<code>family_name</code> = \"Reddy"".
AttributeName: The name of the attribute to search for. You can only search for one attribute at a time.
Filter-Type: For an exact match, use =, for example, "<code>given_name</code> = \"Jon"". For a prefix ("starts with")
match, use ^=, for example, "given_name
^= "Jon"".
AttributeValue: The attribute value that must be matched for each user.
If the filter string is empty, ListUsers
returns all users in the user pool.
You can only search for the following standard attributes:
username
(case-sensitive)
email
phone_number
name
given_name
family_name
preferred_username
cognito:user_status
(called Status in the Console) (case-insensitive)
status (called Enabled in the Console) (case-sensitive)
sub
Custom attributes are not searchable.
For more information, see Searching for Users Using the ListUsers API and Examples of Using the ListUsers API in the Amazon Cognito Developer Guide.
Definition at line 251 of file ListUsersRequest.h.
|
inline |
Maximum number of users to be returned.
Definition at line 157 of file ListUsersRequest.h.
|
inline |
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
Definition at line 179 of file ListUsersRequest.h.
|
overridevirtual |
Reimplemented from Aws::CognitoIdentityProvider::CognitoIdentityProviderRequest.
|
inlineoverridevirtual |
Implements Aws::AmazonWebServiceRequest.
Definition at line 34 of file ListUsersRequest.h.
|
inline |
The user pool ID for the user pool on which the search should be performed.
Definition at line 45 of file ListUsersRequest.h.
|
inline |
Maximum number of users to be returned.
Definition at line 162 of file ListUsersRequest.h.
|
inline |
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
Definition at line 185 of file ListUsersRequest.h.
|
overridevirtual |
Convert payload into String.
Implements Aws::AmazonSerializableWebServiceRequest.
|
inline |
An array of strings, where each string is the name of a user attribute to be returned for each user in the search results. If the array is null, all attributes are returned.
Definition at line 116 of file ListUsersRequest.h.
|
inline |
An array of strings, where each string is the name of a user attribute to be returned for each user in the search results. If the array is null, all attributes are returned.
Definition at line 109 of file ListUsersRequest.h.
|
inline |
A filter string of the form "<i>AttributeName</i> <i>Filter-Type</i> "AttributeValue"". Quotation marks within the filter string must be escaped using the backslash () character. For example, "<code>family_name</code> = \"Reddy"".
AttributeName: The name of the attribute to search for. You can only search for one attribute at a time.
Filter-Type: For an exact match, use =, for example, "<code>given_name</code> = \"Jon"". For a prefix ("starts with")
match, use ^=, for example, "given_name
^= "Jon"".
AttributeValue: The attribute value that must be matched for each user.
If the filter string is empty, ListUsers
returns all users in the user pool.
You can only search for the following standard attributes:
username
(case-sensitive)
email
phone_number
name
given_name
family_name
preferred_username
cognito:user_status
(called Status in the Console) (case-insensitive)
status (called Enabled in the Console) (case-sensitive)
sub
Custom attributes are not searchable.
For more information, see Searching for Users Using the ListUsers API and Examples of Using the ListUsers API in the Amazon Cognito Developer Guide.
Definition at line 338 of file ListUsersRequest.h.
|
inline |
A filter string of the form "<i>AttributeName</i> <i>Filter-Type</i> "AttributeValue"". Quotation marks within the filter string must be escaped using the backslash () character. For example, "<code>family_name</code> = \"Reddy"".
AttributeName: The name of the attribute to search for. You can only search for one attribute at a time.
Filter-Type: For an exact match, use =, for example, "<code>given_name</code> = \"Jon"". For a prefix ("starts with")
match, use ^=, for example, "given_name
^= "Jon"".
AttributeValue: The attribute value that must be matched for each user.
If the filter string is empty, ListUsers
returns all users in the user pool.
You can only search for the following standard attributes:
username
(case-sensitive)
email
phone_number
name
given_name
family_name
preferred_username
cognito:user_status
(called Status in the Console) (case-insensitive)
status (called Enabled in the Console) (case-sensitive)
sub
Custom attributes are not searchable.
For more information, see Searching for Users Using the ListUsers API and Examples of Using the ListUsers API in the Amazon Cognito Developer Guide.
Definition at line 309 of file ListUsersRequest.h.
|
inline |
A filter string of the form "<i>AttributeName</i> <i>Filter-Type</i> "AttributeValue"". Quotation marks within the filter string must be escaped using the backslash () character. For example, "<code>family_name</code> = \"Reddy"".
AttributeName: The name of the attribute to search for. You can only search for one attribute at a time.
Filter-Type: For an exact match, use =, for example, "<code>given_name</code> = \"Jon"". For a prefix ("starts with")
match, use ^=, for example, "given_name
^= "Jon"".
AttributeValue: The attribute value that must be matched for each user.
If the filter string is empty, ListUsers
returns all users in the user pool.
You can only search for the following standard attributes:
username
(case-sensitive)
email
phone_number
name
given_name
family_name
preferred_username
cognito:user_status
(called Status in the Console) (case-insensitive)
status (called Enabled in the Console) (case-sensitive)
sub
Custom attributes are not searchable.
For more information, see Searching for Users Using the ListUsers API and Examples of Using the ListUsers API in the Amazon Cognito Developer Guide.
Definition at line 367 of file ListUsersRequest.h.
|
inline |
Maximum number of users to be returned.
Definition at line 167 of file ListUsersRequest.h.
|
inline |
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
Definition at line 197 of file ListUsersRequest.h.
|
inline |
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
Definition at line 191 of file ListUsersRequest.h.
|
inline |
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
Definition at line 203 of file ListUsersRequest.h.
|
inline |
The user pool ID for the user pool on which the search should be performed.
Definition at line 63 of file ListUsersRequest.h.
|
inline |
The user pool ID for the user pool on which the search should be performed.
Definition at line 57 of file ListUsersRequest.h.
|
inline |
The user pool ID for the user pool on which the search should be performed.
Definition at line 69 of file ListUsersRequest.h.
|
inline |
The user pool ID for the user pool on which the search should be performed.
Definition at line 51 of file ListUsersRequest.h.
|
inline |
An array of strings, where each string is the name of a user attribute to be returned for each user in the search results. If the array is null, all attributes are returned.
Definition at line 130 of file ListUsersRequest.h.
|
inline |
An array of strings, where each string is the name of a user attribute to be returned for each user in the search results. If the array is null, all attributes are returned.
Definition at line 123 of file ListUsersRequest.h.
|
inline |
A filter string of the form "<i>AttributeName</i> <i>Filter-Type</i> "AttributeValue"". Quotation marks within the filter string must be escaped using the backslash () character. For example, "<code>family_name</code> = \"Reddy"".
AttributeName: The name of the attribute to search for. You can only search for one attribute at a time.
Filter-Type: For an exact match, use =, for example, "<code>given_name</code> = \"Jon"". For a prefix ("starts with")
match, use ^=, for example, "given_name
^= "Jon"".
AttributeValue: The attribute value that must be matched for each user.
If the filter string is empty, ListUsers
returns all users in the user pool.
You can only search for the following standard attributes:
username
(case-sensitive)
email
phone_number
name
given_name
family_name
preferred_username
cognito:user_status
(called Status in the Console) (case-insensitive)
status (called Enabled in the Console) (case-sensitive)
sub
Custom attributes are not searchable.
For more information, see Searching for Users Using the ListUsers API and Examples of Using the ListUsers API in the Amazon Cognito Developer Guide.
Definition at line 425 of file ListUsersRequest.h.
|
inline |
A filter string of the form "<i>AttributeName</i> <i>Filter-Type</i> "AttributeValue"". Quotation marks within the filter string must be escaped using the backslash () character. For example, "<code>family_name</code> = \"Reddy"".
AttributeName: The name of the attribute to search for. You can only search for one attribute at a time.
Filter-Type: For an exact match, use =, for example, "<code>given_name</code> = \"Jon"". For a prefix ("starts with")
match, use ^=, for example, "given_name
^= "Jon"".
AttributeValue: The attribute value that must be matched for each user.
If the filter string is empty, ListUsers
returns all users in the user pool.
You can only search for the following standard attributes:
username
(case-sensitive)
email
phone_number
name
given_name
family_name
preferred_username
cognito:user_status
(called Status in the Console) (case-insensitive)
status (called Enabled in the Console) (case-sensitive)
sub
Custom attributes are not searchable.
For more information, see Searching for Users Using the ListUsers API and Examples of Using the ListUsers API in the Amazon Cognito Developer Guide.
Definition at line 396 of file ListUsersRequest.h.
|
inline |
A filter string of the form "<i>AttributeName</i> <i>Filter-Type</i> "AttributeValue"". Quotation marks within the filter string must be escaped using the backslash () character. For example, "<code>family_name</code> = \"Reddy"".
AttributeName: The name of the attribute to search for. You can only search for one attribute at a time.
Filter-Type: For an exact match, use =, for example, "<code>given_name</code> = \"Jon"". For a prefix ("starts with")
match, use ^=, for example, "given_name
^= "Jon"".
AttributeValue: The attribute value that must be matched for each user.
If the filter string is empty, ListUsers
returns all users in the user pool.
You can only search for the following standard attributes:
username
(case-sensitive)
email
phone_number
name
given_name
family_name
preferred_username
cognito:user_status
(called Status in the Console) (case-insensitive)
status (called Enabled in the Console) (case-sensitive)
sub
Custom attributes are not searchable.
For more information, see Searching for Users Using the ListUsers API and Examples of Using the ListUsers API in the Amazon Cognito Developer Guide.
Definition at line 454 of file ListUsersRequest.h.
|
inline |
Maximum number of users to be returned.
Definition at line 172 of file ListUsersRequest.h.
|
inline |
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
Definition at line 215 of file ListUsersRequest.h.
|
inline |
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
Definition at line 209 of file ListUsersRequest.h.
|
inline |
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
Definition at line 221 of file ListUsersRequest.h.
|
inline |
The user pool ID for the user pool on which the search should be performed.
Definition at line 81 of file ListUsersRequest.h.
|
inline |
The user pool ID for the user pool on which the search should be performed.
Definition at line 75 of file ListUsersRequest.h.
|
inline |
The user pool ID for the user pool on which the search should be performed.
Definition at line 87 of file ListUsersRequest.h.