Skip to content

create_anonymous_web_experience_url

Operation

create_anonymous_web_experience_url

create_anonymous_web_experience_url(request: CreateAnonymousWebExperienceUrlInput | CreateAnonymousWebExperienceUrlInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateAnonymousWebExperienceUrlInputDict]) -> 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
request CreateAnonymousWebExperienceUrlInput | CreateAnonymousWebExperienceUrlInputDict | 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[CreateAnonymousWebExperienceUrlInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateAnonymousWebExperienceUrlOutput

An instance of CreateAnonymousWebExperienceUrlOutput.

create_anonymous_web_experience_url async

create_anonymous_web_experience_url(request: CreateAnonymousWebExperienceUrlInput | CreateAnonymousWebExperienceUrlInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateAnonymousWebExperienceUrlInputDict]) -> 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
request CreateAnonymousWebExperienceUrlInput | CreateAnonymousWebExperienceUrlInputDict | 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[CreateAnonymousWebExperienceUrlInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateAnonymousWebExperienceUrlOutput

An instance of CreateAnonymousWebExperienceUrlOutput.

Input

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

CreateAnonymousWebExperienceUrlInputDict

Bases: TypedDict

Dictionary form of CreateAnonymousWebExperienceUrlInput.

Attributes

application_id instance-attribute
application_id: Required[str]

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

session_duration_in_minutes instance-attribute
session_duration_in_minutes: int | None

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

web_experience_id instance-attribute
web_experience_id: Required[str]

The identifier of the web experience.

CreateAnonymousWebExperienceUrlInput dataclass

Bases: _SerdeShape

Dataclass for CreateAnonymousWebExperienceUrlInput structure.

Attributes

application_id class-attribute instance-attribute
application_id: str | 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 = ...

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

The identifier of the web experience.

Output

CreateAnonymousWebExperienceUrlOutput dataclass

Bases: _SerdeShape

Dataclass for CreateAnonymousWebExperienceUrlOutput structure.

Attributes

anonymous_url class-attribute instance-attribute
anonymous_url: str | 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.

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.