- 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.
ListUserProficienciesCommand
Lists proficiencies associated with a user.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { ConnectClient, ListUserProficienciesCommand } from "@aws-sdk/client-connect"; // ES Modules import
// const { ConnectClient, ListUserProficienciesCommand } = require("@aws-sdk/client-connect"); // CommonJS import
const client = new ConnectClient(config);
const input = { // ListUserProficienciesRequest
InstanceId: "STRING_VALUE", // required
UserId: "STRING_VALUE", // required
NextToken: "STRING_VALUE",
MaxResults: Number("int"),
};
const command = new ListUserProficienciesCommand(input);
const response = await client.send(command);
// { // ListUserProficienciesResponse
// NextToken: "STRING_VALUE",
// UserProficiencyList: [ // UserProficiencyList
// { // UserProficiency
// AttributeName: "STRING_VALUE", // required
// AttributeValue: "STRING_VALUE", // required
// Level: Number("float"), // required
// },
// ],
// LastModifiedTime: new Date("TIMESTAMP"),
// LastModifiedRegion: "STRING_VALUE",
// };
ListUserProficienciesCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
InstanceId Required | string | undefined | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. |
UserId Required | string | undefined | The identifier of the user account. |
MaxResults | number | undefined | The maximum number of results to return per page. |
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. |
ListUserProficienciesCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
LastModifiedRegion | string | undefined | The region in which a user's proficiencies were last modified. |
LastModifiedTime | Date | undefined | The last time that the user's proficiencies are were modified. |
NextToken | string | undefined | If there are additional results, this is the token for the next set of results. |
UserProficiencyList | UserProficiency[] | undefined | Information about the user proficiencies. |
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. |