stepfunctions

package

Go to main page

Versions in this module

v1

v1.5.0

Aug 24, 2026

Changes in this version

type MapRun

+ ExecutionCounts MapRunExecutionCounts

+ type MapRunExecutionCounts struct

+ Aborted int

+ Failed int

+ FailuresNotRedrivable int

+ Pending int

+ PendingRedrive int

+ ResultsWritten int

+ Running int

+ Succeeded int

+ TimedOut int

+ Total int

v1.4.0

Aug 19, 2026

v1.3.5

Aug 19, 2026

v1.3.4

Aug 18, 2026

Changes in this version

+ type CloudWatchEventsExecutionDataDetails struct

+ Truncated bool

type Execution

+ InputDetails *CloudWatchEventsExecutionDataDetails

+ MapRunArn string

+ OutputDetails *CloudWatchEventsExecutionDataDetails

+ RedriveStatus string

+ RedriveStatusReason string

+ TraceHeader string

type HistoryEvent

+ TaskStartedEventDetails *TaskStartedEventDetails

+ TaskSubmittedEventDetails *TaskSubmittedEventDetails

+ type HistoryEventExecutionDataDetails struct

+ Truncated bool

type InMemoryBackend

+ func (b *InMemoryBackend) StartExecutionWithTrace(stateMachineArn, name, input, traceHeader string) (*Execution, error)

type StorageBackend

+ StartExecutionWithTrace func(stateMachineArn, name, input, traceHeader string) (*Execution, error)

type TaskFailedEventDetails

+ ResourceType string

type TaskScheduledEventDetails

+ HeartbeatInSeconds *int64

+ Parameters string

+ Region string

+ ResourceType string

+ TimeoutInSeconds *int64

+ type TaskStartedEventDetails struct

+ Resource string

+ ResourceType string

+ type TaskSubmittedEventDetails struct

+ Output string

+ OutputDetails *HistoryEventExecutionDataDetails

+ Resource string

+ ResourceType string

type TaskSucceededEventDetails

+ OutputDetails *HistoryEventExecutionDataDetails

+ ResourceType string

v1.3.3

Aug 17, 2026

v1.3.2

Aug 16, 2026

v1.3.1

Aug 16, 2026

Changes in this version

+ func NewS3ResultWriterIntegration(backend s3pkg.StorageBackend) asl.S3Writer

type InMemoryBackend

+ func (b *InMemoryBackend) SetS3ResultWriter(w asl.S3Writer)

v1.3.0

Aug 3, 2026

v1.2.0

Aug 3, 2026

Changes in this version

+ func NewS3Integration(backend s3pkg.StorageBackend) asl.S3Reader

type Activity

+ EncryptionConfiguration *EncryptionConfiguration

type Execution

+ StateMachineAliasArn string

+ StateMachineVersionArn string

type Handler

+ func (h *Handler) TagResourceByARN(arn string, kv map[string]string) error

+ func (h *Handler) TaggedResources() []TaggedEntry

+ func (h *Handler) UntagResourceByARN(arn string, keys []string) error

type InMemoryBackend

+ func (b *InMemoryBackend) SetActivityEncryptionConfiguration(activityArn string, encryption *EncryptionConfiguration) error

+ func (b *InMemoryBackend) SetS3Reader(s3Reader asl.S3Reader)

type StateMachine

+ RevisionID string

type StorageBackend

+ SetActivityEncryptionConfiguration func(activityArn string, encryption *EncryptionConfiguration) error

+ type TaggedEntry struct

+ ARN string

+ Tags map[string]string

v1.1.4

Jul 20, 2026

v1.1.3

Jul 20, 2026

v1.1.2

Jul 20, 2026

v1.1.1

Jul 20, 2026

v1.1.0

Jul 19, 2026

Changes in this version

+ var ErrActivityAlreadyExists = errors.New("ActivityAlreadyExists")

+ var ErrActivityDoesNotExist = errors.New("ActivityDoesNotExist")

+ var ErrActivityTaskFailed = errors.New("ActivityTaskFailed")

+ var ErrExecutionAlreadyExists = errors.New("ExecutionAlreadyExists")

+ var ErrExecutionDoesNotExist = errors.New("ExecutionDoesNotExist")

+ var ErrExecutionNotRedrivable = errors.New("ExecutionNotRedrivable")

+ var ErrHeartbeatTimeout = errors.New("States.HeartbeatTimeout")

+ var ErrInvalidDefinition = errors.New("InvalidDefinition")

+ var ErrInvalidExecutionInput = errors.New("InvalidExecutionInput")

+ var ErrInvalidExecutionType = errors.New("InvalidExecutionType")

+ var ErrInvalidName = errors.New("InvalidName")

+ var ErrInvalidRoleArn = errors.New("InvalidArn")

+ var ErrInvalidRoutingConfiguration = errors.New("InvalidRoutingConfiguration")

+ var ErrMapRunDoesNotExist = errors.New("MapRunDoesNotExist")

+ var ErrNilAppContext = errors.New("stepfunctions: nil app context")

+ var ErrStateMachineAliasAlreadyExists = errors.New("StateMachineAliasAlreadyExists")

+ var ErrStateMachineAliasDoesNotExist = errors.New("StateMachineAliasDoesNotExist")

+ var ErrStateMachineAlreadyExists = errors.New("StateMachineAlreadyExists")

+ var ErrStateMachineDoesNotExist = errors.New("StateMachineDoesNotExist")

+ var ErrStateMachineTypeNotSupported = errors.New("StateMachineTypeNotSupported")

+ var ErrStateMachineVersionDoesNotExist = errors.New("StateMachineVersionDoesNotExist")

+ var ErrTagPolicyViolation = errors.New("TagPolicyViolation")

+ var ErrTaskTokenAlreadyExists = errors.New("TaskTokenAlreadyExists")

+ var ErrTaskTokenNotFound = errors.New("TaskTokenNotFound")

+ var ErrValidation = errors.New("ValidationException")

+ func NewDynamoDBIntegration(backend dynamodbpkg.StorageBackend) asl.DynamoDBIntegration

+ func NewSNSIntegration(backend sns.StorageBackend) asl.SNSIntegration

+ func NewSQSIntegration(backend sqs.StorageBackend) asl.SQSIntegration

+ type Activity struct

+ ActivityArn string

+ CreationDate float64

+ Name string

+ type ActivityTask struct

+ Input string

+ TaskToken string

+ type AliasRoutingConfig struct

+ StateMachineVersionArn string

+ Weight int

+ type CloudWatchLogsLogGroup struct

+ LogGroupArn string

+ type EBStartExecutionAdapter struct

+ B *InMemoryBackend

+ func (a *EBStartExecutionAdapter) StartExecution(stateMachineARN, name, input string) error

+ type EncryptionConfiguration struct

+ KMSDataKeyReusePeriodSeconds int

+ KMSKeyID string

+ Type string

+ type Execution struct

+ Cause string

+ Error string

+ ExecutionArn string

+ Input string

+ Name string

+ Output string

+ RedriveCount int

+ RedriveDate *float64

+ StartDate float64

+ StateMachineArn string

+ Status string

+ StopDate *float64

+ type Handler struct

+ Backend StorageBackend

+ DefaultRegion string

+ func NewHandler(backend StorageBackend) *Handler

+ func (h *Handler) ChaosOperations() []string

+ func (h *Handler) ChaosRegions() []string

+ func (h *Handler) ChaosServiceName() string

+ func (h *Handler) ExtractOperation(c *echo.Context) string

+ func (h *Handler) ExtractResource(c *echo.Context) string

+ func (h *Handler) GetSupportedOperations() []string

+ func (h *Handler) Handler() echo.HandlerFunc

+ func (h *Handler) MatchPriority() int

+ func (h *Handler) Name() string

+ func (h *Handler) Reset()

+ func (h *Handler) Restore(ctx context.Context, data []byte) error

+ func (h *Handler) RouteMatcher() service.Matcher

+ func (h *Handler) Shutdown(ctx context.Context)

+ func (h *Handler) Snapshot(ctx context.Context) []byte

+ func (h *Handler) StartWorker(ctx context.Context) error

+ type HistoryEvent struct

+ ID int64

+ PreviousEventID int64

+ StateEnteredEventDetails *StateEnteredEventDetails

+ StateExitedEventDetails *StateExitedEventDetails

+ TaskFailedEventDetails *TaskFailedEventDetails

+ TaskScheduledEventDetails *TaskScheduledEventDetails

+ TaskSucceededEventDetails *TaskSucceededEventDetails

+ Timestamp float64

+ Type string

+ type InMemoryBackend struct

+ func NewInMemoryBackend() *InMemoryBackend

+ func NewInMemoryBackendWithConfig(accountID, region string) *InMemoryBackend

+ func NewInMemoryBackendWithContext(svcCtx context.Context, accountID, region string) *InMemoryBackend

+ func (b *InMemoryBackend) AccountID() string

+ func (b *InMemoryBackend) CreateActivity(ctx context.Context, name string) (*Activity, error)

+ func (b *InMemoryBackend) CreateStateMachine(ctx context.Context, name, definition, roleArn, smType string) (*StateMachine, error)

+ func (b *InMemoryBackend) CreateStateMachineAlias(smARN, name, description string, routing []AliasRoutingConfig) (*StateMachineAlias, error)

+ func (b *InMemoryBackend) DeleteActivity(activityArn string) error

+ func (b *InMemoryBackend) DeleteStateMachine(arn string) error

+ func (b *InMemoryBackend) DeleteStateMachineAlias(aliasARN string) error

+ func (b *InMemoryBackend) DeleteStateMachineVersion(versionARN string) error

+ func (b *InMemoryBackend) DescribeActivity(activityArn string) (*Activity, error)

+ func (b *InMemoryBackend) DescribeExecution(executionArn string) (*Execution, error)

+ func (b *InMemoryBackend) DescribeMapRun(mapRunARN string) (*MapRun, error)

+ func (b *InMemoryBackend) DescribeStateMachine(arn string) (*StateMachine, error)

+ func (b *InMemoryBackend) DescribeStateMachineAlias(aliasARN string) (*StateMachineAlias, error)

+ func (b *InMemoryBackend) DescribeStateMachineForExecution(executionARN string) (*StateMachine, error)

+ func (b *InMemoryBackend) DescribeStateMachineVersion(versionARN string) (*StateMachineVersion, error)

+ func (b *InMemoryBackend) Destroy()

+ func (b *InMemoryBackend) GetActivityTask(ctx context.Context, activityArn, _ string) (*ActivityTask, error)

+ func (b *InMemoryBackend) GetExecutionHistory(executionArn, nextToken string, maxResults int, reverseOrder bool) ([]HistoryEvent, string, error)

+ func (b *InMemoryBackend) InvokeActivity(ctx context.Context, activityArn, inputJSON string, heartbeatSeconds int) (string, error)

+ func (b *InMemoryBackend) ListActivities(ctx context.Context, nextToken string, maxResults int) ([]Activity, string, error)

+ func (b *InMemoryBackend) ListExecutions(stateMachineArn, statusFilter, nextToken string, maxResults int) ([]Execution, string, error)

+ func (b *InMemoryBackend) ListMapRuns(executionARN, nextToken string, maxResults int) ([]MapRun, string, error)

+ func (b *InMemoryBackend) ListStateMachineAliases(smARN, nextToken string, maxResults int) ([]StateMachineAlias, string, error)

+ func (b *InMemoryBackend) ListStateMachineVersions(smARN, nextToken string, maxResults int) ([]StateMachineVersion, string, error)

+ func (b *InMemoryBackend) ListStateMachines(ctx context.Context, nextToken string, maxResults int) ([]StateMachine, string, error)

+ func (b *InMemoryBackend) OnMapRunEnd(mapRunARN, status string, succeeded, failed, total int)

+ func (b *InMemoryBackend) OnMapRunStart(executionARN, stateName string, maxConcurrency, itemCount int) string

+ func (b *InMemoryBackend) PruneExecutions(_ context.Context) int

+ func (b *InMemoryBackend) PublishStateMachineVersion(smARN, description, revisionID string) (*StateMachineVersion, error)

+ func (b *InMemoryBackend) RedriveExecution(executionARN string) (*Execution, error)

+ func (b *InMemoryBackend) Region() string

+ func (b *InMemoryBackend) Reset()

+ func (b *InMemoryBackend) Restore(ctx context.Context, data []byte) error

+ func (b *InMemoryBackend) SendTaskFailure(taskToken, errCode, cause string) error

+ func (b *InMemoryBackend) SendTaskHeartbeat(taskToken string) error

+ func (b *InMemoryBackend) SendTaskSuccess(taskToken, output string) error

+ func (b *InMemoryBackend) SetDynamoDBIntegration(ddb asl.DynamoDBIntegration)

+ func (b *InMemoryBackend) SetECSIntegration(ecs asl.ECSIntegration)

+ func (b *InMemoryBackend) SetEventBridgeIntegration(eb asl.EventBridgeIntegration)

+ func (b *InMemoryBackend) SetGlueIntegration(glue asl.GlueIntegration)

+ func (b *InMemoryBackend) SetLambdaInvoker(invoker asl.LambdaInvoker)

+ func (b *InMemoryBackend) SetSNSIntegration(sns asl.SNSIntegration)

+ func (b *InMemoryBackend) SetSQSIntegration(sqs asl.SQSIntegration)

+ func (b *InMemoryBackend) SetSettings(s Settings)

+ func (b *InMemoryBackend) SetStateMachineConfigurations(arn string, tracing *TracingConfiguration, logging *LoggingConfiguration, ...) error

+ func (b *InMemoryBackend) Snapshot(ctx context.Context) []byte

+ func (b *InMemoryBackend) StartExecution(stateMachineArn, name, input string) (*Execution, error)

+ func (b *InMemoryBackend) StartSyncExecution(stateMachineArn, name, input string) (*SyncExecutionResult, error)

+ func (b *InMemoryBackend) StopExecution(executionArn, errCode, cause string) error

+ func (b *InMemoryBackend) SweepTaskTokens() int

+ func (b *InMemoryBackend) UpdateMapRun(mapRunARN string, maxConcurrency int, toleratedFailureCount int, ...) (*MapRun, error)

+ func (b *InMemoryBackend) UpdateStateMachine(smARN, definition, roleArn string) (float64, error)

+ func (b *InMemoryBackend) UpdateStateMachineAlias(aliasARN, description string, routing []AliasRoutingConfig) (*StateMachineAlias, error)

+ func (b *InMemoryBackend) WaitForTaskToken(ctx context.Context, taskToken string, heartbeatSeconds int) (string, error)

+ type Janitor struct

+ Backend *InMemoryBackend

+ Interval time.Duration

+ TaskTimeout time.Duration

+ func NewJanitor(backend *InMemoryBackend, settings Settings) *Janitor

+ func (j *Janitor) Run(ctx context.Context)

+ type LoggingConfiguration struct

+ Destinations []LoggingDestination

+ IncludeExecutionData bool

+ Level string

+ type LoggingDestination struct

+ CloudWatchLogsLogGroup *CloudWatchLogsLogGroup

+ type MapRun struct

+ ExecutionArn string

+ ItemCounts MapRunItemCounts

+ MapRunArn string

+ MaxConcurrency int

+ RedriveCount int

+ RedriveDate *float64

+ StartDate float64

+ StateMachineArn string

+ Status string

+ StopDate *float64

+ ToleratedFailureCount int

+ ToleratedFailurePercentage float64

+ type MapRunItemCounts struct

+ Aborted int

+ Failed int

+ FailuresNotRedrivable int

+ Pending int

+ PendingRedrive int

+ ResultsWritten int

+ Running int

+ Succeeded int

+ TimedOut int

+ Total int

+ type Provider struct

+ func (p *Provider) Init(ctx *service.AppContext) (service.Registerable, error)

+ func (p *Provider) Name() string

+ type Settings struct

+ ExecutionRetention time.Duration

+ JanitorInterval time.Duration

+ TaskTokenTTL time.Duration

+ func DefaultSettings() Settings

+ type SettingsProvider interface

+ GetStepFunctionsSettings func() Settings

+ type StateEnteredEventDetails struct

+ Input string

+ Name string

+ type StateExitedEventDetails struct

+ Name string

+ Output string

+ type StateMachine struct

+ CreationDate float64

+ Definition string

+ EncryptionConfiguration *EncryptionConfiguration

+ LoggingConfiguration *LoggingConfiguration

+ Name string

+ RoleArn string

+ StateMachineArn string

+ Status string

+ TracingConfiguration *TracingConfiguration

+ Type string

+ UpdatedDate float64

+ type StateMachineAlias struct

+ CreationDate float64

+ Description string

+ Name string

+ RoutingConfiguration []AliasRoutingConfig

+ StateMachineAliasArn string

+ UpdatedDate float64

+ type StateMachineVersion struct

+ CreationDate float64

+ Definition string

+ Description string

+ Name string

+ RevisionID string

+ RoleArn string

+ StateMachineArn string

+ StateMachineVersionArn string

+ Status string

+ Type string

+ type StorageBackend interface

+ CreateActivity func(ctx context.Context, name string) (*Activity, error)

+ CreateStateMachine func(ctx context.Context, name, definition, roleArn, smType string) (*StateMachine, error)

+ CreateStateMachineAlias func(smARN, name, description string, routing []AliasRoutingConfig) (*StateMachineAlias, error)

+ DeleteActivity func(activityArn string) error

+ DeleteStateMachine func(arn string) error

+ DeleteStateMachineAlias func(aliasARN string) error

+ DeleteStateMachineVersion func(versionARN string) error

+ DescribeActivity func(activityArn string) (*Activity, error)

+ DescribeExecution func(executionArn string) (*Execution, error)

+ DescribeMapRun func(mapRunARN string) (*MapRun, error)

+ DescribeStateMachine func(arn string) (*StateMachine, error)

+ DescribeStateMachineAlias func(aliasARN string) (*StateMachineAlias, error)

+ DescribeStateMachineForExecution func(executionARN string) (*StateMachine, error)

+ DescribeStateMachineVersion func(versionARN string) (*StateMachineVersion, error)

+ GetActivityTask func(ctx context.Context, activityArn, workerName string) (*ActivityTask, error)

+ GetExecutionHistory func(executionArn, nextToken string, maxResults int, reverseOrder bool) ([]HistoryEvent, string, error)

+ ListActivities func(ctx context.Context, nextToken string, maxResults int) ([]Activity, string, error)

+ ListExecutions func(stateMachineArn, statusFilter, nextToken string, maxResults int) ([]Execution, string, error)

+ ListMapRuns func(executionARN, nextToken string, maxResults int) ([]MapRun, string, error)

+ ListStateMachineAliases func(smARN, nextToken string, maxResults int) ([]StateMachineAlias, string, error)

+ ListStateMachineVersions func(smARN, nextToken string, maxResults int) ([]StateMachineVersion, string, error)

+ ListStateMachines func(ctx context.Context, nextToken string, maxResults int) ([]StateMachine, string, error)

+ PublishStateMachineVersion func(smARN, description, revisionID string) (*StateMachineVersion, error)

+ RedriveExecution func(executionARN string) (*Execution, error)

+ SendTaskFailure func(taskToken, errCode, cause string) error

+ SendTaskHeartbeat func(taskToken string) error

+ SendTaskSuccess func(taskToken, output string) error

+ SetStateMachineConfigurations func(arn string, tracing *TracingConfiguration, logging *LoggingConfiguration, ...) error

+ StartExecution func(stateMachineArn, name, input string) (*Execution, error)

+ StartSyncExecution func(stateMachineArn, name, input string) (*SyncExecutionResult, error)

+ StopExecution func(executionArn, errCode, cause string) error

+ UpdateMapRun func(mapRunARN string, maxConcurrency int, toleratedFailureCount int, ...) (*MapRun, error)

+ UpdateStateMachine func(arn, definition, roleArn string) (float64, error)

+ UpdateStateMachineAlias func(aliasARN, description string, routing []AliasRoutingConfig) (*StateMachineAlias, error)

+ type SyncExecutionResult struct

+ Cause string

+ Error string

+ ExecutionArn string

+ Input string

+ Name string

+ Output string

+ StartDate float64

+ StateMachineArn string

+ Status string

+ StopDate float64

+ type TaskFailedEventDetails struct

+ Cause string

+ Error string

+ Resource string

+ type TaskScheduledEventDetails struct

+ Resource string

+ type TaskSucceededEventDetails struct

+ Output string

+ Resource string

+ type TracingConfiguration struct

+ Enabled bool

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL