@cumulus/api-client
Version:
API client for working with the Cumulus archive API
20 lines • 1.05 kB
TypeScript
import { DeadLetterArchivePayload } from '@cumulus/types/api/dead_letters';
import { ApiGatewayLambdaHttpProxyResponse, InvokeApiFunction } from './types';
/**
* POST a request to start a dead letter processing run
*
* @param {Object} params - params
* @param {string} params.prefix - the prefix configured for the stack
* @param {Object} params.payload - payload to post to the endpoint
* @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 postRecoverCumulusMessages: (params: {
prefix: string;
payload: DeadLetterArchivePayload;
callback?: InvokeApiFunction;
}) => Promise<ApiGatewayLambdaHttpProxyResponse>;
//# sourceMappingURL=deadLetterArchive.d.ts.map