AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Implementation for accessing StepFunctions AWS Step Functions

AWS Step Functions is a service that lets you coordinate the components of distributed applications and microservices using visual workflows.

You can use Step Functions to build applications from individual components, each of which performs a discrete function, or task, allowing you to scale and change applications quickly. Step Functions provides a console that helps visualize the components of your application as a series of steps. Step Functions automatically triggers and tracks each step, and retries steps when there are errors, so your application executes predictably and in the right order every time. Step Functions logs the state of each step, so you can quickly diagnose and debug any issues.

Step Functions manages operations and underlying infrastructure to ensure your application is available at any scale. You can run tasks on AWS, your own servers, or any system that has access to AWS. You can access and use Step Functions using the console, the AWS SDKs, or an HTTP API. For more information about Step Functions, see the AWS Step Functions Developer Guide .

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.StepFunctions.AmazonStepFunctionsClient

Namespace: Amazon.StepFunctions
Assembly: AWSSDK.StepFunctions.dll
Version: 3.x.y.z

Syntax

C#
public class AmazonStepFunctionsClient : AmazonServiceClient
         IAmazonService, IAmazonStepFunctions, IDisposable

The AmazonStepFunctionsClient type exposes the following members

Constructors

NameDescription
Public Method AmazonStepFunctionsClient()

Constructs AmazonStepFunctionsClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonStepFunctionsClient(RegionEndpoint)

Constructs AmazonStepFunctionsClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonStepFunctionsClient(AmazonStepFunctionsConfig)

Constructs AmazonStepFunctionsClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonStepFunctionsClient(AWSCredentials)

Constructs AmazonStepFunctionsClient with AWS Credentials

Public Method AmazonStepFunctionsClient(AWSCredentials, RegionEndpoint)

Constructs AmazonStepFunctionsClient with AWS Credentials

Public Method AmazonStepFunctionsClient(AWSCredentials, AmazonStepFunctionsConfig)

Constructs AmazonStepFunctionsClient with AWS Credentials and an AmazonStepFunctionsClient Configuration object.

Public Method AmazonStepFunctionsClient(string, string)

Constructs AmazonStepFunctionsClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonStepFunctionsClient(string, string, RegionEndpoint)

Constructs AmazonStepFunctionsClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonStepFunctionsClient(string, string, AmazonStepFunctionsConfig)

Constructs AmazonStepFunctionsClient with AWS Access Key ID, AWS Secret Key and an AmazonStepFunctionsClient Configuration object.

Public Method AmazonStepFunctionsClient(string, string, string)

Constructs AmazonStepFunctionsClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonStepFunctionsClient(string, string, string, RegionEndpoint)

Constructs AmazonStepFunctionsClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonStepFunctionsClient(string, string, string, AmazonStepFunctionsConfig)

Constructs AmazonStepFunctionsClient with AWS Access Key ID, AWS Secret Key and an AmazonStepFunctionsClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method CreateActivity(CreateActivityRequest)

Creates an activity. An activity is a task which you write in any programming language and host on any machine which has access to AWS Step Functions. Activities must poll Step Functions using the GetActivityTask API action and respond using SendTask* API actions. This function lets Step Functions know the existence of your activity and returns an identifier for use in a state machine and when polling from the activity.

Public Method CreateActivityAsync(CreateActivityRequest, CancellationToken)

Initiates the asynchronous execution of the CreateActivity operation.

Public Method CreateStateMachine(CreateStateMachineRequest)

Creates a state machine. A state machine consists of a collection of states that can do work (Task states), determine to which states to transition next (Choice states), stop an execution with an error (Fail states), and so on. State machines are specified using a JSON-based, structured language.

Public Method CreateStateMachineAsync(CreateStateMachineRequest, CancellationToken)

Initiates the asynchronous execution of the CreateStateMachine operation.

Public Method DeleteActivity(DeleteActivityRequest)

Deletes an activity.

Public Method DeleteActivityAsync(DeleteActivityRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteActivity operation.

Public Method DeleteStateMachine(DeleteStateMachineRequest)

Deletes a state machine. This is an asynchronous operation: It sets the state machine's status to DELETING and begins the deletion process. Each state machine execution is deleted the next time it makes a state transition.

The state machine itself is deleted after all executions are completed or deleted.

Public Method DeleteStateMachineAsync(DeleteStateMachineRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteStateMachine operation.

Public Method DescribeActivity(DescribeActivityRequest)

Describes an activity.

Public Method DescribeActivityAsync(DescribeActivityRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeActivity operation.

Public Method DescribeExecution(DescribeExecutionRequest)

Describes an execution.

Public Method DescribeExecutionAsync(DescribeExecutionRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeExecution operation.

Public Method DescribeStateMachine(DescribeStateMachineRequest)

Describes a state machine.

Public Method DescribeStateMachineAsync(DescribeStateMachineRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeStateMachine operation.

Public Method DescribeStateMachineForExecution(DescribeStateMachineForExecutionRequest)

Describes the state machine associated with a specific execution.

Public Method DescribeStateMachineForExecutionAsync(DescribeStateMachineForExecutionRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeStateMachineForExecution operation.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method GetActivityTask(GetActivityTaskRequest)

Used by workers to retrieve a task (with the specified activity ARN) which has been scheduled for execution by a running state machine. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available (i.e. an execution of a task of this type is needed.) The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll returns a taskToken with a null string.

Workers should set their client side socket timeout to at least 65 seconds (5 seconds higher than the maximum time the service may hold the poll request).

Public Method GetActivityTaskAsync(GetActivityTaskRequest, CancellationToken)

Initiates the asynchronous execution of the GetActivityTask operation.

Public Method GetExecutionHistory(GetExecutionHistoryRequest)

Returns the history of the specified execution as a list of events. By default, the results are returned in ascending order of the timeStamp of the events. Use the reverseOrder parameter to get the latest events first.

If a nextToken is returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextToken. Keep all other arguments unchanged.

Public Method GetExecutionHistoryAsync(GetExecutionHistoryRequest, CancellationToken)

Initiates the asynchronous execution of the GetExecutionHistory operation.

Public Method ListActivities(ListActivitiesRequest)

Lists the existing activities.

If a nextToken is returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextToken. Keep all other arguments unchanged.

Public Method ListActivitiesAsync(ListActivitiesRequest, CancellationToken)

Initiates the asynchronous execution of the ListActivities operation.

Public Method ListExecutions(ListExecutionsRequest)

Lists the executions of a state machine that meet the filtering criteria.

If a nextToken is returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextToken. Keep all other arguments unchanged.

Public Method ListExecutionsAsync(ListExecutionsRequest, CancellationToken)

Initiates the asynchronous execution of the ListExecutions operation.

Public Method ListStateMachines(ListStateMachinesRequest)

Lists the existing state machines.

If a nextToken is returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextToken. Keep all other arguments unchanged.

Public Method ListStateMachinesAsync(ListStateMachinesRequest, CancellationToken)

Initiates the asynchronous execution of the ListStateMachines operation.

Public Method SendTaskFailure(SendTaskFailureRequest)

Used by workers to report that the task identified by the taskToken failed.

Public Method SendTaskFailureAsync(SendTaskFailureRequest, CancellationToken)

Initiates the asynchronous execution of the SendTaskFailure operation.

Public Method SendTaskHeartbeat(SendTaskHeartbeatRequest)

Used by workers to report to the service that the task represented by the specified taskToken is still making progress. This action resets the Heartbeat clock. The Heartbeat threshold is specified in the state machine's Amazon States Language definition. This action does not in itself create an event in the execution history. However, if the task times out, the execution history contains an ActivityTimedOut event.

The Timeout of a task, defined in the state machine's Amazon States Language definition, is its maximum allowed duration, regardless of the number of SendTaskHeartbeat requests received.

This operation is only useful for long-lived tasks to report the liveliness of the task.

Public Method SendTaskHeartbeatAsync(SendTaskHeartbeatRequest, CancellationToken)

Initiates the asynchronous execution of the SendTaskHeartbeat operation.

Public Method SendTaskSuccess(SendTaskSuccessRequest)

Used by workers to report that the task identified by the taskToken completed successfully.

Public Method SendTaskSuccessAsync(SendTaskSuccessRequest, CancellationToken)

Initiates the asynchronous execution of the SendTaskSuccess operation.

Public Method StartExecution(StartExecutionRequest)

Starts a state machine execution.

Public Method StartExecutionAsync(StartExecutionRequest, CancellationToken)

Initiates the asynchronous execution of the StartExecution operation.

Public Method StopExecution(StopExecutionRequest)

Stops an execution.

Public Method StopExecutionAsync(StopExecutionRequest, CancellationToken)

Initiates the asynchronous execution of the StopExecution operation.

Public Method UpdateStateMachine(UpdateStateMachineRequest)

Updates an existing state machine by modifying its definition and/or roleArn. Running executions will continue to use the previous definition and roleArn.

All StartExecution calls within a few seconds will use the updated definition and roleArn. Executions started immediately after calling UpdateStateMachine may use the previous state machine definition and roleArn. You must include at least one of definition or roleArn or you will receive a MissingRequiredParameter error.

Public Method UpdateStateMachineAsync(UpdateStateMachineRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateStateMachine operation.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms