Support / Client / describe_services

describe_services¶

Support.Client.describe_services(**kwargs)¶

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.

Note

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.

Request Syntax

response = client.describe_services(
    serviceCodeList=[
        'string',
    ],
    language='string',
    dryRun=True|False
)

Parameters:

serviceCodeList (list) –
A JSON-formatted list of service codes available for Amazon Web Services services.
- (string) –
language (string) – 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 (boolean) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'services': [
        {
            'code': 'string',
            'name': 'string',
            'categories': [
                {
                    'code': 'string',
                    'name': 'string'
                },
            ]
        },
    ]
}

Response Structure

(dict) –

The list of Amazon Web Services services returned by the DescribeServices operation.
- services (list) –
  
  A JSON-formatted list of Amazon Web Services services.
  - (dict) –
    
    Information about an Amazon Web Services service returned by the DescribeServices operation.
    - code (string) –
      
      The code for an Amazon Web Services service returned by the DescribeServices response. The name element contains the corresponding friendly name.
    - name (string) –
      
      The friendly name for an Amazon Web Services service. The code element contains the corresponding code.
    - categories (list) –
      
      A list of categories that describe the type of support issue a case describes. Categories consist of a category name and a category code. Category names and codes are passed to Amazon Web Services Support when you call CreateCase.
      - (dict) –
        
        A JSON-formatted name/value pair that represents the category name and category code of the problem, selected from the DescribeServices response for each Amazon Web Services service.
        
        code (string) –
        
        The category code for the support case.
        
        name (string) –
        
        The category name for the support case.