list_web_experiences¶
Operation¶
async
¶
list_web_experiences(input: ListWebExperiencesInput, plugins: list[Plugin] | None = None) -> ListWebExperiencesOutput
Lists one or more Amazon Q Business Web Experiences.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ListWebExperiencesInput
|
An instance of |
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 |
|---|---|
ListWebExperiencesOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for ListWebExperiencesInput structure.
Attributes¶
class-attribute
instance-attribute
¶
application_id: str | None = None
The identifier of the Amazon Q Business application linked to the listed web experiences.
class-attribute
instance-attribute
¶
max_results: int | None = None
The maximum number of Amazon Q Business Web Experiences to return.
class-attribute
instance-attribute
¶
next_token: str | None = None
If the maxResults response was incomplete because there is more data
to retrieve, Amazon Q Business returns a pagination token in the
response. You can use this pagination token to retrieve the next set of
Amazon Q Business conversations.
Output¶
dataclass
¶
Dataclass for ListWebExperiencesOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
next_token: str | None = None
If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of messages.
class-attribute
instance-attribute
¶
web_experiences: list[WebExperience] | None = None
An array of summary information for one or more Amazon Q Business experiences.