Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateAnonymousWebExperienceUrl

Note

Amazon Q Business will no longer be open to new customers starting on July 31, 2026. If you would like to use the service, please sign up prior to July 30. For capabilities similar to Q Business, explore Amazon Quick. Learn more.

Creates a unique URL for anonymous Amazon Q Business web experience. This URL can only be used once and must be used within 5 minutes after it's generated.

Request Syntax


POST /applications/applicationId/experiences/webExperienceId/anonymous-url HTTP/1.1
Content-type: application/json

{
   "sessionDurationInMinutes": number
}

URI Request Parameters

The request uses the following URI parameters.

applicationId

The identifier of the Amazon Q Business application environment attached to the web experience.

Length Constraints: Fixed length of 36.

Pattern: [a-zA-Z0-9][a-zA-Z0-9-]{35}

Required: Yes

webExperienceId

The identifier of the web experience.

Length Constraints: Fixed length of 36.

Pattern: [a-zA-Z0-9][a-zA-Z0-9-]*

Required: Yes

Request Body

The request accepts the following data in JSON format.

sessionDurationInMinutes

The duration of the session associated with the unique URL for the web experience.

Type: Integer

Valid Range: Minimum value of 15. Maximum value of 60.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "anonymousUrl": "string"
}

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.

anonymousUrl

The unique URL for accessing the web experience.

Important

This URL can only be used once and must be used within 5 minutes after it's generated.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: (https?|ftp|file)://([^\s]*)

Errors

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

AccessDeniedException

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

HTTP Status Code: 403

InternalServerException

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.

HTTP Status Code: 500

ResourceNotFoundException

The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

message: The message describing a ResourceNotFoundException.
resourceId: The identifier of the resource affected.
resourceType: The type of the resource affected.

HTTP Status Code: 404

ServiceQuotaExceededException

You have exceeded the set limits for your Amazon Q Business service.

message: The message describing a ServiceQuotaExceededException.
resourceId: The identifier of the resource affected.
resourceType: The type of the resource affected.

HTTP Status Code: 402

ThrottlingException

The request was denied due to throttling. Reduce the number of requests and try again.

HTTP Status Code: 429

ValidationException

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

fields: The input field(s) that failed validation.
message: The message describing the ValidationException.
reason: The reason for the ValidationException.

HTTP Status Code: 400