- 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.
GetQAppSessionMetadataCommand
Retrieves the current configuration of a Q App session.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { QAppsClient, GetQAppSessionMetadataCommand } from "@aws-sdk/client-qapps"; // ES Modules import
// const { QAppsClient, GetQAppSessionMetadataCommand } = require("@aws-sdk/client-qapps"); // CommonJS import
const client = new QAppsClient(config);
const input = { // GetQAppSessionMetadataInput
instanceId: "STRING_VALUE", // required
sessionId: "STRING_VALUE", // required
};
const command = new GetQAppSessionMetadataCommand(input);
const response = await client.send(command);
// { // GetQAppSessionMetadataOutput
// sessionId: "STRING_VALUE", // required
// sessionArn: "STRING_VALUE", // required
// sessionName: "STRING_VALUE",
// sharingConfiguration: { // SessionSharingConfiguration
// enabled: true || false, // required
// acceptResponses: true || false,
// revealCards: true || false,
// },
// sessionOwner: true || false,
// };
Example Usage
GetQAppSessionMetadataCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
instanceIdRequired | string | undefined | The unique identifier of the Amazon Q Business application environment instance. |
sessionIdRequired | string | undefined | The unique identifier of the Q App session. |
GetQAppSessionMetadataCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
sessionArnRequired | string | undefined | The Amazon Resource Name (ARN) of the Q App session. |
sessionIdRequired | string | undefined | The unique identifier of the Q App session. |
sharingConfigurationRequired | SessionSharingConfiguration | undefined | The sharing configuration of the Q App data collection session. |
sessionName | string | undefined | The name of the Q App session. |
sessionOwner | boolean | undefined | Indicates whether the current user is the owner of the Q App session. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| AccessDeniedException | client | The client is not authorized to perform the requested operation. |
| InternalServerException | server | An internal service error occurred while processing the request. |
| ResourceNotFoundException | client | The requested resource could not be found. |
| ServiceQuotaExceededException | client | The requested operation could not be completed because it would exceed the service's quota or limit. |
| ThrottlingException | client | The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later. |
| UnauthorizedException | client | The client is not authenticated or authorized to perform the requested operation. |
| ValidationException | client | The input failed to satisfy the constraints specified by the service. |
| QAppsServiceException | Base exception class for all service exceptions from QApps service. |