Aws::CognitoIdentityProvider::Model::ListUsersRequest Class Reference

#include <ListUsersRequest.h>

Inheritance diagram for Aws::CognitoIdentityProvider::Model::ListUsersRequest:

Public Member Functions
	ListUsersRequest ()
virtual const char *	GetServiceRequestName () const override
Aws::String	SerializePayload () const override
Aws::Http::HeaderValueCollection	GetRequestSpecificHeaders () const override
const Aws::String &	GetUserPoolId () const
bool	UserPoolIdHasBeenSet () const
void	SetUserPoolId (const Aws::String &value)
void	SetUserPoolId (Aws::String &&value)
void	SetUserPoolId (const char *value)
ListUsersRequest &	WithUserPoolId (const Aws::String &value)
ListUsersRequest &	WithUserPoolId (Aws::String &&value)
ListUsersRequest &	WithUserPoolId (const char *value)
const Aws::Vector< Aws::String > &	GetAttributesToGet () const
bool	AttributesToGetHasBeenSet () const
void	SetAttributesToGet (const Aws::Vector< Aws::String > &value)
void	SetAttributesToGet (Aws::Vector< Aws::String > &&value)
ListUsersRequest &	WithAttributesToGet (const Aws::Vector< Aws::String > &value)
ListUsersRequest &	WithAttributesToGet (Aws::Vector< Aws::String > &&value)
ListUsersRequest &	AddAttributesToGet (const Aws::String &value)
ListUsersRequest &	AddAttributesToGet (Aws::String &&value)
ListUsersRequest &	AddAttributesToGet (const char *value)
int	GetLimit () const
bool	LimitHasBeenSet () const
void	SetLimit (int value)
ListUsersRequest &	WithLimit (int value)
const Aws::String &	GetPaginationToken () const
bool	PaginationTokenHasBeenSet () const
void	SetPaginationToken (const Aws::String &value)
void	SetPaginationToken (Aws::String &&value)
void	SetPaginationToken (const char *value)
ListUsersRequest &	WithPaginationToken (const Aws::String &value)
ListUsersRequest &	WithPaginationToken (Aws::String &&value)
ListUsersRequest &	WithPaginationToken (const char *value)
const Aws::String &	GetFilter () const
bool	FilterHasBeenSet () const
void	SetFilter (const Aws::String &value)
void	SetFilter (Aws::String &&value)
void	SetFilter (const char *value)
ListUsersRequest &	WithFilter (const Aws::String &value)
ListUsersRequest &	WithFilter (Aws::String &&value)
ListUsersRequest &	WithFilter (const char *value)
Public Member Functions inherited from Aws::CognitoIdentityProvider::CognitoIdentityProviderRequest
virtual	~CognitoIdentityProviderRequest ()
void	AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
Aws::Http::HeaderValueCollection	GetHeaders () const override
Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
	AmazonSerializableWebServiceRequest ()
virtual	~AmazonSerializableWebServiceRequest ()
std::shared_ptr< Aws::IOStream >	GetBody () const override
Public Member Functions inherited from Aws::AmazonWebServiceRequest
	AmazonWebServiceRequest ()
virtual	~AmazonWebServiceRequest ()=default
virtual void	AddQueryStringParameters (Aws::Http::URI &uri) const
virtual void	PutToPresignedUrl (Aws::Http::URI &uri) const
virtual bool	IsStreaming () const
virtual bool	IsEventStreamRequest () const
virtual bool	SignBody () const
virtual bool	IsChunked () const
virtual void	SetRequestSignedHandler (const RequestSignedHandler &handler)
virtual const RequestSignedHandler &	GetRequestSignedHandler () const
const Aws::IOStreamFactory &	GetResponseStreamFactory () const
void	SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
virtual void	SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
virtual void	SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
virtual void	SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
virtual void	SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
virtual void	SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
virtual void	SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
virtual void	SetRequestRetryHandler (const RequestRetryHandler &handler)
virtual void	SetRequestRetryHandler (RequestRetryHandler &&handler)
virtual const Aws::Http::DataReceivedEventHandler &	GetDataReceivedEventHandler () const
virtual const Aws::Http::DataSentEventHandler &	GetDataSentEventHandler () const
virtual const Aws::Http::ContinueRequestHandler &	GetContinueRequestHandler () const
virtual const RequestRetryHandler &	GetRequestRetryHandler () const
virtual bool	ShouldComputeContentMd5 () const

Additional Inherited Members
Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void	DumpBodyToUrl (Aws::Http::URI &uri) const

Detailed Description

Represents the request to list users.

See Also:

AWS API Reference

Definition at line 25 of file ListUsersRequest.h.

Constructor & Destructor Documentation

ListUsersRequest()

Aws::CognitoIdentityProvider::Model::ListUsersRequest::ListUsersRequest

(

)

Member Function Documentation

AddAttributesToGet() [1/3]

ListUsersRequest& Aws::CognitoIdentityProvider::Model::ListUsersRequest::AddAttributesToGet ( const Aws::String &  value )

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.

AddAttributesToGet() [2/3]

ListUsersRequest& Aws::CognitoIdentityProvider::Model::ListUsersRequest::AddAttributesToGet ( Aws::String &&  value )

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.

AddAttributesToGet() [3/3]

ListUsersRequest& Aws::CognitoIdentityProvider::Model::ListUsersRequest::AddAttributesToGet ( const char *  value )

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.

AttributesToGetHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::ListUsersRequest::AttributesToGetHasBeenSet ( ) const

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.

FilterHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::ListUsersRequest::FilterHasBeenSet ( ) const

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.

GetAttributesToGet()

const Aws::Vector<Aws::String>& Aws::CognitoIdentityProvider::Model::ListUsersRequest::GetAttributesToGet ( ) const

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.

GetFilter()

const Aws::String& Aws::CognitoIdentityProvider::Model::ListUsersRequest::GetFilter ( ) const

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.

GetLimit()

int Aws::CognitoIdentityProvider::Model::ListUsersRequest::GetLimit ( ) const

inline

Maximum number of users to be returned.

Definition at line 157 of file ListUsersRequest.h.

GetPaginationToken()

const Aws::String& Aws::CognitoIdentityProvider::Model::ListUsersRequest::GetPaginationToken ( ) const

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.

GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::CognitoIdentityProvider::Model::ListUsersRequest::GetRequestSpecificHeaders ( ) const

overridevirtual

Reimplemented from Aws::CognitoIdentityProvider::CognitoIdentityProviderRequest.

GetServiceRequestName()

virtual const char* Aws::CognitoIdentityProvider::Model::ListUsersRequest::GetServiceRequestName ( ) const

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file ListUsersRequest.h.

GetUserPoolId()

const Aws::String& Aws::CognitoIdentityProvider::Model::ListUsersRequest::GetUserPoolId ( ) const

inline

The user pool ID for the user pool on which the search should be performed.

Definition at line 45 of file ListUsersRequest.h.

LimitHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::ListUsersRequest::LimitHasBeenSet ( ) const

inline

Maximum number of users to be returned.

Definition at line 162 of file ListUsersRequest.h.

PaginationTokenHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::ListUsersRequest::PaginationTokenHasBeenSet ( ) const

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.

SerializePayload()

Aws::String Aws::CognitoIdentityProvider::Model::ListUsersRequest::SerializePayload ( ) const

overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

SetAttributesToGet() [1/2]

void Aws::CognitoIdentityProvider::Model::ListUsersRequest::SetAttributesToGet ( const Aws::Vector< Aws::String > &  value )

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.

SetAttributesToGet() [2/2]

void Aws::CognitoIdentityProvider::Model::ListUsersRequest::SetAttributesToGet ( Aws::Vector< Aws::String > &&  value )

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.

SetFilter() [1/3]

void Aws::CognitoIdentityProvider::Model::ListUsersRequest::SetFilter ( const Aws::String &  value )

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.

SetFilter() [2/3]

void Aws::CognitoIdentityProvider::Model::ListUsersRequest::SetFilter ( Aws::String &&  value )

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.

SetFilter() [3/3]

void Aws::CognitoIdentityProvider::Model::ListUsersRequest::SetFilter ( const char *  value )

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.

SetLimit()

void Aws::CognitoIdentityProvider::Model::ListUsersRequest::SetLimit ( int  value )

inline

Maximum number of users to be returned.

Definition at line 167 of file ListUsersRequest.h.

SetPaginationToken() [1/3]

void Aws::CognitoIdentityProvider::Model::ListUsersRequest::SetPaginationToken ( const Aws::String &  value )

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.

SetPaginationToken() [2/3]

void Aws::CognitoIdentityProvider::Model::ListUsersRequest::SetPaginationToken ( Aws::String &&  value )

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.

SetPaginationToken() [3/3]

void Aws::CognitoIdentityProvider::Model::ListUsersRequest::SetPaginationToken ( const char *  value )

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.

SetUserPoolId() [1/3]

void Aws::CognitoIdentityProvider::Model::ListUsersRequest::SetUserPoolId ( const Aws::String &  value )

inline

The user pool ID for the user pool on which the search should be performed.

Definition at line 57 of file ListUsersRequest.h.

SetUserPoolId() [2/3]

void Aws::CognitoIdentityProvider::Model::ListUsersRequest::SetUserPoolId ( Aws::String &&  value )

inline

The user pool ID for the user pool on which the search should be performed.

Definition at line 63 of file ListUsersRequest.h.

SetUserPoolId() [3/3]

void Aws::CognitoIdentityProvider::Model::ListUsersRequest::SetUserPoolId ( const char *  value )

inline

The user pool ID for the user pool on which the search should be performed.

Definition at line 69 of file ListUsersRequest.h.

UserPoolIdHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::ListUsersRequest::UserPoolIdHasBeenSet ( ) const

inline

The user pool ID for the user pool on which the search should be performed.

Definition at line 51 of file ListUsersRequest.h.

WithAttributesToGet() [1/2]

ListUsersRequest& Aws::CognitoIdentityProvider::Model::ListUsersRequest::WithAttributesToGet ( const Aws::Vector< Aws::String > &  value )

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.

WithAttributesToGet() [2/2]

ListUsersRequest& Aws::CognitoIdentityProvider::Model::ListUsersRequest::WithAttributesToGet ( Aws::Vector< Aws::String > &&  value )

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.

WithFilter() [1/3]

ListUsersRequest& Aws::CognitoIdentityProvider::Model::ListUsersRequest::WithFilter ( const Aws::String &  value )

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.

WithFilter() [2/3]

ListUsersRequest& Aws::CognitoIdentityProvider::Model::ListUsersRequest::WithFilter ( Aws::String &&  value )

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.

WithFilter() [3/3]

ListUsersRequest& Aws::CognitoIdentityProvider::Model::ListUsersRequest::WithFilter ( const char *  value )

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.

WithLimit()

ListUsersRequest& Aws::CognitoIdentityProvider::Model::ListUsersRequest::WithLimit ( int  value )

inline

Maximum number of users to be returned.

Definition at line 172 of file ListUsersRequest.h.

WithPaginationToken() [1/3]

ListUsersRequest& Aws::CognitoIdentityProvider::Model::ListUsersRequest::WithPaginationToken ( const Aws::String &  value )

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.

WithPaginationToken() [2/3]

ListUsersRequest& Aws::CognitoIdentityProvider::Model::ListUsersRequest::WithPaginationToken ( Aws::String &&  value )

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.

WithPaginationToken() [3/3]

ListUsersRequest& Aws::CognitoIdentityProvider::Model::ListUsersRequest::WithPaginationToken ( const char *  value )

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.

WithUserPoolId() [1/3]

ListUsersRequest& Aws::CognitoIdentityProvider::Model::ListUsersRequest::WithUserPoolId ( const Aws::String &  value )

inline

The user pool ID for the user pool on which the search should be performed.

Definition at line 75 of file ListUsersRequest.h.

WithUserPoolId() [2/3]

ListUsersRequest& Aws::CognitoIdentityProvider::Model::ListUsersRequest::WithUserPoolId ( Aws::String &&  value )

inline

The user pool ID for the user pool on which the search should be performed.

Definition at line 81 of file ListUsersRequest.h.

WithUserPoolId() [3/3]

ListUsersRequest& Aws::CognitoIdentityProvider::Model::ListUsersRequest::WithUserPoolId ( const char *  value )

inline

The user pool ID for the user pool on which the search should be performed.

Definition at line 87 of file ListUsersRequest.h.

---

The documentation for this class was generated from the following file:

• aws-cpp-sdk-cognito-idp/include/aws/cognito-idp/model/ListUsersRequest.h