@cumulus/common/cloudwatch-event.d.ts

import { AwsCloudWatchEvent } from './types';
/**
 * Determine if Cloudwatch event is a Step Function event
 *
 * @param {AwsCloudWatchEvent} event - A Cloudwatch event
 * @returns {boolean} True if event is a Step Function event
 */
export declare const isSfExecutionEvent: (event: AwsCloudWatchEvent) => boolean;
/**
 * Determine if Step Function is in a terminal state.
 *
 * @param {string} status - A Step Function execution status from a Cloudwatch event
 * @returns {boolean} True if Step Function is in terminal state.
 */
export declare const isTerminalSfStatus: (status: string) => boolean;
/**
 * Determine if Step Function is in a failed state.
 *
 * @param {Object} status - A Step Function execution status from a Cloudwatch event
 * @returns {boolean} True if Step Function is in failed state.
 */
export declare const isFailedSfStatus: (status: string) => boolean;
/**
 * Get Step Function status from Cloudwatch event.
 *
 * @param {AwsCloudWatchEvent} event - A Cloudwatch event
 * @returns {string|undefined} Step Function execution status
 */
export declare const getSfEventStatus: (event: AwsCloudWatchEvent) => string | undefined;
/**
 * Get the Step Function output message from a Cloudwatch Event
 *
 * @param {AwsCloudWatchEvent} event - A Cloudwatch event
 * @param {string} field - Field to pull from 'detail', i.e. 'input' or 'output'
 * @param {string} [defaultValue] - A default value for the message, if none exists
 * @returns {string|undefined} Output message from Step Function
 */
export declare const getSfEventDetailValue: (event: AwsCloudWatchEvent, field: 'input' | 'output', defaultValue?: string | undefined) => string | undefined;
/**
 * Get the Step Function output message from a Cloudwatch Event
 *
 * @param {Object} event - A Cloudwatch event
 * @param {string} messageSource - 'input' or 'output' from Step Function
 * @param {string} defaultValue - defaultValue to fetch if no event message object is found
 * @returns {unknown} Message object from Step Function
 */
export declare const getSfEventMessageObject: (event: AwsCloudWatchEvent, messageSource: 'input' | 'output', defaultValue: string) => unknown;
//# sourceMappingURL=cloudwatch-event.d.ts.map