Module Smaws_Client_Support.Types

type nonrec validated_service_code = string
type nonrec validated_language_availability = string
type nonrec validated_issue_type_string = string
type nonrec validated_date_time = string
type nonrec validated_communication_body = string
type nonrec validated_category_code = string
type nonrec type_ = string
type nonrec long = Smaws_Lib.CoreTypes.Int64.t
type nonrec trusted_advisor_resources_summary = {
  1. resources_suppressed : long;
    (*

    The number of Amazon Web Services resources ignored by Trusted Advisor because they were marked as suppressed by the user.

    *)
  2. resources_ignored : long;
    (*

    The number of Amazon Web Services resources ignored by Trusted Advisor because information was unavailable.

    *)
  3. resources_flagged : long;
    (*

    The number of Amazon Web Services resources that were flagged (listed) by the Trusted Advisor check.

    *)
  4. resources_processed : long;
    (*

    The number of Amazon Web Services resources that were analyzed by the Trusted Advisor check.

    *)
}

Details about Amazon Web Services resources that were analyzed in a call to Trusted Advisor DescribeTrustedAdvisorCheckSummaries.

type nonrec string_ = string
type nonrec boolean_ = bool
type nonrec string_list = string_ Smaws_Lib.CoreTypes.Nullable.t list
type nonrec trusted_advisor_resource_detail = {
  1. metadata : string_list;
    (*

    Additional information about the identified resource. The exact metadata and its order can be obtained by inspecting the TrustedAdvisorCheckDescription object returned by the call to DescribeTrustedAdvisorChecks. Metadata contains all the data that is shown in the Excel download, even in those cases where the UI shows just summary data.

    *)
  2. is_suppressed : boolean_ option;
    (*

    Specifies whether the Amazon Web Services resource was ignored by Trusted Advisor because it was marked as suppressed by the user.

    *)
  3. resource_id : string_;
    (*

    The unique identifier for the identified resource.

    *)
  4. region : string_ option;
    (*

    The Amazon Web Services Region in which the identified resource is located.

    *)
  5. status : string_;
    (*

    The status code for the resource identified in the Trusted Advisor check.

    *)
}

Contains information about a resource identified by a Trusted Advisor check.

type nonrec trusted_advisor_resource_detail_list = trusted_advisor_resource_detail list
type nonrec double = float
type nonrec trusted_advisor_cost_optimizing_summary = {
  1. estimated_percent_monthly_savings : double;
    (*

    The estimated percentage of savings that might be realized if the recommended operations are taken.

    *)
  2. estimated_monthly_savings : double;
    (*

    The estimated monthly savings that might be realized if the recommended operations are taken.

    *)
}

The estimated cost savings that might be realized if the recommended operations are taken.

type nonrec trusted_advisor_category_specific_summary = {
  1. cost_optimizing : trusted_advisor_cost_optimizing_summary option;
    (*

    The summary information about cost savings for a Trusted Advisor check that is in the Cost Optimizing category.

    *)
}

The container for summary information that relates to the category of the Trusted Advisor check.

type nonrec trusted_advisor_check_summary = {
  1. category_specific_summary : trusted_advisor_category_specific_summary;
    (*

    Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported.

    *)
  2. resources_summary : trusted_advisor_resources_summary;
  3. has_flagged_resources : boolean_ option;
    (*

    Specifies whether the Trusted Advisor check has flagged resources.

    *)
  4. status : string_;
    (*

    The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available".

    *)
  5. timestamp : string_;
    (*

    The time of the last refresh of the check.

    *)
  6. check_id : string_;
    (*

    The unique identifier for the Trusted Advisor check.

    *)
}

A summary of a Trusted Advisor check result, including the alert status, last refresh, and number of resources examined.

type nonrec trusted_advisor_check_summary_list = trusted_advisor_check_summary list
type nonrec trusted_advisor_check_result = {
  1. flagged_resources : trusted_advisor_resource_detail_list;
    (*

    The details about each resource listed in the check result.

    *)
  2. category_specific_summary : trusted_advisor_category_specific_summary;
    (*

    Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported.

    *)
  3. resources_summary : trusted_advisor_resources_summary;
  4. status : string_;
    (*

    The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available".

    *)
  5. timestamp : string_;
    (*

    The time of the last refresh of the check.

    *)
  6. check_id : string_;
    (*

    The unique identifier for the Trusted Advisor check.

    *)
}

The results of a Trusted Advisor check returned by DescribeTrustedAdvisorCheckResult.

type nonrec trusted_advisor_check_refresh_status = {
  1. millis_until_next_refreshable : long;
    (*

    The amount of time, in milliseconds, until the Trusted Advisor check is eligible for refresh.

    *)
  2. status : string_;
    (*

    The status of the Trusted Advisor check for which a refresh has been requested:

    • none - The check is not refreshed or the non-success status exceeds the timeout
    • enqueued - The check refresh requests has entered the refresh queue
    • processing - The check refresh request is picked up by the rule processing engine
    • success - The check is successfully refreshed
    • abandoned - The check refresh has failed
    *)
  3. check_id : string_;
    (*

    The unique identifier for the Trusted Advisor check.

    *)
}

The refresh status of a Trusted Advisor check.

type nonrec trusted_advisor_check_refresh_status_list = trusted_advisor_check_refresh_status list
type nonrec trusted_advisor_check_description = {
  1. metadata : string_list;
    (*

    The column headings for the data returned by the Trusted Advisor check. The order of the headings corresponds to the order of the data in the Metadata element of the TrustedAdvisorResourceDetail for the check. Metadata contains all the data that is shown in the Excel download, even in those cases where the UI shows just summary data.

    *)
  2. category : string_;
    (*

    The category of the Trusted Advisor check.

    *)
  3. description : string_;
    (*

    The description of the Trusted Advisor check, which includes the alert criteria and recommended operations (contains HTML markup).

    *)
  4. name : string_;
    (*

    The display name for the Trusted Advisor check.

    *)
  5. id : string_;
    (*

    The unique identifier for the Trusted Advisor check.

    *)
}

The description and metadata for a Trusted Advisor check.

type nonrec trusted_advisor_check_list = trusted_advisor_check_description list
type nonrec time_created = string
type nonrec availability_error_message = string
type nonrec throttling_exception = {
  1. message : availability_error_message option;
}

You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations.

type nonrec code = string
type nonrec language = string
type nonrec display = string
type nonrec supported_language = {
  1. display : display option;
    (*

    Language display value e.g. ENGLISH

    *)
  2. language : language option;
    (*

    Full language description e.g. ENGLISH

    *)
  3. code : code option;
    (*

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

    *)
}

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.

type nonrec supported_languages_list = supported_language list
type nonrec start_time = string
type nonrec end_time = string
type nonrec supported_hour = {
  1. end_time : end_time option;
    (*

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

    *)
  2. start_time : start_time option;
    (*

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

    *)
}

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

type nonrec supported_hours_list = supported_hour list
type nonrec submitted_by = string
type nonrec subject = string
type nonrec status = string
type nonrec severity_level_code = string
type nonrec severity_level_name = string
type nonrec severity_level = {
  1. name : severity_level_name option;
    (*

    The name of the severity level that corresponds to the severity level code.

    The values returned by the API are different from the values that appear in the Amazon Web Services Support Center. For example, the API uses the code low, but the name appears as General guidance in Support Center.

    The following are the API code names and how they appear in the console:

    • low - General guidance
    • normal - System impaired
    • high - Production system impaired
    • urgent - Production system down
    • critical - Business-critical system down

    For more information, see Choosing a severity in the Amazon Web Services Support User Guide.

    *)
  2. code : severity_level_code option;
    (*

    The code for case severity level.

    Valid values: low | normal | high | urgent | critical

    *)
}

A code and name pair that represents the severity level of a support case. The available values depend on the support plan for the account. For more information, see Choosing a severity in the Amazon Web Services Support User Guide.

type nonrec severity_levels_list = severity_level list
type nonrec severity_code = string
type nonrec service_name = string
type nonrec service_code = string
type nonrec category_code = string
type nonrec category_name = string
type nonrec category = {
  1. name : category_name option;
    (*

    The category name for the support case.

    *)
  2. code : category_code option;
    (*

    The category code for the support case.

    *)
}

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.

type nonrec category_list = category list
type nonrec service = {
  1. categories : category_list option;
    (*

    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.

    *)
  2. name : service_name option;
    (*

    The friendly name for an Amazon Web Services service. The code element contains the corresponding code.

    *)
  3. code : service_code option;
    (*

    The code for an Amazon Web Services service returned by the DescribeServices response. The name element contains the corresponding friendly name.

    *)
}

Information about an Amazon Web Services service returned by the DescribeServices operation.

type nonrec service_list = service list
type nonrec service_code2 = string
type nonrec service_code_list = service_code2 list
type nonrec result_ = bool
type nonrec case_status = string
type nonrec resolve_case_response = {
  1. final_case_status : case_status option;
    (*

    The status of the case after the ResolveCase request was processed.

    *)
  2. initial_case_status : case_status option;
    (*

    The status of the case when the ResolveCase request was sent.

    *)
}

The status of the case returned by the ResolveCase operation.

type nonrec case_id = string
type nonrec resolve_case_request = {
  1. case_id : case_id option;
    (*

    The support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47

    *)
}
type nonrec error_message = string
type nonrec internal_server_error = {
  1. message : error_message option;
    (*

    An internal server error occurred.

    *)
}

An internal server error occurred.

type nonrec case_id_not_found = {
  1. message : error_message option;
    (*

    The requested CaseId could not be located.

    *)
}

The requested caseId couldn't be located.

type nonrec refresh_trusted_advisor_check_response = {
  1. status : trusted_advisor_check_refresh_status;
    (*

    The current refresh status for a check, including the amount of time until the check is eligible for refresh.

    *)
}

The current refresh status of a Trusted Advisor check.

type nonrec refresh_trusted_advisor_check_request = {
  1. check_id : string_;
    (*

    The unique identifier for the Trusted Advisor check to refresh.

    Specifying the check ID of a check that is automatically refreshed causes an InvalidParameterValue error.

    *)
}
type nonrec attachment_id = string
type nonrec file_name = string
type nonrec attachment_details = {
  1. file_name : file_name option;
    (*

    The file name of the attachment.

    *)
  2. attachment_id : attachment_id option;
    (*

    The ID of the attachment.

    *)
}

The file name and ID of an attachment to a case communication. You can use the ID to retrieve the attachment with the DescribeAttachment operation.

type nonrec attachment_set = attachment_details list
type nonrec communication = {
  1. attachment_set : attachment_set option;
    (*

    Information about the attachments to the case communication.

    *)
  2. time_created : time_created option;
    (*

    The time the communication was created.

    *)
  3. submitted_by : submitted_by option;
    (*

    The identity of the account that submitted, or responded to, the support case. Customer entries include the IAM role as well as the email address (for example, "AdminRole (Role) ). Entries from the Amazon Web Services Support team display "Amazon Web Services," and don't show an email address.

    *)
  4. body : validated_communication_body option;
    (*

    The text of the communication between the customer and Amazon Web Services Support.

    *)
  5. case_id : case_id option;
    (*

    The support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47

    *)
}

A communication associated with a support case. The communication consists of the case ID, the message body, attachment information, the submitter of the communication, and the date and time of the communication.

type nonrec communication_list = communication list
type nonrec next_token = string
type nonrec recent_case_communications = {
  1. next_token : next_token option;
    (*

    A resumption point for pagination.

    *)
  2. communications : communication_list option;
    (*

    The five most recent communications associated with the case.

    *)
}

The five most recent communications associated with the case.

type nonrec max_results = int
type nonrec issue_type = string
type nonrec include_resolved_cases = bool
type nonrec include_communications = bool
type nonrec expiry_time = string
type nonrec display_id = string
type nonrec describe_trusted_advisor_checks_response = {
  1. checks : trusted_advisor_check_list;
    (*

    Information about all available Trusted Advisor checks.

    *)
}

Information about the Trusted Advisor checks returned by the DescribeTrustedAdvisorChecks operation.

type nonrec describe_trusted_advisor_checks_request = {
  1. language : string_;
    (*

    The ISO 639-1 code for the language that you want your checks to appear in.

    The Amazon Web Services Support API currently supports the following languages for Trusted Advisor:

    • Chinese, Simplified - zh
    • Chinese, Traditional - zh_TW
    • English - en
    • French - fr
    • German - de
    • Indonesian - id
    • Italian - it
    • Japanese - ja
    • Korean - ko
    • Portuguese, Brazilian - pt_BR
    • Spanish - es
    *)
}
type nonrec describe_trusted_advisor_check_summaries_response = {
  1. summaries : trusted_advisor_check_summary_list;
    (*

    The summary information for the requested Trusted Advisor checks.

    *)
}

The summaries of the Trusted Advisor checks returned by the DescribeTrustedAdvisorCheckSummaries operation.

type nonrec describe_trusted_advisor_check_summaries_request = {
  1. check_ids : string_list;
    (*

    The IDs of the Trusted Advisor checks.

    *)
}
type nonrec describe_trusted_advisor_check_result_response = {
  1. result_ : trusted_advisor_check_result option;
    (*

    The detailed results of the Trusted Advisor check.

    *)
}

The result of the Trusted Advisor check returned by the DescribeTrustedAdvisorCheckResult operation.

type nonrec describe_trusted_advisor_check_result_request = {
  1. language : string_ option;
    (*

    The ISO 639-1 code for the language that you want your check results to appear in.

    The Amazon Web Services Support API currently supports the following languages for Trusted Advisor:

    • Chinese, Simplified - zh
    • Chinese, Traditional - zh_TW
    • English - en
    • French - fr
    • German - de
    • Indonesian - id
    • Italian - it
    • Japanese - ja
    • Korean - ko
    • Portuguese, Brazilian - pt_BR
    • Spanish - es
    *)
  2. check_id : string_;
    (*

    The unique identifier for the Trusted Advisor check.

    *)
}
type nonrec describe_trusted_advisor_check_refresh_statuses_response = {
  1. statuses : trusted_advisor_check_refresh_status_list;
    (*

    The refresh status of the specified Trusted Advisor checks.

    *)
}

The statuses of the Trusted Advisor checks returned by the DescribeTrustedAdvisorCheckRefreshStatuses operation.

type nonrec describe_trusted_advisor_check_refresh_statuses_request = {
  1. check_ids : string_list;
    (*

    The IDs of the Trusted Advisor checks to get the status.

    If you specify the check ID of a check that is automatically refreshed, you might see an InvalidParameterValue error.

    *)
}
type nonrec describe_supported_languages_response = {
  1. supported_languages : supported_languages_list option;
    (*

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

    *)
}
type nonrec describe_supported_languages_request = {
  1. category_code : validated_category_code;
    (*

    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.

    *)
  2. service_code : validated_service_code;
    (*

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

    *)
  3. issue_type : validated_issue_type_string;
    (*

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

    *)
}
type nonrec describe_severity_levels_response = {
  1. severity_levels : severity_levels_list option;
    (*

    The available severity levels for the support case. Available severity levels are defined by your service level agreement with Amazon Web Services.

    *)
}

The list of severity levels returned by the DescribeSeverityLevels operation.

type nonrec describe_severity_levels_request = {
  1. language : language option;
    (*

    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 nonrec describe_services_response = {
  1. services : service_list option;
    (*

    A JSON-formatted list of Amazon Web Services services.

    *)
}

The list of Amazon Web Services services returned by the DescribeServices operation.

type nonrec describe_services_request = {
  1. language : language option;
    (*

    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.

    *)
  2. service_code_list : service_code_list option;
    (*

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

    *)
}
type nonrec date_interval = {
  1. end_date_time : validated_date_time option;
    (*

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

    *)
  2. start_date_time : validated_date_time option;
    (*

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

    *)
}

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

type nonrec dates_without_support_list = date_interval list
type nonrec communication_type_options = {
  1. dates_without_support : dates_without_support_list option;
    (*

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

    *)
  2. supported_hours : supported_hours_list option;
    (*

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

    *)
  3. type_ : type_ option;
    (*

    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.

    *)
}

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 nonrec communication_type_options_list = communication_type_options list
type nonrec describe_create_case_options_response = {
  1. communication_types : communication_type_options_list option;
    (*

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

    *)
  2. language_availability : validated_language_availability option;
    (*

    Language availability can be any of the following:

    • available
    • best_effort
    • unavailable
    *)
}
type nonrec describe_create_case_options_request = {
  1. category_code : category_code;
    (*

    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.

    *)
  2. language : language;
    (*

    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.

    *)
  3. service_code : service_code2;
    (*

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

    *)
  4. issue_type : issue_type;
    (*

    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 nonrec describe_communications_response = {
  1. next_token : next_token option;
    (*

    A resumption point for pagination.

    *)
  2. communications : communication_list option;
    (*

    The communications for the case.

    *)
}

The communications returned by the DescribeCommunications operation.

type nonrec before_time = string
type nonrec after_time = string
type nonrec describe_communications_request = {
  1. max_results : max_results option;
    (*

    The maximum number of results to return before paginating.

    *)
  2. next_token : next_token option;
    (*

    A resumption point for pagination.

    *)
  3. after_time : after_time option;
    (*

    The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

    *)
  4. before_time : before_time option;
    (*

    The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

    *)
  5. case_id : case_id;
    (*

    The support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47

    *)
}
type nonrec cc_email_address = string
type nonrec cc_email_address_list = cc_email_address list
type nonrec case_details = {
  1. language : language option;
    (*

    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.

    *)
  2. cc_email_addresses : cc_email_address_list option;
    (*

    The email addresses that receive copies of communication about the case.

    *)
  3. recent_communications : recent_case_communications option;
    (*

    The five most recent communications between you and Amazon Web Services Support Center, including the IDs of any attachments to the communications. Also includes a nextToken that you can use to retrieve earlier communications.

    *)
  4. time_created : time_created option;
    (*

    The time that the case was created in the Amazon Web Services Support Center.

    *)
  5. submitted_by : submitted_by option;
    (*

    The email address of the account that submitted the case.

    *)
  6. severity_code : severity_code option;
    (*

    The code for the severity level returned by the call to DescribeSeverityLevels.

    *)
  7. category_code : category_code option;
    (*

    The category of problem for the support case.

    *)
  8. service_code : service_code option;
    (*

    The code for the Amazon Web Services service. You can get a list of codes and the corresponding service names by calling DescribeServices.

    *)
  9. status : status option;
    (*

    The status of the case.

    Valid values:

    • all-open
    • customer-action-completed
    • opened
    • pending-customer-action
    • reopened
    • resolved
    • unassigned
    • work-in-progress
    *)
  10. subject : subject option;
    (*

    The subject line for the case in the Amazon Web Services Support Center.

    *)
  11. display_id : display_id option;
    (*

    The ID displayed for the case in the Amazon Web Services Support Center. This is a numeric string.

    *)
  12. case_id : case_id option;
    (*

    The support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47

    *)
}

A JSON-formatted object that contains the metadata for a support case. It is contained in the response from a DescribeCases request. CaseDetails contains the following fields:

  • caseId - The support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47.
  • categoryCode - The category of problem for the support case. Corresponds to the CategoryCode values returned by a call to DescribeServices.
  • displayId - The identifier for the case on pages in the Amazon Web Services Support Center.
  • language - 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.
  • nextToken - A resumption point for pagination.
  • recentCommunications - One or more Communication objects. Fields of these objects are attachments, body, caseId, submittedBy, and timeCreated.
  • serviceCode - The identifier for the Amazon Web Services service that corresponds to the service code defined in the call to DescribeServices.
  • severityCode - The severity code assigned to the case. Contains one of the values returned by the call to DescribeSeverityLevels. The possible values are: low, normal, high, urgent, and critical.

  • status - The status of the case in the Amazon Web Services Support Center. Valid values:

    • all-open
    • customer-action-completed
    • opened
    • pending-customer-action
    • reopened
    • resolved
    • unassigned
    • work-in-progress
  • subject - The subject line of the case.
  • submittedBy - The email address of the account that submitted the case.
  • timeCreated - The time the case was created, in ISO-8601 format.
type nonrec case_list = case_details list
type nonrec describe_cases_response = {
  1. next_token : next_token option;
    (*

    A resumption point for pagination.

    *)
  2. cases : case_list option;
    (*

    The details for the cases that match the request.

    *)
}

Returns an array of CaseDetails objects and a nextToken that defines a point for pagination in the result set.

type nonrec case_id_list = case_id list
type nonrec describe_cases_request = {
  1. include_communications : include_communications option;
    (*

    Specifies whether to include communications in the DescribeCases response. By default, communications are included.

    *)
  2. language : language option;
    (*

    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.

    *)
  3. max_results : max_results option;
    (*

    The maximum number of results to return before paginating.

    *)
  4. next_token : next_token option;
    (*

    A resumption point for pagination.

    *)
  5. include_resolved_cases : include_resolved_cases option;
    (*

    Specifies whether to include resolved support cases in the DescribeCases response. By default, resolved cases aren't included.

    *)
  6. before_time : before_time option;
    (*

    The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

    *)
  7. after_time : after_time option;
    (*

    The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

    *)
  8. display_id : display_id option;
    (*

    The ID displayed for a case in the Amazon Web Services Support Center user interface.

    *)
  9. case_id_list : case_id_list option;
    (*

    A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.

    *)
}
type nonrec data = bytes
type nonrec attachment = {
  1. data : data option;
    (*

    The content of the attachment file.

    *)
  2. file_name : file_name option;
    (*

    The name of the attachment file.

    *)
}

An attachment to a case communication. The attachment consists of the file name and the content of the file. Each attachment file size should not exceed 5 MB. File types that are supported include the following: pdf, jpeg,.doc, .log, .text

type nonrec describe_attachment_response = {
  1. attachment : attachment option;
    (*

    This object includes the attachment content and file name.

    In the previous response syntax, the value for the data parameter appears as blob, which is represented as a base64-encoded string. The value for fileName is the name of the attachment, such as troubleshoot-screenshot.png.

    *)
}

The content and file name of the attachment returned by the DescribeAttachment operation.

type nonrec describe_attachment_request = {
  1. attachment_id : attachment_id;
    (*

    The ID of the attachment to return. Attachment IDs are returned by the DescribeCommunications operation.

    *)
}
type nonrec describe_attachment_limit_exceeded = {
  1. message : error_message option;
    (*

    The limit for the number of DescribeAttachment requests in a short period of time has been exceeded.

    *)
}

The limit for the number of DescribeAttachment requests in a short period of time has been exceeded.

type nonrec attachment_id_not_found = {
  1. message : error_message option;
    (*

    An attachment with the specified ID could not be found.

    *)
}

An attachment with the specified ID could not be found.

type nonrec create_case_response = {
  1. case_id : case_id option;
    (*

    The support case ID requested or returned in the call. The case ID is an alphanumeric string in the following format: case-12345678910-2013-c4c1d2bf33c5cf47

    *)
}

The support case ID returned by a successful completion of the CreateCase operation.

type nonrec communication_body = string
type nonrec attachment_set_id = string
type nonrec create_case_request = {
  1. attachment_set_id : attachment_set_id option;
    (*

    The ID of a set of one or more attachments for the case. Create the set by using the AddAttachmentsToSet operation.

    *)
  2. issue_type : issue_type option;
    (*

    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.

    *)
  3. language : language option;
    (*

    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.

    *)
  4. cc_email_addresses : cc_email_address_list option;
    (*

    A list of email addresses that Amazon Web Services Support copies on case correspondence. Amazon Web Services Support identifies the account that creates the case when you specify your Amazon Web Services credentials in an HTTP POST method or use the Amazon Web Services SDKs.

    *)
  5. communication_body : communication_body;
    (*

    The communication body text that describes the issue. This text appears in the Description field on the Amazon Web Services Support Center Create Case page.

    *)
  6. category_code : category_code option;
    (*

    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.

    *)
  7. severity_code : severity_code option;
    (*

    A value that indicates the urgency of the case. This value determines the response time according to your service level agreement with Amazon Web Services Support. You can use the DescribeSeverityLevels operation to get the possible values for severityCode.

    For more information, see SeverityLevel and Choosing a Severity in the Amazon Web Services Support User Guide.

    The availability of severity levels depends on the support plan for the Amazon Web Services account.

    *)
  8. service_code : service_code2 option;
    (*

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

    *)
  9. subject : subject;
    (*

    The title of the support case. The title appears in the Subject field on the Amazon Web Services Support Center Create Case page.

    *)
}
type nonrec case_creation_limit_exceeded = {
  1. message : error_message option;
    (*

    An error message that indicates that you have exceeded the number of cases you can have open.

    *)
}

The case creation limit for the account has been exceeded.

type nonrec attachment_set_id_not_found = {
  1. message : error_message option;
    (*

    An attachment set with the specified ID could not be found.

    *)
}

An attachment set with the specified ID could not be found.

type nonrec attachment_set_expired = {
  1. message : error_message option;
    (*

    The expiration time of the attachment set has passed. The set expires one hour after it is created.

    *)
}

The expiration time of the attachment set has passed. The set expires 1 hour after it is created.

type nonrec attachments = attachment list
type nonrec attachment_set_size_limit_exceeded = {
  1. message : error_message option;
    (*

    A limit for the size of an attachment set has been exceeded. The limits are three attachments and 5 MB per attachment.

    *)
}

A limit for the size of an attachment set has been exceeded. The limits are three attachments and 5 MB per attachment.

type nonrec attachment_limit_exceeded = {
  1. message : error_message option;
    (*

    The limit for the number of attachment sets created in a short period of time has been exceeded.

    *)
}

The limit for the number of attachment sets created in a short period of time has been exceeded.

type nonrec add_communication_to_case_response = {
  1. result_ : result_ option;
    (*

    True if AddCommunicationToCase succeeds. Otherwise, returns an error.

    *)
}

The result of the AddCommunicationToCase operation.

type nonrec add_communication_to_case_request = {
  1. attachment_set_id : attachment_set_id option;
    (*

    The ID of a set of one or more attachments for the communication to add to the case. Create the set by calling AddAttachmentsToSet

    *)
  2. cc_email_addresses : cc_email_address_list option;
    (*

    The email addresses in the CC line of an email to be added to the support case.

    *)
  3. communication_body : communication_body;
    (*

    The body of an email communication to add to the support case.

    *)
  4. case_id : case_id option;
    (*

    The support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47

    *)
}
type nonrec add_attachments_to_set_response = {
  1. expiry_time : expiry_time option;
    (*

    The time and date when the attachment set expires.

    *)
  2. attachment_set_id : attachment_set_id option;
    (*

    The ID of the attachment set. If an attachmentSetId was not specified, a new attachment set is created, and the ID of the set is returned in the response. If an attachmentSetId was specified, the attachments are added to the specified set, if it exists.

    *)
}

The ID and expiry time of the attachment set returned by the AddAttachmentsToSet operation.

type nonrec add_attachments_to_set_request = {
  1. attachments : attachments;
    (*

    One or more attachments to add to the set. You can add up to three attachments per set. The size limit is 5 MB per attachment.

    In the Attachment object, use the data parameter to specify the contents of the attachment file. In the previous request syntax, the value for data appear as blob, which is represented as a base64-encoded string. The value for fileName is the name of the attachment, such as troubleshoot-screenshot.png.

    *)
  2. attachment_set_id : attachment_set_id option;
    (*

    The ID of the attachment set. If an attachmentSetId is not specified, a new attachment set is created, and the ID of the set is returned in the response. If an attachmentSetId is specified, the attachments are added to the specified set, if it exists.

    *)
}