Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeUsers

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

Request Syntax


{
   "AuthenticationType": "string",
   "MaxResults": number,
   "NextToken": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

AuthenticationType

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

Type: String

Valid Values: API | SAML | USERPOOL | AWS_AD

Required: Yes

MaxResults

The maximum size of each page of results.

Type: Integer

Required: No

NextToken

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.

Type: String

Length Constraints: Minimum length of 1.

Required: No

Response Syntax


{
   "NextToken": "string",
   "Users": [ 
      { 
         "Arn": "string",
         "AuthenticationType": "string",
         "CreatedTime": number,
         "Enabled": boolean,
         "FirstName": "string",
         "LastName": "string",
         "Status": "string",
         "UserName": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

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.

Type: String

Length Constraints: Minimum length of 1.

Users

Information about users in the user pool.

Type: Array of User objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidParameterCombinationException

Indicates an incorrect combination of parameters, or a missing parameter.

HTTP Status Code: 400

OperationNotPermittedException

The attempted operation is not permitted.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 400