Support / Client / describe_create_case_options

describe_create_case_options

Support.Client.describe_create_case_options(**kwargs)

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.

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_create_case_options(
    issueType='string',
    serviceCode='string',
    language='string',
    categoryCode='string',
    dryRun=True|False
)
Parameters:

  • issueType (string) –

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

  • serviceCode (string) –

    [REQUIRED]

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

  • language (string) –

    [REQUIRED]

    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.

  • categoryCode (string) –

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

  • dryRun (boolean) – Specifies whether to validate the request without actually returning case option data. When set to true, the request is validated but no options are returned, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.

Return type:

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

Exceptions