Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateIPSet

Updates the IPSet specified by the IPSet ID.

Request Syntax


POST /detector/detectorId/ipset/ipSetId 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 detectorID that specifies the GuardDuty service whose IPSet 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

ipSetId

The unique ID that specifies the IPSet that you want to update.

Required: Yes

Request Body

The request accepts the following data in JSON format.

activate

The updated Boolean value that specifies whether the IPSet is active or not.

Type: Boolean

Required: No

expectedBucketOwner

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

Type: String

Length Constraints: Fixed length of 12.

Required: No

location

The updated URI of the file that contains the IPSet.

Type: String

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

Required: No

name

The unique ID that specifies the IPSet that you want to update.

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.

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

InternalServerErrorException

An internal server error exception object.

Message: The error message.
Type: The error type.

HTTP Status Code: 500