aws-sdk-accountaccessruntime 1.2.0

AWS SDK for Account Access Runtime
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListRoles`](crate::operation::list_roles::builders::ListRolesFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_roles::builders::ListRolesFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`tenant_id(impl Into<String>)`](crate::operation::list_roles::builders::ListRolesFluentBuilder::tenant_id) / [`set_tenant_id(Option<String>)`](crate::operation::list_roles::builders::ListRolesFluentBuilder::set_tenant_id):<br>required: **true**<br><p>The identifier of the tenant whose roles you want to list. A tenant ID begins with <code>aa-</code> and is 3 to 24 characters long. It can contain lowercase letters, numbers, and hyphens.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_roles::builders::ListRolesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_roles::builders::ListRolesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of roles to return in a single response. If more roles are available than the specified value, the response includes a <code>nextToken</code> value that you can use to retrieve the next page of results. If you don't specify a value, the service uses a default page size.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_roles::builders::ListRolesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_roles::builders::ListRolesFluentBuilder::set_next_token):<br>required: **false**<br><p>The pagination token from a previous <code>ListRoles</code> response. Use it to retrieve the next page of results. Omit this parameter on the first call.</p><br>
    /// - On success, responds with [`ListRolesOutput`](crate::operation::list_roles::ListRolesOutput) with field(s):
    ///   - [`roles(Vec::<AccessDetails>)`](crate::operation::list_roles::ListRolesOutput::roles): <p>The list of roles that you can access in the tenant. Each entry describes an Amazon Web Services account and a role.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_roles::ListRolesOutput::next_token): <p>The pagination token to include in a subsequent <code>ListRoles</code> request to retrieve the next page of results. This value is absent when there are no more results to return.</p>
    /// - On failure, responds with [`SdkError<ListRolesError>`](crate::operation::list_roles::ListRolesError)
    pub fn list_roles(&self) -> crate::operation::list_roles::builders::ListRolesFluentBuilder {
        crate::operation::list_roles::builders::ListRolesFluentBuilder::new(self.handle.clone())
    }
}