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

Class ActivityLimitExceededException

StepFunctions exception

Class ActivityListItem

Class ActivityScheduledEventDetails

Class ActivityScheduleFailedEventDetails

Class ActivityStartedEventDetails

Class ActivitySucceededEventDetails

Class ActivityTimedOutEventDetails

Class ActivityWorkerLimitExceededException

StepFunctions exception

Class CreateActivityRequest

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

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 delete process.

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 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

Class ExecutionAlreadyExistsException

StepFunctions exception

Class ExecutionDoesNotExistException

StepFunctions exception

Class ExecutionFailedEventDetails

Class ExecutionLimitExceededException

StepFunctions exception

Class ExecutionListItem

Class ExecutionStartedEventDetails

Class ExecutionSucceededEventDetails

Class ExecutionTimedOutEventDetails

Class GetActivityTaskRequest

Container for the parameters to the GetActivityTask operation. Used by workers to retrieve a task (with the specified activity ARN) 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 will return an empty result, that is, the taskToken returned is an empty 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. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextToken returned by the previous call.

Class GetExecutionHistoryResponse

This is the response object from the GetExecutionHistory operation.

Class HistoryEvent

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

Class LambdaFunctionScheduledEventDetails

Class LambdaFunctionScheduleFailedEventDetails

Class LambdaFunctionStartFailedEventDetails

Class LambdaFunctionSucceededEventDetails

Class LambdaFunctionTimedOutEventDetails

Class ListActivitiesRequest

Container for the parameters to the ListActivities operation. Lists the existing activities. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextToken returned by the previous call.

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. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextToken returned by the previous call.

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. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextToken returned by the previous call.

Class ListStateMachinesResponse

This is the response object from the ListStateMachines operation.

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 will contain 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

Class StateExitedEventDetails

Class StateMachineAlreadyExistsException

StepFunctions exception

Class StateMachineDeletingException

StepFunctions exception

Class StateMachineDoesNotExistException

StepFunctions exception

Class StateMachineLimitExceededException

StepFunctions exception

Class StateMachineListItem

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