aws_sdk_workmail/client/list_aliases.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 [`ListAliases`](crate::operation::list_aliases::builders::ListAliasesFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_aliases::builders::ListAliasesFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`organization_id(impl Into<String>)`](crate::operation::list_aliases::builders::ListAliasesFluentBuilder::organization_id) / [`set_organization_id(Option<String>)`](crate::operation::list_aliases::builders::ListAliasesFluentBuilder::set_organization_id):<br>required: **true**<br><p>The identifier for the organization under which the entity exists.</p><br>
8 /// - [`entity_id(impl Into<String>)`](crate::operation::list_aliases::builders::ListAliasesFluentBuilder::entity_id) / [`set_entity_id(Option<String>)`](crate::operation::list_aliases::builders::ListAliasesFluentBuilder::set_entity_id):<br>required: **true**<br><p>The identifier for the entity for which to list the aliases.</p><br>
9 /// - [`next_token(impl Into<String>)`](crate::operation::list_aliases::builders::ListAliasesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_aliases::builders::ListAliasesFluentBuilder::set_next_token):<br>required: **false**<br><p>The token to use to retrieve the next page of results. The first call does not contain any tokens.</p><br>
10 /// - [`max_results(i32)`](crate::operation::list_aliases::builders::ListAliasesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_aliases::builders::ListAliasesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return in a single call.</p><br>
11 /// - On success, responds with [`ListAliasesOutput`](crate::operation::list_aliases::ListAliasesOutput) with field(s):
12 /// - [`aliases(Option<Vec::<String>>)`](crate::operation::list_aliases::ListAliasesOutput::aliases): <p>The entity's paginated aliases.</p>
13 /// - [`next_token(Option<String>)`](crate::operation::list_aliases::ListAliasesOutput::next_token): <p>The token to use to retrieve the next page of results. The value is "null" when there are no more results to return.</p>
14 /// - On failure, responds with [`SdkError<ListAliasesError>`](crate::operation::list_aliases::ListAliasesError)
15 pub fn list_aliases(&self) -> crate::operation::list_aliases::builders::ListAliasesFluentBuilder {
16 crate::operation::list_aliases::builders::ListAliasesFluentBuilder::new(self.handle.clone())
17 }
18}