update_organization_configuration¶
Operation¶
async
¶
update_organization_configuration(input: UpdateOrganizationConfigurationInput, plugins: list[Plugin] | None = None) -> UpdateOrganizationConfigurationOutput
Configures the delegated administrator account with the provided values.
You must provide a value for either autoEnableOrganizationMembers or
autoEnable, but not both.
Specifying both EKS Runtime Monitoring (EKS_RUNTIME_MONITORING) and
Runtime Monitoring (RUNTIME_MONITORING) will cause an error. You can
add only one of these two features because Runtime Monitoring already
includes the threat detection for Amazon EKS resources. For more
information, see Runtime
Monitoring.
There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
UpdateOrganizationConfigurationInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
UpdateOrganizationConfigurationOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for UpdateOrganizationConfigurationInput structure.
Attributes¶
class-attribute
instance-attribute
¶
auto_enable: bool | None = None
Represents whether to automatically enable member accounts in the organization. This applies to only new member accounts, not the existing member accounts. When a new account joins the organization, the chosen features will be enabled for them by default.
Even though this is still supported, we recommend using
AutoEnableOrganizationMembers to achieve the similar results. You must
provide a value for either autoEnableOrganizationMembers or
autoEnable.
class-attribute
instance-attribute
¶
auto_enable_organization_members: AutoEnableMembers | None = None
Indicates the auto-enablement configuration of GuardDuty for the member
accounts in the organization. You must provide a value for either
autoEnableOrganizationMembers or autoEnable.
Use one of the following configuration values for
autoEnableOrganizationMembers:
-
NEW: Indicates that when a new account joins the organization, they will have GuardDuty enabled automatically. -
ALL: Indicates that all accounts in the organization have GuardDuty enabled automatically. This includesNEWaccounts that join the organization and accounts that may have been suspended or removed from the organization in GuardDuty.
It may take up to 24 hours to update the configuration for all the member accounts.
NONE: Indicates that GuardDuty will not be automatically enabled for any account in the organization. The administrator must manage GuardDuty for each account in the organization individually.
When you update the auto-enable setting from ALL or NEW to NONE,
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.
class-attribute
instance-attribute
¶
data_sources: OrganizationDataSourceConfigurations | None = None
Describes which data sources will be updated.
class-attribute
instance-attribute
¶
detector_id: str | None = None
The ID of the detector that configures the delegated administrator.
To find the detectorId in the current Region, see the Settings page in
the GuardDuty console, or run the
ListDetectors
API.
class-attribute
instance-attribute
¶
features: list[OrganizationFeatureConfiguration] | None = None
A list of features that will be configured for the organization.
Output¶
dataclass
¶
Dataclass for UpdateOrganizationConfigurationOutput structure.