Class DescribeExecutionAWSSfnTool

Class for checking the status of an AWS Step Function execution.

Hierarchy

Tool
- DescribeExecutionAWSSfnTool

Index

Constructors

constructor

Properties

description name sfnConfig

Constructors

constructor

new DescribeExecutionAWSSfnTool(config): DescribeExecutionAWSSfnTool
Parameters
- config: Omit<SfnConfig, "stateMachineArn"> & ToolParams
Returns DescribeExecutionAWSSfnTool
Overrides Tool.constructor
- Defined in docs/api_refs/langchain/src/tools/aws_sfn.ts:118

Properties

description

description: string = "This tool should ALWAYS be used for checking the status of any AWS Step Function execution (aka. state machine execution). Input to this tool is a properly formatted AWS Step Function Execution ARN (executionArn). The output is a stringified JSON object containing the executionArn, name, status, startDate, stopDate, input, output, error, and cause of the execution."

name

name: string = "describe-execution-aws-sfn"

sfnConfig

sfnConfig: Omit<SfnConfig, "stateMachineArn">

Class DescribeExecutionAWSSfnTool

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Parameters

config: Omit<SfnConfig, "stateMachineArn"> & ToolParams

Returns DescribeExecutionAWSSfnTool

Properties

description

name

sfnConfig

Settings

Member Visibility

Theme

On This Page