@cumulus/api-client
Version:
API client for working with the Cumulus archive API
30 lines • 1.27 kB
TypeScript
import { ApiGatewayLambdaHttpProxyResponse, InvokeApiFunction } from './types';
/**
* Fetch a workflow from the Cumulus API
*
* @param {Object} params - params
* @param {string} params.prefix - the prefix configured for the stack
* @param {string} params.workflowName
* @param {Function} params.callback - async function to invoke the api lambda
* that takes a prefix / user payload. Defaults
* to cumulusApiClient.invokeApi
* @returns {Promise<Object>} - promise that resolves to the output
* of the API lambda
*/
export declare const getWorkflow: (params: {
prefix: string;
workflowName: string;
callback?: InvokeApiFunction;
}) => Promise<ApiGatewayLambdaHttpProxyResponse>;
/**
* Fetch a list of workflows from the Cumulus API
*
* @param {Object} params - params
* @param {string} params.prefix - the prefix configured for the stack
* @returns {Promise<Object>} - the list of workflows fetched by the API
*/
export declare const getWorkflows: (params: {
prefix: string;
callback?: InvokeApiFunction;
}) => Promise<ApiGatewayLambdaHttpProxyResponse>;
//# sourceMappingURL=workflows.d.ts.map