DescribeCreateCaseOptions
Returns a list of CreateCaseOption types along with the
corresponding supported hours and language availability. You can specify the language
categoryCode
,
issueType
and serviceCode
used to retrieve the CreateCaseOptions.
Note
-
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
-
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the
SubscriptionRequiredException
error message appears. For information about changing your support plan, see Amazon Web Services Support.
Request Syntax
{
"categoryCode": "string
",
"issueType": "string
",
"language": "string
",
"serviceCode": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- categoryCode
-
The category of problem for the support case. You also use the DescribeServices operation to get the category code for a service. Each Amazon service defines its own set of category codes.
Type: String
- issueType
-
The type of issue for the case. You can specify
customer-service
ortechnical
. If you don't specify a value, the default istechnical
.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
- serviceCode
-
The code for the Amazon service. You can use the DescribeServices operation to get the possible
serviceCode
values.Type: String
Response Syntax
{
"communicationTypes": [
{
"datesWithoutSupport": [
{
"endDateTime": "string",
"startDateTime": "string"
}
],
"supportedHours": [
{
"endTime": "string",
"startTime": "string"
}
],
"type": "string"
}
],
"languageAvailability": "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.
- communicationTypes
-
A JSON-formatted array that contains the available communication type options, along with the available support timeframes for the given inputs.
Type: Array of CommunicationTypeOptions objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
- languageAvailability
-
Language availability can be any of the following:
-
available
-
best_effort
-
unavailable
Type: String
Length Constraints: Minimum length of 0. Maximum length of 100.
-
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServerError
-
An internal server error occurred.
HTTP Status Code: 500
- ThrottlingException
-
You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: