Skip to content

create_web_experience

Operation

create_web_experience

create_web_experience(request: CreateWebExperienceInput | CreateWebExperienceInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateWebExperienceInputDict]) -> CreateWebExperienceOutput

Creates an Amazon Q Business web experience.

Parameters:

Name Type Description Default
request CreateWebExperienceInput | CreateWebExperienceInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[CreateWebExperienceInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateWebExperienceOutput

An instance of CreateWebExperienceOutput.

create_web_experience async

create_web_experience(request: CreateWebExperienceInput | CreateWebExperienceInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateWebExperienceInputDict]) -> CreateWebExperienceOutput

Creates an Amazon Q Business web experience.

Parameters:

Name Type Description Default
request CreateWebExperienceInput | CreateWebExperienceInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[CreateWebExperienceInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateWebExperienceOutput

An instance of CreateWebExperienceOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

CreateWebExperienceInputDict

Bases: TypedDict

Dictionary form of CreateWebExperienceInput.

Attributes

application_id instance-attribute
application_id: Required[str]

The identifier of the Amazon Q Business web experience.

browser_extension_configuration instance-attribute
browser_extension_configuration: BrowserExtensionConfiguration | BrowserExtensionConfigurationDict | None

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

Note

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

client_token instance-attribute
client_token: str | None

A token you provide to identify a request to create an Amazon Q Business web experience.

This field is autopopulated if not provided.

customization_configuration instance-attribute
customization_configuration: CustomizationConfiguration | CustomizationConfigurationDict | None

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

identity_provider_configuration instance-attribute
identity_provider_configuration: IdentityProviderConfiguration | IdentityProviderConfigurationDict | None

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

origins instance-attribute
origins: Sequence[str] | None

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

Note

You must only submit a base URL and not a full path. For example, https://docs.aws.amazon.com.

role_arn instance-attribute
role_arn: str | None

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

Note

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.

sample_prompts_control_mode instance-attribute
sample_prompts_control_mode: str | None

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

subtitle instance-attribute
subtitle: str | None

A subtitle to personalize your Amazon Q Business web experience.

tags instance-attribute
tags: Sequence[Tag | TagDict] | None

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: _ . : / = + - @.

title instance-attribute
title: str | None

The title for your Amazon Q Business web experience.

welcome_message instance-attribute
welcome_message: str | None

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

CreateWebExperienceInput dataclass

Bases: _SerdeShape

Dataclass for CreateWebExperienceInput structure.

Attributes

application_id class-attribute instance-attribute
application_id: str | None = ...

The identifier of the Amazon Q Business web experience.

browser_extension_configuration class-attribute instance-attribute
browser_extension_configuration: BrowserExtensionConfiguration | None = ...

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

Note

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

client_token class-attribute instance-attribute
client_token: str | None = ...

A token you provide to identify a request to create an Amazon Q Business web experience.

This field is autopopulated if not provided.

customization_configuration class-attribute instance-attribute
customization_configuration: CustomizationConfiguration | None = ...

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

identity_provider_configuration class-attribute instance-attribute
identity_provider_configuration: IdentityProviderConfiguration | None = ...

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

origins class-attribute instance-attribute
origins: list[str] | None = ...

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

Note

You must only submit a base URL and not a full path. For example, https://docs.aws.amazon.com.

role_arn class-attribute instance-attribute
role_arn: str | None = ...

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

Note

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.

sample_prompts_control_mode class-attribute instance-attribute
sample_prompts_control_mode: str | None = ...

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

subtitle class-attribute instance-attribute
subtitle: str | None = ...

A subtitle to personalize your Amazon Q Business web experience.

tags class-attribute instance-attribute
tags: list[Tag] | None = ...

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: _ . : / = + - @.

title class-attribute instance-attribute
title: str | None = ...

The title for your Amazon Q Business web experience.

welcome_message class-attribute instance-attribute
welcome_message: str | None = ...

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

Output

CreateWebExperienceOutput dataclass

Bases: _SerdeShape

Dataclass for CreateWebExperienceOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

web_experience_arn class-attribute instance-attribute
web_experience_arn: str | None = ...

The Amazon Resource Name (ARN) of an Amazon Q Business web experience.

web_experience_id class-attribute instance-attribute
web_experience_id: str | None = ...

The identifier of the Amazon Q Business web experience.