Class StepFunctionService

Represents a service for interacting with AWS Step Functions.

Inheritance
object
AwsBaseService
StepFunctionService
Implements
Inherited Members
Namespace: Innovt.Cloud.AWS.StepFunction
Assembly: Innovt.Cloud.AWS.StepFunction.dll
Syntax
public class StepFunctionService : AwsBaseService, IDisposable, IStateMachine

Constructors

| Edit this page View Source

StepFunctionService(ILogger, IAwsConfiguration)

Initializes a new instance of the StepFunctionService class.

Declaration
public StepFunctionService(ILogger logger, IAwsConfiguration configuration)
Parameters
Type Name Description
ILogger logger

The logger instance.
IAwsConfiguration configuration

The AWS configuration instance.
| Edit this page View Source

StepFunctionService(ILogger, IAwsConfiguration, string)

Initializes a new instance of the StepFunctionService class with a specific region.

Declaration
public StepFunctionService(ILogger logger, IAwsConfiguration configuration, string region)
Parameters
Type Name Description
ILogger logger

The logger instance.
IAwsConfiguration configuration

The AWS configuration instance.
string region

The AWS region.

Methods

| Edit this page View Source

DisposeServices()

Disposes of the Amazon Step Functions client.

Declaration
protected override void DisposeServices()
Overrides
| Edit this page View Source

SendTaskFailure(string, string, string, CancellationToken)

Sends a failure response for a task in the state machine.

Declaration
public Task SendTaskFailure(string taskToken, string reason, string taskError, CancellationToken cancellationToken)
Parameters
Type Name Description
string taskToken

The token for the task.
string reason

The reason for the failure.
string taskError

The error associated with the failure.
CancellationToken cancellationToken

Cancellation token.
Returns
Type Description
Task

A task representing the asynchronous operation.
| Edit this page View Source

SendTaskHeartbeat(string, CancellationToken)

Sends a heartbeat for a task in the state machine.

Declaration
public Task SendTaskHeartbeat(string taskToken, CancellationToken cancellationToken)
Parameters
Type Name Description
string taskToken

The token for the task.
CancellationToken cancellationToken

Cancellation token.
Returns
Type Description
Task

A task representing the asynchronous operation.
| Edit this page View Source

SendTaskSuccess(string, object, CancellationToken)

Sends a success response for a task in the state machine.

Declaration
public Task SendTaskSuccess(string taskToken, object output, CancellationToken cancellationToken)
Parameters
Type Name Description
string taskToken

The token for the task.
object output

The output of the task.
CancellationToken cancellationToken

Cancellation token.
Returns
Type Description
Task

A task representing the asynchronous operation.
| Edit this page View Source

StartExecution(object, string, string, CancellationToken)

Starts the execution of a state machine.

Declaration
public Task StartExecution(object input, string stateMachineArn, string executionId, CancellationToken cancellationToken)
Parameters
Type Name Description
object input

The input for the execution.
string stateMachineArn

The ARN of the state machine.
string executionId

The execution ID.
CancellationToken cancellationToken

Cancellation token.
Returns
Type Description
Task

A task representing the asynchronous operation.

Implements

Extension Methods