Struct rusoto_ssm::StartAutomationExecutionRequest

pub struct StartAutomationExecutionRequest {
    pub client_token: Option<String>,
    pub document_name: String,
    pub document_version: Option<String>,
    pub max_concurrency: Option<String>,
    pub max_errors: Option<String>,
    pub mode: Option<String>,
    pub parameters: Option<HashMap<String, Vec<String>>>,
    pub tags: Option<Vec<Tag>>,
    pub target_locations: Option<Vec<TargetLocation>>,
    pub target_maps: Option<Vec<HashMap<String, Vec<String>>>>,
    pub target_parameter_name: Option<String>,
    pub targets: Option<Vec<Target>>,
}

Fields

client_token: Option<String>

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

document_name: String

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

document_version: Option<String>

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

max_concurrency: Option<String>

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.

max_errors: Option<String>

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.

mode: Option<String>

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

parameters: Option<HashMap<String, Vec<String>>>

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

tags: Option<Vec<Tag>>

Optional metadata that you assign to a resource. You can specify a maximum of five tags for an automation. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an automation to identify an environment or operating system. In this case, you could specify the following key name/value pairs:

• Key=environment,Value=test

• Key=OS,Value=Windows

To add tags to an existing patch baseline, use the AddTagsToResource action.

target_locations: Option<Vec<TargetLocation>>

A location is a combination of AWS Regions and/or AWS accounts where you want to run the Automation. Use this action to start an Automation in multiple Regions and multiple accounts. For more information, see Running Automation workflows in multiple AWS Regions and accounts in the AWS Systems Manager User Guide.

target_maps: Option<Vec<HashMap<String, Vec<String>>>>

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

target_parameter_name: Option<String>

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

targets: Option<Vec<Target>>

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

Trait Implementations

impl Clone for StartAutomationExecutionRequest

pub fn clone(&self) -> StartAutomationExecutionRequest

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StartAutomationExecutionRequest

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for StartAutomationExecutionRequest

pub fn default() -> StartAutomationExecutionRequest

Returns the "default value" for a type.

impl PartialEq<StartAutomationExecutionRequest> for StartAutomationExecutionRequest

pub fn eq(&self, other: &StartAutomationExecutionRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &StartAutomationExecutionRequest) -> bool

This method tests for !=.

impl Serialize for StartAutomationExecutionRequest

pub fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StartAutomationExecutionRequest