Skip to content

Returns the current list of Amazon Web Services services and a list of service categories for each service

Description

Returns the current list of Amazon Web Services services and a list of service categories for each service. You then use service names and categories in your create_case requests. Each Amazon Web Services 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 describe_services operation. Always use the service codes and categories that the describe_services operation returns, so that you have the most recent set of service and category codes.

  • You must have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan to use the Amazon Web Services Support API. If you're in an Amazon Web Services 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 Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

Usage

support_describe_services(serviceCodeList, language, dryRun)

Arguments

  • serviceCodeList

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

  • 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.

  • 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.

Value

A list with the following syntax:

list(
  services = list(
    list(
      code = "string",
      name = "string",
      categories = list(
        list(
          code = "string",
          name = "string"
        )
      )
    )
  )
)

Request syntax

svc$describe_services(
  serviceCodeList = list(
    "string"
  ),
  language = "string",
  dryRun = TRUE|FALSE
)