UpdateOrganizationConfiguration - Amazon GuardDuty

UpdateOrganizationConfiguration

Configures the delegated administrator account with the provided values. You must provide a value for either autoEnableOrganizationMembers or autoEnable, but not both.

There might be regional differences because some data sources might not be available in all the AWS Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.

Request Syntax

POST /detector/detectorId/admin HTTP/1.1 Content-type: application/json { "autoEnable": boolean, "autoEnableOrganizationMembers": "string", "dataSources": { "kubernetes": { "auditLogs": { "autoEnable": boolean } }, "malwareProtection": { "scanEc2InstanceWithFindings": { "ebsVolumes": { "autoEnable": boolean } } }, "s3Logs": { "autoEnable": boolean } }, "features": [ { "additionalConfiguration": [ { "autoEnable": "string", "name": "string" } ], "autoEnable": "string", "name": "string" } ] }

URI Request Parameters

The request uses the following URI parameters.

detectorId

The ID of the detector that configures the delegated administrator.

Length Constraints: Minimum length of 1. Maximum length of 300.

Required: Yes

Request Body

The request accepts the following data in JSON format.

autoEnable

This parameter has been deprecated.

Represents whether or not to automatically enable member accounts in the organization.

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.

Type: Boolean

Required: No

autoEnableOrganizationMembers

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 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 GuardDuty will not be automatically enabled for any account in the organization. The administrator must manage GuardDuty for each account in the organization individually.

Type: String

Valid Values: NEW | ALL | NONE

Required: No

dataSources

This parameter has been deprecated.

Describes which data sources will be updated.

Type: OrganizationDataSourceConfigurations object

Required: No

features

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

Type: Array of OrganizationFeatureConfiguration objects

Required: No

Response Syntax

HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

A bad request exception object.

HTTP Status Code: 400

InternalServerErrorException

An internal server error exception object.

HTTP Status Code: 500

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: