describe_organization_configuration¶
Operation¶
async
¶
describe_organization_configuration(input: DescribeOrganizationConfigurationInput, plugins: list[Plugin] | None = None) -> DescribeOrganizationConfigurationOutput
Returns information about the account selected as the delegated administrator for GuardDuty.
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
|
DescribeOrganizationConfigurationInput
|
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 |
|---|---|
DescribeOrganizationConfigurationOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for DescribeOrganizationConfigurationInput structure.
Attributes¶
class-attribute
instance-attribute
¶
detector_id: str | None = None
The detector ID of the delegated administrator for which you need to retrieve the information.
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
¶
max_results: int | None = None
You can use this parameter to indicate the maximum number of items that you want in the response.
class-attribute
instance-attribute
¶
next_token: str | None = None
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 nextToken in the request with the
value of NextToken from the previous response to continue listing
data.
Output¶
dataclass
¶
Dataclass for DescribeOrganizationConfigurationOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
auto_enable: bool | None = None
Indicates whether GuardDuty is automatically enabled for accounts added to the organization.
Even though this is still supported, we recommend using
AutoEnableOrganizationMembers to achieve the similar results.
class-attribute
instance-attribute
¶
auto_enable_organization_members: AutoEnableMembers | None = None
Indicates the auto-enablement configuration of GuardDuty or any of the corresponding protection plans for the member accounts in the organization.
-
NEW: Indicates that when a new account joins the organization, they will have GuardDuty or any of the corresponding protection plans enabled automatically. -
ALL: Indicates that all accounts in the organization have GuardDuty and any of the corresponding protection plans enabled automatically. This includesNEWaccounts that join the organization and accounts that may have been suspended or removed from the organization in GuardDuty. -
NONE: 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.
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: OrganizationDataSourceConfigurationsResult | None = None
Describes which data sources are enabled automatically for member accounts.
class-attribute
instance-attribute
¶
features: list[OrganizationFeatureConfigurationResult] | None = None
A list of features that are configured for this organization.
class-attribute
instance-attribute
¶
member_account_limit_reached: bool | None = None
Indicates whether the maximum number of allowed member accounts are already associated with the delegated administrator account for your organization.
class-attribute
instance-attribute
¶
next_token: str | None = None
The pagination parameter to be used on the next list operation to retrieve more items.