Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListCases

Lists all cases the requester has access to.

Request Syntax


POST /v1/list-cases HTTP/1.1
Content-type: application/json

{
   "maxResults": number,
   "nextToken": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

maxResults

Optional element for ListCases to limit the number of responses.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 25.

Required: No

nextToken

Type: String

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

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "caseArn": "string",
         "caseId": "string",
         "caseStatus": "string",
         "closedDate": number,
         "createdDate": number,
         "engagementType": "string",
         "lastUpdatedDate": number,
         "pendingAction": "string",
         "resolverType": "string",
         "title": "string"
      }
   ],
   "nextToken": "string",
   "total": number
}

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.

items

Response element for ListCases that includes caseARN, caseID, caseStatus, closedDate, createdDate, engagementType, lastUpdatedDate, pendingAction, resolverType, and title for each response.

Type: Array of ListCasesItem objects

nextToken

Type: String

total

Response element for ListCases providing the total number of responses.

Type: Long

Errors

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

AccessDeniedException

HTTP Status Code: 403

ConflictException

HTTP Status Code: 409

InternalServerException

HTTP Status Code: 500

InvalidTokenException

HTTP Status Code: 423

ResourceNotFoundException

HTTP Status Code: 404

SecurityIncidentResponseNotActiveException

HTTP Status Code: 400

ServiceQuotaExceededException

HTTP Status Code: 402

ThrottlingException

HTTP Status Code: 429

ValidationException

HTTP Status Code: 400