Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

AddCommunicationToCase

Adds additional customer communication to a Support case. Use the caseId parameter to identify the case to which to add communication. To list a set of email addresses to copy on the communication, use the ccEmailAddresses parameter. The communicationBody value contains the text of the communication.

To attach files larger than 5 MB to the communication, use the uploadIds parameter.

Important

AWS Support automatically redacts sensitive information from support cases to protect your data. The following information is replaced with [REDACTED_BY_AWS] and is not stored:

AWS secret keys - The complete key is replaced. Example: [REDACTED_BY_AWS]
Private keys - The complete key is replaced. Example: [REDACTED_BY_AWS]
Credit card numbers - The number is redacted, but the last 4 digits remain. Example: [REDACTED_BY_AWS]-7016

This sensitive information is never required by AWS Support.

Note

You must have an AWS Business Support+, AWS Enterprise Support, or AWS Unified Operations plan to use the AWS Support API. If you're in an AWS Region that doesn't offer one of these AWS Support plans, or if you haven't transitioned to one of these plans, you can use the AWS Support API with a Business, Enterprise On-Ramp, or Enterprise Support plan.
If you call the AWS Support API from an account that doesn't have an AWS Business Support+, AWS Enterprise Support, or AWS Unified Operations plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see AWS Support.

Request Syntax


{
   "attachmentSetId": "string",
   "caseId": "string",
   "ccEmailAddresses": [ "string" ],
   "communicationBody": "string",
   "dryRun": boolean,
   "uploadIds": [ "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. Each attachment in the set must be 5 MB or smaller. To attach files larger than 5 MB, use uploadIds.

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-exen-2025-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.

dryRun

Specifies whether to validate the request without actually adding the communication to the case. When set to true, the request is validated but the communication isn't added, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.

Type: Boolean

uploadIds

A list of upload IDs that identify attachments to add to the case. Each uploadId is returned by the GetAttachmentUploadLinks operation. The upload must reach the attachment-ready state by calling CompleteAttachmentUpload before it can be passed here. Use uploadIds to attach files of any supported size, including files larger than 5 MB.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 10 items.

Length Constraints: Minimum length of 1. Maximum length of 2048.

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 Error Types.

AttachmentSetExpired

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

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

HTTP Status Code: 400

AttachmentSetIdNotFound

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

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

HTTP Status Code: 400

CaseIdNotFound

The requested caseId couldn't be located.

message: The requested CaseId could not be located.

HTTP Status Code: 400

DryRunOperationException

The request was valid, but the operation wasn't performed because dryRun was set to true.

HTTP Status Code: 400

InternalServerError

An internal server error occurred.

message: An internal server error occurred.

HTTP Status Code: 500