Struct aws_sdk_ssm::types::AutomationExecution

#[non_exhaustive]
pub struct AutomationExecution {

    pub automation_execution_id: Option<String>,
    pub document_name: Option<String>,
    pub document_version: Option<String>,
    pub execution_start_time: Option<DateTime>,
    pub execution_end_time: Option<DateTime>,
    pub automation_execution_status: Option<AutomationExecutionStatus>,
    pub step_executions: Option<Vec<StepExecution>>,
    pub step_executions_truncated: bool,
    pub parameters: Option<HashMap<String, Vec<String>>>,
    pub outputs: Option<HashMap<String, Vec<String>>>,
    pub failure_message: Option<String>,
    pub mode: Option<ExecutionMode>,
    pub parent_automation_execution_id: Option<String>,
    pub executed_by: Option<String>,
    pub current_step_name: Option<String>,
    pub current_action: Option<String>,
    pub target_parameter_name: Option<String>,
    pub targets: Option<Vec<Target>>,
    pub target_maps: Option<Vec<HashMap<String, Vec<String>>>>,
    pub resolved_targets: Option<ResolvedTargets>,
    pub max_concurrency: Option<String>,
    pub max_errors: Option<String>,
    pub target: Option<String>,
    pub target_locations: Option<Vec<TargetLocation>>,
    pub progress_counters: Option<ProgressCounters>,
    pub alarm_configuration: Option<AlarmConfiguration>,
    pub triggered_alarms: Option<Vec<AlarmStateInformation>>,
    pub automation_subtype: Option<AutomationSubtype>,
    pub scheduled_time: Option<DateTime>,
    pub runbooks: Option<Vec<Runbook>>,
    pub ops_item_id: Option<String>,
    pub association_id: Option<String>,
    pub change_request_name: Option<String>,
    pub variables: Option<HashMap<String, Vec<String>>>,
}

Detailed information about the current state of an individual Automation execution.

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.

automation_execution_id: Option<String>

The execution ID.

document_name: Option<String>

The name of the Automation runbook used during the execution.

document_version: Option<String>

The version of the document to use during execution.

execution_start_time: Option<DateTime>

The time the execution started.

execution_end_time: Option<DateTime>

The time the execution finished.

automation_execution_status: Option<AutomationExecutionStatus>

The execution status of the Automation.

step_executions: Option<Vec<StepExecution>>

A list of details about the current state of all steps that comprise an execution. An Automation runbook contains a list of steps that are run in order.

step_executions_truncated: bool

A boolean value that indicates if the response contains the full list of the Automation step executions. If true, use the DescribeAutomationStepExecutions API operation to get the full list of step executions.

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

The key-value map of execution parameters, which were supplied when calling StartAutomationExecution.

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

The list of execution outputs as defined in the Automation runbook.

failure_message: Option<String>

A message describing why an execution has failed, if the status is set to Failed.

mode: Option<ExecutionMode>

The automation execution mode.

parent_automation_execution_id: Option<String>

The AutomationExecutionId of the parent automation.

executed_by: Option<String>

The Amazon Resource Name (ARN) of the user who ran the automation.

current_step_name: Option<String>

The name of the step that is currently running.

current_action: Option<String>

The action of the step that is currently running.

target_parameter_name: Option<String>

The parameter name.

targets: Option<Vec<Target>>

The specified targets.

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

The specified key-value mapping of document parameters to target resources.

resolved_targets: Option<ResolvedTargets>

A list of resolved targets in the rate control execution.

max_concurrency: Option<String>

The MaxConcurrency value specified by the user when the execution started.

max_errors: Option<String>

The MaxErrors value specified by the user when the execution started.

target: Option<String>

The target of the execution.

target_locations: Option<Vec<TargetLocation>>

The combination of Amazon Web Services Regions and/or Amazon Web Services accounts where you want to run the Automation.

progress_counters: Option<ProgressCounters>

An aggregate of step execution statuses displayed in the Amazon Web Services Systems Manager console for a multi-Region and multi-account Automation execution.

alarm_configuration: Option<AlarmConfiguration>

The details for the CloudWatch alarm applied to your automation.

triggered_alarms: Option<Vec<AlarmStateInformation>>

The CloudWatch alarm that was invoked by the automation.

automation_subtype: Option<AutomationSubtype>

The subtype of the Automation operation. Currently, the only supported value is ChangeRequest.

scheduled_time: Option<DateTime>

The date and time the Automation operation is scheduled to start.

runbooks: Option<Vec<Runbook>>

Information about the Automation runbooks that are run as part of a runbook workflow.

The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

ops_item_id: Option<String>

The ID of an OpsItem that is created to represent a Change Manager change request.

association_id: Option<String>

The ID of a State Manager association used in the Automation operation.

change_request_name: Option<String>

The name of the Change Manager change request.

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

Variables defined for the automation.

Implementations

impl AutomationExecution

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

The execution ID.

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

The name of the Automation runbook used during the execution.

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

The version of the document to use during execution.

pub fn execution_start_time(&self) -> Option<&DateTime>

The time the execution started.

pub fn execution_end_time(&self) -> Option<&DateTime>

The time the execution finished.

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

The execution status of the Automation.

pub fn step_executions(&self) -> &[StepExecution]

A list of details about the current state of all steps that comprise an execution. An Automation runbook contains a list of steps that are run in order.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .step_executions.is_none().

pub fn step_executions_truncated(&self) -> bool

A boolean value that indicates if the response contains the full list of the Automation step executions. If true, use the DescribeAutomationStepExecutions API operation to get the full list of step executions.

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

The key-value map of execution parameters, which were supplied when calling StartAutomationExecution.

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

The list of execution outputs as defined in the Automation runbook.

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

A message describing why an execution has failed, if the status is set to Failed.

pub fn mode(&self) -> Option<&ExecutionMode>

The automation execution mode.

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

The AutomationExecutionId of the parent automation.

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

The Amazon Resource Name (ARN) of the user who ran the automation.

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

The name of the step that is currently running.

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

The action of the step that is currently running.

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

The parameter name.

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

The specified targets.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .targets.is_none().

pub fn target_maps(&self) -> &[HashMap<String, Vec<String>>]

The specified key-value mapping of document parameters to target resources.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .target_maps.is_none().

pub fn resolved_targets(&self) -> Option<&ResolvedTargets>

A list of resolved targets in the rate control execution.

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

The MaxConcurrency value specified by the user when the execution started.

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

The MaxErrors value specified by the user when the execution started.

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

The target of the execution.

pub fn target_locations(&self) -> &[TargetLocation]

The combination of Amazon Web Services Regions and/or Amazon Web Services accounts where you want to run the Automation.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .target_locations.is_none().

pub fn progress_counters(&self) -> Option<&ProgressCounters>

An aggregate of step execution statuses displayed in the Amazon Web Services Systems Manager console for a multi-Region and multi-account Automation execution.

pub fn alarm_configuration(&self) -> Option<&AlarmConfiguration>

The details for the CloudWatch alarm applied to your automation.

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

The CloudWatch alarm that was invoked by the automation.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .triggered_alarms.is_none().

pub fn automation_subtype(&self) -> Option<&AutomationSubtype>

The subtype of the Automation operation. Currently, the only supported value is ChangeRequest.

pub fn scheduled_time(&self) -> Option<&DateTime>

The date and time the Automation operation is scheduled to start.

pub fn runbooks(&self) -> &[Runbook]

Information about the Automation runbooks that are run as part of a runbook workflow.

The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .runbooks.is_none().

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

The ID of an OpsItem that is created to represent a Change Manager change request.

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

The ID of a State Manager association used in the Automation operation.

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

The name of the Change Manager change request.

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

Variables defined for the automation.

impl AutomationExecution

pub fn builder() -> AutomationExecutionBuilder

Creates a new builder-style object to manufacture AutomationExecution.

Trait Implementations

impl Clone for AutomationExecution

fn clone(&self) -> AutomationExecution

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AutomationExecution

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

Formats the value using the given formatter.

impl PartialEq for AutomationExecution

fn eq(&self, other: &AutomationExecution) -> 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 AutomationExecution