aws_sdk_securityir/client/
list_comments.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 [`ListComments`](crate::operation::list_comments::builders::ListCommentsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_comments::builders::ListCommentsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`next_token(impl Into<String>)`](crate::operation::list_comments::builders::ListCommentsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_comments::builders::ListCommentsFluentBuilder::set_next_token):<br>required: **false**<br><p>An optional string that, if supplied, must be copied from the output of a previous call to ListComments. When provided in this manner, the API fetches the next page of results.</p><br>
8    ///   - [`max_results(i32)`](crate::operation::list_comments::builders::ListCommentsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_comments::builders::ListCommentsFluentBuilder::set_max_results):<br>required: **false**<br><p>Optional element for ListComments to limit the number of responses.</p><br>
9    ///   - [`case_id(impl Into<String>)`](crate::operation::list_comments::builders::ListCommentsFluentBuilder::case_id) / [`set_case_id(Option<String>)`](crate::operation::list_comments::builders::ListCommentsFluentBuilder::set_case_id):<br>required: **true**<br><p>Required element for ListComments to designate the case to query.</p><br>
10    /// - On success, responds with [`ListCommentsOutput`](crate::operation::list_comments::ListCommentsOutput) with field(s):
11    ///   - [`next_token(Option<String>)`](crate::operation::list_comments::ListCommentsOutput::next_token): <p>An optional string that, if supplied on subsequent calls to ListComments, allows the API to fetch the next page of results.</p>
12    ///   - [`items(Option<Vec::<ListCommentsItem>>)`](crate::operation::list_comments::ListCommentsOutput::items): <p>Response element for ListComments providing the body, commentID, createDate, creator, lastUpdatedBy and lastUpdatedDate for each response.</p>
13    ///   - [`total(Option<i32>)`](crate::operation::list_comments::ListCommentsOutput::total): <p>Response element for ListComments identifying the number of responses.</p>
14    /// - On failure, responds with [`SdkError<ListCommentsError>`](crate::operation::list_comments::ListCommentsError)
15    pub fn list_comments(&self) -> crate::operation::list_comments::builders::ListCommentsFluentBuilder {
16        crate::operation::list_comments::builders::ListCommentsFluentBuilder::new(self.handle.clone())
17    }
18}
aws_sdk_securityir/client/list_comments.rs

aws_sdk_securityir/client/
list_comments.rs
