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 DescribeStateMachine operation.

Inheritance Hierarchy

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

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

Syntax

C#
public class DescribeStateMachineResponse : AmazonWebServiceResponse

The DescribeStateMachineResponse type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property ContentLength System.Int64 Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property CreationDate System.DateTime

Gets and sets the property CreationDate.

The date the state machine is created.

For a state machine version, creationDate is the date the version was created.

Public Property Definition System.String

Gets and sets the property Definition.

The Amazon States Language definition of the state machine. See Amazon States Language.

Public Property Description System.String

Gets and sets the property Description.

The description of the state machine version.

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

Gets and sets the property Label.

A user-defined or an auto-generated string that identifies a Map state. This parameter is present only if the stateMachineArn specified in input is a qualified state machine ARN.

Public Property LoggingConfiguration Amazon.StepFunctions.Model.LoggingConfiguration

Gets and sets the property LoggingConfiguration.

Public Property Name System.String

Gets and sets the property Name.

The name of the state machine.

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 ResponseMetadata Amazon.Runtime.ResponseMetadata Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property RevisionId System.String

Gets and sets the property RevisionId.

The revision identifier for the state machine.

Use the revisionId parameter to compare between versions of a state machine configuration used for executions without performing a diff of the properties, such as definition and roleArn.

Public Property RoleArn System.String

Gets and sets the property RoleArn.

The Amazon Resource Name (ARN) of the IAM role used when creating this state machine. (The IAM role maintains security by granting Step Functions access to Amazon Web Services resources.)

Public Property StateMachineArn System.String

Gets and sets the property StateMachineArn.

The Amazon Resource Name (ARN) that identifies the state machine.

If you specified a state machine version ARN in your request, the API returns the version ARN. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1.

Public Property Status Amazon.StepFunctions.StateMachineStatus

Gets and sets the property Status.

The current status of the state machine.

Public Property TracingConfiguration Amazon.StepFunctions.Model.TracingConfiguration

Gets and sets the property TracingConfiguration.

Selects whether X-Ray tracing is enabled.

Public Property Type Amazon.StepFunctions.StateMachineType

Gets and sets the property Type.

The type of the state machine (STANDARD or EXPRESS).

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5