- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
ListUsersCommand
Provides summary information about the users for the specified Amazon Connect instance.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { ConnectClient, ListUsersCommand } from "@aws-sdk/client-connect"; // ES Modules import
// const { ConnectClient, ListUsersCommand } = require("@aws-sdk/client-connect"); // CommonJS import
const client = new ConnectClient(config);
const input = { // ListUsersRequest
InstanceId: "STRING_VALUE", // required
NextToken: "STRING_VALUE",
MaxResults: Number("int"),
};
const command = new ListUsersCommand(input);
const response = await client.send(command);
// { // ListUsersResponse
// UserSummaryList: [ // UserSummaryList
// { // UserSummary
// Id: "STRING_VALUE",
// Arn: "STRING_VALUE",
// Username: "STRING_VALUE",
// LastModifiedTime: new Date("TIMESTAMP"),
// LastModifiedRegion: "STRING_VALUE",
// },
// ],
// NextToken: "STRING_VALUE",
// };
ListUsersCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
InstanceIdRequired | string | undefined | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. |
MaxResults | number | undefined | The maximum number of results to return per page. The default MaxResult size is 100. |
NextToken | string | undefined | The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. |
ListUsersCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
NextToken | string | undefined | If there are additional results, this is the token for the next set of results. |
UserSummaryList | UserSummary[] | undefined | Information about the users. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| InternalServiceException | server | Request processing failed because of an error or failure with the service. |
| InvalidParameterException | client | One or more of the specified parameters are not valid. |
| InvalidRequestException | client | The request is not valid. |
| ResourceNotFoundException | client | The specified resource was not found. |
| ThrottlingException | client | The throttling limit has been exceeded. |
| ConnectServiceException | Base exception class for all service exceptions from Connect service. |