CaseDetails
A JSON-formatted object that contains the metadata for a support case. It is contained in the response from a DescribeCases request. CaseDetails contains the following fields:
-
caseId - The support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47.
-
categoryCode - The category of problem for the support case. Corresponds to the
CategoryCode
values returned by a call to DescribeServices. -
displayId - The identifier for the case on pages in the Amazon Web Services Support Center.
-
language - The language in which Amazon Web Services Support handles the case. Amazon Web Services Support currently supports Chinese (“zh”), English ("en"), Japanese ("ja") and Korean (“ko”). You must specify the ISO 639-1 code for the
language
parameter if you want support in that language. -
nextToken - A resumption point for pagination.
-
recentCommunications - One or more Communication objects. Fields of these objects are
attachments
,body
,caseId
,submittedBy
, andtimeCreated
. -
serviceCode - The identifier for the Amazon service that corresponds to the service code defined in the call to DescribeServices.
-
severityCode - The severity code assigned to the case. Contains one of the values returned by the call to DescribeSeverityLevels. The possible values are:
low
,normal
,high
,urgent
, andcritical
. -
status - The status of the case in the Amazon Web Services Support Center. Valid values:
-
opened
-
pending-customer-action
-
reopened
-
resolved
-
unassigned
-
work-in-progress
-
-
subject - The subject line of the case.
-
submittedBy - The email address of the account that submitted the case.
-
timeCreated - The time the case was created, in ISO-8601 format.
Contents
- caseId
-
The support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47
Type: String
- categoryCode
-
The category of problem for the support case.
Type: String
- ccEmailAddresses
-
The email addresses that receive copies of communication about the case.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 10 items.
- displayId
-
The ID displayed for the case in the Amazon Web Services Support Center. This is a numeric string.
Type: String
- language
-
The language in which Amazon Web Services Support handles the case. Amazon Web Services Support currently supports Chinese (“zh”), English ("en"), Japanese ("ja") and Korean (“ko”). You must specify the ISO 639-1 code for the
language
parameter if you want support in that language.Type: String
- recentCommunications
-
The five most recent communications between you and Amazon Web Services Support Center, including the IDs of any attachments to the communications. Also includes a
nextToken
that you can use to retrieve earlier communications.Type: RecentCaseCommunications object
- serviceCode
-
The code for the Amazon service. You can get a list of codes and the corresponding service names by calling DescribeServices.
Type: String
- severityCode
-
The code for the severity level returned by the call to DescribeSeverityLevels.
Type: String
- status
-
The status of the case.
Valid values:
-
opened
-
pending-customer-action
-
reopened
-
resolved
-
unassigned
-
work-in-progress
Type: String
-
- subject
-
The subject line for the case in the Amazon Web Services Support Center.
Type: String
- submittedBy
-
The email address of the account that submitted the case.
Type: String
- timeCreated
-
The time that the case was created in the Amazon Web Services Support Center.
Type: String
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: