Skip to content

Qbusiness  >  Operations  >  create_anonymous_web_experience_url

create_anonymous_web_experience_url

Operation

create_anonymous_web_experience_url async

create_anonymous_web_experience_url(input: CreateAnonymousWebExperienceUrlInput, plugins: list[Plugin] | None = None) -> CreateAnonymousWebExperienceUrlOutput

Creates a unique URL for anonymous Amazon Q Business web experience. This URL can only be used once and must be used within 5 minutes after it's generated.

Parameters:

Name Type Description Default
input CreateAnonymousWebExperienceUrlInput

An instance of CreateAnonymousWebExperienceUrlInput.

required
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

Returns:

Type Description
CreateAnonymousWebExperienceUrlOutput

An instance of CreateAnonymousWebExperienceUrlOutput.

Input

CreateAnonymousWebExperienceUrlInput dataclass

Dataclass for CreateAnonymousWebExperienceUrlInput structure.

Attributes

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

The identifier of the Amazon Q Business application environment attached to the web experience.

session_duration_in_minutes class-attribute instance-attribute
session_duration_in_minutes: int | None = None

The duration of the session associated with the unique URL for the web experience.

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

The identifier of the web experience.

Output

CreateAnonymousWebExperienceUrlOutput dataclass

Dataclass for CreateAnonymousWebExperienceUrlOutput structure.

Attributes

anonymous_url class-attribute instance-attribute
anonymous_url: str | None = None

The unique URL for accessing the web experience.

Warning

This URL can only be used once and must be used within 5 minutes after it's generated.