AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

ListUsersInput

import "github.com/aws/aws-sdk-go/service/cognitoidentityprovider"

type ListUsersInput struct { AttributesToGet []*string `type:"list"` Filter *string `type:"string"` Limit *int64 `type:"integer"` PaginationToken *string `min:"1" type:"string"` UserPoolId *string `min:"1" type:"string" required:"true"` }

Represents the request to list users.

AttributesToGet

Type: []*string

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.

Filter

Type: *string

A filter string of the form "AttributeNameFilter-Type "AttributeValue"". Quotation marks within the filter string must be escaped using the backslash (\) character. For example, "family_name = \"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, "given_name = \"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 (https://docs.aws.amazon.com/cognito/latest/developerguide/how-to-manage-user-accounts.html#cognito-user-pools-searching-for-users-using-listusers-api) and Examples of Using the ListUsers API (https://docs.aws.amazon.com/cognito/latest/developerguide/how-to-manage-user-accounts.html#cognito-user-pools-searching-for-users-listusers-api-examples) in the Amazon Cognito Developer Guide.

Limit

Type: *int64

Maximum number of users to be returned.

PaginationToken

Type: *string

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.

UserPoolId

Type: *string

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

UserPoolId is a required field

Method

GoString

func (s ListUsersInput) GoString() string

GoString returns the string representation

SetAttributesToGet

func (s *ListUsersInput) SetAttributesToGet(v []*string) *ListUsersInput

SetAttributesToGet sets the AttributesToGet field's value.

SetFilter

func (s *ListUsersInput) SetFilter(v string) *ListUsersInput

SetFilter sets the Filter field's value.

SetLimit

func (s *ListUsersInput) SetLimit(v int64) *ListUsersInput

SetLimit sets the Limit field's value.

SetPaginationToken

func (s *ListUsersInput) SetPaginationToken(v string) *ListUsersInput

SetPaginationToken sets the PaginationToken field's value.

SetUserPoolId

func (s *ListUsersInput) SetUserPoolId(v string) *ListUsersInput

SetUserPoolId sets the UserPoolId field's value.

String

func (s ListUsersInput) String() string

String returns the string representation

Validate

func (s *ListUsersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: