UpdateThreatEntitySet - Amazon GuardDuty

UpdateThreatEntitySet

Updates the threat entity set associated with the specified threatEntitySetId.

Request Syntax

POST /detector/detectorId/threatentityset/threatEntitySetId HTTP/1.1 Content-type: application/json { "activate": boolean, "expectedBucketOwner": "string", "location": "string", "name": "string" }

URI Request Parameters

The request uses the following URI parameters.

detectorId

The unique ID of the GuardDuty detector associated with the threat entity set that you want to update.

To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

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

Required: Yes

threatEntitySetId

The ID returned by GuardDuty after updating the threat entity set resource.

Required: Yes

Request Body

The request accepts the following data in JSON format.

activate

A boolean value that indicates whether GuardDuty is to start using this updated threat entity set. After you update an entity set, you will need to activate it again. It might take up to 15 minutes for the updated entity set to be effective.

Type: Boolean

Required: No

expectedBucketOwner

The AWS account ID that owns the Amazon S3 bucket specified in the location parameter.

Type: String

Length Constraints: Fixed length of 12.

Pattern: ^[0-9]+$

Required: No

location

The URI of the file that contains the trusted entity set.

Type: String

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

Required: No

name

A user-friendly name to identify the trusted entity set.

List naming constraints - The name of your list can include lowercase letters, uppercase letters, numbers, dash (-), and underscore (_).

Type: String

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

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: