Struct aws_sdk_ssm::model::StepExecution
source · [−]#[non_exhaustive]pub struct StepExecution {Show 22 fields
pub step_name: Option<String>,
pub action: Option<String>,
pub timeout_seconds: Option<i64>,
pub on_failure: Option<String>,
pub max_attempts: Option<i32>,
pub execution_start_time: Option<DateTime>,
pub execution_end_time: Option<DateTime>,
pub step_status: Option<AutomationExecutionStatus>,
pub response_code: Option<String>,
pub inputs: Option<HashMap<String, String>>,
pub outputs: Option<HashMap<String, Vec<String>>>,
pub response: Option<String>,
pub failure_message: Option<String>,
pub failure_details: Option<FailureDetails>,
pub step_execution_id: Option<String>,
pub overridden_parameters: Option<HashMap<String, Vec<String>>>,
pub is_end: Option<bool>,
pub next_step: Option<String>,
pub is_critical: Option<bool>,
pub valid_next_steps: Option<Vec<String>>,
pub targets: Option<Vec<Target>>,
pub target_location: Option<TargetLocation>,
}
Expand description
Detailed information about an the execution state of an Automation step.
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.step_name: Option<String>
The name of this execution step.
action: Option<String>
The action this step performs. The action determines the behavior of the step.
timeout_seconds: Option<i64>
The timeout seconds of the step.
on_failure: Option<String>
The action to take if the step fails. The default value is Abort
.
max_attempts: Option<i32>
The maximum number of tries to run the action of the step. The default value is 1
.
execution_start_time: Option<DateTime>
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.
execution_end_time: Option<DateTime>
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.
step_status: Option<AutomationExecutionStatus>
The execution status for this step.
response_code: Option<String>
The response code returned by the execution of the step.
inputs: Option<HashMap<String, String>>
Fully-resolved values passed into the step before execution.
outputs: Option<HashMap<String, Vec<String>>>
Returned values from the execution of the step.
response: Option<String>
A message associated with the response code for an execution.
failure_message: Option<String>
If a step failed, this message explains why the execution failed.
failure_details: Option<FailureDetails>
Information about the Automation failure.
step_execution_id: Option<String>
The unique ID of a step execution.
overridden_parameters: Option<HashMap<String, Vec<String>>>
A user-specified list of parameters to override when running a step.
is_end: Option<bool>
The flag which can be used to end automation no matter whether the step succeeds or fails.
next_step: Option<String>
The next step after the step succeeds.
is_critical: Option<bool>
The flag which can be used to help decide whether the failure of current step leads to the Automation failure.
valid_next_steps: Option<Vec<String>>
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.
targets: Option<Vec<Target>>
The targets for the step execution.
target_location: Option<TargetLocation>
The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Automation execution.
Implementations
sourceimpl StepExecution
impl StepExecution
sourcepub fn action(&self) -> Option<&str>
pub fn action(&self) -> Option<&str>
The action this step performs. The action determines the behavior of the step.
sourcepub fn timeout_seconds(&self) -> Option<i64>
pub fn timeout_seconds(&self) -> Option<i64>
The timeout seconds of the step.
sourcepub fn on_failure(&self) -> Option<&str>
pub fn on_failure(&self) -> Option<&str>
The action to take if the step fails. The default value is Abort
.
sourcepub fn max_attempts(&self) -> Option<i32>
pub fn max_attempts(&self) -> Option<i32>
The maximum number of tries to run the action of the step. The default value is 1
.
sourcepub fn execution_start_time(&self) -> Option<&DateTime>
pub fn execution_start_time(&self) -> Option<&DateTime>
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.
sourcepub fn execution_end_time(&self) -> Option<&DateTime>
pub fn execution_end_time(&self) -> Option<&DateTime>
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.
sourcepub fn step_status(&self) -> Option<&AutomationExecutionStatus>
pub fn step_status(&self) -> Option<&AutomationExecutionStatus>
The execution status for this step.
sourcepub fn response_code(&self) -> Option<&str>
pub fn response_code(&self) -> Option<&str>
The response code returned by the execution of the step.
sourcepub fn inputs(&self) -> Option<&HashMap<String, String>>
pub fn inputs(&self) -> Option<&HashMap<String, String>>
Fully-resolved values passed into the step before execution.
sourcepub fn outputs(&self) -> Option<&HashMap<String, Vec<String>>>
pub fn outputs(&self) -> Option<&HashMap<String, Vec<String>>>
Returned values from the execution of the step.
sourcepub fn response(&self) -> Option<&str>
pub fn response(&self) -> Option<&str>
A message associated with the response code for an execution.
sourcepub fn failure_message(&self) -> Option<&str>
pub fn failure_message(&self) -> Option<&str>
If a step failed, this message explains why the execution failed.
sourcepub fn failure_details(&self) -> Option<&FailureDetails>
pub fn failure_details(&self) -> Option<&FailureDetails>
Information about the Automation failure.
sourcepub fn step_execution_id(&self) -> Option<&str>
pub fn step_execution_id(&self) -> Option<&str>
The unique ID of a step execution.
sourcepub fn overridden_parameters(&self) -> Option<&HashMap<String, Vec<String>>>
pub fn overridden_parameters(&self) -> Option<&HashMap<String, Vec<String>>>
A user-specified list of parameters to override when running a step.
sourcepub fn is_end(&self) -> Option<bool>
pub fn is_end(&self) -> Option<bool>
The flag which can be used to end automation no matter whether the step succeeds or fails.
sourcepub fn is_critical(&self) -> Option<bool>
pub fn is_critical(&self) -> Option<bool>
The flag which can be used to help decide whether the failure of current step leads to the Automation failure.
sourcepub fn valid_next_steps(&self) -> Option<&[String]>
pub fn valid_next_steps(&self) -> Option<&[String]>
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.
sourcepub fn target_location(&self) -> Option<&TargetLocation>
pub fn target_location(&self) -> Option<&TargetLocation>
The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Automation execution.
sourceimpl StepExecution
impl StepExecution
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture StepExecution
Trait Implementations
sourceimpl Clone for StepExecution
impl Clone for StepExecution
sourcefn clone(&self) -> StepExecution
fn clone(&self) -> StepExecution
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 StepExecution
impl Debug for StepExecution
sourceimpl PartialEq<StepExecution> for StepExecution
impl PartialEq<StepExecution> for StepExecution
sourcefn eq(&self, other: &StepExecution) -> bool
fn eq(&self, other: &StepExecution) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &StepExecution) -> bool
fn ne(&self, other: &StepExecution) -> bool
This method tests for !=
.
impl StructuralPartialEq for StepExecution
Auto Trait Implementations
impl RefUnwindSafe for StepExecution
impl Send for StepExecution
impl Sync for StepExecution
impl Unpin for StepExecution
impl UnwindSafe for StepExecution
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