#[non_exhaustive]pub struct AutomationExecution {Show 35 fields
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 target_locations_url: Option<String>,
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>>>,
}Expand description
Detailed information about the current state of an individual Automation execution.
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.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: boolA 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.
target_locations_url: Option<String>A publicly accessible URL for a file that contains the TargetLocations body. Currently, only files in presigned Amazon S3 buckets are supported
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§
Source§impl AutomationExecution
impl AutomationExecution
Sourcepub fn automation_execution_id(&self) -> Option<&str>
pub fn automation_execution_id(&self) -> Option<&str>
The execution ID.
Sourcepub fn document_name(&self) -> Option<&str>
pub fn document_name(&self) -> Option<&str>
The name of the Automation runbook used during the execution.
Sourcepub fn document_version(&self) -> Option<&str>
pub fn document_version(&self) -> Option<&str>
The version of the document to use during execution.
Sourcepub fn execution_start_time(&self) -> Option<&DateTime>
pub fn execution_start_time(&self) -> Option<&DateTime>
The time the execution started.
Sourcepub fn execution_end_time(&self) -> Option<&DateTime>
pub fn execution_end_time(&self) -> Option<&DateTime>
The time the execution finished.
Sourcepub fn automation_execution_status(&self) -> Option<&AutomationExecutionStatus>
pub fn automation_execution_status(&self) -> Option<&AutomationExecutionStatus>
The execution status of the Automation.
Sourcepub fn step_executions(&self) -> &[StepExecution]
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().
Sourcepub fn step_executions_truncated(&self) -> bool
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.
Sourcepub fn parameters(&self) -> Option<&HashMap<String, Vec<String>>>
pub fn parameters(&self) -> Option<&HashMap<String, Vec<String>>>
The key-value map of execution parameters, which were supplied when calling StartAutomationExecution.
Sourcepub fn outputs(&self) -> Option<&HashMap<String, Vec<String>>>
pub fn outputs(&self) -> Option<&HashMap<String, Vec<String>>>
The list of execution outputs as defined in the Automation runbook.
Sourcepub fn failure_message(&self) -> Option<&str>
pub fn failure_message(&self) -> Option<&str>
A message describing why an execution has failed, if the status is set to Failed.
Sourcepub fn mode(&self) -> Option<&ExecutionMode>
pub fn mode(&self) -> Option<&ExecutionMode>
The automation execution mode.
Sourcepub fn parent_automation_execution_id(&self) -> Option<&str>
pub fn parent_automation_execution_id(&self) -> Option<&str>
The AutomationExecutionId of the parent automation.
Sourcepub fn executed_by(&self) -> Option<&str>
pub fn executed_by(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the user who ran the automation.
Sourcepub fn current_step_name(&self) -> Option<&str>
pub fn current_step_name(&self) -> Option<&str>
The name of the step that is currently running.
Sourcepub fn current_action(&self) -> Option<&str>
pub fn current_action(&self) -> Option<&str>
The action of the step that is currently running.
Sourcepub fn target_parameter_name(&self) -> Option<&str>
pub fn target_parameter_name(&self) -> Option<&str>
The parameter name.
Sourcepub fn targets(&self) -> &[Target]
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().
Sourcepub fn target_maps(&self) -> &[HashMap<String, Vec<String>>]
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().
Sourcepub fn resolved_targets(&self) -> Option<&ResolvedTargets>
pub fn resolved_targets(&self) -> Option<&ResolvedTargets>
A list of resolved targets in the rate control execution.
Sourcepub fn max_concurrency(&self) -> Option<&str>
pub fn max_concurrency(&self) -> Option<&str>
The MaxConcurrency value specified by the user when the execution started.
Sourcepub fn max_errors(&self) -> Option<&str>
pub fn max_errors(&self) -> Option<&str>
The MaxErrors value specified by the user when the execution started.
Sourcepub fn target_locations(&self) -> &[TargetLocation]
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().
Sourcepub fn progress_counters(&self) -> Option<&ProgressCounters>
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.
Sourcepub fn alarm_configuration(&self) -> Option<&AlarmConfiguration>
pub fn alarm_configuration(&self) -> Option<&AlarmConfiguration>
The details for the CloudWatch alarm applied to your automation.
Sourcepub fn triggered_alarms(&self) -> &[AlarmStateInformation]
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().
Sourcepub fn target_locations_url(&self) -> Option<&str>
pub fn target_locations_url(&self) -> Option<&str>
A publicly accessible URL for a file that contains the TargetLocations body. Currently, only files in presigned Amazon S3 buckets are supported
Sourcepub fn automation_subtype(&self) -> Option<&AutomationSubtype>
pub fn automation_subtype(&self) -> Option<&AutomationSubtype>
The subtype of the Automation operation. Currently, the only supported value is ChangeRequest.
Sourcepub fn scheduled_time(&self) -> Option<&DateTime>
pub fn scheduled_time(&self) -> Option<&DateTime>
The date and time the Automation operation is scheduled to start.
Sourcepub fn runbooks(&self) -> &[Runbook]
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().
Sourcepub fn ops_item_id(&self) -> Option<&str>
pub fn ops_item_id(&self) -> Option<&str>
The ID of an OpsItem that is created to represent a Change Manager change request.
Sourcepub fn association_id(&self) -> Option<&str>
pub fn association_id(&self) -> Option<&str>
The ID of a State Manager association used in the Automation operation.
Sourcepub fn change_request_name(&self) -> Option<&str>
pub fn change_request_name(&self) -> Option<&str>
The name of the Change Manager change request.
Source§impl AutomationExecution
impl AutomationExecution
Sourcepub fn builder() -> AutomationExecutionBuilder
pub fn builder() -> AutomationExecutionBuilder
Creates a new builder-style object to manufacture AutomationExecution.
Trait Implementations§
Source§impl Clone for AutomationExecution
impl Clone for AutomationExecution
Source§fn clone(&self) -> AutomationExecution
fn clone(&self) -> AutomationExecution
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for AutomationExecution
impl Debug for AutomationExecution
Source§impl PartialEq for AutomationExecution
impl PartialEq for AutomationExecution
impl StructuralPartialEq for AutomationExecution
Auto Trait Implementations§
impl Freeze for AutomationExecution
impl RefUnwindSafe for AutomationExecution
impl Send for AutomationExecution
impl Sync for AutomationExecution
impl Unpin for AutomationExecution
impl UnwindSafe for AutomationExecution
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);