createServiceDocumentUploadDestination

Creates an upload destination.

Usage Plan:

Rate (requests per second)	Burst
5	20

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

Request

Body Params application/json

Input for to be uploaded document.

contentType

enum<string>

required

The content type of the to-be-uploaded file

Allowed values:

TIFFJPGPNGJPEGGIFPDF

contentLength

number <int64>

required

The content length of the to-be-uploaded file

>= 1<= 5242880

contentMD5

string

optional

An MD5 hash of the content to be submitted to the upload destination. This value is used to determine if the data has been corrupted or tampered with during transit.

Match pattern:

^[A-Za-z0-9\\+/]{22}={2}$

Example

{
    "contentType": "TIFF",
    "contentLength": 1,
    "contentMD5": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Successfully created an upload destination for the given resource.

Headers

x-amzn-RateLimit-Limit

string

optional

Your rate limit (requests per second) for this operation.

x-amzn-requestId

string

optional

Unique request reference identifier.

Body

The response schema for the `createServiceDocumentUploadDestination` operation.

payload

object (ServiceDocumentUploadDestination)

optional

Information about an upload destination.

uploadDestinationId

string

required

The unique identifier to be used by APIs that reference the upload destination.

url

string

required

The URL to which to upload the file.

encryptionDetails

object (EncryptionDetails)

required

Encryption details for required client-side encryption and decryption of document contents.

headers

object

optional

The headers to include in the upload request.

errors

array[object (Error) {3}]

optional

A list of error responses that are returned when a request is unsuccessful.

code

string

required

An error code that identifies the type of error that occurred.

message

string

required

A message that describes the error condition.

details

string

optional

Additional details that can help the caller understand or fix the issue.

Example

{
    "payload": {
        "uploadDestinationId": "string",
        "url": "string",
        "encryptionDetails": {
            "standard": "AES",
            "initializationVector": "string",
            "key": "string"
        },
        "headers": {}
    },
    "errors": [
        {
            "code": "string",
            "message": "string",
            "details": "string"
        }
    ]
}

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

🟠413413

🟠415415

🟠422Parameter Error

🟠429429

🔴500Server Error

🔴503Service Unavailable