list_web_experiences¶
Operation¶
list_web_experiences
¶
list_web_experiences(request: ListWebExperiencesInput | ListWebExperiencesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListWebExperiencesInputDict]) -> ListWebExperiencesOutput
Lists one or more Amazon Q Business Web Experiences.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ListWebExperiencesInput | ListWebExperiencesInputDict | 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[ListWebExperiencesInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListWebExperiencesOutput
|
An instance of |
list_web_experiences
async
¶
list_web_experiences(request: ListWebExperiencesInput | ListWebExperiencesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListWebExperiencesInputDict]) -> ListWebExperiencesOutput
Lists one or more Amazon Q Business Web Experiences.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ListWebExperiencesInput | ListWebExperiencesInputDict | 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[ListWebExperiencesInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListWebExperiencesOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
ListWebExperiencesInputDict
¶
Bases: TypedDict
Dictionary form of ListWebExperiencesInput.
ListWebExperiencesInput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListWebExperiencesInput structure.
Attributes¶
application_id
class-attribute
instance-attribute
¶
application_id: str | None = ...
The identifier of the Amazon Q Business application linked to the listed web experiences.
max_results
class-attribute
instance-attribute
¶
max_results: int | None = ...
The maximum number of Amazon Q Business Web Experiences to return.
next_token
class-attribute
instance-attribute
¶
next_token: str | 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¶
ListWebExperiencesOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListWebExperiencesOutput structure.
Attributes¶
next_token
class-attribute
instance-attribute
¶
next_token: str | 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.
response_metadata
class-attribute
instance-attribute
¶
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.
web_experiences
class-attribute
instance-attribute
¶
web_experiences: list[WebExperience] | None = ...
An array of summary information for one or more Amazon Q Business experiences.