amazonka-ssm-2.0: Amazon Simple Systems Manager (SSM) SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.SSM.Types.AutomationExecution

Description

 
Synopsis

Documentation

data AutomationExecution Source #

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

See: newAutomationExecution smart constructor.

Constructors

AutomationExecution' 

Fields

Instances

Instances details
FromJSON AutomationExecution Source # 
Instance details

Defined in Amazonka.SSM.Types.AutomationExecution

Generic AutomationExecution Source # 
Instance details

Defined in Amazonka.SSM.Types.AutomationExecution

Associated Types

type Rep AutomationExecution :: Type -> Type #

Read AutomationExecution Source # 
Instance details

Defined in Amazonka.SSM.Types.AutomationExecution

Show AutomationExecution Source # 
Instance details

Defined in Amazonka.SSM.Types.AutomationExecution

NFData AutomationExecution Source # 
Instance details

Defined in Amazonka.SSM.Types.AutomationExecution

Methods

rnf :: AutomationExecution -> () #

Eq AutomationExecution Source # 
Instance details

Defined in Amazonka.SSM.Types.AutomationExecution

Hashable AutomationExecution Source # 
Instance details

Defined in Amazonka.SSM.Types.AutomationExecution

type Rep AutomationExecution Source # 
Instance details

Defined in Amazonka.SSM.Types.AutomationExecution

type Rep AutomationExecution = D1 ('MetaData "AutomationExecution" "Amazonka.SSM.Types.AutomationExecution" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "AutomationExecution'" 'PrefixI 'True) (((((S1 ('MetaSel ('Just "alarmConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AlarmConfiguration)) :*: S1 ('MetaSel ('Just "associationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "automationExecutionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "automationExecutionStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AutomationExecutionStatus)))) :*: ((S1 ('MetaSel ('Just "automationSubtype") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AutomationSubtype)) :*: S1 ('MetaSel ('Just "changeRequestName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "currentAction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "currentStepName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: (((S1 ('MetaSel ('Just "documentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "documentVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "executedBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "executionEndTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: ((S1 ('MetaSel ('Just "executionStartTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "failureMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "maxConcurrency") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxErrors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :*: ((((S1 ('MetaSel ('Just "mode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExecutionMode)) :*: S1 ('MetaSel ('Just "opsItemId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "outputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [Text]))) :*: S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [Text]))))) :*: ((S1 ('MetaSel ('Just "parentAutomationExecutionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "progressCounters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProgressCounters))) :*: (S1 ('MetaSel ('Just "resolvedTargets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResolvedTargets)) :*: S1 ('MetaSel ('Just "runbooks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Runbook)))))) :*: (((S1 ('MetaSel ('Just "scheduledTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "stepExecutions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [StepExecution]))) :*: (S1 ('MetaSel ('Just "stepExecutionsTruncated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "target") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "targetLocations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty TargetLocation))) :*: S1 ('MetaSel ('Just "targetMaps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [HashMap Text [Text]]))) :*: (S1 ('MetaSel ('Just "targetParameterName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "targets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Target])) :*: S1 ('MetaSel ('Just "triggeredAlarms") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty AlarmStateInformation))))))))))

newAutomationExecution :: AutomationExecution Source #

Create a value of AutomationExecution with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:alarmConfiguration:AutomationExecution', automationExecution_alarmConfiguration - The details for the CloudWatch alarm applied to your automation.

$sel:associationId:AutomationExecution', automationExecution_associationId - The ID of a State Manager association used in the Automation operation.

$sel:automationExecutionId:AutomationExecution', automationExecution_automationExecutionId - The execution ID.

$sel:automationExecutionStatus:AutomationExecution', automationExecution_automationExecutionStatus - The execution status of the Automation.

$sel:automationSubtype:AutomationExecution', automationExecution_automationSubtype - The subtype of the Automation operation. Currently, the only supported value is ChangeRequest.

$sel:changeRequestName:AutomationExecution', automationExecution_changeRequestName - The name of the Change Manager change request.

$sel:currentAction:AutomationExecution', automationExecution_currentAction - The action of the step that is currently running.

$sel:currentStepName:AutomationExecution', automationExecution_currentStepName - The name of the step that is currently running.

AutomationExecution, automationExecution_documentName - The name of the Automation runbook used during the execution.

AutomationExecution, automationExecution_documentVersion - The version of the document to use during execution.

$sel:executedBy:AutomationExecution', automationExecution_executedBy - The Amazon Resource Name (ARN) of the user who ran the automation.

AutomationExecution, automationExecution_executionEndTime - The time the execution finished.

AutomationExecution, automationExecution_executionStartTime - The time the execution started.

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

AutomationExecution, automationExecution_maxConcurrency - The MaxConcurrency value specified by the user when the execution started.

AutomationExecution, automationExecution_maxErrors - The MaxErrors value specified by the user when the execution started.

$sel:mode:AutomationExecution', automationExecution_mode - The automation execution mode.

$sel:opsItemId:AutomationExecution', automationExecution_opsItemId - The ID of an OpsItem that is created to represent a Change Manager change request.

AutomationExecution, automationExecution_outputs - The list of execution outputs as defined in the Automation runbook.

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

$sel:parentAutomationExecutionId:AutomationExecution', automationExecution_parentAutomationExecutionId - The AutomationExecutionId of the parent automation.

$sel:progressCounters:AutomationExecution', automationExecution_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.

$sel:resolvedTargets:AutomationExecution', automationExecution_resolvedTargets - A list of resolved targets in the rate control execution.

$sel:runbooks:AutomationExecution', automationExecution_runbooks - 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.

$sel:scheduledTime:AutomationExecution', automationExecution_scheduledTime - The date and time the Automation operation is scheduled to start.

$sel:stepExecutions:AutomationExecution', automationExecution_stepExecutions - 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.

$sel:stepExecutionsTruncated:AutomationExecution', automationExecution_stepExecutionsTruncated - 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.

$sel:target:AutomationExecution', automationExecution_target - The target of the execution.

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

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

AutomationExecution, automationExecution_targetParameterName - The parameter name.

AutomationExecution, automationExecution_targets - The specified targets.

AutomationExecution, automationExecution_triggeredAlarms - The CloudWatch alarm that was invoked by the automation.

automationExecution_alarmConfiguration :: Lens' AutomationExecution (Maybe AlarmConfiguration) Source #

The details for the CloudWatch alarm applied to your automation.

automationExecution_associationId :: Lens' AutomationExecution (Maybe Text) Source #

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

automationExecution_automationSubtype :: Lens' AutomationExecution (Maybe AutomationSubtype) Source #

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

automationExecution_changeRequestName :: Lens' AutomationExecution (Maybe Text) Source #

The name of the Change Manager change request.

automationExecution_currentAction :: Lens' AutomationExecution (Maybe Text) Source #

The action of the step that is currently running.

automationExecution_currentStepName :: Lens' AutomationExecution (Maybe Text) Source #

The name of the step that is currently running.

automationExecution_documentName :: Lens' AutomationExecution (Maybe Text) Source #

The name of the Automation runbook used during the execution.

automationExecution_documentVersion :: Lens' AutomationExecution (Maybe Text) Source #

The version of the document to use during execution.

automationExecution_executedBy :: Lens' AutomationExecution (Maybe Text) Source #

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

automationExecution_failureMessage :: Lens' AutomationExecution (Maybe Text) Source #

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

automationExecution_maxConcurrency :: Lens' AutomationExecution (Maybe Text) Source #

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

automationExecution_maxErrors :: Lens' AutomationExecution (Maybe Text) Source #

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

automationExecution_opsItemId :: Lens' AutomationExecution (Maybe Text) Source #

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

automationExecution_outputs :: Lens' AutomationExecution (Maybe (HashMap Text [Text])) Source #

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

automationExecution_parameters :: Lens' AutomationExecution (Maybe (HashMap Text [Text])) Source #

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

automationExecution_parentAutomationExecutionId :: Lens' AutomationExecution (Maybe Text) Source #

The AutomationExecutionId of the parent automation.

automationExecution_progressCounters :: Lens' AutomationExecution (Maybe ProgressCounters) Source #

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

automationExecution_resolvedTargets :: Lens' AutomationExecution (Maybe ResolvedTargets) Source #

A list of resolved targets in the rate control execution.

automationExecution_runbooks :: Lens' AutomationExecution (Maybe (NonEmpty Runbook)) Source #

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.

automationExecution_scheduledTime :: Lens' AutomationExecution (Maybe UTCTime) Source #

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

automationExecution_stepExecutions :: Lens' AutomationExecution (Maybe [StepExecution]) Source #

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.

automationExecution_stepExecutionsTruncated :: Lens' AutomationExecution (Maybe Bool) Source #

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.

automationExecution_targetLocations :: Lens' AutomationExecution (Maybe (NonEmpty TargetLocation)) Source #

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

automationExecution_targetMaps :: Lens' AutomationExecution (Maybe [HashMap Text [Text]]) Source #

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

automationExecution_triggeredAlarms :: Lens' AutomationExecution (Maybe (NonEmpty AlarmStateInformation)) Source #

The CloudWatch alarm that was invoked by the automation.