Module Values.GetWebExperienceResponseSource

Gets information about an existing Amazon Q Business web experience.

Sourcetype nonrec t = {
  1. applicationId : ApplicationId.t option;
    (*

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

    *)
  2. webExperienceId : WebExperienceId.t option;
    (*

    The identifier of the Amazon Q Business web experience.

    *)
  3. webExperienceArn : WebExperienceArn.t option;
    (*

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

    *)
  4. defaultEndpoint : Url.t option;
    (*

    The endpoint of your Amazon Q Business web experience.

    *)
  5. status : WebExperienceStatus.t option;
    (*

    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.

    *)
  6. createdAt : Timestamp.t option;
    (*

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

    *)
  7. updatedAt : Timestamp.t option;
    (*

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

    *)
  8. title : WebExperienceTitle.t option;
    (*

    The title for your Amazon Q Business web experience.

    *)
  9. subtitle : WebExperienceSubtitle.t option;
    (*

    The subtitle for your Amazon Q Business web experience.

    *)
  10. welcomeMessage : WebExperienceWelcomeMessage.t option;
    (*

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

    *)
  11. samplePromptsControlMode : WebExperienceSamplePromptsControlMode.t option;
    (*

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

    *)
  12. origins : WebExperienceOrigins.t option;
    (*

    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).

    *)
  13. roleArn : RoleArn.t option;
    (*

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

    *)
  14. identityProviderConfiguration : IdentityProviderConfiguration.t option;
    (*

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

    *)
  15. authenticationConfiguration : WebExperienceAuthConfiguration.t option;
    (*

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

    *)
  16. error : ErrorDetail.t option;
    (*

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

    *)
  17. browserExtensionConfiguration : BrowserExtensionConfiguration.t option;
    (*

    The browser extension configuration for an Amazon Q Business web experience.

    *)
  18. customizationConfiguration : CustomizationConfiguration.t option;
    (*

    Gets the custom logo, favicon, font, and color used in the Amazon Q web experience.

    *)
}
Sourcetype nonrec error = [
  1. | `AccessDeniedException of AccessDeniedException.t
  2. | `InternalServerException of InternalServerException.t
  3. | `ResourceNotFoundException of ResourceNotFoundException.t
  4. | `ThrottlingException of ThrottlingException.t
  5. | `ValidationException of ValidationException.t
  6. | `Unknown_operation_error of string * string option
]
Sourceval make : ?applicationId:??? -> ?webExperienceId:??? -> ?webExperienceArn:??? -> ?defaultEndpoint:??? -> ?status:??? -> ?createdAt:??? -> ?updatedAt:??? -> ?title:??? -> ?subtitle:??? -> ?welcomeMessage:??? -> ?samplePromptsControlMode:??? -> ?origins:??? -> ?roleArn:??? -> ?identityProviderConfiguration:??? -> ?authenticationConfiguration:??? -> ?error:??? -> ?browserExtensionConfiguration:??? -> ?customizationConfiguration:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `AccessDeniedException of AccessDeniedException.t | `InternalServerException of InternalServerException.t | `ResourceNotFoundException of ResourceNotFoundException.t | `ThrottlingException of ThrottlingException.t | `Unknown_operation_error of string * string option | `ValidationException of ValidationException.t ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `AccessDeniedException of AccessDeniedException.t | `InternalServerException of InternalServerException.t | `ResourceNotFoundException of ResourceNotFoundException.t | `ThrottlingException of ThrottlingException.t | `Unknown_operation_error of string * string option | `ValidationException of ValidationException.t ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `List of [> `String of Origin.t ] list | `String of ApplicationId.t | `Structure of (string * [> `Enum of string | `List of [> `Enum of string ] list | `String of ErrorMessage.t | `Structure of (string * [> `String of SamlAuthenticationUrl.t ]) list ]) list | `Timestamp of Timestamp.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t