aws_sdk_guardduty/client/

describe_organization_configuration.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeOrganizationConfiguration`](crate::operation::describe_organization_configuration::builders::DescribeOrganizationConfigurationFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_organization_configuration::builders::DescribeOrganizationConfigurationFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`detector_id(impl Into<String>)`](crate::operation::describe_organization_configuration::builders::DescribeOrganizationConfigurationFluentBuilder::detector_id) / [`set_detector_id(Option<String>)`](crate::operation::describe_organization_configuration::builders::DescribeOrganizationConfigurationFluentBuilder::set_detector_id):<br>required: **true**<br><p>The detector ID of the delegated administrator for which you need to retrieve the information.</p> <p>To find the <code>detectorId</code> in the current Region, see the Settings page in the GuardDuty console, or run the <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html">ListDetectors</a> API.</p><br>
    ///   - [`max_results(i32)`](crate::operation::describe_organization_configuration::builders::DescribeOrganizationConfigurationFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_organization_configuration::builders::DescribeOrganizationConfigurationFluentBuilder::set_max_results):<br>required: **false**<br><p>You can use this parameter to indicate the maximum number of items that you want in the response.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_organization_configuration::builders::DescribeOrganizationConfigurationFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_organization_configuration::builders::DescribeOrganizationConfigurationFluentBuilder::set_next_token):<br>required: **false**<br><p>You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill <code>nextToken</code> in the request with the value of <code>NextToken</code> from the previous response to continue listing data.</p><br>
    /// - On success, responds with [`DescribeOrganizationConfigurationOutput`](crate::operation::describe_organization_configuration::DescribeOrganizationConfigurationOutput) with field(s):
    ///   - [`auto_enable(Option<bool>)`](crate::operation::describe_organization_configuration::DescribeOrganizationConfigurationOutput::auto_enable): <p>Indicates whether GuardDuty is automatically enabled for accounts added to the organization.</p> <p>Even though this is still supported, we recommend using <code>AutoEnableOrganizationMembers</code> to achieve the similar results.</p>
    ///   - [`member_account_limit_reached(Option<bool>)`](crate::operation::describe_organization_configuration::DescribeOrganizationConfigurationOutput::member_account_limit_reached): <p>Indicates whether the maximum number of allowed member accounts are already associated with the delegated administrator account for your organization.</p>
    ///   - [`data_sources(Option<OrganizationDataSourceConfigurationsResult>)`](crate::operation::describe_organization_configuration::DescribeOrganizationConfigurationOutput::data_sources): <p>Describes which data sources are enabled automatically for member accounts.</p>
    ///   - [`features(Option<Vec::<OrganizationFeatureConfigurationResult>>)`](crate::operation::describe_organization_configuration::DescribeOrganizationConfigurationOutput::features): <p>A list of features that are configured for this organization.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::describe_organization_configuration::DescribeOrganizationConfigurationOutput::next_token): <p>The pagination parameter to be used on the next list operation to retrieve more items.</p>
    ///   - [`auto_enable_organization_members(Option<AutoEnableMembers>)`](crate::operation::describe_organization_configuration::DescribeOrganizationConfigurationOutput::auto_enable_organization_members): <p>Indicates the auto-enablement configuration of GuardDuty or any of the corresponding protection plans for the member accounts in the organization.</p> <ul>  <li>   <p><code>NEW</code>: Indicates that when a new account joins the organization, they will have GuardDuty or any of the corresponding protection plans enabled automatically.</p></li>  <li>   <p><code>ALL</code>: Indicates that all accounts in the organization have GuardDuty and any of the corresponding protection plans enabled automatically. This includes <code>NEW</code> accounts that join the organization and accounts that may have been suspended or removed from the organization in GuardDuty.</p></li>  <li>   <p><code>NONE</code>: Indicates that GuardDuty or any of the corresponding protection plans will not be automatically enabled for any account in the organization. The administrator must manage GuardDuty for each account in the organization individually.</p>   <p>When you update the auto-enable setting from <code>ALL</code> or <code>NEW</code> to <code>NONE</code>, this action doesn't disable the corresponding option for your existing accounts. This configuration will apply to the new accounts that join the organization. After you update the auto-enable settings, no new account will have the corresponding option as enabled.</p></li> </ul>
    /// - On failure, responds with [`SdkError<DescribeOrganizationConfigurationError>`](crate::operation::describe_organization_configuration::DescribeOrganizationConfigurationError)
    pub fn describe_organization_configuration(
        &self,
    ) -> crate::operation::describe_organization_configuration::builders::DescribeOrganizationConfigurationFluentBuilder {
        crate::operation::describe_organization_configuration::builders::DescribeOrganizationConfigurationFluentBuilder::new(self.handle.clone())
    }
}