Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1424171133.3 KB

Creates a new case.

post/v1/create-case

Request body

clientTokenstring
<p><note> <p>The <code>clientToken</code> field is an idempotency key used to ensure that repeated attempts for a single action will be ignored by the server during retries. A caller supplied unique ID (typically a UUID) should be provided. </p> </note></p>
resolverType'AWS' | 'Self' required

Required element used in combination with CreateCase to identify the resolver type.

titlestring password required

Required element used in combination with CreateCase to provide a title for the new case.

descriptionstring password required
<p>Required element used in combination with CreateCase</p> <p>to provide a description for the new case.</p>
engagementType'Security Incident' | 'Investigation' required

Required element used in combination with CreateCase to provide an engagement type for the new cases. Available engagement types include Security Incident | Investigation

reportedIncidentStartDatestring date-time required

Required element used in combination with CreateCase to provide an initial start date for the unauthorized activity.

impactedAccountsAWSAccountId[] required
<p>Required element used in combination with CreateCase to provide a list of impacted accounts.</p> <note> <p> AWS account ID's may appear less than 12 characters and need to be zero-prepended. An example would be <code>123123123</code> which is nine digits, and with zero-prepend would be <code>000123123123</code>. Not zero-prepending to 12 digits could result in errors. </p> </note>
impactedServicesAwsService[]

An optional element used in combination with CreateCase to provide a list of services impacted.

tagsobject

An optional element used in combination with CreateCase to add customer specified tags to a case.

Response

Success

caseIdstring required

A response element providing responses for requests to CreateCase. This element responds with the case ID.