UpdateIPSetCommand

Suggest an Edit

Updates the IPSet specified by the IPSet ID.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { GuardDutyClient, UpdateIPSetCommand } from "@aws-sdk/client-guardduty"; // ES Modules import
// const { GuardDutyClient, UpdateIPSetCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import
const client = new GuardDutyClient(config);
const input = { // UpdateIPSetRequest
  DetectorId: "STRING_VALUE", // required
  IpSetId: "STRING_VALUE", // required
  Name: "STRING_VALUE",
  Location: "STRING_VALUE",
  Activate: true || false,
};
const command = new UpdateIPSetCommand(input);
const response = await client.send(command);
// {};

UpdateIPSetCommand Input

See UpdateIPSetCommandInput for more details

Parameter
Type
Description
DetectorId
Required
string | undefined

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.

IpSetId
Required
string | undefined

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

Activate
boolean | undefined

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

Location
string | undefined

The updated URI of the file that contains the IPSet.

Name
string | undefined

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

UpdateIPSetCommand Output

See UpdateIPSetCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
BadRequestException
client

A bad request exception object.

InternalServerErrorException
server

An internal server error exception object.

GuardDutyServiceException
Base exception class for all service exceptions from GuardDuty service.