aws_sdk_codebuild/client/
list_shared_report_groups.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 [`ListSharedReportGroups`](crate::operation::list_shared_report_groups::builders::ListSharedReportGroupsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_shared_report_groups::builders::ListSharedReportGroupsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`sort_order(SortOrderType)`](crate::operation::list_shared_report_groups::builders::ListSharedReportGroupsFluentBuilder::sort_order) / [`set_sort_order(Option<SortOrderType>)`](crate::operation::list_shared_report_groups::builders::ListSharedReportGroupsFluentBuilder::set_sort_order):<br>required: **false**<br><p>The order in which to list shared report groups. Valid values include:</p> <ul>  <li>   <p><code>ASCENDING</code>: List in ascending order.</p></li>  <li>   <p><code>DESCENDING</code>: List in descending order.</p></li> </ul><br>
8    ///   - [`sort_by(SharedResourceSortByType)`](crate::operation::list_shared_report_groups::builders::ListSharedReportGroupsFluentBuilder::sort_by) / [`set_sort_by(Option<SharedResourceSortByType>)`](crate::operation::list_shared_report_groups::builders::ListSharedReportGroupsFluentBuilder::set_sort_by):<br>required: **false**<br><p>The criterion to be used to list report groups shared with the current Amazon Web Services account or user. Valid values include:</p> <ul>  <li>   <p><code>ARN</code>: List based on the ARN.</p></li>  <li>   <p><code>MODIFIED_TIME</code>: List based on when information about the shared report group was last changed.</p></li> </ul><br>
9    ///   - [`next_token(impl Into<String>)`](crate::operation::list_shared_report_groups::builders::ListSharedReportGroupsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_shared_report_groups::builders::ListSharedReportGroupsFluentBuilder::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>
10    ///   - [`max_results(i32)`](crate::operation::list_shared_report_groups::builders::ListSharedReportGroupsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_shared_report_groups::builders::ListSharedReportGroupsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of paginated shared report groups per response. Use <code>nextToken</code> to iterate pages in the list of returned <code>ReportGroup</code> objects. The default value is 100.</p><br>
11    /// - On success, responds with [`ListSharedReportGroupsOutput`](crate::operation::list_shared_report_groups::ListSharedReportGroupsOutput) with field(s):
12    ///   - [`next_token(Option<String>)`](crate::operation::list_shared_report_groups::ListSharedReportGroupsOutput::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    ///   - [`report_groups(Option<Vec::<String>>)`](crate::operation::list_shared_report_groups::ListSharedReportGroupsOutput::report_groups): <p>The list of ARNs for the report groups shared with the current Amazon Web Services account or user.</p>
14    /// - On failure, responds with [`SdkError<ListSharedReportGroupsError>`](crate::operation::list_shared_report_groups::ListSharedReportGroupsError)
15    pub fn list_shared_report_groups(&self) -> crate::operation::list_shared_report_groups::builders::ListSharedReportGroupsFluentBuilder {
16        crate::operation::list_shared_report_groups::builders::ListSharedReportGroupsFluentBuilder::new(self.handle.clone())
17    }
18}