The AWS Support API contains several data types that various actions use. This section describes each data type in detail.
Note
The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order.
The following data types are supported:
• Attachment (p. 40)
• AttachmentDetails (p. 41)
• CaseDetails (p. 42)
• Category (p. 45)
• Communication (p. 46)
• RecentCaseCommunications (p. 47)
• Service (p. 48)
• SeverityLevel (p. 49)
• TrustedAdvisorCategorySpecificSummary (p. 50)
• TrustedAdvisorCheckDescription (p. 51)
• TrustedAdvisorCheckRefreshStatus (p. 52)
• TrustedAdvisorCheckResult (p. 53)
• TrustedAdvisorCheckSummary (p. 54)
• TrustedAdvisorCostOptimizingSummary (p. 55)
• TrustedAdvisorResourceDetail (p. 56)
• TrustedAdvisorResourcesSummary (p. 57)
Attachment
Attachment
An attachment to a case communication. The attachment consists of the file name and the content of the file.
Contents
data
The content of the attachment file.
Type: Base64-encoded binary data object fileName
The name of the attachment file.
Type: String
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
AttachmentDetails
AttachmentDetails
The file name and ID of an attachment to a case communication. You can use the ID to retrieve the attachment with the DescribeAttachment (p. 13) operation.
Contents
attachmentId
The ID of the attachment.
Type: String fileName
The file name of the attachment.
Type: String
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
CaseDetails
CaseDetails
A JSON-formatted object that contains the metadata for a support case. It is contained in the response from a DescribeCases (p. 15) 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 (p. 22).
• displayId - The identifier for the case on pages in the AWS Support Center.
• language - The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.
• nextToken - A resumption point for pagination.
• recentCommunications - One or more Communication (p. 46) objects. Fields of these objects are attachments, body, caseId, submittedBy, and timeCreated.
• serviceCode - The identifier for the AWS service that corresponds to the service code defined in the call to DescribeServices (p. 22).
• severityCode - The severity code assigned to the case. Contains one of the values returned by the call to DescribeSeverityLevels (p. 24). The possible values are: low, normal, high, urgent, and critical.
• status - The status of the case in the AWS Support Center. Valid values:
• opened
• 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.
Contents
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
Type: String categoryCode
The category of problem for the support case.
Type: String ccEmailAddresses
The email addresses that receive copies of communication about the case.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Contents
displayId
The ID displayed for the case in the AWS Support Center. This is a numeric string.
Type: String language
The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.
Type: String recentCommunications
The five most recent communications between you and AWS Support Center, including the IDs of any attachments to the communications. Also includes a nextToken that you can use to retrieve earlier communications.
Type: RecentCaseCommunications (p. 47) object serviceCode
The code for the AWS service. You can get a list of codes and the corresponding service names by calling DescribeServices (p. 22).
Type: String severityCode
The code for the severity level returned by the call to DescribeSeverityLevels (p. 24).
Type: String status
The status of the case.
Valid values:
The subject line for the case in the AWS Support Center.
Type: String submittedBy
The email address of the account that submitted the case.
Type: String timeCreated
The time that the case was created in the AWS Support Center.
See Also
Type: String
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Category
Category
A JSON-formatted name/value pair that represents the category name and category code of the problem, selected from the DescribeServices (p. 22) response for each AWS service.
Contents
code
The category code for the support case.
Type: String name
The category name for the support case.
Type: String
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Communication
Communication
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.
Contents
attachmentSet
Information about the attachments to the case communication.
Type: Array of AttachmentDetails (p. 41) objects body
The text of the communication between the customer and AWS Support.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 8000.
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
Type: String submittedBy
The identity of the account that submitted, or responded to, the support case. Customer entries include the role or IAM user as well as the email address. For example, "AdminRole (Role)
<[email protected]>. Entries from the AWS Support team display "Amazon Web Services," and don't show an email address.
Type: String timeCreated
The time the communication was created.
Type: String
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
RecentCaseCommunications
RecentCaseCommunications
The five most recent communications associated with the case.
Contents
communications
The five most recent communications associated with the case.
Type: Array of Communication (p. 46) objects nextToken
A resumption point for pagination.
Type: String
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Service
Service
Information about an AWS service returned by the DescribeServices (p. 22) operation.
Contents
categories
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 AWS Support when you call CreateCase (p. 9).
Type: Array of Category (p. 45) objects code
The code for an AWS service returned by the DescribeServices (p. 22) response. The name element contains the corresponding friendly name.
Type: String name
The friendly name for an AWS service. The code element contains the corresponding code.
Type: String
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
SeverityLevel
SeverityLevel
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 AWS Support User Guide.
Contents
code
The code for case severity level.
Valid values: low | normal | high | urgent | critical Type: String
name
The name of the severity level that corresponds to the severity level code.
NoteThe values returned by the API are different from the values that appear in the AWS 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 AWS Support User Guide.
Type: String
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3