describe_services
async
¶
describe_services(
*,
config_overrides: Optional[AsyncSupportClientConfig] = None,
service_code_list: Optional[ServiceCodeList] = None,
language: Optional[Language] = None,
dry_run: Optional[NullableBooleanType] = None,
) -> DescribeServicesResponse
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 CreateCase 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 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.
-
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
SubscriptionRequiredExceptionerror message appears. For information about changing your support plan, see Amazon Web Services Support.
Parameters:
-
service_code_list(Optional[ServiceCodeList], default:None) –A JSON-formatted list of service codes available for Amazon Web Services services.
-
language(Optional[Language], default:None) –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
languageparameter if you want support in that language. -
dry_run(Optional[NullableBooleanType], default:None) –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 aDryRunOperationException. When omitted or set tofalse, the request runs normally.
Raises:
-
DryRunOperationException–The request was valid, but the operation wasn't performed because
dryRunwas set totrue. -
InternalServerError–An internal server error occurred.
-
UnknownServiceError–The service returned an error code this client does not model.