Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

AddAttachmentsToSet

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.

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


{
   "attachments": [ 
      { 
         "data": blob,
         "fileName": "string"
      }
   ],
   "attachmentSetId": "string",
   "dryRun": boolean
}

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.

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.

Type: Array of Attachment objects

attachmentSetId

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.

Type: String

dryRun

Specifies whether to validate the request without actually adding the attachments. When set to true, the request is validated but no attachments are stored, and the operation returns a DryRunOperationException. When omitted or set to false, the request runs normally.

Type: Boolean

Response Syntax


{
   "attachmentSetId": "string",
   "expiryTime": "string"
}

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.

attachmentSetId

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.

Type: String

expiryTime

The time and date when the attachment set expires.

Type: String

Errors

For information about the errors that are common to all actions, see Common Error Types.

AttachmentLimitExceeded

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

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

HTTP Status Code: 400

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

AttachmentSetSizeLimitExceeded

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

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

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