aws_sdk_omics/client/
list_run_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 [`ListRunGroups`](crate::operation::list_run_groups::builders::ListRunGroupsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_run_groups::builders::ListRunGroupsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`name(impl Into<String>)`](crate::operation::list_run_groups::builders::ListRunGroupsFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::list_run_groups::builders::ListRunGroupsFluentBuilder::set_name):<br>required: **false**<br><p>The run groups' name.</p><br>
8    ///   - [`starting_token(impl Into<String>)`](crate::operation::list_run_groups::builders::ListRunGroupsFluentBuilder::starting_token) / [`set_starting_token(Option<String>)`](crate::operation::list_run_groups::builders::ListRunGroupsFluentBuilder::set_starting_token):<br>required: **false**<br><p>Specify the pagination token from a previous request to retrieve the next page of results.</p><br>
9    ///   - [`max_results(i32)`](crate::operation::list_run_groups::builders::ListRunGroupsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_run_groups::builders::ListRunGroupsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of run groups to return in one page of results.</p><br>
10    /// - On success, responds with [`ListRunGroupsOutput`](crate::operation::list_run_groups::ListRunGroupsOutput) with field(s):
11    ///   - [`items(Option<Vec::<RunGroupListItem>>)`](crate::operation::list_run_groups::ListRunGroupsOutput::items): <p>A list of groups.</p>
12    ///   - [`next_token(Option<String>)`](crate::operation::list_run_groups::ListRunGroupsOutput::next_token): <p>A pagination token that's included if more results are available.</p>
13    /// - On failure, responds with [`SdkError<ListRunGroupsError>`](crate::operation::list_run_groups::ListRunGroupsError)
14    pub fn list_run_groups(&self) -> crate::operation::list_run_groups::builders::ListRunGroupsFluentBuilder {
15        crate::operation::list_run_groups::builders::ListRunGroupsFluentBuilder::new(self.handle.clone())
16    }
17}