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.

Container for the parameters to the SendTaskFailure operation. Used by activity workers, Task states using the callback pattern, and optionally Task states using the job run pattern to report that the task identified by the taskToken failed.

For an execution with encryption enabled, Step Functions will encrypt the error and cause fields using the KMS key for the execution role.

A caller can mark a task as fail without using any KMS permissions in the execution role if the caller provides a null value for both error and cause fields because no data needs to be encrypted.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.StepFunctions.AmazonStepFunctionsRequest
      Amazon.StepFunctions.Model.SendTaskFailureRequest

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

Syntax

C#
public class SendTaskFailureRequest : AmazonStepFunctionsRequest
         IAmazonWebServiceRequest

The SendTaskFailureRequest type exposes the following members

Constructors

NameDescription
Public Method SendTaskFailureRequest()

Properties

NameTypeDescription
Public Property Cause System.String

Gets and sets the property Cause.

A more detailed explanation of the cause of the failure.

Public Property Error System.String

Gets and sets the property Error.

The error code of the failure.

Public Property TaskToken System.String

Gets and sets the property TaskToken.

The token that represents this task. Task tokens are generated by Step Functions when tasks are assigned to a worker, or in the context object when a workflow enters a task state. See GetActivityTaskOutput$taskToken.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5