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.

Classes

NameDescription
Class ActivityDoesNotExistException

StepFunctions exception

Class ActivityFailedEventDetails

Contains details about an activity which failed during an execution.

Class ActivityLimitExceededException

StepFunctions exception

Class ActivityListItem

Contains details about an activity.

Class ActivityScheduledEventDetails

Contains details about an activity scheduled during an execution.

Class ActivityScheduleFailedEventDetails

Contains details about an activity schedule failure which occurred during an execution.

Class ActivityStartedEventDetails

Contains details about the start of an activity during an execution.

Class ActivitySucceededEventDetails

Contains details about an activity which successfully terminated during an execution.

Class ActivityTimedOutEventDetails

Contains details about an activity timeout which occurred during an execution.

Class ActivityWorkerLimitExceededException

StepFunctions exception

Class CreateActivityRequest

Container for the parameters to the CreateActivity operation. 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.

Class CreateActivityResponse

This is the response object from the CreateActivity operation.

Class CreateStateMachineRequest

Container for the parameters to the CreateStateMachine operation. 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.

Class CreateStateMachineResponse

This is the response object from the CreateStateMachine operation.

Class DeleteActivityRequest

Container for the parameters to the DeleteActivity operation. Deletes an activity.

Class DeleteActivityResponse

This is the response object from the DeleteActivity operation.

Class DeleteStateMachineRequest

Container for the parameters to the DeleteStateMachine operation. 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.

Class DeleteStateMachineResponse

This is the response object from the DeleteStateMachine operation.

Class DescribeActivityRequest

Container for the parameters to the DescribeActivity operation. Describes an activity.

Class DescribeActivityResponse

This is the response object from the DescribeActivity operation.

Class DescribeExecutionRequest

Container for the parameters to the DescribeExecution operation. Describes an execution.

Class DescribeExecutionResponse

This is the response object from the DescribeExecution operation.

Class DescribeStateMachineForExecutionRequest

Container for the parameters to the DescribeStateMachineForExecution operation. Describes the state machine associated with a specific execution.

Class DescribeStateMachineForExecutionResponse

This is the response object from the DescribeStateMachineForExecution operation.

Class DescribeStateMachineRequest

Container for the parameters to the DescribeStateMachine operation. Describes a state machine.

Class DescribeStateMachineResponse

This is the response object from the DescribeStateMachine operation.

Class ExecutionAbortedEventDetails

Contains details about an abort of an execution.

Class ExecutionAlreadyExistsException

StepFunctions exception

Class ExecutionDoesNotExistException

StepFunctions exception

Class ExecutionFailedEventDetails

Contains details about an execution failure event.

Class ExecutionLimitExceededException

StepFunctions exception

Class ExecutionListItem

Contains details about an execution.

Class ExecutionStartedEventDetails

Contains details about the start of the execution.

Class ExecutionSucceededEventDetails

Contains details about the successful termination of the execution.

Class ExecutionTimedOutEventDetails

Contains details about the execution timeout which occurred during the execution.

Class GetActivityTaskRequest

Container for the parameters to the GetActivityTask operation. 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).

Class GetActivityTaskResponse

This is the response object from the GetActivityTask operation.

Class GetExecutionHistoryRequest

Container for the parameters to the GetExecutionHistory operation. 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.

Class GetExecutionHistoryResponse

This is the response object from the GetExecutionHistory operation.

Class HistoryEvent

Contains details about the events of an execution.

Class InvalidArnException

StepFunctions exception

Class InvalidDefinitionException

StepFunctions exception

Class InvalidExecutionInputException

StepFunctions exception

Class InvalidNameException

StepFunctions exception

Class InvalidOutputException

StepFunctions exception

Class InvalidTokenException

StepFunctions exception

Class LambdaFunctionFailedEventDetails

Contains details about a lambda function which failed during an execution.

Class LambdaFunctionScheduledEventDetails

Contains details about a lambda function scheduled during an execution.

Class LambdaFunctionScheduleFailedEventDetails

Contains details about a failed lambda function schedule event which occurred during an execution.

Class LambdaFunctionStartFailedEventDetails

Contains details about a lambda function which failed to start during an execution.

Class LambdaFunctionSucceededEventDetails

Contains details about a lambda function which successfully terminated during an execution.

Class LambdaFunctionTimedOutEventDetails

Contains details about a lambda function timeout which occurred during an execution.

Class ListActivitiesRequest

Container for the parameters to the ListActivities operation. 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.

Class ListActivitiesResponse

This is the response object from the ListActivities operation.

Class ListExecutionsRequest

Container for the parameters to the ListExecutions operation. 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.

Class ListExecutionsResponse

This is the response object from the ListExecutions operation.

Class ListStateMachinesRequest

Container for the parameters to the ListStateMachines operation. 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.

Class ListStateMachinesResponse

This is the response object from the ListStateMachines operation.

Class MissingRequiredParameterException

StepFunctions exception

Class SendTaskFailureRequest

Container for the parameters to the SendTaskFailure operation. Used by workers to report that the task identified by the taskToken failed.

Class SendTaskFailureResponse

This is the response object from the SendTaskFailure operation.

Class SendTaskHeartbeatRequest

Container for the parameters to the SendTaskHeartbeat operation. 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.

Class SendTaskHeartbeatResponse

This is the response object from the SendTaskHeartbeat operation.

Class SendTaskSuccessRequest

Container for the parameters to the SendTaskSuccess operation. Used by workers to report that the task identified by the taskToken completed successfully.

Class SendTaskSuccessResponse

This is the response object from the SendTaskSuccess operation.

Class StartExecutionRequest

Container for the parameters to the StartExecution operation. Starts a state machine execution.

Class StartExecutionResponse

This is the response object from the StartExecution operation.

Class StateEnteredEventDetails

Contains details about a state entered during an execution.

Class StateExitedEventDetails

Contains details about an exit from a state during an execution.

Class StateMachineAlreadyExistsException

StepFunctions exception

Class StateMachineDeletingException

StepFunctions exception

Class StateMachineDoesNotExistException

StepFunctions exception

Class StateMachineLimitExceededException

StepFunctions exception

Class StateMachineListItem

Contains details about the state machine.

Class StopExecutionRequest

Container for the parameters to the StopExecution operation. Stops an execution.

Class StopExecutionResponse

This is the response object from the StopExecution operation.

Class TaskDoesNotExistException

StepFunctions exception

Class TaskTimedOutException

StepFunctions exception

Class UpdateStateMachineRequest

Container for the parameters to the UpdateStateMachine operation. 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.

Class UpdateStateMachineResponse

This is the response object from the UpdateStateMachine operation.