@cumulus/aws-client/StepFunctions.d.ts

Utilities for working with AWS

/**
 * @module StepFunctions
 */
import { DescribeExecutionInput, DescribeExecutionOutput, DescribeStateMachineInput, DescribeStateMachineOutput, GetExecutionHistoryInput, HistoryEvent, ListExecutionsCommandInput } from '@aws-sdk/client-sfn';
export { DescribeExecutionOutput, ExecutionDoesNotExist, ExecutionAlreadyExists, HistoryEvent, StateMachineDoesNotExist, } from '@aws-sdk/client-sfn';
export declare const doesExecutionExist: (describeExecutionPromise: Promise<unknown>) => Promise<boolean>;
/**
 * Call StepFunctions DescribeExecution
 *
 * See [StepFunctions.describeExecution()](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/StepFunctions.html#describeExecution-property)
 * for descriptions of `params` and the return data.
 *
 * If a ThrottlingException is received, this function will retry using an
 * exponential backoff.
 *
 * @param {DescribeExecutionInput} params
 * @returns {Promise<DescribeExecutionOutput>}
 *
 * @kind function
 */
export declare const describeExecution: (params: DescribeExecutionInput) => Promise<DescribeExecutionOutput>;
/**
 * Call StepFunctions DescribeStateMachine
 *
 * See [StepFunctions.describeStateMachine()](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/StepFunctions.html#describeStateMachine-property)
 * for descriptions of `params` and the return data.
 *
 * If a ThrottlingException is received, this function will retry using an
 * exponential backoff.
 *
 * @param {DescribeStateMachineInput} params
 * @returns {Promise<DescribeStateMachineOutput>}
 *
 * @kind function
 */
export declare const describeStateMachine: (params: DescribeStateMachineInput) => Promise<DescribeStateMachineOutput>;
/**
 * Check if a Step Function Execution exists
 *
 * If a ThrottlingException is received, this function will retry using an
 * exponential backoff.
 *
 * @param {string} executionArn - the ARN of the Step Function Execution to
 *   check for
 * @returns {Promise<boolean>}
 *
 * @kind function
 */
export declare const executionExists: (executionArn: string) => Promise<boolean>;
/**
 * Call StepFunctions GetExecutionHistory
 *
 * See [StepFunctions.getExecutionHistory()](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/StepFunctions.html#getExecutionHistory-property)
 * for descriptions of `params` and the return data.
 *
 * If a ThrottlingException is received, this function will retry using an
 * exponential backoff.
 *
 * @param {GetExecutionHistoryInput} params
 * @returns {Promise<GetExecutionHistoryOutput>}
 *
 * @kind function
 */
export declare const getExecutionHistory: (params: GetExecutionHistoryInput, previousResponse?: {
    events: HistoryEvent[];
} | undefined) => Promise<{
    events: HistoryEvent[];
}>;
export declare const getExecutionStatus: (executionArn: string) => Promise<{
    execution: DescribeExecutionOutput;
    executionHistory: {
        events: HistoryEvent[];
    };
    stateMachine: DescribeStateMachineOutput;
}>;
/**
 * Call StepFunctions ListExecutions
 *
 * See [StepFunctions.listExecutions()](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/StepFunctions.html#listExecutions-property)
 * for descriptions of `params` and the return data.
 *
 * If a ThrottlingException is received, this function will retry using an
 * exponential backoff.
 *
 * @param {Object} params
 * @returns {Promise<Object>}
 *
 * @kind function
 */
export declare const listExecutions: (params: ListExecutionsCommandInput) => Promise<import("@aws-sdk/client-sfn").ListExecutionsCommandOutput>;
//# sourceMappingURL=StepFunctions.d.ts.map