Function UploadsApiFp

UploadsApi - functional programming interface

Export

  • UploadsApiFp(
        configuration?: Configuration,
    ): {
        createUploadDestinationForResource(
            marketplaceIds: string[],
            contentMD5: string,
            resource: string,
            contentType?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CreateUploadDestinationResponse>,
        >;
    }

  • Parameters

    • Optionalconfiguration: Configuration

    Returns {
        createUploadDestinationForResource(
            marketplaceIds: string[],
            contentMD5: string,
            resource: string,
            contentType?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CreateUploadDestinationResponse>,
        >;
    }

    • createUploadDestinationForResource:function
      • createUploadDestinationForResource(
            marketplaceIds: string[],
            contentMD5: string,
            resource: string,
            contentType?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CreateUploadDestinationResponse>,
        >

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

        Parameters

        • marketplaceIds: string[]

          A list of marketplace identifiers. This specifies the marketplaces where the upload will be available. Only one marketplace can be specified.

        • contentMD5: string

          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.

        • resource: string

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

        • OptionalcontentType: string

          The content type of the file to be uploaded.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CreateUploadDestinationResponse>,
        >

        Throws

Settings

Member Visibility