Struct aws_sdk_qbusiness::operation::get_web_experience::GetWebExperienceOutput

#[non_exhaustive]
pub struct GetWebExperienceOutput {

    pub application_id: Option<String>,
    pub web_experience_id: Option<String>,
    pub web_experience_arn: Option<String>,
    pub default_endpoint: Option<String>,
    pub status: Option<WebExperienceStatus>,
    pub created_at: Option<DateTime>,
    pub updated_at: Option<DateTime>,
    pub title: Option<String>,
    pub subtitle: Option<String>,
    pub welcome_message: Option<String>,
    pub sample_prompts_control_mode: Option<WebExperienceSamplePromptsControlMode>,
    pub authentication_configuration: Option<WebExperienceAuthConfiguration>,
    pub error: Option<ErrorDetail>,
    /* private fields */
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

application_id: Option<String>

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

web_experience_id: Option<String>

The identifier of the Amazon Q web experience.

web_experience_arn: Option<String>

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

default_endpoint: Option<String>

The endpoint of your Amazon Q web experience.

status: Option<WebExperienceStatus>

The current status of the Amazon Q 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.

created_at: Option<DateTime>

The Unix timestamp when the retriever was created.

updated_at: Option<DateTime>

The Unix timestamp when the data source connector was last updated.

title: Option<String>

The title for your Amazon Q web experience.

subtitle: Option<String>

The subtitle for your Amazon Q web experience.

welcome_message: Option<String>

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

sample_prompts_control_mode: Option<WebExperienceSamplePromptsControlMode>

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

authentication_configuration: Option<WebExperienceAuthConfiguration>

The authentication configuration information for your Amazon Q web experience.

error: Option<ErrorDetail>

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

Implementations

impl GetWebExperienceOutput

pub fn application_id(&self) -> Option<&str>

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

pub fn web_experience_id(&self) -> Option<&str>

The identifier of the Amazon Q web experience.

pub fn web_experience_arn(&self) -> Option<&str>

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

pub fn default_endpoint(&self) -> Option<&str>

The endpoint of your Amazon Q web experience.

pub fn status(&self) -> Option<&WebExperienceStatus>

The current status of the Amazon Q 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.

pub fn created_at(&self) -> Option<&DateTime>

The Unix timestamp when the retriever was created.

pub fn updated_at(&self) -> Option<&DateTime>

The Unix timestamp when the data source connector was last updated.

pub fn title(&self) -> Option<&str>

The title for your Amazon Q web experience.

pub fn subtitle(&self) -> Option<&str>

The subtitle for your Amazon Q web experience.

pub fn welcome_message(&self) -> Option<&str>

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

pub fn sample_prompts_control_mode( &self ) -> Option<&WebExperienceSamplePromptsControlMode>

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

pub fn authentication_configuration( &self ) -> Option<&WebExperienceAuthConfiguration>

The authentication configuration information for your Amazon Q web experience.

pub fn error(&self) -> Option<&ErrorDetail>

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

impl GetWebExperienceOutput

pub fn builder() -> GetWebExperienceOutputBuilder

Creates a new builder-style object to manufacture GetWebExperienceOutput.

Trait Implementations

impl Clone for GetWebExperienceOutput

fn clone(&self) -> GetWebExperienceOutput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetWebExperienceOutput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for GetWebExperienceOutput

fn eq(&self, other: &GetWebExperienceOutput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RequestId for GetWebExperienceOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for GetWebExperienceOutput