aws_sdk_sesv2/client/
list_tenants.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 [`ListTenants`](crate::operation::list_tenants::builders::ListTenantsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_tenants::builders::ListTenantsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`next_token(impl Into<String>)`](crate::operation::list_tenants::builders::ListTenantsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_tenants::builders::ListTenantsFluentBuilder::set_next_token):<br>required: **false**<br><p>A token returned from a previous call to <code>ListTenants</code> to indicate the position in the list of tenants.</p><br>
8    ///   - [`page_size(i32)`](crate::operation::list_tenants::builders::ListTenantsFluentBuilder::page_size) / [`set_page_size(Option<i32>)`](crate::operation::list_tenants::builders::ListTenantsFluentBuilder::set_page_size):<br>required: **false**<br><p>The number of results to show in a single call to <code>ListTenants</code>. If the number of results is larger than the number you specified in this parameter, then the response includes a <code>NextToken</code> element, which you can use to obtain additional results.</p><br>
9    /// - On success, responds with [`ListTenantsOutput`](crate::operation::list_tenants::ListTenantsOutput) with field(s):
10    ///   - [`tenants(Option<Vec::<TenantInfo>>)`](crate::operation::list_tenants::ListTenantsOutput::tenants): <p>An array that contains basic information about each tenant.</p>
11    ///   - [`next_token(Option<String>)`](crate::operation::list_tenants::ListTenantsOutput::next_token): <p>A token that indicates that there are additional tenants to list. To view additional tenants, issue another request to <code>ListTenants</code>, and pass this token in the <code>NextToken</code> parameter.</p>
12    /// - On failure, responds with [`SdkError<ListTenantsError>`](crate::operation::list_tenants::ListTenantsError)
13    pub fn list_tenants(&self) -> crate::operation::list_tenants::builders::ListTenantsFluentBuilder {
14        crate::operation::list_tenants::builders::ListTenantsFluentBuilder::new(self.handle.clone())
15    }
16}
aws_sdk_sesv2/client/list_tenants.rs

aws_sdk_sesv2/client/
list_tenants.rs
