GuardDuty / Client / describe_organization_configuration

describe_organization_configuration#

GuardDuty.Client.describe_organization_configuration(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_organization_configuration(
    DetectorId='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • DetectorId (string) –

    [REQUIRED]

    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.

  • MaxResults (integer) – You can use this parameter to indicate the maximum number of items that you want in the response.

  • NextToken (string) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'AutoEnable': True|False,
    'MemberAccountLimitReached': True|False,
    'DataSources': {
        'S3Logs': {
            'AutoEnable': True|False
        },
        'Kubernetes': {
            'AuditLogs': {
                'AutoEnable': True|False
            }
        },
        'MalwareProtection': {
            'ScanEc2InstanceWithFindings': {
                'EbsVolumes': {
                    'AutoEnable': True|False
                }
            }
        }
    },
    'Features': [
        {
            'Name': 'S3_DATA_EVENTS'|'EKS_AUDIT_LOGS'|'EBS_MALWARE_PROTECTION'|'RDS_LOGIN_EVENTS'|'EKS_RUNTIME_MONITORING'|'LAMBDA_NETWORK_LOGS'|'RUNTIME_MONITORING',
            'AutoEnable': 'NEW'|'NONE'|'ALL',
            'AdditionalConfiguration': [
                {
                    'Name': 'EKS_ADDON_MANAGEMENT'|'ECS_FARGATE_AGENT_MANAGEMENT'|'EC2_AGENT_MANAGEMENT',
                    'AutoEnable': 'NEW'|'NONE'|'ALL'
                },
            ]
        },
    ],
    'NextToken': 'string',
    'AutoEnableOrganizationMembers': 'NEW'|'ALL'|'NONE'
}

Response Structure

  • (dict) –

    • AutoEnable (boolean) –

      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.

    • MemberAccountLimitReached (boolean) –

      Indicates whether the maximum number of allowed member accounts are already associated with the delegated administrator account for your organization.

    • DataSources (dict) –

      Describes which data sources are enabled automatically for member accounts.

      • S3Logs (dict) –

        Describes whether S3 data event logs are enabled as a data source.

        • AutoEnable (boolean) –

          A value that describes whether S3 data event logs are automatically enabled for new members of the organization.

      • Kubernetes (dict) –

        Describes the configuration of Kubernetes data sources.

        • AuditLogs (dict) –

          The current configuration of Kubernetes audit logs as a data source for the organization.

          • AutoEnable (boolean) –

            Whether Kubernetes audit logs data source should be auto-enabled for new members joining the organization.

      • MalwareProtection (dict) –

        Describes the configuration of Malware Protection data source for an organization.

        • ScanEc2InstanceWithFindings (dict) –

          Describes the configuration for scanning EC2 instances with findings for an organization.

          • EbsVolumes (dict) –

            Describes the configuration for scanning EBS volumes for an organization.

            • AutoEnable (boolean) –

              An object that contains the status of whether scanning EBS volumes should be auto-enabled for new members joining the organization.

    • Features (list) –

      A list of features that are configured for this organization.

      • (dict) –

        A list of features which will be configured for the organization.

        • Name (string) –

          The name of the feature that is configured for the member accounts within the organization.

        • AutoEnable (string) –

          Describes the status of the feature that is configured for the member accounts within the organization.

          • NEW: Indicates that when a new account joins the organization, they will have the feature enabled automatically.

          • ALL: Indicates that all accounts in the organization have the feature enabled automatically. This includes NEW accounts that join the organization and accounts that may have been suspended or removed from the organization in GuardDuty.

          • NONE: Indicates that the feature will not be automatically enabled for any account in the organization. In this case, each account will be managed individually by the administrator.

        • AdditionalConfiguration (list) –

          The additional configuration that is configured for the member accounts within the organization.

          • (dict) –

            A list of additional configuration which will be configured for the organization.

            • Name (string) –

              The name of the additional configuration that is configured for the member accounts within the organization.

            • AutoEnable (string) –

              Describes the status of the additional configuration that is configured for the member accounts within the organization. One of the following values is the status for the entire organization:

              • NEW: Indicates that when a new account joins the organization, they will have the additional configuration enabled automatically.

              • ALL: Indicates that all accounts in the organization have the additional configuration enabled automatically. This includes NEW accounts 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 the additional configuration will not be automatically enabled for any account in the organization. The administrator must manage the additional configuration for each account individually.

    • NextToken (string) –

      The pagination parameter to be used on the next list operation to retrieve more items.

    • AutoEnableOrganizationMembers (string) –

      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 includes NEW accounts 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.

Exceptions