aws_sdk_connectcases/client/list_fields.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 [`ListFields`](crate::operation::list_fields::builders::ListFieldsFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_fields::builders::ListFieldsFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`domain_id(impl Into<String>)`](crate::operation::list_fields::builders::ListFieldsFluentBuilder::domain_id) / [`set_domain_id(Option<String>)`](crate::operation::list_fields::builders::ListFieldsFluentBuilder::set_domain_id):<br>required: **true**<br><p>The unique identifier of the Cases domain.</p><br>
8 /// - [`max_results(i32)`](crate::operation::list_fields::builders::ListFieldsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_fields::builders::ListFieldsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return per page.</p><br>
9 /// - [`next_token(impl Into<String>)`](crate::operation::list_fields::builders::ListFieldsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_fields::builders::ListFieldsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p><br>
10 /// - On success, responds with [`ListFieldsOutput`](crate::operation::list_fields::ListFieldsOutput) with field(s):
11 /// - [`fields(Vec::<FieldSummary>)`](crate::operation::list_fields::ListFieldsOutput::fields): <p>List of detailed field information.</p>
12 /// - [`next_token(Option<String>)`](crate::operation::list_fields::ListFieldsOutput::next_token): <p>The token for the next set of results. This is null if there are no more results to return.</p>
13 /// - On failure, responds with [`SdkError<ListFieldsError>`](crate::operation::list_fields::ListFieldsError)
14 pub fn list_fields(&self) -> crate::operation::list_fields::builders::ListFieldsFluentBuilder {
15 crate::operation::list_fields::builders::ListFieldsFluentBuilder::new(self.handle.clone())
16 }
17}