aws_sdk_codebuild/client/list_reports.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 [`ListReports`](crate::operation::list_reports::builders::ListReportsFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_reports::builders::ListReportsFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`sort_order(SortOrderType)`](crate::operation::list_reports::builders::ListReportsFluentBuilder::sort_order) / [`set_sort_order(Option<SortOrderType>)`](crate::operation::list_reports::builders::ListReportsFluentBuilder::set_sort_order):<br>required: **false**<br><p>Specifies the sort order for the list of returned reports. Valid values are:</p> <ul> <li> <p><code>ASCENDING</code>: return reports in chronological order based on their creation date.</p></li> <li> <p><code>DESCENDING</code>: return reports in the reverse chronological order based on their creation date.</p></li> </ul><br>
8 /// - [`next_token(impl Into<String>)`](crate::operation::list_reports::builders::ListReportsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_reports::builders::ListReportsFluentBuilder::set_next_token):<br>required: **false**<br><p>During a previous call, the maximum number of items that can be returned is the value specified in <code>maxResults</code>. If there more items in the list, then a unique string called a <i>nextToken</i> is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.</p><br>
9 /// - [`max_results(i32)`](crate::operation::list_reports::builders::ListReportsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_reports::builders::ListReportsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of paginated reports returned per response. Use <code>nextToken</code> to iterate pages in the list of returned <code>Report</code> objects. The default value is 100.</p><br>
10 /// - [`filter(ReportFilter)`](crate::operation::list_reports::builders::ListReportsFluentBuilder::filter) / [`set_filter(Option<ReportFilter>)`](crate::operation::list_reports::builders::ListReportsFluentBuilder::set_filter):<br>required: **false**<br><p>A <code>ReportFilter</code> object used to filter the returned reports.</p><br>
11 /// - On success, responds with [`ListReportsOutput`](crate::operation::list_reports::ListReportsOutput) with field(s):
12 /// - [`next_token(Option<String>)`](crate::operation::list_reports::ListReportsOutput::next_token): <p>During a previous call, the maximum number of items that can be returned is the value specified in <code>maxResults</code>. If there more items in the list, then a unique string called a <i>nextToken</i> is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.</p>
13 /// - [`reports(Option<Vec::<String>>)`](crate::operation::list_reports::ListReportsOutput::reports): <p>The list of returned ARNs for the reports in the current Amazon Web Services account.</p>
14 /// - On failure, responds with [`SdkError<ListReportsError>`](crate::operation::list_reports::ListReportsError)
15 pub fn list_reports(&self) -> crate::operation::list_reports::builders::ListReportsFluentBuilder {
16 crate::operation::list_reports::builders::ListReportsFluentBuilder::new(self.handle.clone())
17 }
18}