# Overview
The Uploads API lets you upload files that you can programmatically access using other Selling Partner APIs, such as the A+ Content API and the Messaging API.
# Version information
Version : 2020-11-01
# Operations
createUploadDestinationForResource
# Paths
# createUploadDestinationForResource
POST /uploads/2020-11-01/uploadDestinations/{resource}
# Description
Creates an upload destination, returning the information required to upload a file to the destination and to programmatically access the file.
Usage Plan:
| Rate (requests per second) | Burst |
|---|---|
| .1 | 5 |
For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.
# Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | marketplaceIds required | A list of marketplace identifiers. This specifies the marketplaces where the upload will be available. Only one marketplace can be specified. Max count : 1 | < string > array |
| Query | contentMD5 required | 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. | string |
| Path | resource required | The resource for the upload destination that you are creating. For example, if you are creating an upload destination for the createLegalDisclosure operation of the Messaging API, the {resource} would be /messaging/v1/orders/{amazonOrderId}/messages/legalDisclosure, and the entire path would be /uploads/2020-11-01/uploadDestinations/messaging/v1/orders/{amazonOrderId}/messages/legalDisclosure. If you are creating an upload destination for an Aplus content document, the {resource} would be aplus/2020-11-01/contentDocuments and the path would be /uploads/v1/uploadDestinations/aplus/2020-11-01/contentDocuments. | string |
| Query | contentType optional | The content type of the file to be uploaded. | string |
# Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | CreateUploadDestinationResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
# Error Responses and Schemas
This table contains HTTP status codes and associated information for error responses.
| HTTP Code | Description | Schema |
|---|---|---|
| 400 | Request has missing or invalid parameters and cannot be parsed. Headers: x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation. x-amzn-RequestId (string):Unique request reference identifier. | CreateUploadDestinationResponse |
| 403 | Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. Headers: x-amzn-RequestId (string):Unique request reference identifier. | CreateUploadDestinationResponse |
| 404 | The resource specified does not exist. Headers: x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation. x-amzn-RequestId (string):Unique request reference identifier. | CreateUploadDestinationResponse |
| 413 | The request size exceeded the maximum accepted size. Headers: x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string):Unique request reference identifier. | CreateUploadDestinationResponse |
| 415 | The request payload is in an unsupported format. Headers: x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string):Unique request reference identifier. | CreateUploadDestinationResponse |
| 429 | The frequency of requests was greater than allowed. Headers: x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string):Unique request reference identifier. | CreateUploadDestinationResponse |
| 500 | An unexpected condition occurred that prevented the server from fulfilling the request. Headers: x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string):Unique request reference identifier. | CreateUploadDestinationResponse |
| 503 | Temporary overloading or maintenance of the server. Headers: x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string):Unique request reference identifier. | CreateUploadDestinationResponse |
# Definitions
# CreateUploadDestinationResponse
The response schema for the createUploadDestination operation.
| Name | Description | Schema |
|---|---|---|
| payload optional | Information about an upload destination. | UploadDestination |
| errors optional | A list of error responses returned when a request is unsuccessful. | ErrorList |
# UploadDestination
Information about an upload destination.
| Name | Description | Schema |
|---|---|---|
| uploadDestinationId optional | The unique identifier for the upload destination. | string |
| url optional | The URL for the upload destination. | string |
| headers optional | The headers to include in the upload request. | object |
# ErrorList
A list of error responses returned when a request is unsuccessful.
Type : < Error > array
# Error
Error response returned when the request is unsuccessful.
| Name | Description | Schema |
|---|---|---|
| code required | An error code that identifies the type of error that occurred. | string |
| message required | A message that describes the error condition in a human-readable form. | string |
| details optional | Additional details that can help the caller understand or fix the issue. | string |