list_attachments¶
Operation¶
list_attachments
¶
list_attachments(request: ListAttachmentsInput | ListAttachmentsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListAttachmentsInputDict]) -> 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 |
|---|---|---|---|
request
|
ListAttachmentsInput | ListAttachmentsInputDict | 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[ListAttachmentsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListAttachmentsOutput
|
An instance of |
list_attachments
async
¶
list_attachments(request: ListAttachmentsInput | ListAttachmentsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListAttachmentsInputDict]) -> 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 |
|---|---|---|---|
request
|
ListAttachmentsInput | ListAttachmentsInputDict | 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[ListAttachmentsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListAttachmentsOutput
|
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.
ListAttachmentsInputDict
¶
Bases: TypedDict
Dictionary form of ListAttachmentsInput.
Attributes¶
application_id
instance-attribute
¶
The unique identifier for the Amazon Q Business application.
conversation_id
instance-attribute
¶
conversation_id: str | None
The unique identifier of the Amazon Q Business web experience conversation.
max_results
instance-attribute
¶
max_results: int | None
The maximum number of attachements to return.
ListAttachmentsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListAttachmentsInput structure.
Attributes¶
application_id
class-attribute
instance-attribute
¶
application_id: str | None = ...
The unique identifier for the Amazon Q Business application.
conversation_id
class-attribute
instance-attribute
¶
conversation_id: str | None = ...
The unique identifier of the Amazon Q Business web experience conversation.
max_results
class-attribute
instance-attribute
¶
max_results: int | None = ...
The maximum number of attachements to return.
Output¶
ListAttachmentsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListAttachmentsOutput structure.
Attributes¶
attachments
class-attribute
instance-attribute
¶
attachments: list[Attachment] | None = ...
An array of information on one or more attachments.
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 attachments.
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.