Lists cases for a given contact.
Request Syntax
POST /domains/domainId/list-cases-for-contact HTTP/1.1
Content-type: application/json
{
"contactArn": "string",
"maxResults": number,
"nextToken": "string"
}URI Request Parameters
The request uses the following URI parameters.
- domainId
-
The unique identifier of the Cases domain.
Length Constraints: Minimum length of 1. Maximum length of 500.
Required: Yes
Request Body
The request accepts the following data in JSON format.
- contactArn
-
A unique identifier of a contact in Amazon Connect.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 500.
Required: Yes
- maxResults
-
The maximum number of results to return per page.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 10.
Required: No
- nextToken
-
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 9000.
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"cases": [
{
"caseId": "string",
"templateId": "string"
}
],
"nextToken": "string"
}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.
- cases
-
A list of Case summary information.
Type: Array of CaseSummary objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
- nextToken
-
The token for the next set of results. This is null if there are no more results to return.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 9000.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- InternalServerException
-
We couldn't process your request because of an issue with the server. Try again later.
HTTP Status Code: 500
- ResourceNotFoundException
-
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.
HTTP Status Code: 404
- ThrottlingException
-
The rate has been exceeded for this API. Please try again after a few minutes.
HTTP Status Code: 429
- ValidationException
-
The request isn't valid. Check the syntax and try again.
HTTP Status Code: 400
Examples
Request and Response example
This example illustrates one usage of ListCasesForContact.
{
"contactArn": "arn:aws:connect:us-west-2:[account_id]:instance/[connect_instance_id]/contact/[contact_id]",
"maxResults": 10
}
{
"cases": [
{
"caseId": "[case_id_1]",
"templateId": "[template_id_1]"
},
{
"caseId": "[case_id_2]",
"templateId": "[template_id_2]"
},
{
"caseId": "[case_id_3]",
"templateId": "[template_id_3]"
}
]
"nextToken": null
} See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
