Function FeedsApiFactory

FeedsApi - factory interface

Export

  • FeedsApiFactory(
        configuration?: Configuration,
        basePath?: string,
        axios?: AxiosInstance,
    ): {
        cancelFeed(
            requestParameters: FeedsApiCancelFeedRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<void>;
        createFeed(
            requestParameters: FeedsApiCreateFeedRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<CreateFeedResponse>;
        createFeedDocument(
            requestParameters: FeedsApiCreateFeedDocumentRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<CreateFeedDocumentResponse>;
        getFeed(
            requestParameters: FeedsApiGetFeedRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<Feed>;
        getFeedDocument(
            requestParameters: FeedsApiGetFeedDocumentRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<FeedDocument>;
        getFeeds(
            requestParameters?: FeedsApiGetFeedsRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<GetFeedsResponse>;
    }

  • Parameters

    • Optionalconfiguration: Configuration
    • OptionalbasePath: string
    • Optionalaxios: AxiosInstance

    Returns {
        cancelFeed(
            requestParameters: FeedsApiCancelFeedRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<void>;
        createFeed(
            requestParameters: FeedsApiCreateFeedRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<CreateFeedResponse>;
        createFeedDocument(
            requestParameters: FeedsApiCreateFeedDocumentRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<CreateFeedDocumentResponse>;
        getFeed(
            requestParameters: FeedsApiGetFeedRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<Feed>;
        getFeedDocument(
            requestParameters: FeedsApiGetFeedDocumentRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<FeedDocument>;
        getFeeds(
            requestParameters?: FeedsApiGetFeedsRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<GetFeedsResponse>;
    }

    • cancelFeed:function
      • cancelFeed(
            requestParameters: FeedsApiCancelFeedRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<void>

      • Cancels the feed that you specify. Only feeds with processingStatus=IN_QUEUE can be cancelled. Cancelled feeds are returned in subsequent calls to the getFeed and getFeeds operations. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 15 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

        Parameters

        • requestParameters: FeedsApiCancelFeedRequest

          Request parameters.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<void>

        Throws

    • createFeed:function
    • createFeedDocument:function
      • createFeedDocument(
            requestParameters: FeedsApiCreateFeedDocumentRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<CreateFeedDocumentResponse>

      • Creates a feed document for the feed type that you specify. This operation returns a presigned URL for uploading the feed document contents. It also returns a feedDocumentId value that you can pass in with a subsequent call to the createFeed operation. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 15 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

        Parameters

        Returns AxiosPromise<CreateFeedDocumentResponse>

        Throws

    • getFeed:function
      • getFeed(
            requestParameters: FeedsApiGetFeedRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<Feed>

      • Returns feed details (including the resultDocumentId, if available) for the feed that you specify. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 15 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

        Parameters

        • requestParameters: FeedsApiGetFeedRequest

          Request parameters.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<Feed>

        Throws

    • getFeedDocument:function
      • getFeedDocument(
            requestParameters: FeedsApiGetFeedDocumentRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<FeedDocument>

      • Returns the information required for retrieving a feed document's contents. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

        Parameters

        Returns AxiosPromise<FeedDocument>

        Throws

    • getFeeds:function
      • getFeeds(
            requestParameters?: FeedsApiGetFeedsRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<GetFeedsResponse>

      • Returns feed details for the feeds that match the filters that you specify. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

        Parameters

        • requestParameters: FeedsApiGetFeedsRequest = {}

          Request parameters.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<GetFeedsResponse>

        Throws

Settings

Member Visibility