- 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.
GetUserCommand
Describes the universally unique identifier (UUID) associated with a local user in a data source.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { QBusinessClient, GetUserCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import
// const { QBusinessClient, GetUserCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import
const client = new QBusinessClient(config);
const input = { // GetUserRequest
applicationId: "STRING_VALUE", // required
userId: "STRING_VALUE", // required
};
const command = new GetUserCommand(input);
const response = await client.send(command);
// { // GetUserResponse
// userAliases: [ // UserAliases
// { // UserAlias
// indexId: "STRING_VALUE",
// dataSourceId: "STRING_VALUE",
// userId: "STRING_VALUE", // required
// },
// ],
// };
GetUserCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
applicationIdRequired | string | undefined | The identifier of the application connected to the user. |
userIdRequired | string | undefined | The user email address attached to the user. |
GetUserCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
userAliases | UserAlias[] | undefined | A list of user aliases attached to a user. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| AccessDeniedException | client | You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again. |
| ConflictException | client | You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again. |
| InternalServerException | server | An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help. |
| ResourceNotFoundException | client | The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again. |
| ThrottlingException | client | The request was denied due to throttling. Reduce the number of requests and try again. |
| ValidationException | client | The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again. |
| QBusinessServiceException | Base exception class for all service exceptions from QBusiness service. |