Class LambdaApi

LambdaApi - object-oriented interface

Export

Hierarchy

  • BaseAPI
    • LambdaApi

Constructors

constructor

Properties

axios basePath configuration

Methods

lambdaCreateFunctions lambdaCreateRequests lambdaDeleteRequests lambdaListFunctions lambdaListRequests lambdaRetrieveFunctions lambdaRetrieveRequests

Constructors

constructor

  • Parameters

    • Optional configuration: Configuration
    • basePath: string = BASE_PATH
    • axios: AxiosInstance = globalAxios

    Returns LambdaApi

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: undefined | Configuration

Methods

lambdaCreateFunctions

  • Allows to execute a function for immediate computation. Intended for short-lived executions, useful for interactive calls. When executed for interactive annotation, the job id must be specified in the 'job' input field. The task id is not required in this case, but if it is specified, it must match the job task id.

    Parameters

    Returns Promise<AxiosResponse<void, any>>

    Throws

    Memberof

    LambdaApi

lambdaCreateRequests

lambdaDeleteRequests

  • Parameters

    Returns Promise<AxiosResponse<void, any>>

    Summary

    Method cancels the request

    Throws

    Memberof

    LambdaApi

lambdaListFunctions

  • Parameters

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<void, any>>

    Summary

    Method returns a list of functions

    Throws

    Memberof

    LambdaApi

lambdaListRequests

  • Parameters

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<FunctionCall[], any>>

    Summary

    Method returns a list of requests

    Throws

    Memberof

    LambdaApi

lambdaRetrieveFunctions

  • Parameters

    Returns Promise<AxiosResponse<object, any>>

    Summary

    Method returns the information about the function

    Throws

    Memberof

    LambdaApi

lambdaRetrieveRequests

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc