aws-native.qbusiness.getWebExperience

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

Using getWebExperience

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getWebExperience(args: GetWebExperienceArgs, opts?: InvokeOptions): Promise<GetWebExperienceResult>
function getWebExperienceOutput(args: GetWebExperienceOutputArgs, opts?: InvokeOptions): Output<GetWebExperienceResult>

def get_web_experience(application_id: Optional[str] = None,
                       web_experience_id: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetWebExperienceResult
def get_web_experience_output(application_id: Optional[pulumi.Input[str]] = None,
                       web_experience_id: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetWebExperienceResult]

func LookupWebExperience(ctx *Context, args *LookupWebExperienceArgs, opts ...InvokeOption) (*LookupWebExperienceResult, error)
func LookupWebExperienceOutput(ctx *Context, args *LookupWebExperienceOutputArgs, opts ...InvokeOption) LookupWebExperienceResultOutput

> Note: This function is named LookupWebExperience in the Go SDK.

public static class GetWebExperience 
{
    public static Task<GetWebExperienceResult> InvokeAsync(GetWebExperienceArgs args, InvokeOptions? opts = null)
    public static Output<GetWebExperienceResult> Invoke(GetWebExperienceInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetWebExperienceResult> getWebExperience(GetWebExperienceArgs args, InvokeOptions options)
public static Output<GetWebExperienceResult> getWebExperience(GetWebExperienceArgs args, InvokeOptions options)

fn::invoke:
  function: aws-native:qbusiness:getWebExperience
  arguments:
    # arguments dictionary

The following arguments are supported:

ApplicationId string: The identifier of the Amazon Q Business web experience.
WebExperienceId string: The identifier of your Amazon Q Business web experience.

ApplicationId string: The identifier of the Amazon Q Business web experience.
WebExperienceId string: The identifier of your Amazon Q Business web experience.

applicationId String: The identifier of the Amazon Q Business web experience.
webExperienceId String: The identifier of your Amazon Q Business web experience.

applicationId string: The identifier of the Amazon Q Business web experience.
webExperienceId string: The identifier of your Amazon Q Business web experience.

application_id str: The identifier of the Amazon Q Business web experience.
web_experience_id str: The identifier of your Amazon Q Business web experience.

applicationId String: The identifier of the Amazon Q Business web experience.
webExperienceId String: The identifier of your Amazon Q Business web experience.

getWebExperience Result

The following output properties are available:

BrowserExtensionConfiguration Pulumi.AwsNative.QBusiness.Outputs.WebExperienceBrowserExtensionConfiguration: The container for browser extension configuration for an Amazon Q Business web experience.
CreatedAt string: The Unix timestamp when the Amazon Q Business application was last updated.
CustomizationConfiguration Pulumi.AwsNative.QBusiness.Outputs.WebExperienceCustomizationConfiguration: Contains the configuration information to customize the logo, font, and color of an Amazon Q Business web experience with individual files for each property or a CSS file for them all.
DefaultEndpoint string: The endpoint URLs for your Amazon Q Business web experience. The URLs are unique and fully hosted by AWS .
IdentityProviderConfiguration Pulumi.AwsNative.QBusiness.Outputs.WebExperienceIdentityProviderConfiguration0Properties | Pulumi.AwsNative.QBusiness.Outputs.WebExperienceIdentityProviderConfiguration1Properties: Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
Origins List<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 .
RoleArn string: The Amazon Resource Name (ARN) of the service role attached to your web experience.
You must provide this value if you're using IAM Identity Center to manage end user access to your application. If you're using legacy identity management to manage user access, you don't need to provide this value.
SamplePromptsControlMode Pulumi.AwsNative.QBusiness.WebExperienceSamplePromptsControlMode: Determines whether sample prompts are enabled in the web experience for an end user.
Status Pulumi.AwsNative.QBusiness.WebExperienceStatus: The status of your Amazon Q Business web experience.
Subtitle string: A subtitle to personalize your Amazon Q Business web experience.
Tags List<Pulumi.AwsNative.Outputs.Tag>: 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 string: The title for your Amazon Q Business web experience.
UpdatedAt string: The Unix timestamp when your Amazon Q Business web experience was updated.
WebExperienceArn string: The Amazon Resource Name (ARN) of an Amazon Q Business web experience.
WebExperienceId string: The identifier of your Amazon Q Business web experience.
WelcomeMessage string: A message in an Amazon Q Business web experience.

BrowserExtensionConfiguration WebExperienceBrowserExtensionConfiguration: The container for browser extension configuration for an Amazon Q Business web experience.
CreatedAt string: The Unix timestamp when the Amazon Q Business application was last updated.
CustomizationConfiguration WebExperienceCustomizationConfiguration: Contains the configuration information to customize the logo, font, and color of an Amazon Q Business web experience with individual files for each property or a CSS file for them all.
DefaultEndpoint string: The endpoint URLs for your Amazon Q Business web experience. The URLs are unique and fully hosted by AWS .
IdentityProviderConfiguration WebExperienceIdentityProviderConfiguration0Properties | WebExperienceIdentityProviderConfiguration1Properties: Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
Origins []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 .
RoleArn string: The Amazon Resource Name (ARN) of the service role attached to your web experience.
You must provide this value if you're using IAM Identity Center to manage end user access to your application. If you're using legacy identity management to manage user access, you don't need to provide this value.
SamplePromptsControlMode WebExperienceSamplePromptsControlMode: Determines whether sample prompts are enabled in the web experience for an end user.
Status WebExperienceStatus: The status of your Amazon Q Business web experience.
Subtitle string: A subtitle to personalize your Amazon Q Business web experience.
Tags Tag: 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 string: The title for your Amazon Q Business web experience.
UpdatedAt string: The Unix timestamp when your Amazon Q Business web experience was updated.
WebExperienceArn string: The Amazon Resource Name (ARN) of an Amazon Q Business web experience.
WebExperienceId string: The identifier of your Amazon Q Business web experience.
WelcomeMessage string: A message in an Amazon Q Business web experience.

browserExtensionConfiguration WebExperienceBrowserExtensionConfiguration: The container for browser extension configuration for an Amazon Q Business web experience.
createdAt String: The Unix timestamp when the Amazon Q Business application was last updated.
customizationConfiguration WebExperienceCustomizationConfiguration: Contains the configuration information to customize the logo, font, and color of an Amazon Q Business web experience with individual files for each property or a CSS file for them all.
defaultEndpoint String: The endpoint URLs for your Amazon Q Business web experience. The URLs are unique and fully hosted by AWS .
identityProviderConfiguration WebExperienceIdentityProviderConfiguration0Properties | WebExperienceIdentityProviderConfiguration1Properties: Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
origins List<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 .
roleArn String: The Amazon Resource Name (ARN) of the service role attached to your web experience.
You must provide this value if you're using IAM Identity Center to manage end user access to your application. If you're using legacy identity management to manage user access, you don't need to provide this value.
samplePromptsControlMode WebExperienceSamplePromptsControlMode: Determines whether sample prompts are enabled in the web experience for an end user.
status WebExperienceStatus: The status of your Amazon Q Business web experience.
subtitle String: A subtitle to personalize your Amazon Q Business web experience.
tags List<Tag>: 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 String: The title for your Amazon Q Business web experience.
updatedAt String: The Unix timestamp when your Amazon Q Business web experience was updated.
webExperienceArn String: The Amazon Resource Name (ARN) of an Amazon Q Business web experience.
webExperienceId String: The identifier of your Amazon Q Business web experience.
welcomeMessage String: A message in an Amazon Q Business web experience.

browserExtensionConfiguration WebExperienceBrowserExtensionConfiguration: The container for browser extension configuration for an Amazon Q Business web experience.
createdAt string: The Unix timestamp when the Amazon Q Business application was last updated.
customizationConfiguration WebExperienceCustomizationConfiguration: Contains the configuration information to customize the logo, font, and color of an Amazon Q Business web experience with individual files for each property or a CSS file for them all.
defaultEndpoint string: The endpoint URLs for your Amazon Q Business web experience. The URLs are unique and fully hosted by AWS .
identityProviderConfiguration WebExperienceIdentityProviderConfiguration0Properties | WebExperienceIdentityProviderConfiguration1Properties: Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
origins 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 .
roleArn string: The Amazon Resource Name (ARN) of the service role attached to your web experience.
You must provide this value if you're using IAM Identity Center to manage end user access to your application. If you're using legacy identity management to manage user access, you don't need to provide this value.
samplePromptsControlMode WebExperienceSamplePromptsControlMode: Determines whether sample prompts are enabled in the web experience for an end user.
status WebExperienceStatus: The status of your Amazon Q Business web experience.
subtitle string: A subtitle to personalize your Amazon Q Business web experience.
tags Tag[]: 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 string: The title for your Amazon Q Business web experience.
updatedAt string: The Unix timestamp when your Amazon Q Business web experience was updated.
webExperienceArn string: The Amazon Resource Name (ARN) of an Amazon Q Business web experience.
webExperienceId string: The identifier of your Amazon Q Business web experience.
welcomeMessage string: A message in an Amazon Q Business web experience.

browser_extension_configuration WebExperienceBrowserExtensionConfiguration: The container for browser extension configuration for an Amazon Q Business web experience.
created_at str: The Unix timestamp when the Amazon Q Business application was last updated.
customization_configuration WebExperienceCustomizationConfiguration: Contains the configuration information to customize the logo, font, and color of an Amazon Q Business web experience with individual files for each property or a CSS file for them all.
default_endpoint str: The endpoint URLs for your Amazon Q Business web experience. The URLs are unique and fully hosted by AWS .
identity_provider_configuration WebExperienceIdentityProviderConfiguration0Properties | WebExperienceIdentityProviderConfiguration1Properties: Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
origins Sequence[str]: 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 .
role_arn str: The Amazon Resource Name (ARN) of the service role attached to your web experience.
You must provide this value if you're using IAM Identity Center to manage end user access to your application. If you're using legacy identity management to manage user access, you don't need to provide this value.
sample_prompts_control_mode WebExperienceSamplePromptsControlMode: Determines whether sample prompts are enabled in the web experience for an end user.
status WebExperienceStatus: The status of your Amazon Q Business web experience.
subtitle str: A subtitle to personalize your Amazon Q Business web experience.
tags Sequence[root_Tag]: 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 str: The title for your Amazon Q Business web experience.
updated_at str: The Unix timestamp when your Amazon Q Business web experience was updated.
web_experience_arn str: The Amazon Resource Name (ARN) of an Amazon Q Business web experience.
web_experience_id str: The identifier of your Amazon Q Business web experience.
welcome_message str: A message in an Amazon Q Business web experience.

browserExtensionConfiguration Property Map: The container for browser extension configuration for an Amazon Q Business web experience.
createdAt String: The Unix timestamp when the Amazon Q Business application was last updated.
customizationConfiguration Property Map: Contains the configuration information to customize the logo, font, and color of an Amazon Q Business web experience with individual files for each property or a CSS file for them all.
defaultEndpoint String: The endpoint URLs for your Amazon Q Business web experience. The URLs are unique and fully hosted by AWS .
identityProviderConfiguration Property Map | Property Map: Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
origins List<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 .
roleArn String: The Amazon Resource Name (ARN) of the service role attached to your web experience.
You must provide this value if you're using IAM Identity Center to manage end user access to your application. If you're using legacy identity management to manage user access, you don't need to provide this value.
samplePromptsControlMode "ENABLED" | "DISABLED": Determines whether sample prompts are enabled in the web experience for an end user.
status "CREATING" | "ACTIVE" | "DELETING" | "FAILED" | "PENDING_AUTH_CONFIG": The status of your Amazon Q Business web experience.
subtitle String: A subtitle to personalize your Amazon Q Business web experience.
tags List<Property Map>: 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 String: The title for your Amazon Q Business web experience.
updatedAt String: The Unix timestamp when your Amazon Q Business web experience was updated.
webExperienceArn String: The Amazon Resource Name (ARN) of an Amazon Q Business web experience.
webExperienceId String: The identifier of your Amazon Q Business web experience.
welcomeMessage String: A message in an Amazon Q Business web experience.