Struct aws_sdk_ssm::client::fluent_builders::StartAutomationExecution

pub struct StartAutomationExecution { /* private fields */ }

Fluent builder constructing a request to StartAutomationExecution.

Initiates execution of an Automation runbook.

Implementations

impl StartAutomationExecution

pub async fn send(
    self
) -> Result<StartAutomationExecutionOutput, SdkError<StartAutomationExecutionError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn document_name(self, input: impl Into<String>) -> Self

The name of the SSM document to run. This can be a public document or a custom document. To run a shared document belonging to another account, specify the document ARN. For more information about how to use shared documents, see Using shared SSM documents in the Amazon Web Services Systems Manager User Guide.

pub fn set_document_name(self, input: Option<String>) -> Self

The name of the SSM document to run. This can be a public document or a custom document. To run a shared document belonging to another account, specify the document ARN. For more information about how to use shared documents, see Using shared SSM documents in the Amazon Web Services Systems Manager User Guide.

pub fn document_version(self, input: impl Into<String>) -> Self

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

pub fn set_document_version(self, input: Option<String>) -> Self

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

pub fn parameters(self, k: impl Into<String>, v: Vec<String>) -> Self

Adds a key-value pair to Parameters.

To override the contents of this collection use set_parameters.

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

pub fn set_parameters(self, input: Option<HashMap<String, Vec<String>>>) -> Self

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

pub fn client_token(self, input: impl Into<String>) -> Self

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

pub fn set_client_token(self, input: Option<String>) -> Self

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

pub fn mode(self, input: ExecutionMode) -> Self

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

pub fn set_mode(self, input: Option<ExecutionMode>) -> Self

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

pub fn target_parameter_name(self, input: impl Into<String>) -> Self

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

pub fn set_target_parameter_name(self, input: Option<String>) -> Self

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

pub fn targets(self, input: Target) -> Self

Appends an item to Targets.

To override the contents of this collection use set_targets.

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

pub fn set_targets(self, input: Option<Vec<Target>>) -> Self

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

pub fn target_maps(self, input: HashMap<String, Vec<String>>) -> Self

Appends an item to TargetMaps.

To override the contents of this collection use set_target_maps.

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

pub fn set_target_maps(
    self,
    input: Option<Vec<HashMap<String, Vec<String>>>>
) -> Self

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

pub fn max_concurrency(self, input: impl Into<String>) -> Self

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.

pub fn set_max_concurrency(self, input: Option<String>) -> Self

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.

pub fn max_errors(self, input: impl Into<String>) -> Self

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.

pub fn set_max_errors(self, input: Option<String>) -> Self

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.

pub fn target_locations(self, input: TargetLocation) -> Self

Appends an item to TargetLocations.

To override the contents of this collection use set_target_locations.

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

pub fn set_target_locations(self, input: Option<Vec<TargetLocation>>) -> Self

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

pub fn tags(self, input: Tag) -> Self

Appends an item to Tags.

To override the contents of this collection use set_tags.

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-value pairs:

• Key=environment,Value=test

• Key=OS,Value=Windows

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

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

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-value pairs:

• Key=environment,Value=test

• Key=OS,Value=Windows

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

Trait Implementations

impl Clone for StartAutomationExecution

fn clone(&self) -> StartAutomationExecution

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StartAutomationExecution

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

Formats the value using the given formatter.