- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
ListCaseEditsCommand
Grants permissions to view the aidt log for edits made to a designated case.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { SecurityIRClient, ListCaseEditsCommand } from "@aws-sdk/client-security-ir"; // ES Modules import
// const { SecurityIRClient, ListCaseEditsCommand } = require("@aws-sdk/client-security-ir"); // CommonJS import
const client = new SecurityIRClient(config);
const input = { // ListCaseEditsRequest
nextToken: "STRING_VALUE",
maxResults: Number("int"),
caseId: "STRING_VALUE", // required
};
const command = new ListCaseEditsCommand(input);
const response = await client.send(command);
// { // ListCaseEditsResponse
// nextToken: "STRING_VALUE",
// items: [ // CaseEditItems
// { // CaseEditItem
// eventTimestamp: new Date("TIMESTAMP"),
// principal: "STRING_VALUE",
// action: "STRING_VALUE",
// message: "STRING_VALUE",
// },
// ],
// total: Number("int"),
// };
Example Usage
Loading code editorLoading code editor
ListCaseEditsCommand Input
See ListCaseEditsCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
caseIdRequired | string | undefined | Required element used with ListCaseEdits to identify the case to query. |
maxResults | number | undefined | Optional element to identify how many results to obtain. There is a maximum value of 25. |
nextToken | string | undefined | Optional element for a customer provided token. |
ListCaseEditsCommand Output
See ListCaseEditsCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
items | CaseEditItem[] | undefined | Response element for ListCaseEdits that includes the action, eventtimestamp, message, and principal for the response. |
nextToken | string | undefined | Optional element. |
total | number | undefined | Response element for ListCaseEdits that identifies the total number of edits. |
Throws
Name | Fault | Details |
|---|
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. |