1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListRegions`](crate::operation::list_regions::builders::ListRegionsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_regions::builders::ListRegionsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`account_id(impl Into<String>)`](crate::operation::list_regions::builders::ListRegionsFluentBuilder::account_id) / [`set_account_id(Option<String>)`](crate::operation::list_regions::builders::ListRegionsFluentBuilder::set_account_id):<br>required: **false**<br><p>Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. If you don't specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation. To use this parameter, the caller must be an identity in the <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account">organization's management account</a> or a delegated administrator account. The specified account ID must also be a member account in the same organization. The organization must have <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html">all features enabled</a>, and the organization must have <a href="https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html">trusted access</a> enabled for the Account Management service, and optionally a <a href="https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html">delegated admin</a> account assigned.</p><note>  <p>The management account can't specify its own <code>AccountId</code>. It must call the operation in standalone context by not including the <code>AccountId</code> parameter.</p> </note> <p>To call this operation on an account that is not a member of an organization, don't specify this parameter. Instead, call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_regions::builders::ListRegionsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_regions::builders::ListRegionsFluentBuilder::set_max_results):<br>required: **false**<br><p>The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a <code>NextToken</code> is provided in the command’s output. To resume pagination, provide the <code>NextToken</code> value in the <code>starting-token</code> argument of a subsequent command. Do not use the <code>NextToken</code> response element directly outside of the Amazon Web Services CLI. For usage examples, see <a href="http://docs.aws.amazon.com/cli/latest/userguide/pagination.html">Pagination</a> in the <i>Amazon Web Services Command Line Interface User Guide</i>.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_regions::builders::ListRegionsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_regions::builders::ListRegionsFluentBuilder::set_next_token):<br>required: **false**<br><p>A token used to specify where to start paginating. This is the <code>NextToken</code> from a previously truncated response. For usage examples, see <a href="http://docs.aws.amazon.com/cli/latest/userguide/pagination.html">Pagination</a> in the <i>Amazon Web Services Command Line Interface User Guide</i>.</p><br>
    ///   - [`region_opt_status_contains(RegionOptStatus)`](crate::operation::list_regions::builders::ListRegionsFluentBuilder::region_opt_status_contains) / [`set_region_opt_status_contains(Option<Vec::<RegionOptStatus>>)`](crate::operation::list_regions::builders::ListRegionsFluentBuilder::set_region_opt_status_contains):<br>required: **false**<br><p>A list of Region statuses (Enabling, Enabled, Disabling, Disabled, Enabled_by_default) to use to filter the list of Regions for a given account. For example, passing in a value of ENABLING will only return a list of Regions with a Region status of ENABLING.</p><br>
    /// - On success, responds with [`ListRegionsOutput`](crate::operation::list_regions::ListRegionsOutput) with field(s):
    ///   - [`next_token(Option<String>)`](crate::operation::list_regions::ListRegionsOutput::next_token): <p>If there is more data to be returned, this will be populated. It should be passed into the <code>next-token</code> request parameter of <code>list-regions</code>.</p>
    ///   - [`regions(Option<Vec::<Region>>)`](crate::operation::list_regions::ListRegionsOutput::regions): <p>This is a list of Regions for a given account, or if the filtered parameter was used, a list of Regions that match the filter criteria set in the <code>filter</code> parameter.</p>
    /// - On failure, responds with [`SdkError<ListRegionsError>`](crate::operation::list_regions::ListRegionsError)
    pub fn list_regions(&self) -> crate::operation::list_regions::builders::ListRegionsFluentBuilder {
        crate::operation::list_regions::builders::ListRegionsFluentBuilder::new(self.handle.clone())
    }
}