aws_sdk_sesv2/client/
list_resource_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 [`ListResourceTenants`](crate::operation::list_resource_tenants::builders::ListResourceTenantsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_resource_tenants::builders::ListResourceTenantsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`resource_arn(impl Into<String>)`](crate::operation::list_resource_tenants::builders::ListResourceTenantsFluentBuilder::resource_arn) / [`set_resource_arn(Option<String>)`](crate::operation::list_resource_tenants::builders::ListResourceTenantsFluentBuilder::set_resource_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the resource to list associated tenants for.</p><br>
8    ///   - [`page_size(i32)`](crate::operation::list_resource_tenants::builders::ListResourceTenantsFluentBuilder::page_size) / [`set_page_size(Option<i32>)`](crate::operation::list_resource_tenants::builders::ListResourceTenantsFluentBuilder::set_page_size):<br>required: **false**<br><p>The number of results to show in a single call to <code>ListResourceTenants</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    ///   - [`next_token(impl Into<String>)`](crate::operation::list_resource_tenants::builders::ListResourceTenantsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_resource_tenants::builders::ListResourceTenantsFluentBuilder::set_next_token):<br>required: **false**<br><p>A token returned from a previous call to <code>ListResourceTenants</code> to indicate the position in the list of resource tenants.</p><br>
10    /// - On success, responds with [`ListResourceTenantsOutput`](crate::operation::list_resource_tenants::ListResourceTenantsOutput) with field(s):
11    ///   - [`resource_tenants(Option<Vec::<ResourceTenantMetadata>>)`](crate::operation::list_resource_tenants::ListResourceTenantsOutput::resource_tenants): <p>An array that contains information about each tenant associated with the resource.</p>
12    ///   - [`next_token(Option<String>)`](crate::operation::list_resource_tenants::ListResourceTenantsOutput::next_token): <p>A token that indicates that there are additional tenants to list. To view additional tenants, issue another request to <code>ListResourceTenants</code>, and pass this token in the <code>NextToken</code> parameter.</p>
13    /// - On failure, responds with [`SdkError<ListResourceTenantsError>`](crate::operation::list_resource_tenants::ListResourceTenantsError)
14    pub fn list_resource_tenants(&self) -> crate::operation::list_resource_tenants::builders::ListResourceTenantsFluentBuilder {
15        crate::operation::list_resource_tenants::builders::ListResourceTenantsFluentBuilder::new(self.handle.clone())
16    }
17}