UpdateCaseCommand

Suggest an Edit

Grants permission to update an existing case.

Example Syntax

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

import { SecurityIRClient, UpdateCaseCommand } from "@aws-sdk/client-security-ir"; // ES Modules import
// const { SecurityIRClient, UpdateCaseCommand } = require("@aws-sdk/client-security-ir"); // CommonJS import
const client = new SecurityIRClient(config);
const input = { // UpdateCaseRequest
  caseId: "STRING_VALUE", // required
  title: "STRING_VALUE",
  description: "STRING_VALUE",
  reportedIncidentStartDate: new Date("TIMESTAMP"),
  actualIncidentStartDate: new Date("TIMESTAMP"),
  engagementType: "Security Incident" || "Investigation",
  watchersToAdd: [ // Watchers
    { // Watcher
      email: "STRING_VALUE", // required
      name: "STRING_VALUE",
      jobTitle: "STRING_VALUE",
    },
  ],
  watchersToDelete: [
    {
      email: "STRING_VALUE", // required
      name: "STRING_VALUE",
      jobTitle: "STRING_VALUE",
    },
  ],
  threatActorIpAddressesToAdd: [ // ThreatActorIpList
    { // ThreatActorIp
      ipAddress: "STRING_VALUE", // required
      userAgent: "STRING_VALUE",
    },
  ],
  threatActorIpAddressesToDelete: [
    {
      ipAddress: "STRING_VALUE", // required
      userAgent: "STRING_VALUE",
    },
  ],
  impactedServicesToAdd: [ // ImpactedServicesList
    "STRING_VALUE",
  ],
  impactedServicesToDelete: [
    "STRING_VALUE",
  ],
  impactedAwsRegionsToAdd: [ // ImpactedAwsRegionList
    { // ImpactedAwsRegion
      region: "af-south-1" || "ap-east-1" || "ap-northeast-1" || "ap-northeast-2" || "ap-northeast-3" || "ap-south-1" || "ap-south-2" || "ap-southeast-1" || "ap-southeast-2" || "ap-southeast-3" || "ap-southeast-4" || "ap-southeast-5" || "ca-central-1" || "ca-west-1" || "cn-north-1" || "cn-northwest-1" || "eu-central-1" || "eu-central-2" || "eu-north-1" || "eu-south-1" || "eu-south-2" || "eu-west-1" || "eu-west-2" || "eu-west-3" || "il-central-1" || "me-central-1" || "me-south-1" || "sa-east-1" || "us-east-1" || "us-east-2" || "us-west-1" || "us-west-2", // required
    },
  ],
  impactedAwsRegionsToDelete: [
    {
      region: "af-south-1" || "ap-east-1" || "ap-northeast-1" || "ap-northeast-2" || "ap-northeast-3" || "ap-south-1" || "ap-south-2" || "ap-southeast-1" || "ap-southeast-2" || "ap-southeast-3" || "ap-southeast-4" || "ap-southeast-5" || "ca-central-1" || "ca-west-1" || "cn-north-1" || "cn-northwest-1" || "eu-central-1" || "eu-central-2" || "eu-north-1" || "eu-south-1" || "eu-south-2" || "eu-west-1" || "eu-west-2" || "eu-west-3" || "il-central-1" || "me-central-1" || "me-south-1" || "sa-east-1" || "us-east-1" || "us-east-2" || "us-west-1" || "us-west-2", // required
    },
  ],
  impactedAccountsToAdd: [ // ImpactedAccounts
    "STRING_VALUE",
  ],
  impactedAccountsToDelete: [
    "STRING_VALUE",
  ],
};
const command = new UpdateCaseCommand(input);
const response = await client.send(command);
// {};

Example Usage

 Loading code editor

UpdateCaseCommand Input

See UpdateCaseCommandInput for more details

Parameter
Type
Description
caseId
Required
string | undefined

Required element for UpdateCase to identify the case ID for updates.

actualIncidentStartDate
Date | undefined

Optional element for UpdateCase to provide content for the incident start date field.

description
string | undefined

Optional element for UpdateCase to provide content for the description field.

engagementType
EngagementType | undefined

Optional element for UpdateCase to provide content for the engagement type field. Available engagement types include Security Incident | Investigation.

impactedAccountsToAdd
string[] | undefined

Optional element for UpdateCase to provide content to add accounts impacted.

impactedAccountsToDelete
string[] | undefined

Optional element for UpdateCase to provide content to add accounts impacted.

impactedAwsRegionsToAdd
ImpactedAwsRegion[] | undefined

Optional element for UpdateCase to provide content to add regions impacted.

impactedAwsRegionsToDelete
ImpactedAwsRegion[] | undefined

Optional element for UpdateCase to provide content to remove regions impacted.

impactedServicesToAdd
string[] | undefined

Optional element for UpdateCase to provide content to add services impacted.

impactedServicesToDelete
string[] | undefined

Optional element for UpdateCase to provide content to remove services impacted.

reportedIncidentStartDate
Date | undefined

Optional element for UpdateCase to provide content for the customer reported incident start date field.

threatActorIpAddressesToAdd
ThreatActorIp[] | undefined

Optional element for UpdateCase to provide content to add additional suspicious IP addresses related to a case.

threatActorIpAddressesToDelete
ThreatActorIp[] | undefined

Optional element for UpdateCase to provide content to remove suspicious IP addresses from a case.

title
string | undefined

Optional element for UpdateCase to provide content for the title field.

watchersToAdd
Watcher[] | undefined

Optional element for UpdateCase to provide content to add additional watchers to a case.

watchersToDelete
Watcher[] | undefined

Optional element for UpdateCase to provide content to remove existing watchers from a case.

UpdateCaseCommand Output

See UpdateCaseCommandOutput for details

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

Throws

Name
Fault
Details
AccessDeniedException
client
<p/>
ConflictException
client
<p/>
InternalServerException
server
<p/>
InvalidTokenException
client
<p/>
ResourceNotFoundException
client
<p/>
SecurityIncidentResponseNotActiveException
client
<p/>
ServiceQuotaExceededException
client
<p/>
ThrottlingException
client
<p/>
ValidationException
client
<p/>
SecurityIRServiceException
Base exception class for all service exceptions from SecurityIR service.