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 StartAutomationExecution operation. Initiates execution of an Automation document.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementRequest
      Amazon.SimpleSystemsManagement.Model.StartAutomationExecutionRequest

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

Syntax

C#
public class StartAutomationExecutionRequest : AmazonSimpleSystemsManagementRequest
         IAmazonWebServiceRequest

The StartAutomationExecutionRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property ClientToken System.String

Gets and sets the property ClientToken.

User-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.

Public Property DocumentName System.String

Gets and sets the property DocumentName.

The name of the Automation document to use for this execution.

Public Property DocumentVersion System.String

Gets and sets the property DocumentVersion.

The version of the Automation document to use for this execution.

Public Property MaxConcurrency System.String

Gets and sets the property MaxConcurrency.

The maximum number of targets allowed to run this task in parallel. You can specify a number, such as 10, or a percentage, such as 10%. The default value is 10.

Public Property MaxErrors System.String

Gets and sets the property MaxErrors.

The number of errors that are allowed before the system stops running the automation on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops running the automation when the fourth error is received. If you specify 0, then the system stops running the automation on additional targets after the first error result is returned. If you run an automation on 50 resources and set max-errors to 10%, then the system stops running the automation on additional targets when the sixth error is received.

Executions that are already running an automation when max-errors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set max-concurrency to 1 so the executions proceed one at a time.

Public Property Mode Amazon.SimpleSystemsManagement.ExecutionMode

Gets and sets the property Mode.

The execution mode of the automation. Valid modes include the following: Auto and Interactive. The default mode is Auto.

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

Gets and sets the property Parameters.

A key-value map of execution parameters, which match the declared parameters in the Automation document.

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

Gets and sets the property TargetMaps.

A key-value mapping of document parameters to target resources. Both Targets and TargetMaps cannot be specified together.

Public Property TargetParameterName System.String

Gets and sets the property TargetParameterName.

The name of the parameter used as the target resource for the rate-controlled execution. Required if you specify Targets.

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

Gets and sets the property Targets.

A key-value mapping to target resources. Required if you specify TargetParameterName.

Version Information

.NET Standard:
Supported in: 1.3

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms