Function QueriesApiFactory

QueriesApi - factory interface

Export

  • QueriesApiFactory(
        configuration?: Configuration,
        basePath?: string,
        axios?: AxiosInstance,
    ): {
        cancelQuery(
            requestParameters: QueriesApiCancelQueryRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<void>;
        createQuery(
            requestParameters: QueriesApiCreateQueryRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<CreateQueryResponse>;
        getDocument(
            requestParameters: QueriesApiGetDocumentRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<GetDocumentResponse>;
        getQueries(
            requestParameters?: QueriesApiGetQueriesRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<GetQueriesResponse>;
        getQuery(
            requestParameters: QueriesApiGetQueryRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<Query>;
    }

  • Parameters

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

    Returns {
        cancelQuery(
            requestParameters: QueriesApiCancelQueryRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<void>;
        createQuery(
            requestParameters: QueriesApiCreateQueryRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<CreateQueryResponse>;
        getDocument(
            requestParameters: QueriesApiGetDocumentRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<GetDocumentResponse>;
        getQueries(
            requestParameters?: QueriesApiGetQueriesRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<GetQueriesResponse>;
        getQuery(
            requestParameters: QueriesApiGetQueryRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<Query>;
    }

    • cancelQuery:function
      • cancelQuery(
            requestParameters: QueriesApiCancelQueryRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<void>

      • Cancels the query specified by the queryId parameter. Only queries with a non-terminal processingStatus (IN_QUEUE, IN_PROGRESS) can be cancelled. Cancelling a query that already has a processingStatus of CANCELLED will no-op. Cancelled queries are returned in subsequent calls to the getQuery and getQueries operations. 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 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, refer to Usage Plans and Rate Limits in the Selling Partner API.

        Parameters

        Returns AxiosPromise<void>

        Throws

    • createQuery:function
      • createQuery(
            requestParameters: QueriesApiCreateQueryRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<CreateQueryResponse>

      • Creates a Data Kiosk query request. Note: The retention of a query varies based on the fields requested. Each field within a schema is annotated with a @resultRetention directive that defines how long a query containing that field will be retained. When a query contains multiple fields with different retentions, the shortest (minimum) retention is applied. The retention of a query's resulting documents always matches the retention of the query. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 15 | 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, refer to Usage Plans and Rate Limits in the Selling Partner API.

        Parameters

        Returns AxiosPromise<CreateQueryResponse>

        Throws

    • getDocument:function
      • getDocument(
            requestParameters: QueriesApiGetDocumentRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<GetDocumentResponse>

      • Returns the information required for retrieving a Data Kiosk document's contents. See the createQuery operation for details about document retention. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 15 | 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, refer to Usage Plans and Rate Limits in the Selling Partner API.

        Parameters

        Returns AxiosPromise<GetDocumentResponse>

        Throws

    • getQueries:function
      • getQueries(
            requestParameters?: QueriesApiGetQueriesRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<GetQueriesResponse>

      • Returns details for the Data Kiosk queries that match the specified filters. See the createQuery operation for details about query retention. 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 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, refer to Usage Plans and Rate Limits in the Selling Partner API.

        Parameters

        • requestParameters: QueriesApiGetQueriesRequest = {}

          Request parameters.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<GetQueriesResponse>

        Throws

    • getQuery:function
      • getQuery(
            requestParameters: QueriesApiGetQueryRequest,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<Query>

      • Returns query details for the query specified by the queryId parameter. See the createQuery operation for details about query retention. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 2.0 | 15 | 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, refer to Usage Plans and Rate Limits in the Selling Partner API.

        Parameters

        • requestParameters: QueriesApiGetQueryRequest

          Request parameters.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<Query>

        Throws

Settings

Member Visibility