Struct aws_sdk_ssm::types::StepExecution

#[non_exhaustive]
pub struct StepExecution {

    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>,
    pub triggered_alarms: Option<Vec<AlarmStateInformation>>,
}

Detailed information about an the execution state of an Automation step.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional 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.

triggered_alarms: Option<Vec<AlarmStateInformation>>

The CloudWatch alarms that were invoked by the automation.

Implementations

impl StepExecution

pub fn step_name(&self) -> Option<&str>

The name of this execution step.

pub fn action(&self) -> Option<&str>

The action this step performs. The action determines the behavior of the step.

pub fn timeout_seconds(&self) -> Option<i64>

The timeout seconds of the step.

pub fn on_failure(&self) -> Option<&str>

The action to take if the step fails. The default value is Abort.

pub fn max_attempts(&self) -> Option<i32>

The maximum number of tries to run the action of the step. The default value is 1.

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.

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.

pub fn step_status(&self) -> Option<&AutomationExecutionStatus>

The execution status for this step.

pub fn response_code(&self) -> Option<&str>

The response code returned by the execution of the step.

pub fn inputs(&self) -> Option<&HashMap<String, String>>

Fully-resolved values passed into the step before execution.

pub fn outputs(&self) -> Option<&HashMap<String, Vec<String>>>

Returned values from the execution of the step.

pub fn response(&self) -> Option<&str>

A message associated with the response code for an execution.

pub fn failure_message(&self) -> Option<&str>

If a step failed, this message explains why the execution failed.

pub fn failure_details(&self) -> Option<&FailureDetails>

Information about the Automation failure.

pub fn step_execution_id(&self) -> Option<&str>

The unique ID of a step execution.

pub fn overridden_parameters(&self) -> Option<&HashMap<String, Vec<String>>>

A user-specified list of parameters to override when running a step.

pub fn is_end(&self) -> Option<bool>

The flag which can be used to end automation no matter whether the step succeeds or fails.

pub fn next_step(&self) -> Option<&str>

The next step after the step succeeds.

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.

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.

pub fn targets(&self) -> Option<&[Target]>

The targets for the step execution.

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.

pub fn triggered_alarms(&self) -> Option<&[AlarmStateInformation]>

The CloudWatch alarms that were invoked by the automation.

impl StepExecution

pub fn builder() -> StepExecutionBuilder

Creates a new builder-style object to manufacture StepExecution.

Trait Implementations

impl Clone for StepExecution

fn clone(&self) -> StepExecution

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StepExecution

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

Formats the value using the given formatter.

impl PartialEq for StepExecution

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for StepExecution