Struct aws_sdk_ssm::input::StartAutomationExecutionInput
source · [−]#[non_exhaustive]pub struct StartAutomationExecutionInput {
pub document_name: Option<String>,
pub document_version: Option<String>,
pub parameters: Option<HashMap<String, Vec<String>>>,
pub client_token: Option<String>,
pub mode: Option<ExecutionMode>,
pub target_parameter_name: Option<String>,
pub targets: Option<Vec<Target>>,
pub target_maps: Option<Vec<HashMap<String, Vec<String>>>>,
pub max_concurrency: Option<String>,
pub max_errors: Option<String>,
pub target_locations: Option<Vec<TargetLocation>>,
pub tags: Option<Vec<Tag>>,
}Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.document_name: Option<String>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.
document_version: Option<String>The version of the Automation runbook to use for this execution.
parameters: Option<HashMap<String, Vec<String>>>A key-value map of execution parameters, which match the declared parameters in the Automation runbook.
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.
mode: Option<ExecutionMode>The execution mode of the automation. Valid modes include the following: Auto and Interactive. The default mode is Auto.
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.
target_maps: Option<Vec<HashMap<String, Vec<String>>>>A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.
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.
target_locations: Option<Vec<TargetLocation>>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.
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 automation, use the AddTagsToResource operation.
Implementations
sourceimpl StartAutomationExecutionInput
impl StartAutomationExecutionInput
sourcepub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<StartAutomationExecution, AwsErrorRetryPolicy>, BuildError>
pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<StartAutomationExecution, AwsErrorRetryPolicy>, BuildError>
Consumes the builder and constructs an Operation<StartAutomationExecution>
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture StartAutomationExecutionInput
sourceimpl StartAutomationExecutionInput
impl StartAutomationExecutionInput
sourcepub fn document_name(&self) -> Option<&str>
pub fn document_name(&self) -> Option<&str>
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.
sourcepub fn document_version(&self) -> Option<&str>
pub fn document_version(&self) -> Option<&str>
The version of the Automation runbook to use for this execution.
sourcepub fn parameters(&self) -> Option<&HashMap<String, Vec<String>>>
pub fn parameters(&self) -> Option<&HashMap<String, Vec<String>>>
A key-value map of execution parameters, which match the declared parameters in the Automation runbook.
sourcepub fn client_token(&self) -> Option<&str>
pub fn client_token(&self) -> Option<&str>
User-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.
sourcepub fn mode(&self) -> Option<&ExecutionMode>
pub fn mode(&self) -> Option<&ExecutionMode>
The execution mode of the automation. Valid modes include the following: Auto and Interactive. The default mode is Auto.
sourcepub fn target_parameter_name(&self) -> Option<&str>
pub fn target_parameter_name(&self) -> Option<&str>
The name of the parameter used as the target resource for the rate-controlled execution. Required if you specify targets.
sourcepub fn targets(&self) -> Option<&[Target]>
pub fn targets(&self) -> Option<&[Target]>
A key-value mapping to target resources. Required if you specify TargetParameterName.
sourcepub fn target_maps(&self) -> Option<&[HashMap<String, Vec<String>>]>
pub fn target_maps(&self) -> Option<&[HashMap<String, Vec<String>>]>
A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.
sourcepub fn max_concurrency(&self) -> Option<&str>
pub fn max_concurrency(&self) -> Option<&str>
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.
sourcepub fn max_errors(&self) -> Option<&str>
pub fn max_errors(&self) -> Option<&str>
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.
sourcepub fn target_locations(&self) -> Option<&[TargetLocation]>
pub fn target_locations(&self) -> Option<&[TargetLocation]>
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.
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 automation, use the AddTagsToResource operation.
Trait Implementations
sourceimpl Clone for StartAutomationExecutionInput
impl Clone for StartAutomationExecutionInput
sourcefn clone(&self) -> StartAutomationExecutionInput
fn clone(&self) -> StartAutomationExecutionInput
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
sourceimpl Debug for StartAutomationExecutionInput
impl Debug for StartAutomationExecutionInput
sourceimpl PartialEq<StartAutomationExecutionInput> for StartAutomationExecutionInput
impl PartialEq<StartAutomationExecutionInput> for StartAutomationExecutionInput
sourcefn eq(&self, other: &StartAutomationExecutionInput) -> bool
fn eq(&self, other: &StartAutomationExecutionInput) -> bool
This method tests for self and other values to be equal, and is used
by ==. Read more
sourcefn ne(&self, other: &StartAutomationExecutionInput) -> bool
fn ne(&self, other: &StartAutomationExecutionInput) -> bool
This method tests for !=.
impl StructuralPartialEq for StartAutomationExecutionInput
Auto Trait Implementations
impl RefUnwindSafe for StartAutomationExecutionInput
impl Send for StartAutomationExecutionInput
impl Sync for StartAutomationExecutionInput
impl Unpin for StartAutomationExecutionInput
impl UnwindSafe for StartAutomationExecutionInput
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber to this type, returning a
WithDispatch wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
WithDispatch wrapper. Read more