Skip to content

Returns one or more presigned upload URLs for uploading a large file attachment to a support case by using a multipart upload workflow

Description

Returns one or more presigned upload URLs for uploading a large file attachment to a support case by using a multipart upload workflow. The maximum file size that you can upload with this workflow is 150 MB, and parts can be up to 100 MB each. Initiate a new upload by providing fileName and fileSizeBytes; the response returns a unique uploadId, the part size, the total number of parts, and a list of presigned upload URLs for the requested range of parts. A maximum of 10 upload URLs are returned per call. To retrieve more upload URLs for an upload that's already in progress, call get_attachment_upload_links again with the existing uploadId and a new uploadRange.

Upload each part to its presigned URL by using HTTP PUT and capture the ETag from the response. After you upload all parts, call complete_attachment_upload with the uploadId and the list of part indexes and ETags to finalize the upload. You can then attach the upload to a case by passing the uploadId in the uploadIds parameter of create_case or add_communication_to_case. To monitor progress before completion, call describe_attachment_upload_status.

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

Usage

support_get_attachment_upload_links(fileName, fileSizeBytes, uploadId,
  uploadRange, dryRun)

Arguments

  • fileName

[required] The name of the file to upload, including the file extension. This value is required when you initiate a new upload.

  • fileSizeBytes

The total size of the file in bytes. The service uses this value to calculate the total number of parts and the size of each part. Required when you initiate a new upload (when uploadId isn't provided). Valid range: 1 to 157,286,400 bytes (approximately 150 MB).

  • uploadId

The unique identifier of an in-progress multipart upload, returned by a previous call to get_attachment_upload_links. Specify uploadId to retrieve additional presigned upload URLs for an upload that has already been initiated. Required when fileSizeBytes isn't provided. Length: 1 to 2,048 characters.

  • uploadRange

The range of part indexes for which to return presigned upload URLs. Use this parameter to page through the upload URLs for a large file across multiple calls. If you omit this parameter, the service determines the range to return.

  • dryRun

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

Value

A list with the following syntax:

list(
  uploadId = "string",
  partSizeBytes = 123,
  totalParts = 123,
  nextIndex = 123,
  uploadUrls = list(
    list(
      url = "string",
      partIndex = 123,
      expiryDate = "string"
    )
  )
)

Request syntax

svc$get_attachment_upload_links(
  fileName = "string",
  fileSizeBytes = 123,
  uploadId = "string",
  uploadRange = list(
    startIndex = 123,
    endIndex = 123
  ),
  dryRun = TRUE|FALSE
)