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.

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.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginSendTaskFailure and EndSendTaskFailure.

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

Syntax

C#
public abstract Task<SendTaskFailureResponse> SendTaskFailureAsync(
         SendTaskFailureRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.StepFunctions.Model.SendTaskFailureRequest

Container for the necessary parameters to execute the SendTaskFailure service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the SendTaskFailure service method, as returned by StepFunctions.

Exceptions

ExceptionCondition
InvalidTokenException The provided token is not valid.
KmsAccessDeniedException Either your KMS key policy or API caller does not have the required permissions.
KmsInvalidStateException The KMS key is not in valid state, for example: Disabled or Deleted.
KmsThrottlingException Received when KMS returns ThrottlingException for a KMS call that Step Functions makes on behalf of the caller.
TaskDoesNotExistException The activity does not exist.
TaskTimedOutException The task token has either expired or the task associated with the token has already been closed.

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

See Also