DescribeUsersCommand

Suggest an Edit

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { AppStreamClient, DescribeUsersCommand } from "@aws-sdk/client-appstream"; // ES Modules import
// const { AppStreamClient, DescribeUsersCommand } = require("@aws-sdk/client-appstream"); // CommonJS import
const client = new AppStreamClient(config);
const input = { // DescribeUsersRequest
  AuthenticationType: "API" || "SAML" || "USERPOOL" || "AWS_AD", // required
  MaxResults: Number("int"),
  NextToken: "STRING_VALUE",
};
const command = new DescribeUsersCommand(input);
const response = await client.send(command);
// { // DescribeUsersResult
//   Users: [ // UserList
//     { // User
//       Arn: "STRING_VALUE",
//       UserName: "STRING_VALUE",
//       Enabled: true || false,
//       Status: "STRING_VALUE",
//       FirstName: "STRING_VALUE",
//       LastName: "STRING_VALUE",
//       CreatedTime: new Date("TIMESTAMP"),
//       AuthenticationType: "API" || "SAML" || "USERPOOL" || "AWS_AD", // required
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

DescribeUsersCommand Input

See DescribeUsersCommandInput for more details

Parameter
Type
Description
AuthenticationType
Required
AuthenticationType | undefined

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

MaxResults
number | undefined

The maximum size of each page of results.

NextToken
string | undefined

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.

DescribeUsersCommand Output

See DescribeUsersCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
NextToken
string | undefined

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.

Users
User[] | undefined

Information about users in the user pool.

Throws

Name
Fault
Details
InvalidParameterCombinationException
client

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

OperationNotPermittedException
client

The attempted operation is not permitted.

ResourceNotFoundException
client

The specified resource was not found.

AppStreamServiceException
Base exception class for all service exceptions from AppStream service.