Struct aws_sdk_ssm::types::AutomationExecutionMetadata

#[non_exhaustive]
pub struct AutomationExecutionMetadata {

    pub automation_execution_id: Option<String>,
    pub document_name: Option<String>,
    pub document_version: Option<String>,
    pub automation_execution_status: Option<AutomationExecutionStatus>,
    pub execution_start_time: Option<DateTime>,
    pub execution_end_time: Option<DateTime>,
    pub executed_by: Option<String>,
    pub log_file: Option<String>,
    pub outputs: Option<HashMap<String, Vec<String>>>,
    pub mode: Option<ExecutionMode>,
    pub parent_automation_execution_id: Option<String>,
    pub current_step_name: Option<String>,
    pub current_action: Option<String>,
    pub failure_message: 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 automation_type: Option<AutomationType>,
    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>,
}

Details about a specific 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 execution.

document_version: Option<String>

The document version used during the execution.

automation_execution_status: Option<AutomationExecutionStatus>

The status of the execution.

execution_start_time: Option<DateTime>

The time the execution started.

execution_end_time: Option<DateTime>

The time the execution finished. This isn't populated if the execution is still in progress.

executed_by: Option<String>

The IAM role ARN of the user who ran the automation.

log_file: Option<String>

An S3 bucket where execution information is stored.

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

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

mode: Option<ExecutionMode>

The Automation execution mode.

parent_automation_execution_id: Option<String>

The execution ID of the parent 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.

failure_message: Option<String>

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

target_parameter_name: Option<String>

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

targets: Option<Vec<Target>>

The targets defined by the user when starting the automation.

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 targets that resolved during the execution.

max_concurrency: Option<String>

The MaxConcurrency value specified by the user when starting the automation.

max_errors: Option<String>

The MaxErrors value specified by the user when starting the automation.

target: Option<String>

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

automation_type: Option<AutomationType>

Use this filter with DescribeAutomationExecutions. Specify either Local or CrossAccount. CrossAccount is an Automation that runs in multiple Amazon Web Services Regions and Amazon Web Services accounts. For more information, see Running Automation workflows in multiple Amazon Web Services Regions and accounts in the Amazon Web Services Systems Manager User Guide.

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 during a runbook workflow in Change Manager.

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.

Implementations

impl AutomationExecutionMetadata

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 execution.

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

The document version used during the execution.

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

The status of the 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. This isn't populated if the execution is still in progress.

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

The IAM role ARN of the user who ran the automation.

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

An S3 bucket where execution information is stored.

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

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

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

The Automation execution mode.

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

The execution ID of the parent 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 failure_message(&self) -> Option<&str>

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

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

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

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

The targets defined by the user when starting 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 .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 targets that resolved during the execution.

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

The MaxConcurrency value specified by the user when starting the automation.

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

The MaxErrors value specified by the user when starting the automation.

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

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

pub fn automation_type(&self) -> Option<&AutomationType>

Use this filter with DescribeAutomationExecutions. Specify either Local or CrossAccount. CrossAccount is an Automation that runs in multiple Amazon Web Services Regions and Amazon Web Services accounts. For more information, see Running Automation workflows in multiple Amazon Web Services Regions and accounts in the Amazon Web Services Systems Manager User Guide.

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 during a runbook workflow in Change Manager.

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.

impl AutomationExecutionMetadata

pub fn builder() -> AutomationExecutionMetadataBuilder

Creates a new builder-style object to manufacture AutomationExecutionMetadata.

Trait Implementations

impl Clone for AutomationExecutionMetadata

fn clone(&self) -> AutomationExecutionMetadata

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AutomationExecutionMetadata

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

Formats the value using the given formatter.

impl PartialEq for AutomationExecutionMetadata

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