{ "version": "2.0", "metadata": { "apiVersion": "2013-04-15", "endpointPrefix": "support", "jsonVersion": "1.1", "protocol": "json", "protocols": [ "json" ], "serviceFullName": "AWS Support", "serviceId": "Support", "signatureVersion": "v4", "targetPrefix": "AWSSupport_20130415", "uid": "support-2013-04-15", "auth": [ "aws.auth#sigv4" ] }, "operations": { "AddAttachmentsToSet": { "name": "AddAttachmentsToSet", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "AddAttachmentsToSetRequest" }, "output": { "shape": "AddAttachmentsToSetResponse" }, "errors": [ { "shape": "InternalServerError" }, { "shape": "AttachmentSetIdNotFound" }, { "shape": "AttachmentSetExpired" }, { "shape": "AttachmentSetSizeLimitExceeded" }, { "shape": "AttachmentLimitExceeded" } ], "documentation": "
Adds one or more attachments to an attachment set.
An attachment set is a temporary container for attachments that you add to a case or case communication. The set is available for 1 hour after it's created. The expiryTime
returned in the response is when the set expires.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException
error message appears. For information about changing your support plan, see Amazon Web Services Support.
Adds additional customer communication to an Amazon Web Services Support case. Use the caseId
parameter to identify the case to which to add communication. You can list a set of email addresses to copy on the communication by using the ccEmailAddresses
parameter. The communicationBody
value contains the text of the communication.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException
error message appears. For information about changing your support plan, see Amazon Web Services Support.
Creates a case in the Amazon Web Services Support Center. This operation is similar to how you create a case in the Amazon Web Services Support Center Create Case page.
The Amazon Web Services Support API doesn't support requesting service limit increases. You can submit a service limit increase in the following ways:
Submit a request from the Amazon Web Services Support Center Create Case page.
Use the Service Quotas RequestServiceQuotaIncrease operation.
A successful CreateCase
request returns an Amazon Web Services Support case number. You can use the DescribeCases operation and specify the case number to get existing Amazon Web Services Support cases. After you create a case, use the AddCommunicationToCase operation to add additional communication or attachments to an existing case.
The caseId
is separate from the displayId
that appears in the Amazon Web Services Support Center. Use the DescribeCases operation to get the displayId
.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException
error message appears. For information about changing your support plan, see Amazon Web Services Support.
Returns the attachment that has the specified ID. Attachments can include screenshots, error logs, or other files that describe your issue. Attachment IDs are generated by the case management system when you add an attachment to a case or case communication. Attachment IDs are returned in the AttachmentDetails objects that are returned by the DescribeCommunications operation.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException
error message appears. For information about changing your support plan, see Amazon Web Services Support.
Returns a list of cases that you specify by passing one or more case IDs. You can use the afterTime
and beforeTime
parameters to filter the cases by date. You can set values for the includeResolvedCases
and includeCommunications
parameters to specify how much information to return.
The response returns the following in JSON format:
One or more CaseDetails data types.
One or more nextToken
values, which specify where to paginate the returned records represented by the CaseDetails
objects.
Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request might return an error.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException
error message appears. For information about changing your support plan, see Amazon Web Services Support.
Returns communications and attachments for one or more support cases. Use the afterTime
and beforeTime
parameters to filter by date. You can use the caseId
parameter to restrict the results to a specific case.
Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error.
You can use the maxResults
and nextToken
parameters to control the pagination of the results. Set maxResults
to the number of cases that you want to display on each page, and use nextToken
to specify the resumption of pagination.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException
error message appears. For information about changing your support plan, see Amazon Web Services 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.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException
error message appears. For information about changing your support plan, see Amazon Web Services Support.
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.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException
error message appears. For information about changing your support plan, see Amazon Web Services Support.
Returns the list of severity levels that you can assign to a support case. The severity level for a case is also a field in the CaseDetails data type that you include for a CreateCase request.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException
error message appears. For information about changing your support plan, see Amazon Web Services Support.
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.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException
error message appears. For information about changing your support plan, see Amazon Web Services Support.
Returns the refresh status of the Trusted Advisor checks that have the specified check IDs. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.
Some checks are refreshed automatically, and you can't return their refresh statuses by using the DescribeTrustedAdvisorCheckRefreshStatuses
operation. If you call this operation for these checks, you might see an InvalidParameterValue
error.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException
error message appears. For information about changing your support plan, see Amazon Web Services Support.
To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.
" }, "DescribeTrustedAdvisorCheckResult": { "name": "DescribeTrustedAdvisorCheckResult", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeTrustedAdvisorCheckResultRequest" }, "output": { "shape": "DescribeTrustedAdvisorCheckResultResponse" }, "errors": [ { "shape": "InternalServerError" }, { "shape": "ThrottlingException" } ], "documentation": "Returns the results of the Trusted Advisor check that has the specified check ID. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.
The response contains a TrustedAdvisorCheckResult object, which contains these three objects:
In addition, the response contains these fields:
status - The alert status of the check can be ok
(green), warning
(yellow), error
(red), or not_available
.
timestamp - The time of the last refresh of the check.
checkId - The unique identifier for the check.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException
error message appears. For information about changing your support plan, see Amazon Web Services Support.
To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.
" }, "DescribeTrustedAdvisorCheckSummaries": { "name": "DescribeTrustedAdvisorCheckSummaries", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeTrustedAdvisorCheckSummariesRequest" }, "output": { "shape": "DescribeTrustedAdvisorCheckSummariesResponse" }, "errors": [ { "shape": "InternalServerError" }, { "shape": "ThrottlingException" } ], "documentation": "Returns the results for the Trusted Advisor check summaries for the check IDs that you specified. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.
The response contains an array of TrustedAdvisorCheckSummary objects.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException
error message appears. For information about changing your support plan, see Amazon Web Services Support.
To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.
" }, "DescribeTrustedAdvisorChecks": { "name": "DescribeTrustedAdvisorChecks", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeTrustedAdvisorChecksRequest" }, "output": { "shape": "DescribeTrustedAdvisorChecksResponse" }, "errors": [ { "shape": "InternalServerError" }, { "shape": "ThrottlingException" } ], "documentation": "Returns information about all available Trusted Advisor checks, including the name, ID, category, description, and metadata. You must specify a language code.
The response contains a TrustedAdvisorCheckDescription object for each check. You must set the Amazon Web Services Region to us-east-1.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException
error message appears. For information about changing your support plan, see Amazon Web Services Support.
The names and descriptions for Trusted Advisor checks are subject to change. We recommend that you specify the check ID in your code to uniquely identify a check.
To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.
" }, "RefreshTrustedAdvisorCheck": { "name": "RefreshTrustedAdvisorCheck", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "RefreshTrustedAdvisorCheckRequest" }, "output": { "shape": "RefreshTrustedAdvisorCheckResponse" }, "errors": [ { "shape": "InternalServerError" } ], "documentation": "Refreshes the Trusted Advisor check that you specify using the check ID. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.
Some checks are refreshed automatically. If you call the RefreshTrustedAdvisorCheck
operation to refresh them, you might see the InvalidParameterValue
error.
The response contains a TrustedAdvisorCheckRefreshStatus object.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException
error message appears. For information about changing your support plan, see Amazon Web Services Support.
To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.
" }, "ResolveCase": { "name": "ResolveCase", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ResolveCaseRequest" }, "output": { "shape": "ResolveCaseResponse" }, "errors": [ { "shape": "InternalServerError" }, { "shape": "CaseIdNotFound" } ], "documentation": "Resolves a support case. This operation takes a caseId
and returns the initial and final state of the case.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException
error message appears. For information about changing your support plan, see Amazon Web Services Support.
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.
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
.
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 time and date when the attachment set expires.
" } }, "documentation": "The ID and expiry time of the attachment set returned by the AddAttachmentsToSet operation.
" }, "AddCommunicationToCaseRequest": { "type": "structure", "required": [ "communicationBody" ], "members": { "caseId": { "shape": "CaseId", "documentation": "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
" }, "communicationBody": { "shape": "CommunicationBody", "documentation": "The body of an email communication to add to the support case.
" }, "ccEmailAddresses": { "shape": "CcEmailAddressList", "documentation": "The email addresses in the CC line of an email to be added to the support case.
" }, "attachmentSetId": { "shape": "AttachmentSetId", "documentation": "The ID of a set of one or more attachments for the communication to add to the case. Create the set by calling AddAttachmentsToSet
" } } }, "AddCommunicationToCaseResponse": { "type": "structure", "members": { "result": { "shape": "Result", "documentation": "True if AddCommunicationToCase succeeds. Otherwise, returns an error.
" } }, "documentation": "The result of the AddCommunicationToCase operation.
" }, "AfterTime": { "type": "string" }, "Attachment": { "type": "structure", "members": { "fileName": { "shape": "FileName", "documentation": "The name of the attachment file.
" }, "data": { "shape": "Data", "documentation": "The content of the attachment file.
" } }, "documentation": "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
" }, "AttachmentDetails": { "type": "structure", "members": { "attachmentId": { "shape": "AttachmentId", "documentation": "The ID of the attachment.
" }, "fileName": { "shape": "FileName", "documentation": "The file name of the attachment.
" } }, "documentation": "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.
" }, "AttachmentId": { "type": "string" }, "AttachmentSet": { "type": "list", "member": { "shape": "AttachmentDetails" } }, "AttachmentSetId": { "type": "string" }, "Attachments": { "type": "list", "member": { "shape": "Attachment" } }, "BeforeTime": { "type": "string" }, "Boolean": { "type": "boolean" }, "CaseDetails": { "type": "structure", "members": { "caseId": { "shape": "CaseId", "documentation": "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
" }, "displayId": { "shape": "DisplayId", "documentation": "The ID displayed for the case in the Amazon Web Services Support Center. This is a numeric string.
" }, "subject": { "shape": "Subject", "documentation": "The subject line for the case in the Amazon Web Services Support Center.
" }, "status": { "shape": "Status", "documentation": "The status of the case.
Valid values:
all-open
customer-action-completed
opened
pending-customer-action
reopened
resolved
unassigned
work-in-progress
The code for the Amazon Web Services service. You can get a list of codes and the corresponding service names by calling DescribeServices.
" }, "categoryCode": { "shape": "CategoryCode", "documentation": "The category of problem for the support case.
" }, "severityCode": { "shape": "SeverityCode", "documentation": "The code for the severity level returned by the call to DescribeSeverityLevels.
" }, "submittedBy": { "shape": "SubmittedBy", "documentation": "The email address of the account that submitted the case.
" }, "timeCreated": { "shape": "TimeCreated", "documentation": "The time that the case was created in the Amazon Web Services Support Center.
" }, "recentCommunications": { "shape": "RecentCaseCommunications", "documentation": "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.
The email addresses that receive copies of communication about the case.
" }, "language": { "shape": "Language", "documentation": "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.
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.
The category code for the support case.
" }, "name": { "shape": "CategoryName", "documentation": "The category name for the support case.
" } }, "documentation": "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.
" }, "CategoryCode": { "type": "string" }, "CategoryList": { "type": "list", "member": { "shape": "Category" } }, "CategoryName": { "type": "string" }, "CcEmailAddress": { "type": "string" }, "CcEmailAddressList": { "type": "list", "member": { "shape": "CcEmailAddress" }, "max": 10, "min": 0 }, "Code": { "type": "string" }, "Communication": { "type": "structure", "members": { "caseId": { "shape": "CaseId", "documentation": "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
" }, "body": { "shape": "ValidatedCommunicationBody", "documentation": "The text of the communication between the customer and Amazon Web Services Support.
" }, "submittedBy": { "shape": "SubmittedBy", "documentation": "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) <janedoe@example.com>). Entries from the Amazon Web Services Support team display \"Amazon Web Services,\" and don't show an email address.
" }, "timeCreated": { "shape": "TimeCreated", "documentation": "The time the communication was created.
" }, "attachmentSet": { "shape": "AttachmentSet", "documentation": "Information about the attachments to the case communication.
" } }, "documentation": "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.
" }, "CommunicationBody": { "type": "string", "max": 8000, "min": 1 }, "CommunicationList": { "type": "list", "member": { "shape": "Communication" } }, "CommunicationTypeOptions": { "type": "structure", "members": { "type": { "shape": "Type", "documentation": "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": { "shape": "SupportedHoursList", "documentation": "A JSON-formatted list containing time ranges when support is available.
" }, "datesWithoutSupport": { "shape": "DatesWithoutSupportList", "documentation": "A JSON-formatted list containing date and time ranges for periods without support
" } }, "documentation": "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
.
The title of the support case. The title appears in the Subject field on the Amazon Web Services Support Center Create Case page.
" }, "serviceCode": { "shape": "ServiceCode", "documentation": "The code for the Amazon Web Services service. You can use the DescribeServices operation to get the possible serviceCode
values.
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.
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.
" }, "communicationBody": { "shape": "CommunicationBody", "documentation": "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.
" }, "ccEmailAddresses": { "shape": "CcEmailAddressList", "documentation": "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.
" }, "language": { "shape": "Language", "documentation": "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.
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
.
The ID of a set of one or more attachments for the case. Create the set by using the AddAttachmentsToSet operation.
" } } }, "CreateCaseResponse": { "type": "structure", "members": { "caseId": { "shape": "CaseId", "documentation": "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
" } }, "documentation": "The support case ID returned by a successful completion of the CreateCase operation.
" }, "Data": { "type": "blob" }, "DateInterval": { "type": "structure", "members": { "startDateTime": { "shape": "ValidatedDateTime", "documentation": "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": { "shape": "ValidatedDateTime", "documentation": "End Date Time (UTC). RFC 3339 format : 'yyyy-MM-dd'T'HH:mm:ss.SSSZZ'.
" } }, "documentation": "Date and time (UTC) format in RFC 3339 : 'yyyy-MM-dd'T'HH:mm:ss.SSSZZ'.
" }, "DatesWithoutSupportList": { "type": "list", "member": { "shape": "DateInterval" } }, "DescribeAttachmentRequest": { "type": "structure", "required": [ "attachmentId" ], "members": { "attachmentId": { "shape": "AttachmentId", "documentation": "The ID of the attachment to return. Attachment IDs are returned by the DescribeCommunications operation.
" } } }, "DescribeAttachmentResponse": { "type": "structure", "members": { "attachment": { "shape": "Attachment", "documentation": "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.
" }, "DescribeCasesRequest": { "type": "structure", "members": { "caseIdList": { "shape": "CaseIdList", "documentation": "A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.
" }, "displayId": { "shape": "DisplayId", "documentation": "The ID displayed for a case in the Amazon Web Services Support Center user interface.
" }, "afterTime": { "shape": "AfterTime", "documentation": "The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
" }, "beforeTime": { "shape": "BeforeTime", "documentation": "The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
" }, "includeResolvedCases": { "shape": "IncludeResolvedCases", "documentation": "Specifies whether to include resolved support cases in the DescribeCases
response. By default, resolved cases aren't included.
A resumption point for pagination.
" }, "maxResults": { "shape": "MaxResults", "documentation": "The maximum number of results to return before paginating.
" }, "language": { "shape": "Language", "documentation": "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.
Specifies whether to include communications in the DescribeCases
response. By default, communications are included.
The details for the cases that match the request.
" }, "nextToken": { "shape": "NextToken", "documentation": "A resumption point for pagination.
" } }, "documentation": "Returns an array of CaseDetails objects and a nextToken
that defines a point for pagination in the result set.
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
" }, "beforeTime": { "shape": "BeforeTime", "documentation": "The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
" }, "afterTime": { "shape": "AfterTime", "documentation": "The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
" }, "nextToken": { "shape": "NextToken", "documentation": "A resumption point for pagination.
" }, "maxResults": { "shape": "MaxResults", "documentation": "The maximum number of results to return before paginating.
" } } }, "DescribeCommunicationsResponse": { "type": "structure", "members": { "communications": { "shape": "CommunicationList", "documentation": "The communications for the case.
" }, "nextToken": { "shape": "NextToken", "documentation": "A resumption point for pagination.
" } }, "documentation": "The communications returned by the DescribeCommunications operation.
" }, "DescribeCreateCaseOptionsRequest": { "type": "structure", "required": [ "issueType", "serviceCode", "language", "categoryCode" ], "members": { "issueType": { "shape": "IssueType", "documentation": "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
.
The code for the Amazon Web Services service. You can use the DescribeServices operation to get the possible serviceCode
values.
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.
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.
" } } }, "DescribeCreateCaseOptionsResponse": { "type": "structure", "members": { "languageAvailability": { "shape": "ValidatedLanguageAvailability", "documentation": "Language availability can be any of the following:
available
best_effort
unavailable
A JSON-formatted array that contains the available communication type options, along with the available support timeframes for the given inputs.
" } } }, "DescribeServicesRequest": { "type": "structure", "members": { "serviceCodeList": { "shape": "ServiceCodeList", "documentation": "A JSON-formatted list of service codes available for Amazon Web Services services.
" }, "language": { "shape": "Language", "documentation": "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.
A JSON-formatted list of Amazon Web Services services.
" } }, "documentation": "The list of Amazon Web Services services returned by the DescribeServices operation.
" }, "DescribeSeverityLevelsRequest": { "type": "structure", "members": { "language": { "shape": "Language", "documentation": "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.
The available severity levels for the support case. Available severity levels are defined by your service level agreement with Amazon Web Services.
" } }, "documentation": "The list of severity levels returned by the DescribeSeverityLevels operation.
" }, "DescribeSupportedLanguagesRequest": { "type": "structure", "required": [ "issueType", "serviceCode", "categoryCode" ], "members": { "issueType": { "shape": "ValidatedIssueTypeString", "documentation": "The type of issue for the case. You can specify customer-service
or technical
.
The code for the Amazon Web Services service. You can use the DescribeServices operation to get the possible serviceCode
values.
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.
" } } }, "DescribeSupportedLanguagesResponse": { "type": "structure", "members": { "supportedLanguages": { "shape": "SupportedLanguagesList", "documentation": "A JSON-formatted array that contains the available ISO 639-1 language codes.
" } } }, "DescribeTrustedAdvisorCheckRefreshStatusesRequest": { "type": "structure", "required": [ "checkIds" ], "members": { "checkIds": { "shape": "StringList", "documentation": "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.
The refresh status of the specified Trusted Advisor checks.
" } }, "documentation": "The statuses of the Trusted Advisor checks returned by the DescribeTrustedAdvisorCheckRefreshStatuses operation.
" }, "DescribeTrustedAdvisorCheckResultRequest": { "type": "structure", "required": [ "checkId" ], "members": { "checkId": { "shape": "String", "documentation": "The unique identifier for the Trusted Advisor check.
" }, "language": { "shape": "String", "documentation": "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
The detailed results of the Trusted Advisor check.
" } }, "documentation": "The result of the Trusted Advisor check returned by the DescribeTrustedAdvisorCheckResult operation.
" }, "DescribeTrustedAdvisorCheckSummariesRequest": { "type": "structure", "required": [ "checkIds" ], "members": { "checkIds": { "shape": "StringList", "documentation": "The IDs of the Trusted Advisor checks.
" } } }, "DescribeTrustedAdvisorCheckSummariesResponse": { "type": "structure", "required": [ "summaries" ], "members": { "summaries": { "shape": "TrustedAdvisorCheckSummaryList", "documentation": "The summary information for the requested Trusted Advisor checks.
" } }, "documentation": "The summaries of the Trusted Advisor checks returned by the DescribeTrustedAdvisorCheckSummaries operation.
" }, "DescribeTrustedAdvisorChecksRequest": { "type": "structure", "required": [ "language" ], "members": { "language": { "shape": "String", "documentation": "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
Information about all available Trusted Advisor checks.
" } }, "documentation": "Information about the Trusted Advisor checks returned by the DescribeTrustedAdvisorChecks operation.
" }, "Display": { "type": "string" }, "DisplayId": { "type": "string" }, "Double": { "type": "double" }, "EndTime": { "type": "string" }, "ExpiryTime": { "type": "string" }, "FileName": { "type": "string" }, "IncludeCommunications": { "type": "boolean" }, "IncludeResolvedCases": { "type": "boolean" }, "IssueType": { "type": "string" }, "Language": { "type": "string" }, "Long": { "type": "long" }, "MaxResults": { "type": "integer", "max": 100, "min": 10 }, "NextToken": { "type": "string" }, "RecentCaseCommunications": { "type": "structure", "members": { "communications": { "shape": "CommunicationList", "documentation": "The five most recent communications associated with the case.
" }, "nextToken": { "shape": "NextToken", "documentation": "A resumption point for pagination.
" } }, "documentation": "The five most recent communications associated with the case.
" }, "RefreshTrustedAdvisorCheckRequest": { "type": "structure", "required": [ "checkId" ], "members": { "checkId": { "shape": "String", "documentation": "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.
The current refresh status for a check, including the amount of time until the check is eligible for refresh.
" } }, "documentation": "The current refresh status of a Trusted Advisor check.
" }, "ResolveCaseRequest": { "type": "structure", "members": { "caseId": { "shape": "CaseId", "documentation": "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
" } } }, "ResolveCaseResponse": { "type": "structure", "members": { "initialCaseStatus": { "shape": "CaseStatus", "documentation": "The status of the case when the ResolveCase request was sent.
" }, "finalCaseStatus": { "shape": "CaseStatus", "documentation": "The status of the case after the ResolveCase request was processed.
" } }, "documentation": "The status of the case returned by the ResolveCase operation.
" }, "Result": { "type": "boolean" }, "Service": { "type": "structure", "members": { "code": { "shape": "ServiceCode", "documentation": "The code for an Amazon Web Services service returned by the DescribeServices response. The name
element contains the corresponding friendly name.
The friendly name for an Amazon Web Services service. The code
element contains the corresponding code.
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.
" } }, "documentation": "Information about an Amazon Web Services service returned by the DescribeServices operation.
" }, "ServiceCode": { "type": "string" }, "ServiceCodeList": { "type": "list", "member": { "shape": "ServiceCode" }, "max": 100, "min": 0 }, "ServiceList": { "type": "list", "member": { "shape": "Service" } }, "ServiceName": { "type": "string" }, "SeverityCode": { "type": "string" }, "SeverityLevel": { "type": "structure", "members": { "code": { "shape": "SeverityLevelCode", "documentation": "The code for case severity level.
Valid values: low
| normal
| high
| urgent
| critical
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.
" } }, "documentation": "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.
" }, "SeverityLevelCode": { "type": "string" }, "SeverityLevelName": { "type": "string" }, "SeverityLevelsList": { "type": "list", "member": { "shape": "SeverityLevel" } }, "StartTime": { "type": "string" }, "Status": { "type": "string" }, "String": { "type": "string" }, "StringList": { "type": "list", "member": { "shape": "String" } }, "Subject": { "type": "string" }, "SubmittedBy": { "type": "string" }, "SupportedHour": { "type": "structure", "members": { "startTime": { "shape": "StartTime", "documentation": " Start Time. RFC 3339 format 'HH:mm:ss.SSS'
.
End Time. RFC 3339 format 'HH:mm:ss.SSS'
.
Time range object with startTime
and endTime
range in RFC 3339 format. 'HH:mm:ss.SSS'
.
2 digit ISO 639-1 code. e.g. en
Full language description e.g. ENGLISH
Language display value e.g. ENGLISH
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.
The summary information about cost savings for a Trusted Advisor check that is in the Cost Optimizing category.
" } }, "documentation": "The container for summary information that relates to the category of the Trusted Advisor check.
" }, "TrustedAdvisorCheckDescription": { "type": "structure", "required": [ "id", "name", "description", "category", "metadata" ], "members": { "id": { "shape": "String", "documentation": "The unique identifier for the Trusted Advisor check.
" }, "name": { "shape": "String", "documentation": "The display name for the Trusted Advisor check.
" }, "description": { "shape": "String", "documentation": "The description of the Trusted Advisor check, which includes the alert criteria and recommended operations (contains HTML markup).
" }, "category": { "shape": "String", "documentation": "The category of the Trusted Advisor check.
" }, "metadata": { "shape": "StringList", "documentation": "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.
" } }, "documentation": "The description and metadata for a Trusted Advisor check.
" }, "TrustedAdvisorCheckList": { "type": "list", "member": { "shape": "TrustedAdvisorCheckDescription" } }, "TrustedAdvisorCheckRefreshStatus": { "type": "structure", "required": [ "checkId", "status", "millisUntilNextRefreshable" ], "members": { "checkId": { "shape": "String", "documentation": "The unique identifier for the Trusted Advisor check.
" }, "status": { "shape": "String", "documentation": "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
The amount of time, in milliseconds, until the Trusted Advisor check is eligible for refresh.
" } }, "documentation": "The refresh status of a Trusted Advisor check.
" }, "TrustedAdvisorCheckRefreshStatusList": { "type": "list", "member": { "shape": "TrustedAdvisorCheckRefreshStatus" } }, "TrustedAdvisorCheckResult": { "type": "structure", "required": [ "checkId", "timestamp", "status", "resourcesSummary", "categorySpecificSummary", "flaggedResources" ], "members": { "checkId": { "shape": "String", "documentation": "The unique identifier for the Trusted Advisor check.
" }, "timestamp": { "shape": "String", "documentation": "The time of the last refresh of the check.
" }, "status": { "shape": "String", "documentation": "The alert status of the check: \"ok\" (green), \"warning\" (yellow), \"error\" (red), or \"not_available\".
" }, "resourcesSummary": { "shape": "TrustedAdvisorResourcesSummary" }, "categorySpecificSummary": { "shape": "TrustedAdvisorCategorySpecificSummary", "documentation": "Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported.
" }, "flaggedResources": { "shape": "TrustedAdvisorResourceDetailList", "documentation": "The details about each resource listed in the check result.
" } }, "documentation": "The results of a Trusted Advisor check returned by DescribeTrustedAdvisorCheckResult.
" }, "TrustedAdvisorCheckSummary": { "type": "structure", "required": [ "checkId", "timestamp", "status", "resourcesSummary", "categorySpecificSummary" ], "members": { "checkId": { "shape": "String", "documentation": "The unique identifier for the Trusted Advisor check.
" }, "timestamp": { "shape": "String", "documentation": "The time of the last refresh of the check.
" }, "status": { "shape": "String", "documentation": "The alert status of the check: \"ok\" (green), \"warning\" (yellow), \"error\" (red), or \"not_available\".
" }, "hasFlaggedResources": { "shape": "Boolean", "documentation": "Specifies whether the Trusted Advisor check has flagged resources.
" }, "resourcesSummary": { "shape": "TrustedAdvisorResourcesSummary" }, "categorySpecificSummary": { "shape": "TrustedAdvisorCategorySpecificSummary", "documentation": "Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported.
" } }, "documentation": "A summary of a Trusted Advisor check result, including the alert status, last refresh, and number of resources examined.
" }, "TrustedAdvisorCheckSummaryList": { "type": "list", "member": { "shape": "TrustedAdvisorCheckSummary" } }, "TrustedAdvisorCostOptimizingSummary": { "type": "structure", "required": [ "estimatedMonthlySavings", "estimatedPercentMonthlySavings" ], "members": { "estimatedMonthlySavings": { "shape": "Double", "documentation": "The estimated monthly savings that might be realized if the recommended operations are taken.
" }, "estimatedPercentMonthlySavings": { "shape": "Double", "documentation": "The estimated percentage of savings that might be realized if the recommended operations are taken.
" } }, "documentation": "The estimated cost savings that might be realized if the recommended operations are taken.
" }, "TrustedAdvisorResourceDetail": { "type": "structure", "required": [ "status", "resourceId", "metadata" ], "members": { "status": { "shape": "String", "documentation": "The status code for the resource identified in the Trusted Advisor check.
" }, "region": { "shape": "String", "documentation": "The Amazon Web Services Region in which the identified resource is located.
" }, "resourceId": { "shape": "String", "documentation": "The unique identifier for the identified resource.
" }, "isSuppressed": { "shape": "Boolean", "documentation": "Specifies whether the Amazon Web Services resource was ignored by Trusted Advisor because it was marked as suppressed by the user.
" }, "metadata": { "shape": "StringList", "documentation": "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.
" } }, "documentation": "Contains information about a resource identified by a Trusted Advisor check.
" }, "TrustedAdvisorResourceDetailList": { "type": "list", "member": { "shape": "TrustedAdvisorResourceDetail" } }, "TrustedAdvisorResourcesSummary": { "type": "structure", "required": [ "resourcesProcessed", "resourcesFlagged", "resourcesIgnored", "resourcesSuppressed" ], "members": { "resourcesProcessed": { "shape": "Long", "documentation": "The number of Amazon Web Services resources that were analyzed by the Trusted Advisor check.
" }, "resourcesFlagged": { "shape": "Long", "documentation": "The number of Amazon Web Services resources that were flagged (listed) by the Trusted Advisor check.
" }, "resourcesIgnored": { "shape": "Long", "documentation": "The number of Amazon Web Services resources ignored by Trusted Advisor because information was unavailable.
" }, "resourcesSuppressed": { "shape": "Long", "documentation": "The number of Amazon Web Services resources ignored by Trusted Advisor because they were marked as suppressed by the user.
" } }, "documentation": "Details about Amazon Web Services resources that were analyzed in a call to Trusted Advisor DescribeTrustedAdvisorCheckSummaries.
" }, "Type": { "type": "string" }, "ValidatedCategoryCode": { "type": "string", "max": 100, "min": 0 }, "ValidatedCommunicationBody": { "type": "string", "max": 8000, "min": 1 }, "ValidatedDateTime": { "type": "string", "max": 30, "min": 8 }, "ValidatedIssueTypeString": { "type": "string", "max": 22, "min": 9 }, "ValidatedLanguageAvailability": { "type": "string", "max": 100, "min": 0 }, "ValidatedServiceCode": { "type": "string", "max": 100, "min": 0 } }, "documentation": "The Amazon Web Services Support API Reference is intended for programmers who need detailed information about the Amazon Web Services Support operations and data types. You can use the API to manage your support cases programmatically. The Amazon Web Services Support API uses HTTP methods that return results in JSON format.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException
error message appears. For information about changing your support plan, see Amazon Web Services Support.
You can also use the Amazon Web Services Support API to access features for Trusted Advisor. You can return a list of checks and their descriptions, get check results, specify checks to refresh, and get the refresh status of checks.
You can manage your support cases with the following Amazon Web Services Support API operations:
The CreateCase, DescribeCases, DescribeAttachment, and ResolveCase operations create Amazon Web Services Support cases, retrieve information about cases, and resolve cases.
The DescribeCommunications, AddCommunicationToCase, and AddAttachmentsToSet operations retrieve and add communications and attachments to Amazon Web Services Support cases.
The DescribeServices and DescribeSeverityLevels operations return Amazon Web Service names, service codes, service categories, and problem severity levels. You use these values when you call the CreateCase operation.
You can also use the Amazon Web Services Support API to call the Trusted Advisor operations. For more information, see Trusted Advisor in the Amazon Web Services Support User Guide.
For authentication of requests, Amazon Web Services Support uses Signature Version 4 Signing Process.
For more information about this service and the endpoints to use, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.
" }