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

GetWebExperience

Gets information about an existing Amazon Q Business web experience.

Request Syntax


GET /applications/applicationId/experiences/webExperienceId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

applicationId

The identifier of the Amazon Q Business application linked 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 Amazon Q Business web experience.

Length Constraints: Fixed length of 36.

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "applicationId": "string",
   "authenticationConfiguration": { ... },
   "createdAt": number,
   "defaultEndpoint": "string",
   "error": { 
      "errorCode": "string",
      "errorMessage": "string"
   },
   "identityProviderConfiguration": { ... },
   "origins": [ "string" ],
   "roleArn": "string",
   "samplePromptsControlMode": "string",
   "status": "string",
   "subtitle": "string",
   "title": "string",
   "updatedAt": number,
   "webExperienceArn": "string",
   "webExperienceId": "string",
   "welcomeMessage": "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.

applicationId

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

Type: String

Length Constraints: Fixed length of 36.

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

authenticationConfiguration

This parameter has been deprecated.

The authentication configuration information for your Amazon Q Business web experience.

Type: WebExperienceAuthConfiguration object

Note: This object is a Union. Only one member of this object can be specified or returned.

createdAt

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

Type: Timestamp

defaultEndpoint

The endpoint of your Amazon Q Business web experience.

Type: String

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

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

error

When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.

Type: ErrorDetail object

identityProviderConfiguration

Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.

Type: IdentityProviderConfiguration object

Note: This object is a Union. Only one member of this object can be specified or returned.

origins

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

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 10 items.

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

Pattern: (http://|https://)[a-zA-Z0-9-_.]+(?::[0-9]{1,5})?

roleArn

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

Type: String

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

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

samplePromptsControlMode

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

Type: String

Valid Values: ENABLED | DISABLED

status

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

Type: String

Valid Values: CREATING | ACTIVE | DELETING | FAILED | PENDING_AUTH_CONFIG

subtitle

The subtitle for your Amazon Q Business web experience.

Type: String

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

Pattern: \P{C}*

title

The title for your Amazon Q Business web experience.

Type: String

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

Pattern: \P{C}*

updatedAt

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

Type: Timestamp

webExperienceArn

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

Type: String

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

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

webExperienceId

The identifier of the Amazon Q Business web experience.

Type: String

Length Constraints: Fixed length of 36.

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

welcomeMessage

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

Type: String

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

Errors

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

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 resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

HTTP Status Code: 404

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.

HTTP Status Code: 400