CreateIPSet - Amazon GuardDuty

CreateIPSet

Creates a new IPSet, called Trusted IP list in the consoler user interface. An IPSet is a list IP addresses trusted for secure communication with AWS infrastructure and applications. GuardDuty does not generate findings for IP addresses included in IPSets. Only users from the master account can use this operation.

Request Syntax

POST /detector/detectorId/ipset HTTP/1.1 Content-type: application/json { "activate": boolean, "clientToken": "string", "format": "string", "location": "string", "name": "string", "tags": { "string" : "string" } }

URI Request Parameters

The request requires the following URI parameters.

detectorId

The unique ID of the detector of the GuardDuty account for which you want to create an IPSet.

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

Request Body

The request accepts the following data in JSON format.

activate

A boolean value that indicates whether GuardDuty is to start using the uploaded IPSet.

Type: Boolean

Required: Yes

clientToken

The idempotency token for the create request.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 64.

Required: No

format

The format of the file that contains the IPSet.

Type: String

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

Valid Values: TXT | STIX | OTX_CSV | ALIEN_VAULT | PROOF_POINT | FIRE_EYE

Required: Yes

location

The URI of the file that contains the IPSet. For example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key)

Type: String

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

Required: Yes

name

The user friendly name to identify the IPSet. This name is displayed in all findings that are triggered by activity that involves IP addresses included in this IPSet.

Type: String

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

Required: Yes

tags

The tags to be added to a new IP set resource.

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$

Value Length Constraints: Maximum length of 256.

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "ipSetId": "string" }

Response Elements

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

The following data is returned in JSON format by the service.

ipSetId

The ID of the IPSet resource.

Type: String

Errors

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

BadRequestException

Bad request exception object.

HTTP Status Code: 400

InternalServerErrorException

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: