Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

UpdateQAppSessionMetadata - Amazon Q Business

UpdateQAppSessionMetadata

Updates the configuration metadata of a session for a given Q App sessionId.

Request Syntax

POST /runtime.updateQAppSessionMetadata HTTP/1.1 instance-id: instanceId Content-type: application/json { "sessionId": "string", "sessionName": "string", "sharingConfiguration": { "acceptResponses": boolean, "enabled": boolean, "revealCards": boolean } }

URI Request Parameters

The request uses the following URI parameters.

instanceId

The unique identifier of the Amazon Q Business application environment instance.

Required: Yes

Request Body

The request accepts the following data in JSON format.

sessionId

The unique identifier of the Q App session to update configuration for.

Type: String

Pattern: [\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}

Required: Yes

sessionName

The new name for the Q App session.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 100.

Required: No

sharingConfiguration

The new sharing configuration for the Q App data collection session.

Type: SessionSharingConfiguration object

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "sessionArn": "string", "sessionId": "string", "sessionName": "string", "sharingConfiguration": { "acceptResponses": boolean, "enabled": boolean, "revealCards": boolean } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

sessionArn

The Amazon Resource Name (ARN) of the updated Q App session.

Type: String

sessionId

The unique identifier of the updated Q App session.

Type: String

Pattern: [\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}

sessionName

The new name of the updated Q App session.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 100.

sharingConfiguration

The new sharing configuration of the updated Q App data collection session.

Type: SessionSharingConfiguration object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The client is not authorized to perform the requested operation.

HTTP Status Code: 403

InternalServerException

An internal service error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource could not be found.

HTTP Status Code: 404

ServiceQuotaExceededException

The requested operation could not be completed because it would exceed the service's quota or limit.

HTTP Status Code: 402

ThrottlingException

The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.

HTTP Status Code: 429

UnauthorizedException

The client is not authenticated or authorized to perform the requested operation.

HTTP Status Code: 401

ValidationException

The input failed to satisfy the constraints specified by the service.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

PrivacySite termsCookie preferences
© 2025, Amazon Web Services, Inc. or its affiliates. All rights reserved.