v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1465286243.1 KB

Retrieves a list that describes one or more specified users in the user pool.

post/#X-Amz-Target=PhotonAdminProxyService.DescribeUsers

Headers

X-Amz-Target'PhotonAdminProxyService.DescribeUsers' required

Request body

AuthenticationType'API' | 'SAML' | 'USERPOOL' | 'AWS_AD' required

The authentication type for the users in the user pool to describe. You must specify USERPOOL.

MaxResultsinteger

The maximum size of each page of results.

NextTokenstring

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Response

Success

NextTokenstring

The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.