Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

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 an AWS Business Support+, AWS Enterprise Support, or AWS Unified Operations plan to use the AWS Support API. If you're in an AWS Region that doesn't offer one of these AWS Support plans, or if you haven't transitioned to one of these plans, you can use the AWS Support API with a Business, Enterprise On-Ramp, or Enterprise Support plan.
If you call the AWS Support API from an account that doesn't have an AWS Business Support+, AWS Enterprise Support, or AWS Unified Operations plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see AWS Support.

Request Syntax


{
   "categoryCode": "string",
   "dryRun": boolean,
   "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 AWS service defines its own set of category codes.

Type: String

dryRun

Specifies whether to validate the request without actually returning case option data. When set to true, the request is validated but no options are returned, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.

Type: Boolean

issueType

The type of issue for the case. You can specify customer-service or technical. If you don't specify a value, the default is technical.

Type: String

language

The language in which AWS Support handles the case. AWS Support currently supports Chinese (“zh”), English ("en"), Japanese ("ja") , Chinese ("zh"), Spanish ("es"), Portuguese ("pt"), French ("fr"), Korean (“ko”), and Turkish ("tr"). 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 AWS 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 Error Types.

DryRunOperationException

The request was valid, but the operation wasn't performed because dryRun was set to true.

HTTP Status Code: 400

InternalServerError

An internal server error occurred.

message: 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