list_attachments¶
Operation¶
async
¶
list_attachments(input: ListAttachmentsInput, plugins: list[Plugin] | None = None) -> ListAttachmentsOutput
Gets a list of attachments associated with an Amazon Q Business web experience or a list of attachements associated with a specific Amazon Q Business conversation.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ListAttachmentsInput
|
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 |
|---|---|
ListAttachmentsOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for ListAttachmentsInput structure.
Attributes¶
class-attribute
instance-attribute
¶
application_id: str | None = None
The unique identifier for the Amazon Q Business application.
class-attribute
instance-attribute
¶
conversation_id: str | None = None
The unique identifier of the Amazon Q Business web experience conversation.
class-attribute
instance-attribute
¶
max_results: int | None = None
The maximum number of attachements to return.
class-attribute
instance-attribute
¶
next_token: str | None = None
If the number of attachments returned exceeds maxResults, Amazon Q
Business returns a next token as a pagination token to retrieve the next
set of attachments.
class-attribute
instance-attribute
¶
user_id: str | None = None
The unique identifier of the user involved in the Amazon Q Business web experience conversation.
Output¶
dataclass
¶
Dataclass for ListAttachmentsOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
attachments: list[Attachment] | None = None
An array of information on one or more attachments.
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 attachments.