Function QueriesApiFp

QueriesApi - functional programming interface

Export

  • QueriesApiFp(
        configuration?: Configuration,
    ): {
        cancelQuery(
            queryId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
        >;
        createQuery(
            body: CreateQuerySpecification,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CreateQueryResponse>,
        >;
        getDocument(
            documentId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetDocumentResponse>,
        >;
        getQueries(
            processingStatuses?: GetQueriesProcessingStatusesEnum[],
            pageSize?: number,
            createdSince?: string,
            createdUntil?: string,
            paginationToken?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetQueriesResponse>,
        >;
        getQuery(
            queryId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<Query>,
        >;
    }

  • Parameters

    • Optionalconfiguration: Configuration

    Returns {
        cancelQuery(
            queryId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
        >;
        createQuery(
            body: CreateQuerySpecification,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<CreateQueryResponse>,
        >;
        getDocument(
            documentId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetDocumentResponse>,
        >;
        getQueries(
            processingStatuses?: GetQueriesProcessingStatusesEnum[],
            pageSize?: number,
            createdSince?: string,
            createdUntil?: string,
            paginationToken?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GetQueriesResponse>,
        >;
        getQuery(
            queryId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<Query>,
        >;
    }

    • cancelQuery:function
      • cancelQuery(
            queryId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<(axios?: AxiosInstance, basePath?: string) => 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

        • queryId: string

          The identifier for the query. This identifier is unique only in combination with a selling partner account ID.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • createQuery:function
      • createQuery(
            body: CreateQuerySpecification,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => 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

        • body: CreateQuerySpecification

          The body of the request.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • getDocument:function
      • getDocument(
            documentId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => 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

        • documentId: string

          The identifier for the Data Kiosk document.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • getQueries:function
      • getQueries(
            processingStatuses?: GetQueriesProcessingStatusesEnum[],
            pageSize?: number,
            createdSince?: string,
            createdUntil?: string,
            paginationToken?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => 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

        • OptionalprocessingStatuses: GetQueriesProcessingStatusesEnum[]

          A list of processing statuses used to filter queries.

        • OptionalpageSize: number

          The maximum number of queries to return in a single call.

        • OptionalcreatedSince: string

          The earliest query creation date and time for queries to include in the response, in ISO 8601 date time format. The default is 90 days ago.

        • OptionalcreatedUntil: string

          The latest query creation date and time for queries to include in the response, in ISO 8601 date time format. The default is the time of the `getQueries` request.

        • OptionalpaginationToken: string

          A token to fetch a certain page of results when there are multiple pages of results available. The value of this token is fetched from the `pagination.nextToken` field returned in the `GetQueriesResponse` object. All other parameters must be provided with the same values that were provided with the request that generated this token, with the exception of `pageSize` which can be modified between calls to `getQueries`. In the absence of this token value, `getQueries` returns the first page of results.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • getQuery:function
      • getQuery(
            queryId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => 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

        • queryId: string

          The query identifier.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

Settings

Member Visibility