#[non_exhaustive]pub struct CreateWebExperienceInputBuilder { /* private fields */ }Expand description
A builder for CreateWebExperienceInput.
Implementations§
Source§impl CreateWebExperienceInputBuilder
impl CreateWebExperienceInputBuilder
Sourcepub fn application_id(self, input: impl Into<String>) -> Self
pub fn application_id(self, input: impl Into<String>) -> Self
The identifier of the Amazon Q Business web experience.
This field is required.Sourcepub fn set_application_id(self, input: Option<String>) -> Self
pub fn set_application_id(self, input: Option<String>) -> Self
The identifier of the Amazon Q Business web experience.
Sourcepub fn get_application_id(&self) -> &Option<String>
pub fn get_application_id(&self) -> &Option<String>
The identifier of the Amazon Q Business web experience.
Sourcepub fn title(self, input: impl Into<String>) -> Self
pub fn title(self, input: impl Into<String>) -> Self
The title for your Amazon Q Business web experience.
Sourcepub fn set_title(self, input: Option<String>) -> Self
pub fn set_title(self, input: Option<String>) -> Self
The title for your Amazon Q Business web experience.
Sourcepub fn get_title(&self) -> &Option<String>
pub fn get_title(&self) -> &Option<String>
The title for your Amazon Q Business web experience.
Sourcepub fn subtitle(self, input: impl Into<String>) -> Self
pub fn subtitle(self, input: impl Into<String>) -> Self
A subtitle to personalize your Amazon Q Business web experience.
Sourcepub fn set_subtitle(self, input: Option<String>) -> Self
pub fn set_subtitle(self, input: Option<String>) -> Self
A subtitle to personalize your Amazon Q Business web experience.
Sourcepub fn get_subtitle(&self) -> &Option<String>
pub fn get_subtitle(&self) -> &Option<String>
A subtitle to personalize your Amazon Q Business web experience.
Sourcepub fn welcome_message(self, input: impl Into<String>) -> Self
pub fn welcome_message(self, input: impl Into<String>) -> Self
The customized welcome message for end users of an Amazon Q Business web experience.
Sourcepub fn set_welcome_message(self, input: Option<String>) -> Self
pub fn set_welcome_message(self, input: Option<String>) -> Self
The customized welcome message for end users of an Amazon Q Business web experience.
Sourcepub fn get_welcome_message(&self) -> &Option<String>
pub fn get_welcome_message(&self) -> &Option<String>
The customized welcome message for end users of an Amazon Q Business web experience.
Sourcepub fn sample_prompts_control_mode(
self,
input: WebExperienceSamplePromptsControlMode,
) -> Self
pub fn sample_prompts_control_mode( self, input: WebExperienceSamplePromptsControlMode, ) -> Self
Determines whether sample prompts are enabled in the web experience for an end user.
Sourcepub fn set_sample_prompts_control_mode(
self,
input: Option<WebExperienceSamplePromptsControlMode>,
) -> Self
pub fn set_sample_prompts_control_mode( self, input: Option<WebExperienceSamplePromptsControlMode>, ) -> Self
Determines whether sample prompts are enabled in the web experience for an end user.
Sourcepub fn get_sample_prompts_control_mode(
&self,
) -> &Option<WebExperienceSamplePromptsControlMode>
pub fn get_sample_prompts_control_mode( &self, ) -> &Option<WebExperienceSamplePromptsControlMode>
Determines whether sample prompts are enabled in the web experience for an end user.
Sourcepub fn origins(self, input: impl Into<String>) -> Self
pub fn origins(self, input: impl Into<String>) -> Self
Appends an item to origins.
To override the contents of this collection use set_origins.
Sets 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).
You must only submit a base URL and not a full path. For example, https://docs.aws.amazon.com.
Sourcepub fn set_origins(self, input: Option<Vec<String>>) -> Self
pub fn set_origins(self, input: Option<Vec<String>>) -> Self
Sets 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).
You must only submit a base URL and not a full path. For example, https://docs.aws.amazon.com.
Sourcepub fn get_origins(&self) -> &Option<Vec<String>>
pub fn get_origins(&self) -> &Option<Vec<String>>
Sets 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).
You must only submit a base URL and not a full path. For example, https://docs.aws.amazon.com.
Sourcepub fn role_arn(self, input: impl Into<String>) -> Self
pub fn role_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the service role attached to your web experience.
The roleArn parameter is required when your Amazon Q Business application is created with IAM Identity Center. It is not required for SAML-based applications.
Sourcepub fn set_role_arn(self, input: Option<String>) -> Self
pub fn set_role_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the service role attached to your web experience.
The roleArn parameter is required when your Amazon Q Business application is created with IAM Identity Center. It is not required for SAML-based applications.
Sourcepub fn get_role_arn(&self) -> &Option<String>
pub fn get_role_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the service role attached to your web experience.
The roleArn parameter is required when your Amazon Q Business application is created with IAM Identity Center. It is not required for SAML-based applications.
Appends an item to tags.
To override the contents of this collection use set_tags.
A list of key-value pairs that identify or categorize your Amazon Q Business web experience. You can also use tags to help control access to the web experience. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
A list of key-value pairs that identify or categorize your Amazon Q Business web experience. You can also use tags to help control access to the web experience. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
A list of key-value pairs that identify or categorize your Amazon Q Business web experience. You can also use tags to help control access to the web experience. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
Sourcepub fn client_token(self, input: impl Into<String>) -> Self
pub fn client_token(self, input: impl Into<String>) -> Self
A token you provide to identify a request to create an Amazon Q Business web experience.
Sourcepub fn set_client_token(self, input: Option<String>) -> Self
pub fn set_client_token(self, input: Option<String>) -> Self
A token you provide to identify a request to create an Amazon Q Business web experience.
Sourcepub fn get_client_token(&self) -> &Option<String>
pub fn get_client_token(&self) -> &Option<String>
A token you provide to identify a request to create an Amazon Q Business web experience.
Sourcepub fn identity_provider_configuration(
self,
input: IdentityProviderConfiguration,
) -> Self
pub fn identity_provider_configuration( self, input: IdentityProviderConfiguration, ) -> Self
Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
Sourcepub fn set_identity_provider_configuration(
self,
input: Option<IdentityProviderConfiguration>,
) -> Self
pub fn set_identity_provider_configuration( self, input: Option<IdentityProviderConfiguration>, ) -> Self
Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
Sourcepub fn get_identity_provider_configuration(
&self,
) -> &Option<IdentityProviderConfiguration>
pub fn get_identity_provider_configuration( &self, ) -> &Option<IdentityProviderConfiguration>
Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
Sourcepub fn browser_extension_configuration(
self,
input: BrowserExtensionConfiguration,
) -> Self
pub fn browser_extension_configuration( self, input: BrowserExtensionConfiguration, ) -> Self
The browser extension configuration for an Amazon Q Business web experience.
For Amazon Q Business application using external OIDC-compliant identity providers (IdPs). The IdP administrator must add the browser extension sign-in redirect URLs to the IdP application. For more information, see Configure external OIDC identity provider for your browser extensions..
Sourcepub fn set_browser_extension_configuration(
self,
input: Option<BrowserExtensionConfiguration>,
) -> Self
pub fn set_browser_extension_configuration( self, input: Option<BrowserExtensionConfiguration>, ) -> Self
The browser extension configuration for an Amazon Q Business web experience.
For Amazon Q Business application using external OIDC-compliant identity providers (IdPs). The IdP administrator must add the browser extension sign-in redirect URLs to the IdP application. For more information, see Configure external OIDC identity provider for your browser extensions..
Sourcepub fn get_browser_extension_configuration(
&self,
) -> &Option<BrowserExtensionConfiguration>
pub fn get_browser_extension_configuration( &self, ) -> &Option<BrowserExtensionConfiguration>
The browser extension configuration for an Amazon Q Business web experience.
For Amazon Q Business application using external OIDC-compliant identity providers (IdPs). The IdP administrator must add the browser extension sign-in redirect URLs to the IdP application. For more information, see Configure external OIDC identity provider for your browser extensions..
Sourcepub fn customization_configuration(
self,
input: CustomizationConfiguration,
) -> Self
pub fn customization_configuration( self, input: CustomizationConfiguration, ) -> Self
Sets the custom logo, favicon, font, and color used in the Amazon Q web experience.
Sourcepub fn set_customization_configuration(
self,
input: Option<CustomizationConfiguration>,
) -> Self
pub fn set_customization_configuration( self, input: Option<CustomizationConfiguration>, ) -> Self
Sets the custom logo, favicon, font, and color used in the Amazon Q web experience.
Sourcepub fn get_customization_configuration(
&self,
) -> &Option<CustomizationConfiguration>
pub fn get_customization_configuration( &self, ) -> &Option<CustomizationConfiguration>
Sets the custom logo, favicon, font, and color used in the Amazon Q web experience.
Sourcepub fn build(self) -> Result<CreateWebExperienceInput, BuildError>
pub fn build(self) -> Result<CreateWebExperienceInput, BuildError>
Consumes the builder and constructs a CreateWebExperienceInput.
Source§impl CreateWebExperienceInputBuilder
impl CreateWebExperienceInputBuilder
Sourcepub async fn send_with(
self,
client: &Client,
) -> Result<CreateWebExperienceOutput, SdkError<CreateWebExperienceError, HttpResponse>>
pub async fn send_with( self, client: &Client, ) -> Result<CreateWebExperienceOutput, SdkError<CreateWebExperienceError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
Source§impl Clone for CreateWebExperienceInputBuilder
impl Clone for CreateWebExperienceInputBuilder
Source§fn clone(&self) -> CreateWebExperienceInputBuilder
fn clone(&self) -> CreateWebExperienceInputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Default for CreateWebExperienceInputBuilder
impl Default for CreateWebExperienceInputBuilder
Source§fn default() -> CreateWebExperienceInputBuilder
fn default() -> CreateWebExperienceInputBuilder
Source§impl PartialEq for CreateWebExperienceInputBuilder
impl PartialEq for CreateWebExperienceInputBuilder
Source§fn eq(&self, other: &CreateWebExperienceInputBuilder) -> bool
fn eq(&self, other: &CreateWebExperienceInputBuilder) -> bool
self and other values to be equal, and is used by ==.impl StructuralPartialEq for CreateWebExperienceInputBuilder
Auto Trait Implementations§
impl Freeze for CreateWebExperienceInputBuilder
impl RefUnwindSafe for CreateWebExperienceInputBuilder
impl Send for CreateWebExperienceInputBuilder
impl Sync for CreateWebExperienceInputBuilder
impl Unpin for CreateWebExperienceInputBuilder
impl UnwindSafe for CreateWebExperienceInputBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);