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.

This is the response object from the DescribeExecution operation.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceResponse
    Amazon.StepFunctions.Model.DescribeExecutionResponse

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

Syntax

C#
public class DescribeExecutionResponse : AmazonWebServiceResponse

The DescribeExecutionResponse type exposes the following members

Constructors

NameDescription
Public Method DescribeExecutionResponse()

Properties

NameTypeDescription
Public Property Cause System.String

Gets and sets the property Cause.

The cause string if the state machine execution failed.

Public Property ContentLength System.Int64 Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property Error System.String

Gets and sets the property Error.

The error string if the state machine execution failed.

Public Property ExecutionArn System.String

Gets and sets the property ExecutionArn.

The Amazon Resource Name (ARN) that identifies the execution.

Public Property HttpStatusCode System.Net.HttpStatusCode Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property Input System.String

Gets and sets the property Input.

The string that contains the JSON input data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

Public Property InputDetails Amazon.StepFunctions.Model.CloudWatchEventsExecutionDataDetails

Gets and sets the property InputDetails.

Public Property MapRunArn System.String

Gets and sets the property MapRunArn.

The Amazon Resource Name (ARN) that identifies a Map Run, which dispatched this execution.

Public Property Name System.String

Gets and sets the property Name.

The name of the execution.

A name must not contain:

  • white space

  • brackets < > { } [ ]

  • wildcard characters ? *

  • special characters " # % \ ^ | ~ ` $ & , ; : /

  • control characters (U+0000-001F, U+007F-009F)

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

Public Property Output System.String

Gets and sets the property Output.

The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

This field is set only if the execution succeeds. If the execution fails, this field is null.

Public Property OutputDetails Amazon.StepFunctions.Model.CloudWatchEventsExecutionDataDetails

Gets and sets the property OutputDetails.

Public Property RedriveCount System.Int32

Gets and sets the property RedriveCount.

The number of times you've redriven an execution. If you have not yet redriven an execution, the redriveCount is 0. This count is only updated if you successfully redrive an execution.

Public Property RedriveDate System.DateTime

Gets and sets the property RedriveDate.

The date the execution was last redriven. If you have not yet redriven an execution, the redriveDate is null.

The redriveDate is unavailable if you redrive a Map Run that starts child workflow executions of type EXPRESS.

Public Property RedriveStatus Amazon.StepFunctions.ExecutionRedriveStatus

Gets and sets the property RedriveStatus.

Indicates whether or not an execution can be redriven at a given point in time.

  • For executions of type STANDARD, redriveStatus is NOT_REDRIVABLE if calling the RedriveExecution API action would return the ExecutionNotRedrivable error.

  • For a Distributed Map that includes child workflows of type STANDARD, redriveStatus indicates whether or not the Map Run can redrive child workflow executions.

  • For a Distributed Map that includes child workflows of type EXPRESS, redriveStatus indicates whether or not the Map Run can redrive child workflow executions.

    You can redrive failed or timed out EXPRESS workflows only if they're a part of a Map Run. When you redrive the Map Run, these workflows are restarted using the StartExecution API action.

Public Property RedriveStatusReason System.String

Gets and sets the property RedriveStatusReason.

When redriveStatus is NOT_REDRIVABLE, redriveStatusReason specifies the reason why an execution cannot be redriven.

  • For executions of type STANDARD, or for a Distributed Map that includes child workflows of type STANDARD, redriveStatusReason can include one of the following reasons:

    • State machine is in DELETING status.

    • Execution is RUNNING and cannot be redriven.

    • Execution is SUCCEEDED and cannot be redriven.

    • Execution was started before the launch of RedriveExecution.

    • Execution history event limit exceeded.

    • Execution has exceeded the max execution time.

    • Execution redrivable period exceeded.

  • For a Distributed Map that includes child workflows of type EXPRESS, redriveStatusReason is only returned if the child workflows are not redrivable. This happens when the child workflow executions have completed successfully.

Public Property ResponseMetadata Amazon.Runtime.ResponseMetadata Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property StartDate System.DateTime

Gets and sets the property StartDate.

The date the execution is started.

Public Property StateMachineAliasArn System.String

Gets and sets the property StateMachineAliasArn.

The Amazon Resource Name (ARN) of the state machine alias associated with the execution. The alias ARN is a combination of state machine ARN and the alias name separated by a colon (:). For example, stateMachineARN:PROD.

If you start an execution from a StartExecution request with a state machine version ARN, this field will be null.

Public Property StateMachineArn System.String

Gets and sets the property StateMachineArn.

The Amazon Resource Name (ARN) of the executed stated machine.

Public Property StateMachineVersionArn System.String

Gets and sets the property StateMachineVersionArn.

The Amazon Resource Name (ARN) of the state machine version associated with the execution. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1.

If you start an execution from a StartExecution request without specifying a state machine version or alias ARN, Step Functions returns a null value.

Public Property Status Amazon.StepFunctions.ExecutionStatus

Gets and sets the property Status.

The current status of the execution.

Public Property StopDate System.DateTime

Gets and sets the property StopDate.

If the execution ended, the date the execution stopped.

Public Property TraceHeader System.String

Gets and sets the property TraceHeader.

The X-Ray trace header that was passed to the execution.

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