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.

Detailed information about an the execution state of an Automation step.

Inheritance Hierarchy

System.Object
  Amazon.SimpleSystemsManagement.Model.StepExecution

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

Syntax

C#
public class StepExecution

The StepExecution type exposes the following members

Constructors

NameDescription
Public Method StepExecution()

Properties

NameTypeDescription
Public Property Action System.String

Gets and sets the property Action.

The action this step performs. The action determines the behavior of the step.

Public Property ExecutionEndTime System.DateTime

Gets and sets the property ExecutionEndTime.

If a step has finished execution, this contains the time the execution ended. If the step hasn't yet concluded, this field isn't populated.

Public Property ExecutionStartTime System.DateTime

Gets and sets the property ExecutionStartTime.

If a step has begun execution, this contains the time the step started. If the step is in Pending status, this field isn't populated.

Public Property FailureDetails Amazon.SimpleSystemsManagement.Model.FailureDetails

Gets and sets the property FailureDetails.

Information about the Automation failure.

Public Property FailureMessage System.String

Gets and sets the property FailureMessage.

If a step failed, this message explains why the execution failed.

Public Property Inputs System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property Inputs.

Fully-resolved values passed into the step before execution.

Public Property IsCritical System.Boolean

Gets and sets the property IsCritical.

The flag which can be used to help decide whether the failure of current step leads to the Automation failure.

Public Property IsEnd System.Boolean

Gets and sets the property IsEnd.

The flag which can be used to end automation no matter whether the step succeeds or fails.

Public Property MaxAttempts System.Int32

Gets and sets the property MaxAttempts.

The maximum number of tries to run the action of the step. The default value is 1.

Public Property NextStep System.String

Gets and sets the property NextStep.

The next step after the step succeeds.

Public Property OnFailure System.String

Gets and sets the property OnFailure.

The action to take if the step fails. The default value is Abort.

Public Property Outputs System.Collections.Generic.Dictionary<System.String, System.Collections.Generic.List<System.String>>

Gets and sets the property Outputs.

Returned values from the execution of the step.

Public Property OverriddenParameters System.Collections.Generic.Dictionary<System.String, System.Collections.Generic.List<System.String>>

Gets and sets the property OverriddenParameters.

A user-specified list of parameters to override when running a step.

Public Property ParentStepDetails Amazon.SimpleSystemsManagement.Model.ParentStepDetails

Gets and sets the property ParentStepDetails.

Information about the parent step.

Public Property Response System.String

Gets and sets the property Response.

A message associated with the response code for an execution.

Public Property ResponseCode System.String

Gets and sets the property ResponseCode.

The response code returned by the execution of the step.

Public Property StepExecutionId System.String

Gets and sets the property StepExecutionId.

The unique ID of a step execution.

Public Property StepName System.String

Gets and sets the property StepName.

The name of this execution step.

Public Property StepStatus Amazon.SimpleSystemsManagement.AutomationExecutionStatus

Gets and sets the property StepStatus.

The execution status for this step.

Public Property TargetLocation Amazon.SimpleSystemsManagement.Model.TargetLocation

Gets and sets the property TargetLocation.

The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Automation execution.

Public Property Targets System.Collections.Generic.List<Amazon.SimpleSystemsManagement.Model.Target>

Gets and sets the property Targets.

The targets for the step execution.

Public Property TimeoutSeconds System.Int64

Gets and sets the property TimeoutSeconds.

The timeout seconds of the step.

Public Property TriggeredAlarms System.Collections.Generic.List<Amazon.SimpleSystemsManagement.Model.AlarmStateInformation>

Gets and sets the property TriggeredAlarms.

The CloudWatch alarms that were invoked by the automation.

Public Property ValidNextSteps System.Collections.Generic.List<System.String>

Gets and sets the property ValidNextSteps.

Strategies used when step fails, we support Continue and Abort. Abort will fail the automation when the step fails. Continue will ignore the failure of current step and allow automation to run the next step. With conditional branching, we add step:stepName to support the automation to go to another specific step.

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