AWS Support

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.

See also: AWS API Documentation

Request Syntax

client.describe_create_case_options(
    issueType='string',
    serviceCode='string',
    language='string',
    categoryCode='string'
)

type issueType:

string

param issueType:

[REQUIRED]

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

string

param serviceCode:

[REQUIRED]

The code for the Amazon Web Services service. You can use the DescribeServices operation to get the possible serviceCode values.

type language:

string

param language:

[REQUIRED]

The language in which Amazon Web Services Support handles the case. Amazon Web Services Support currently supports Chinese (“zh”), English ("en"), Japanese ("ja") and Korean (“ko”). You must specify the ISO 639-1 code for the language parameter if you want support in that language.

type categoryCode:

string

param categoryCode:

[REQUIRED]

The category of problem for the support case. You also use the DescribeServices operation to get the category code for a service. Each Amazon Web Services service defines its own set of category codes.

rtype:

dict

returns:

Response Syntax

{
    'languageAvailability': 'string',
    'communicationTypes': [
        {
            'type': 'string',
            'supportedHours': [
                {
                    'startTime': 'string',
                    'endTime': 'string'
                },
            ],
            'datesWithoutSupport': [
                {
                    'startDateTime': 'string',
                    'endDateTime': 'string'
                },
            ]
        },
    ]
}

Response Structure

• (dict) --

  • languageAvailability (string) --

    Language availability can be any of the following:

    • available

    • best_effort

    • unavailable

  • communicationTypes (list) --

    A JSON-formatted array that contains the available communication type options, along with the available support timeframes for the given inputs.

    • (dict) --

      A JSON-formatted object that contains the CommunicationTypeOptions for creating a case for a certain communication channel. It is contained in the response from a DescribeCreateCaseOptions request. CommunicationTypeOptions contains the following fields:

      • datesWithoutSupport - A JSON-formatted list containing date and time ranges for periods without support in UTC time. Date and time format is RFC 3339 : 'yyyy-MM-dd'T'HH:mm:ss.SSSZZ'.

      • supportedHours - A JSON-formatted list containing time ranges when support are available. Time format is RFC 3339 : 'HH:mm:ss.SSS'.

      • type - A string value indicating the communication type that the aforementioned rules apply to. At the moment the type value can assume one of 3 values at the moment chat, web and call.

      • type (string) --

        A string value indicating the communication type. At the moment the type value can assume one of 3 values at the moment chat, web and call.

      • supportedHours (list) --

        A JSON-formatted list containing time ranges when support is available.

        • (dict) --

          Time range object with startTime and endTime range in RFC 3339 format. 'HH:mm:ss.SSS'.

          • startTime (string) --

            Start Time. RFC 3339 format 'HH:mm:ss.SSS'.

          • endTime (string) --

            End Time. RFC 3339 format 'HH:mm:ss.SSS'.

      • datesWithoutSupport (list) --

        A JSON-formatted list containing date and time ranges for periods without support

        • (dict) --

          Date and time (UTC) format in RFC 3339 : 'yyyy-MM-dd'T'HH:mm:ss.SSSZZ'.

          • startDateTime (string) --

            A JSON object containing start and date time (UTC). Date and time format is RFC 3339 : 'yyyy-MM-dd'T'HH:mm:ss.SSSZZ'.

          • endDateTime (string) --

            End Date Time (UTC). RFC 3339 format : 'yyyy-MM-dd'T'HH:mm:ss.SSSZZ'.

Returns a list of supported languages for a specified categoryCode, issueType and serviceCode. The returned supported languages will include a ISO 639-1 code for the language, and the language display name.

See also: AWS API Documentation

Request Syntax

client.describe_supported_languages(
    issueType='string',
    serviceCode='string',
    categoryCode='string'
)

type issueType:

string

param issueType:

[REQUIRED]

The type of issue for the case. You can specify customer-service or technical.

type serviceCode:

string

param serviceCode:

[REQUIRED]

The code for the Amazon Web Services service. You can use the DescribeServices operation to get the possible serviceCode values.

type categoryCode:

string

param categoryCode:

[REQUIRED]

The category of problem for the support case. You also use the DescribeServices operation to get the category code for a service. Each Amazon Web Services service defines its own set of category codes.

rtype:

dict

returns:

Response Syntax

{
    'supportedLanguages': [
        {
            'code': 'string',
            'language': 'string',
            'display': 'string'
        },
    ]
}

Response Structure

• (dict) --

  • supportedLanguages (list) --

    A JSON-formatted array that contains the available ISO 639-1 language codes.

    • (dict) --

      A JSON-formatted object that contains the available ISO 639-1 language code, language name and langauge display value. The language code is what should be used in the CreateCase call.

      • code (string) --

        2 digit ISO 639-1 code. e.g. en

      • language (string) --

        Full language description e.g. ENGLISH

      • display (string) --

        Language display value e.g. ENGLISH