aws_sdk_qbusiness/client/
list_attachments.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`ListAttachments`](crate::operation::list_attachments::builders::ListAttachmentsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_attachments::builders::ListAttachmentsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`application_id(impl Into<String>)`](crate::operation::list_attachments::builders::ListAttachmentsFluentBuilder::application_id) / [`set_application_id(Option<String>)`](crate::operation::list_attachments::builders::ListAttachmentsFluentBuilder::set_application_id):<br>required: **true**<br><p>The unique identifier for the Amazon Q Business application.</p><br>
8    ///   - [`conversation_id(impl Into<String>)`](crate::operation::list_attachments::builders::ListAttachmentsFluentBuilder::conversation_id) / [`set_conversation_id(Option<String>)`](crate::operation::list_attachments::builders::ListAttachmentsFluentBuilder::set_conversation_id):<br>required: **false**<br><p>The unique identifier of the Amazon Q Business web experience conversation.</p><br>
9    ///   - [`user_id(impl Into<String>)`](crate::operation::list_attachments::builders::ListAttachmentsFluentBuilder::user_id) / [`set_user_id(Option<String>)`](crate::operation::list_attachments::builders::ListAttachmentsFluentBuilder::set_user_id):<br>required: **false**<br><p>The unique identifier of the user involved in the Amazon Q Business web experience conversation.</p><br>
10    ///   - [`next_token(impl Into<String>)`](crate::operation::list_attachments::builders::ListAttachmentsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_attachments::builders::ListAttachmentsFluentBuilder::set_next_token):<br>required: **false**<br><p>If the number of attachments returned exceeds <code>maxResults</code>, Amazon Q Business returns a next token as a pagination token to retrieve the next set of attachments.</p><br>
11    ///   - [`max_results(i32)`](crate::operation::list_attachments::builders::ListAttachmentsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_attachments::builders::ListAttachmentsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of attachements to return.</p><br>
12    /// - On success, responds with [`ListAttachmentsOutput`](crate::operation::list_attachments::ListAttachmentsOutput) with field(s):
13    ///   - [`attachments(Option<Vec::<Attachment>>)`](crate::operation::list_attachments::ListAttachmentsOutput::attachments): <p>An array of information on one or more attachments.</p>
14    ///   - [`next_token(Option<String>)`](crate::operation::list_attachments::ListAttachmentsOutput::next_token): <p>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.</p>
15    /// - On failure, responds with [`SdkError<ListAttachmentsError>`](crate::operation::list_attachments::ListAttachmentsError)
16    pub fn list_attachments(&self) -> crate::operation::list_attachments::builders::ListAttachmentsFluentBuilder {
17        crate::operation::list_attachments::builders::ListAttachmentsFluentBuilder::new(self.handle.clone())
18    }
19}