Support / Client / get_attachment_upload_links

get_attachment_upload_links

Support.Client.get_attachment_upload_links(**kwargs)

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 GetAttachmentUploadLinks 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 CompleteAttachmentUpload 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 CreateCase or AddCommunicationToCase. To monitor progress before completion, call DescribeAttachmentUploadStatus.

Note

• 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.

See also: AWS API Documentation

Request Syntax

response = client.get_attachment_upload_links(
    fileName='string',
    fileSizeBytes=123,
    uploadId='string',
    uploadRange={
        'startIndex': 123,
        'endIndex': 123
    },
    dryRun=True|False
)

Parameters:

• fileName (string) –

  [REQUIRED]

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

• fileSizeBytes (integer) – 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 (string) – The unique identifier of an in-progress multipart upload, returned by a previous call to GetAttachmentUploadLinks. 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 (dict) –

  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.

  • startIndex (integer) – [REQUIRED]

    The starting part index of the range, inclusive. Part indexes start at 1.

  • endIndex (integer) –

    The ending part index of the range, exclusive. The range is half-open: startIndex is inclusive and endIndex is exclusive. For example, a range with startIndex of 1 and endIndex of 4 requests URLs for parts 1, 2, and 3. The range size ( endIndex - startIndex) must not exceed 10. If you omit endIndex, the service defaults to startIndex + 10, capped by the total number of parts.

• dryRun (boolean) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'uploadId': 'string',
    'partSizeBytes': 123,
    'totalParts': 123,
    'nextIndex': 123,
    'uploadUrls': [
        {
            'url': 'string',
            'partIndex': 123,
            'expiryDate': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • uploadId (string) –

    The unique identifier for the multipart upload. Use this value in subsequent calls to GetAttachmentUploadLinks, DescribeAttachmentUploadStatus, and CompleteAttachmentUpload, and to attach the upload to a case through the uploadIds parameter on CreateCase or AddCommunicationToCase.

  • partSizeBytes (integer) –

    The size, in bytes, of each part. Split the file into parts of this size before you upload them to the presigned URLs. For an upload with n total parts, parts 1 through n - 1 are exactly this size; the last part may be smaller. Maximum: 104,857,600 bytes (approximately 100 MB).

  • totalParts (integer) –

    The total number of parts that the file is split into. Upload one part to each presigned URL.

  • nextIndex (integer) –

    The next part index to request presigned URLs for. If all upload URLs for the file have been returned, this field is null. Use this value as the startIndex in uploadRange on a subsequent call to GetAttachmentUploadLinks to retrieve the next batch of upload URLs.

  • uploadUrls (list) –

    The list of presigned upload URLs for the requested range of parts. The list contains at most 10 URLs per call. Upload each part to its corresponding URL by using HTTP PUT before the URL expires.

    • (dict) –

      A presigned URL for uploading a single part of a multipart attachment upload, along with the part index and the date and time the URL expires. Returned by GetAttachmentUploadLinks.

      • url (string) –

        The presigned HTTPS URL that you use to upload a single part with HTTP PUT. Upload URLs are served from uploadv1.attachments.support.{region}.amazonaws.com. The uploadv1 prefix is subject to change.

      • partIndex (integer) –

        The index of the part that this URL uploads.

      • expiryDate (string) –

        The date and time, in ISO-8601 format, when the presigned URL expires. Upload the part before this time.

Exceptions

• Support.Client.exceptions.InternalServerError

• Support.Client.exceptions.DryRunOperationException

• Support.Client.exceptions.UploadIdNotFound