Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data AutomationExecution = AutomationExecution' {
- alarmConfiguration :: Maybe AlarmConfiguration
- associationId :: Maybe Text
- automationExecutionId :: Maybe Text
- automationExecutionStatus :: Maybe AutomationExecutionStatus
- automationSubtype :: Maybe AutomationSubtype
- changeRequestName :: Maybe Text
- currentAction :: Maybe Text
- currentStepName :: Maybe Text
- documentName :: Maybe Text
- documentVersion :: Maybe Text
- executedBy :: Maybe Text
- executionEndTime :: Maybe POSIX
- executionStartTime :: Maybe POSIX
- failureMessage :: Maybe Text
- maxConcurrency :: Maybe Text
- maxErrors :: Maybe Text
- mode :: Maybe ExecutionMode
- opsItemId :: Maybe Text
- outputs :: Maybe (HashMap Text [Text])
- parameters :: Maybe (HashMap Text [Text])
- parentAutomationExecutionId :: Maybe Text
- progressCounters :: Maybe ProgressCounters
- resolvedTargets :: Maybe ResolvedTargets
- runbooks :: Maybe (NonEmpty Runbook)
- scheduledTime :: Maybe POSIX
- stepExecutions :: Maybe [StepExecution]
- stepExecutionsTruncated :: Maybe Bool
- target :: Maybe Text
- targetLocations :: Maybe (NonEmpty TargetLocation)
- targetMaps :: Maybe [HashMap Text [Text]]
- targetParameterName :: Maybe Text
- targets :: Maybe [Target]
- triggeredAlarms :: Maybe (NonEmpty AlarmStateInformation)
- newAutomationExecution :: AutomationExecution
- automationExecution_alarmConfiguration :: Lens' AutomationExecution (Maybe AlarmConfiguration)
- automationExecution_associationId :: Lens' AutomationExecution (Maybe Text)
- automationExecution_automationExecutionId :: Lens' AutomationExecution (Maybe Text)
- automationExecution_automationExecutionStatus :: Lens' AutomationExecution (Maybe AutomationExecutionStatus)
- automationExecution_automationSubtype :: Lens' AutomationExecution (Maybe AutomationSubtype)
- automationExecution_changeRequestName :: Lens' AutomationExecution (Maybe Text)
- automationExecution_currentAction :: Lens' AutomationExecution (Maybe Text)
- automationExecution_currentStepName :: Lens' AutomationExecution (Maybe Text)
- automationExecution_documentName :: Lens' AutomationExecution (Maybe Text)
- automationExecution_documentVersion :: Lens' AutomationExecution (Maybe Text)
- automationExecution_executedBy :: Lens' AutomationExecution (Maybe Text)
- automationExecution_executionEndTime :: Lens' AutomationExecution (Maybe UTCTime)
- automationExecution_executionStartTime :: Lens' AutomationExecution (Maybe UTCTime)
- automationExecution_failureMessage :: Lens' AutomationExecution (Maybe Text)
- automationExecution_maxConcurrency :: Lens' AutomationExecution (Maybe Text)
- automationExecution_maxErrors :: Lens' AutomationExecution (Maybe Text)
- automationExecution_mode :: Lens' AutomationExecution (Maybe ExecutionMode)
- automationExecution_opsItemId :: Lens' AutomationExecution (Maybe Text)
- automationExecution_outputs :: Lens' AutomationExecution (Maybe (HashMap Text [Text]))
- automationExecution_parameters :: Lens' AutomationExecution (Maybe (HashMap Text [Text]))
- automationExecution_parentAutomationExecutionId :: Lens' AutomationExecution (Maybe Text)
- automationExecution_progressCounters :: Lens' AutomationExecution (Maybe ProgressCounters)
- automationExecution_resolvedTargets :: Lens' AutomationExecution (Maybe ResolvedTargets)
- automationExecution_runbooks :: Lens' AutomationExecution (Maybe (NonEmpty Runbook))
- automationExecution_scheduledTime :: Lens' AutomationExecution (Maybe UTCTime)
- automationExecution_stepExecutions :: Lens' AutomationExecution (Maybe [StepExecution])
- automationExecution_stepExecutionsTruncated :: Lens' AutomationExecution (Maybe Bool)
- automationExecution_target :: Lens' AutomationExecution (Maybe Text)
- automationExecution_targetLocations :: Lens' AutomationExecution (Maybe (NonEmpty TargetLocation))
- automationExecution_targetMaps :: Lens' AutomationExecution (Maybe [HashMap Text [Text]])
- automationExecution_targetParameterName :: Lens' AutomationExecution (Maybe Text)
- automationExecution_targets :: Lens' AutomationExecution (Maybe [Target])
- automationExecution_triggeredAlarms :: Lens' AutomationExecution (Maybe (NonEmpty AlarmStateInformation))
Documentation
data AutomationExecution Source #
Detailed information about the current state of an individual Automation execution.
See: newAutomationExecution
smart constructor.
AutomationExecution' | |
|
Instances
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_automationExecutionId :: Lens' AutomationExecution (Maybe Text) Source #
The execution ID.
automationExecution_automationExecutionStatus :: Lens' AutomationExecution (Maybe AutomationExecutionStatus) Source #
The execution status of the Automation.
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_executionEndTime :: Lens' AutomationExecution (Maybe UTCTime) Source #
The time the execution finished.
automationExecution_executionStartTime :: Lens' AutomationExecution (Maybe UTCTime) Source #
The time the execution started.
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_mode :: Lens' AutomationExecution (Maybe ExecutionMode) Source #
The automation execution mode.
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_target :: Lens' AutomationExecution (Maybe Text) Source #
The target of the execution.
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_targetParameterName :: Lens' AutomationExecution (Maybe Text) Source #
The parameter name.
automationExecution_targets :: Lens' AutomationExecution (Maybe [Target]) Source #
The specified targets.
automationExecution_triggeredAlarms :: Lens' AutomationExecution (Maybe (NonEmpty AlarmStateInformation)) Source #
The CloudWatch alarm that was invoked by the automation.