ListUsersRequest

public struct ListUsersRequest : AWSShape
extension CognitoIdentityProvider.ListUsersRequest: AWSPaginateStringToken

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • 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.

    Declaration

    Swift

    public let attributesToGet: [String]?

  • A filter string of the form “AttributeName Filter-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 and Examples of Using the ListUsers API in the Amazon Cognito Developer Guide.

    Declaration

    Swift

    public let filter: String?

  • Maximum number of users to be returned.

    Declaration

    Swift

    public let limit: Int?

  • 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.

    Declaration

    Swift

    public let paginationToken: String?

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

    Declaration

    Swift

    public let userPoolId: String

  • Undocumented

    Declaration

    Swift

    public init(attributesToGet: [String]? = nil, filter: String? = nil, limit: Int? = nil, paginationToken: String? = nil, userPoolId: String)

  • Declaration

    Swift

    public func validate(name: String) throws

Paginators