class Amazonite::Ssm::AutomationExecution

• Amazonite::Ssm::AutomationExecution
• Reference
• Object

Overview

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

Included Modules

• JSON::Serializable

Defined in:

ssm/automation_execution.cr

Constructors

• .new(pull : JSON::PullParser)
• .new(automation_execution_id : String | Nil = nil, document_name : String | Nil = nil, document_version : String | Nil = nil, execution_start_time : Time | Nil = nil, execution_end_time : Time | Nil = nil, automation_execution_status : AutomationExecutionStatus | Nil = nil, step_executions : Array(StepExecution) | Nil = nil, step_executions_truncated : Bool | Nil = nil, parameters : Hash(String, Array(String)) | Nil = nil, outputs : Hash(String, Array(String)) | Nil = nil, failure_message : String | Nil = nil, warning_message : String | Nil = nil, mode : ExecutionMode | Nil = nil, parent_automation_execution_id : String | Nil = nil, executed_by : String | Nil = nil, current_step_name : String | Nil = nil, current_action : String | Nil = nil, target_parameter_name : String | Nil = nil, targets : Array(Target) | Nil = nil, target_maps : Array(Hash(String, Array(String))) | Nil = nil, resolved_targets : ResolvedTargets | Nil = nil, max_concurrency : String | Nil = nil, max_errors : String | Nil = nil, target : String | Nil = nil, target_locations : Array(TargetLocation) | Nil = nil, progress_counters : ProgressCounters | Nil = nil, alarm_configuration : AlarmConfiguration | Nil = nil, triggered_alarms : Array(AlarmStateInformation) | Nil = nil, target_locations_url : String | Nil = nil, automation_subtype : AutomationSubtype | Nil = nil, scheduled_time : Time | Nil = nil, runbooks : Array(Runbook) | Nil = nil, ops_item_id : String | Nil = nil, association_id : String | Nil = nil, change_request_name : String | Nil = nil, variables : Hash(String, Array(String)) | Nil = nil)

Instance Method Summary

• #==(other : self)

  Returns true if this reference is the same as other.

• #alarm_configuration : AlarmConfiguration | Nil

  The details for the CloudWatch alarm applied to your automation.

• #alarm_configuration=(alarm_configuration : AlarmConfiguration | Nil)

  The details for the CloudWatch alarm applied to your automation.

• #association_id : String | Nil

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

• #association_id=(association_id : String | Nil)

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

• #automation_execution_id : String | Nil

  The execution ID.

• #automation_execution_id=(automation_execution_id : String | Nil)

  The execution ID.

• #automation_execution_status : AutomationExecutionStatus | Nil

  The execution status of the Automation.

• #automation_execution_status=(automation_execution_status : AutomationExecutionStatus | Nil)

  The execution status of the Automation.

• #automation_subtype : AutomationSubtype | Nil

  The subtype of the Automation operation.

• #automation_subtype=(automation_subtype : AutomationSubtype | Nil)

  The subtype of the Automation operation.

• #change_request_name : String | Nil

  The name of the Change Manager change request.

• #change_request_name=(change_request_name : String | Nil)

  The name of the Change Manager change request.

• #current_action : String | Nil

  The action of the step that is currently running.

• #current_action=(current_action : String | Nil)

  The action of the step that is currently running.

• #current_step_name : String | Nil

  The name of the step that is currently running.

• #current_step_name=(current_step_name : String | Nil)

  The name of the step that is currently running.

• #document_name : String | Nil

  The name of the Automation runbook used during the execution.

• #document_name=(document_name : String | Nil)

  The name of the Automation runbook used during the execution.

• #document_version : String | Nil

  The version of the document to use during execution.

• #document_version=(document_version : String | Nil)

  The version of the document to use during execution.

• #executed_by : String | Nil

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

• #executed_by=(executed_by : String | Nil)

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

• #execution_end_time : Time | Nil

  The time the execution finished.

• #execution_end_time=(execution_end_time : Time | Nil)

  The time the execution finished.

• #execution_start_time : Time | Nil

  The time the execution started.

• #execution_start_time=(execution_start_time : Time | Nil)

  The time the execution started.

• #failure_message : String | Nil

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

• #failure_message=(failure_message : String | Nil)

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

• #hash(hasher)

  See Object#hash(hasher)

• #max_concurrency : String | Nil

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

• #max_concurrency=(max_concurrency : String | Nil)

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

• #max_errors : String | Nil

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

• #max_errors=(max_errors : String | Nil)

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

• #mode : ExecutionMode | Nil

  The automation execution mode.

• #mode=(mode : ExecutionMode | Nil)

  The automation execution mode.

• #ops_item_id : String | Nil

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

• #ops_item_id=(ops_item_id : String | Nil)

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

• #outputs : Hash(String, Array(String)) | Nil

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

• #outputs=(outputs : Hash(String, Array(String)) | Nil)

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

• #parameters : Hash(String, Array(String)) | Nil

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

• #parameters=(parameters : Hash(String, Array(String)) | Nil)

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

• #parent_automation_execution_id : String | Nil

  The AutomationExecutionId of the parent automation.

• #parent_automation_execution_id=(parent_automation_execution_id : String | Nil)

  The AutomationExecutionId of the parent automation.

• #progress_counters : ProgressCounters | Nil

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

• #progress_counters=(progress_counters : ProgressCounters | Nil)

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

• #resolved_targets : ResolvedTargets | Nil

  A list of resolved targets in the rate control execution.

• #resolved_targets=(resolved_targets : ResolvedTargets | Nil)

  A list of resolved targets in the rate control execution.

• #runbooks : Array(Runbook) | Nil

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

• #runbooks=(runbooks : Array(Runbook) | Nil)

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

• #scheduled_time : Time | Nil

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

• #scheduled_time=(scheduled_time : Time | Nil)

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

• #step_executions : Array(StepExecution) | Nil

  A list of details about the current state of all steps that comprise an execution.

• #step_executions=(step_executions : Array(StepExecution) | Nil)

  A list of details about the current state of all steps that comprise an execution.

• #step_executions_truncated : Bool | Nil

  A boolean value that indicates if the response contains the full list of the Automation step executions.

• #step_executions_truncated=(step_executions_truncated : Bool | Nil)

  A boolean value that indicates if the response contains the full list of the Automation step executions.

• #target : String | Nil

  The target of the execution.

• #target=(target : String | Nil)

  The target of the execution.

• #target_locations : Array(TargetLocation) | Nil

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

• #target_locations=(target_locations : Array(TargetLocation) | Nil)

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

• #target_locations_url : String | Nil

  A publicly accessible URL for a file that contains the TargetLocations body.

• #target_locations_url=(target_locations_url : String | Nil)

  A publicly accessible URL for a file that contains the TargetLocations body.

• #target_maps : Array(Hash(String, Array(String))) | Nil

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

• #target_maps=(target_maps : Array(Hash(String, Array(String))) | Nil)

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

• #target_parameter_name : String | Nil

  The parameter name.

• #target_parameter_name=(target_parameter_name : String | Nil)

  The parameter name.

• #targets : Array(Target) | Nil

  The specified targets.

• #targets=(targets : Array(Target) | Nil)

  The specified targets.

• #triggered_alarms : Array(AlarmStateInformation) | Nil

  The CloudWatch alarm that was invoked by the automation.

• #triggered_alarms=(triggered_alarms : Array(AlarmStateInformation) | Nil)

  The CloudWatch alarm that was invoked by the automation.

• #validate! : Nil
• #variables : Hash(String, Array(String)) | Nil

  Variables defined for the automation.

• #variables=(variables : Hash(String, Array(String)) | Nil)

  Variables defined for the automation.

• #warning_message : String | Nil

  A message that describes a non-critical issue that occurred during the automation execution.

• #warning_message=(warning_message : String | Nil)

  A message that describes a non-critical issue that occurred during the automation execution.

Constructor Detail

Instance Method Detail