aws_sdk_ecs/client/

list_account_settings.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListAccountSettings`](crate::operation::list_account_settings::builders::ListAccountSettingsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_account_settings::builders::ListAccountSettingsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`name(SettingName)`](crate::operation::list_account_settings::builders::ListAccountSettingsFluentBuilder::name) / [`set_name(Option<SettingName>)`](crate::operation::list_account_settings::builders::ListAccountSettingsFluentBuilder::set_name):<br>required: **false**<br><p>The name of the account setting you want to list the settings for.</p><br>
    ///   - [`value(impl Into<String>)`](crate::operation::list_account_settings::builders::ListAccountSettingsFluentBuilder::value) / [`set_value(Option<String>)`](crate::operation::list_account_settings::builders::ListAccountSettingsFluentBuilder::set_value):<br>required: **false**<br><p>The value of the account settings to filter results with. You must also specify an account setting name to use this parameter.</p><br>
    ///   - [`principal_arn(impl Into<String>)`](crate::operation::list_account_settings::builders::ListAccountSettingsFluentBuilder::principal_arn) / [`set_principal_arn(Option<String>)`](crate::operation::list_account_settings::builders::ListAccountSettingsFluentBuilder::set_principal_arn):<br>required: **false**<br><p>The ARN of the principal, which can be a user, role, or the root user. If this field is omitted, the account settings are listed only for the authenticated user.</p> <p>In order to use this parameter, you must be the root user, or the principal.</p><note>  <p>Federated users assume the account setting of the root user and can't have explicit account settings set for them.</p> </note><br>
    ///   - [`effective_settings(bool)`](crate::operation::list_account_settings::builders::ListAccountSettingsFluentBuilder::effective_settings) / [`set_effective_settings(Option<bool>)`](crate::operation::list_account_settings::builders::ListAccountSettingsFluentBuilder::set_effective_settings):<br>required: **false**<br><p>Determines whether to return the effective settings. If <code>true</code>, the account settings for the root user or the default setting for the <code>principalArn</code> are returned. If <code>false</code>, the account settings for the <code>principalArn</code> are returned if they're set. Otherwise, no account settings are returned.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_account_settings::builders::ListAccountSettingsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_account_settings::builders::ListAccountSettingsFluentBuilder::set_next_token):<br>required: **false**<br><p>The <code>nextToken</code> value returned from a <code>ListAccountSettings</code> request indicating that more results are available to fulfill the request and further calls will be needed. If <code>maxResults</code> was provided, it's possible the number of results to be fewer than <code>maxResults</code>.</p><note>  <p>This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.</p> </note><br>
    ///   - [`max_results(i32)`](crate::operation::list_account_settings::builders::ListAccountSettingsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_account_settings::builders::ListAccountSettingsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of account setting results returned by <code>ListAccountSettings</code> in paginated output. When this parameter is used, <code>ListAccountSettings</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListAccountSettings</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 10. If this parameter isn't used, then <code>ListAccountSettings</code> returns up to 10 results and a <code>nextToken</code> value if applicable.</p><br>
    /// - On success, responds with [`ListAccountSettingsOutput`](crate::operation::list_account_settings::ListAccountSettingsOutput) with field(s):
    ///   - [`settings(Option<Vec::<Setting>>)`](crate::operation::list_account_settings::ListAccountSettingsOutput::settings): <p>The account settings for the resource.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_account_settings::ListAccountSettingsOutput::next_token): <p>The <code>nextToken</code> value to include in a future <code>ListAccountSettings</code> request. When the results of a <code>ListAccountSettings</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>
    /// - On failure, responds with [`SdkError<ListAccountSettingsError>`](crate::operation::list_account_settings::ListAccountSettingsError)
    pub fn list_account_settings(&self) -> crate::operation::list_account_settings::builders::ListAccountSettingsFluentBuilder {
        crate::operation::list_account_settings::builders::ListAccountSettingsFluentBuilder::new(self.handle.clone())
    }
}