Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeServices

Returns the current list of Amazon services and a list of service categories for each service. You then use service names and categories in your CreateCase requests. Each Amazon service has its own set of categories.

The service codes and category codes correspond to the values that appear in the Service and Category lists on the Amazon Web Services Support Center Create Case page. The values in those fields don't necessarily match the service codes and categories returned by the DescribeServices operation. Always use the service codes and categories that the DescribeServices operation returns, so that you have the most recent set of service and category codes.

Note

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

Request Syntax


{
   "dryRun": boolean,
   "language": "string",
   "serviceCodeList": [ "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.

dryRun

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

Type: Boolean

language

The language in which Amazon Web Services Support handles the case. Amazon Web Services 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

serviceCodeList

A JSON-formatted list of service codes available for Amazon services.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 100 items.

Response Syntax


{
   "services": [ 
      { 
         "categories": [ 
            { 
               "code": "string",
               "name": "string"
            }
         ],
         "code": "string",
         "name": "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.

services

A JSON-formatted list of Amazon services.

Type: Array of Service objects

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