Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1483595482.8 KB

Gets information about an existing Amazon Q Business web experience.

get/applications/{applicationId}/experiences/{webExperienceId}

Path parameters

applicationIdstring required

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

webExperienceIdstring required

The identifier of the Amazon Q Business web experience.

Response

Success

applicationIdstring

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

webExperienceIdstring

The identifier of the Amazon Q Business web experience.

webExperienceArnstring

The Amazon Resource Name (ARN) of the role with the permission to access the Amazon Q Business web experience and required resources.

defaultEndpointstring

The endpoint of your Amazon Q Business web experience.

status'CREATING' | 'ACTIVE' | 'DELETING' | 'FAILED' | 'PENDING_AUTH_CONFIG'

The current status of the Amazon Q Business web experience. When the <code>Status</code> field value is <code>FAILED</code>, the <code>ErrorMessage</code> field contains a description of the error that caused the data source connector to fail.

createdAtstring date-time

The Unix timestamp when the Amazon Q Business web experience was last created.

updatedAtstring date-time

The Unix timestamp when the Amazon Q Business web experience was last updated.

titlestring

The title for your Amazon Q Business web experience.

subtitlestring

The subtitle for your Amazon Q Business web experience.

welcomeMessagestring

The customized welcome message for end users of an Amazon Q Business web experience.

samplePromptsControlMode'ENABLED' | 'DISABLED'

Determines whether sample prompts are enabled in the web experience for an end user.

originsOrigin[]

Gets the website domain origins that are allowed to embed the Amazon Q Business web experience. The <i>domain origin</i> refers to the base URL for accessing a website including the protocol (<code>http/https</code>), the domain name, and the port number (if specified).

roleArnstring

The Amazon Resource Name (ARN) of the service role attached to your web experience.