aws_sdk_omics/client/list_references.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 [`ListReferences`](crate::operation::list_references::builders::ListReferencesFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_references::builders::ListReferencesFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`reference_store_id(impl Into<String>)`](crate::operation::list_references::builders::ListReferencesFluentBuilder::reference_store_id) / [`set_reference_store_id(Option<String>)`](crate::operation::list_references::builders::ListReferencesFluentBuilder::set_reference_store_id):<br>required: **true**<br><p>The references' reference store ID.</p><br>
8 /// - [`max_results(i32)`](crate::operation::list_references::builders::ListReferencesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_references::builders::ListReferencesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of references to return in one page of results.</p><br>
9 /// - [`next_token(impl Into<String>)`](crate::operation::list_references::builders::ListReferencesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_references::builders::ListReferencesFluentBuilder::set_next_token):<br>required: **false**<br><p>Specify the pagination token from a previous request to retrieve the next page of results.</p><br>
10 /// - [`filter(ReferenceFilter)`](crate::operation::list_references::builders::ListReferencesFluentBuilder::filter) / [`set_filter(Option<ReferenceFilter>)`](crate::operation::list_references::builders::ListReferencesFluentBuilder::set_filter):<br>required: **false**<br><p>A filter to apply to the list.</p><br>
11 /// - On success, responds with [`ListReferencesOutput`](crate::operation::list_references::ListReferencesOutput) with field(s):
12 /// - [`next_token(Option<String>)`](crate::operation::list_references::ListReferencesOutput::next_token): <p>A pagination token that's included if more results are available.</p>
13 /// - [`references(Vec::<ReferenceListItem>)`](crate::operation::list_references::ListReferencesOutput::references): <p>A list of references.</p>
14 /// - On failure, responds with [`SdkError<ListReferencesError>`](crate::operation::list_references::ListReferencesError)
15 pub fn list_references(&self) -> crate::operation::list_references::builders::ListReferencesFluentBuilder {
16 crate::operation::list_references::builders::ListReferencesFluentBuilder::new(self.handle.clone())
17 }
18}