Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetCaseAttachmentUploadUrl

Uploads an attachment to a case.

Request Syntax


POST /v1/cases/caseId/get-presigned-url HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "contentLength": number,
   "fileName": "string"
}

URI Request Parameters

The request uses the following URI parameters.

caseId

Required element for GetCaseAttachmentUploadUrl to identify the case ID for uploading an attachment.

Length Constraints: Minimum length of 10. Maximum length of 32.

Pattern: \d{10,32}.*

Required: Yes

Request Body

The request accepts the following data in JSON format.

clientToken

Note

The clientToken field is an idempotency key used to ensure that repeated attempts for a single action will be ignored by the server during retries. A caller supplied unique ID (typically a UUID) should be provided.

Type: String

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

Required: No

contentLength

Required element for GetCaseAttachmentUploadUrl to identify the size of the file attachment.

Type: Long

Valid Range: Minimum value of 1. Maximum value of 104857600.

Required: Yes

fileName

Required element for GetCaseAttachmentUploadUrl to identify the file name of the attachment to upload.

Type: String

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

Pattern: [a-zA-Z0-9._-]+

Required: Yes

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "attachmentPresignedUrl": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

attachmentPresignedUrl

Response element providing the Amazon S3 presigned URL to upload the attachment.

Type: String

Pattern: https?://(?:www.)?[a-zA-Z0-9@:._+~#=-]{2,256}\.[a-z]{2,6}\b(?:[-a-zA-Z0-9@:%_+.~#?&/=]{0,2048})

Errors

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

AccessDeniedException

message: The ID of the resource which lead to the access denial.

HTTP Status Code: 403

ConflictException

message: The exception message.
resourceId: The ID of the conflicting resource.
resourceType: The type of the conflicting resource.

HTTP Status Code: 409

InternalServerException

message: The exception message.
retryAfterSeconds: The number of seconds after which to retry the request.

HTTP Status Code: 500

InvalidTokenException

message: The exception message.

HTTP Status Code: 423

ResourceNotFoundException

message: The exception message.

HTTP Status Code: 404

SecurityIncidentResponseNotActiveException

message: The exception message.

HTTP Status Code: 400

ServiceQuotaExceededException

message: The exception message.
quotaCode: The code of the quota.
resourceId: The ID of the requested resource which lead to the service quota exception.
resourceType: The type of the requested resource which lead to the service quota exception.
serviceCode: The service code of the quota.

HTTP Status Code: 402

ThrottlingException

message: The exception message.
quotaCode: The quota code of the exception.
retryAfterSeconds: The number of seconds after which to retry the request.
serviceCode: The service code of the exception.

HTTP Status Code: 429

ValidationException

fieldList: The fields which lead to the exception.
message: The exception message.
reason: The reason for the exception.

HTTP Status Code: 400