Adds additional customer communication to an 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.
Note
-
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the AWS Support API.
-
If you call the AWS Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the
SubscriptionRequiredExceptionerror message appears. For information about changing your support plan, see AWS Support.
Request Syntax
{
"attachmentSetId": "string",
"caseId": "string",
"ccEmailAddresses": [ "string" ],
"communicationBody": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- attachmentSetId
-
The ID of a set of one or more attachments for the communication to add to the case. Create the set by calling AddAttachmentsToSet
Type: String
- 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
- ccEmailAddresses
-
The email addresses in the CC line of an email to be added to the support case.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 10 items.
- communicationBody
-
The body of an email communication to add to the support case.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 8000.
Response Syntax
{
"result": boolean
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- result
-
True if AddCommunicationToCase succeeds. Otherwise, returns an error.
Type: Boolean
Errors
For information about the errors that are common to all actions, see Common Errors.
- AttachmentSetExpired
-
The expiration time of the attachment set has passed. The set expires 1 hour after it is created.
HTTP Status Code: 400
- AttachmentSetIdNotFound
-
An attachment set with the specified ID could not be found.
HTTP Status Code: 400
- CaseIdNotFound
-
The requested
caseIdcouldn't be located.HTTP Status Code: 400
- InternalServerError
-
An internal server error occurred.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
