AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon QBusiness CreateWebExperience API operation.

Syntax

New-QBUSWebExperience
-ApplicationId <String>
-SamlConfiguration_AuthenticationUrl <String>
-CustomizationConfiguration_CustomCSSUrl <String>
-BrowserExtensionConfiguration_EnabledBrowserExtension <String[]>
-CustomizationConfiguration_FaviconUrl <String>
-CustomizationConfiguration_FontUrl <String>
-CustomizationConfiguration_LogoUrl <String>
-Origin <String[]>
-RoleArn <String>
-SamplePromptsControlMode <WebExperienceSamplePromptsControlMode>
-OpenIDConnectConfiguration_SecretsArn <String>
-OpenIDConnectConfiguration_SecretsRole <String>
-Subtitle <String>
-Tag <Tag[]>
-Title <String>
-WelcomeMessage <String>
-ClientToken <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonQBusinessConfig>

Description

Creates an Amazon Q Business web experience.

Parameters

-ApplicationId <String>
The identifier of the Amazon Q Business web experience.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-BrowserExtensionConfiguration_EnabledBrowserExtension <String[]>
Specify the browser extensions allowed for your Amazon Q web experience.
  • CHROME — Enables the extension for Chromium-based browsers (Google Chrome, Microsoft Edge, Opera, etc.).
  • FIREFOX — Enables the extension for Mozilla Firefox.
  • CHROME and FIREFOX — Enable the extension for Chromium-based browsers and Mozilla Firefox.
Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesBrowserExtensionConfiguration_EnabledBrowserExtensions
-ClientConfig <AmazonQBusinessConfig>
Amazon.PowerShell.Cmdlets.QBUS.AmazonQBusinessClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
A token you provide to identify a request to create an Amazon Q Business web experience.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CustomizationConfiguration_CustomCSSUrl <String>
Provides the URL where the custom CSS file is hosted for an Amazon Q web experience.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CustomizationConfiguration_FaviconUrl <String>
Provides the URL where the custom favicon file is hosted for an Amazon Q web experience.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CustomizationConfiguration_FontUrl <String>
Provides the URL where the custom font file is hosted for an Amazon Q web experience.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CustomizationConfiguration_LogoUrl <String>
Provides the URL where the custom logo file is hosted for an Amazon Q web experience.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OpenIDConnectConfiguration_SecretsArn <String>
The Amazon Resource Name (ARN) of a Secrets Manager secret containing the OIDC client secret.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesIdentityProviderConfiguration_OpenIDConnectConfiguration_SecretsArn
-OpenIDConnectConfiguration_SecretsRole <String>
An IAM role with permissions to access KMS to decrypt the Secrets Manager secret containing your OIDC client secret.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesIdentityProviderConfiguration_OpenIDConnectConfiguration_SecretsRole
-Origin <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. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOrigins
-RoleArn <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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SamlConfiguration_AuthenticationUrl <String>
The URL where Amazon Q Business end users will be redirected for authentication.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesIdentityProviderConfiguration_SamlConfiguration_AuthenticationUrl
-SamplePromptsControlMode <WebExperienceSamplePromptsControlMode>
Determines whether sample prompts are enabled in the web experience for an end user.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QBusiness.Model.CreateWebExperienceResponse). Specifying the name of a property of type Amazon.QBusiness.Model.CreateWebExperienceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Subtitle <String>
A subtitle to personalize your Amazon Q Business web experience.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <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: _ . : / = + - @. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-Title <String>
The title for your Amazon Q Business web experience.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-WelcomeMessage <String>
The customized welcome message for end users of an Amazon Q Business web experience.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.QBusiness.Model.CreateWebExperienceResponse
This cmdlet returns an Amazon.QBusiness.Model.CreateWebExperienceResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z