View a markdown version of this page

ðŸ“Ē āđāļˆāđ‰āļ‡āđ€āļ•āļ·āļ­āļ™: guardduty/latest/APIReference/API UpdateCustomDetectionRuleOrgConfiguration.html - Kapook Update 2025

UpdateCustomDetectionRuleOrgConfiguration

Replaces the include and exclude account lists of an existing organization-level configuration for a custom detection rule. Updating a dry run configuration restarts its 14-day expiry.

This operation doesn't change the mode of the configuration. To change the mode, delete the configuration with DeleteCustomDetectionRuleOrgConfiguration, and then create a configuration in the new mode with CreateCustomDetectionRuleOrgConfiguration.

Request Syntax

PUT /custom-detection-rule/org-configuration/RuleId HTTP/1.1 Content-type: application/json { "excludeAccountIds": [ "string" ], "includeAccountIds": [ "string" ], "mode": "string" }

URI Request Parameters

The request uses the following URI parameters.

RuleId

The unique identifier for the custom detection rule.

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

Pattern: [a-z0-9]+(-[a-z0-9]+)*

Required: Yes

Request Body

The request accepts the following data in JSON format.

excludeAccountIds

The account IDs to exclude from the organization configuration. Mutually exclusive with IncludeAccountIds.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 50000 items.

Length Constraints: Fixed length of 12.

Required: No

includeAccountIds

The account IDs to include in the organization configuration. Mutually exclusive with ExcludeAccountIds.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 50000 items.

Length Constraints: Fixed length of 12.

Required: No

mode

The execution mode of the organization configuration to update. This value selects the configuration and doesn't change its mode. Valid values: LIVE | DRY_RUN.

Type: String

Valid Values: LIVE | DRY_RUN

Required: Yes

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 Error Types.

AccessDeniedException

An access denied exception object.

Message

The error message.

Type

The error type.

HTTP Status Code: 403

BadRequestException

A bad request exception object.

Message

The error message.

Type

The error type.

HTTP Status Code: 400

ConflictException

A request conflict exception object.

Message

The error message.

Type

The error type.

HTTP Status Code: 409

InternalServerErrorException

An internal server error exception object.

Message

The error message.

Type

The error type.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource can't be found.

Message

The error message.

Type

The error type.

HTTP Status Code: 404

See Also

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