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 AutomationExecutionMetadata = AutomationExecutionMetadata' {
- alarmConfiguration :: Maybe AlarmConfiguration
- associationId :: Maybe Text
- automationExecutionId :: Maybe Text
- automationExecutionStatus :: Maybe AutomationExecutionStatus
- automationSubtype :: Maybe AutomationSubtype
- automationType :: Maybe AutomationType
- 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
- logFile :: Maybe Text
- maxConcurrency :: Maybe Text
- maxErrors :: Maybe Text
- mode :: Maybe ExecutionMode
- opsItemId :: Maybe Text
- outputs :: Maybe (HashMap Text [Text])
- parentAutomationExecutionId :: Maybe Text
- resolvedTargets :: Maybe ResolvedTargets
- runbooks :: Maybe (NonEmpty Runbook)
- scheduledTime :: Maybe POSIX
- target :: Maybe Text
- targetMaps :: Maybe [HashMap Text [Text]]
- targetParameterName :: Maybe Text
- targets :: Maybe [Target]
- triggeredAlarms :: Maybe (NonEmpty AlarmStateInformation)
- newAutomationExecutionMetadata :: AutomationExecutionMetadata
- automationExecutionMetadata_alarmConfiguration :: Lens' AutomationExecutionMetadata (Maybe AlarmConfiguration)
- automationExecutionMetadata_associationId :: Lens' AutomationExecutionMetadata (Maybe Text)
- automationExecutionMetadata_automationExecutionId :: Lens' AutomationExecutionMetadata (Maybe Text)
- automationExecutionMetadata_automationExecutionStatus :: Lens' AutomationExecutionMetadata (Maybe AutomationExecutionStatus)
- automationExecutionMetadata_automationSubtype :: Lens' AutomationExecutionMetadata (Maybe AutomationSubtype)
- automationExecutionMetadata_automationType :: Lens' AutomationExecutionMetadata (Maybe AutomationType)
- automationExecutionMetadata_changeRequestName :: Lens' AutomationExecutionMetadata (Maybe Text)
- automationExecutionMetadata_currentAction :: Lens' AutomationExecutionMetadata (Maybe Text)
- automationExecutionMetadata_currentStepName :: Lens' AutomationExecutionMetadata (Maybe Text)
- automationExecutionMetadata_documentName :: Lens' AutomationExecutionMetadata (Maybe Text)
- automationExecutionMetadata_documentVersion :: Lens' AutomationExecutionMetadata (Maybe Text)
- automationExecutionMetadata_executedBy :: Lens' AutomationExecutionMetadata (Maybe Text)
- automationExecutionMetadata_executionEndTime :: Lens' AutomationExecutionMetadata (Maybe UTCTime)
- automationExecutionMetadata_executionStartTime :: Lens' AutomationExecutionMetadata (Maybe UTCTime)
- automationExecutionMetadata_failureMessage :: Lens' AutomationExecutionMetadata (Maybe Text)
- automationExecutionMetadata_logFile :: Lens' AutomationExecutionMetadata (Maybe Text)
- automationExecutionMetadata_maxConcurrency :: Lens' AutomationExecutionMetadata (Maybe Text)
- automationExecutionMetadata_maxErrors :: Lens' AutomationExecutionMetadata (Maybe Text)
- automationExecutionMetadata_mode :: Lens' AutomationExecutionMetadata (Maybe ExecutionMode)
- automationExecutionMetadata_opsItemId :: Lens' AutomationExecutionMetadata (Maybe Text)
- automationExecutionMetadata_outputs :: Lens' AutomationExecutionMetadata (Maybe (HashMap Text [Text]))
- automationExecutionMetadata_parentAutomationExecutionId :: Lens' AutomationExecutionMetadata (Maybe Text)
- automationExecutionMetadata_resolvedTargets :: Lens' AutomationExecutionMetadata (Maybe ResolvedTargets)
- automationExecutionMetadata_runbooks :: Lens' AutomationExecutionMetadata (Maybe (NonEmpty Runbook))
- automationExecutionMetadata_scheduledTime :: Lens' AutomationExecutionMetadata (Maybe UTCTime)
- automationExecutionMetadata_target :: Lens' AutomationExecutionMetadata (Maybe Text)
- automationExecutionMetadata_targetMaps :: Lens' AutomationExecutionMetadata (Maybe [HashMap Text [Text]])
- automationExecutionMetadata_targetParameterName :: Lens' AutomationExecutionMetadata (Maybe Text)
- automationExecutionMetadata_targets :: Lens' AutomationExecutionMetadata (Maybe [Target])
- automationExecutionMetadata_triggeredAlarms :: Lens' AutomationExecutionMetadata (Maybe (NonEmpty AlarmStateInformation))
Documentation
data AutomationExecutionMetadata Source #
Details about a specific Automation execution.
See: newAutomationExecutionMetadata
smart constructor.
AutomationExecutionMetadata' | |
|
Instances
newAutomationExecutionMetadata :: AutomationExecutionMetadata Source #
Create a value of AutomationExecutionMetadata
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:AutomationExecutionMetadata'
, automationExecutionMetadata_alarmConfiguration
- The details for the CloudWatch alarm applied to your automation.
$sel:associationId:AutomationExecutionMetadata'
, automationExecutionMetadata_associationId
- The ID of a State Manager association used in the Automation operation.
$sel:automationExecutionId:AutomationExecutionMetadata'
, automationExecutionMetadata_automationExecutionId
- The execution ID.
$sel:automationExecutionStatus:AutomationExecutionMetadata'
, automationExecutionMetadata_automationExecutionStatus
- The status of the execution.
$sel:automationSubtype:AutomationExecutionMetadata'
, automationExecutionMetadata_automationSubtype
- The subtype of the Automation operation. Currently, the only supported
value is ChangeRequest
.
$sel:automationType:AutomationExecutionMetadata'
, automationExecutionMetadata_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.
$sel:changeRequestName:AutomationExecutionMetadata'
, automationExecutionMetadata_changeRequestName
- The name of the Change Manager change request.
$sel:currentAction:AutomationExecutionMetadata'
, automationExecutionMetadata_currentAction
- The action of the step that is currently running.
$sel:currentStepName:AutomationExecutionMetadata'
, automationExecutionMetadata_currentStepName
- The name of the step that is currently running.
AutomationExecutionMetadata
, automationExecutionMetadata_documentName
- The name of the Automation runbook used during execution.
AutomationExecutionMetadata
, automationExecutionMetadata_documentVersion
- The document version used during the execution.
$sel:executedBy:AutomationExecutionMetadata'
, automationExecutionMetadata_executedBy
- The IAM role ARN of the user who ran the automation.
$sel:executionEndTime:AutomationExecutionMetadata'
, automationExecutionMetadata_executionEndTime
- The time the execution finished. This isn't populated if the execution
is still in progress.
$sel:executionStartTime:AutomationExecutionMetadata'
, automationExecutionMetadata_executionStartTime
- The time the execution started.
$sel:failureMessage:AutomationExecutionMetadata'
, automationExecutionMetadata_failureMessage
- The list of execution outputs as defined in the Automation runbook.
$sel:logFile:AutomationExecutionMetadata'
, automationExecutionMetadata_logFile
- An S3 bucket where execution information is stored.
AutomationExecutionMetadata
, automationExecutionMetadata_maxConcurrency
- The MaxConcurrency
value specified by the user when starting the
automation.
AutomationExecutionMetadata
, automationExecutionMetadata_maxErrors
- The MaxErrors
value specified by the user when starting the
automation.
$sel:mode:AutomationExecutionMetadata'
, automationExecutionMetadata_mode
- The Automation execution mode.
$sel:opsItemId:AutomationExecutionMetadata'
, automationExecutionMetadata_opsItemId
- The ID of an OpsItem that is created to represent a Change Manager
change request.
$sel:outputs:AutomationExecutionMetadata'
, automationExecutionMetadata_outputs
- The list of execution outputs as defined in the Automation runbook.
$sel:parentAutomationExecutionId:AutomationExecutionMetadata'
, automationExecutionMetadata_parentAutomationExecutionId
- The execution ID of the parent automation.
$sel:resolvedTargets:AutomationExecutionMetadata'
, automationExecutionMetadata_resolvedTargets
- A list of targets that resolved during the execution.
$sel:runbooks:AutomationExecutionMetadata'
, automationExecutionMetadata_runbooks
- 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.
$sel:scheduledTime:AutomationExecutionMetadata'
, automationExecutionMetadata_scheduledTime
- The date and time the Automation operation is scheduled to start.
$sel:target:AutomationExecutionMetadata'
, automationExecutionMetadata_target
- The list of execution outputs as defined in the Automation runbook.
AutomationExecutionMetadata
, automationExecutionMetadata_targetMaps
- The specified key-value mapping of document parameters to target
resources.
AutomationExecutionMetadata
, automationExecutionMetadata_targetParameterName
- The list of execution outputs as defined in the Automation runbook.
AutomationExecutionMetadata
, automationExecutionMetadata_targets
- The targets defined by the user when starting the automation.
$sel:triggeredAlarms:AutomationExecutionMetadata'
, automationExecutionMetadata_triggeredAlarms
- The CloudWatch alarm that was invoked by the automation.
automationExecutionMetadata_alarmConfiguration :: Lens' AutomationExecutionMetadata (Maybe AlarmConfiguration) Source #
The details for the CloudWatch alarm applied to your automation.
automationExecutionMetadata_associationId :: Lens' AutomationExecutionMetadata (Maybe Text) Source #
The ID of a State Manager association used in the Automation operation.
automationExecutionMetadata_automationExecutionId :: Lens' AutomationExecutionMetadata (Maybe Text) Source #
The execution ID.
automationExecutionMetadata_automationExecutionStatus :: Lens' AutomationExecutionMetadata (Maybe AutomationExecutionStatus) Source #
The status of the execution.
automationExecutionMetadata_automationSubtype :: Lens' AutomationExecutionMetadata (Maybe AutomationSubtype) Source #
The subtype of the Automation operation. Currently, the only supported
value is ChangeRequest
.
automationExecutionMetadata_automationType :: Lens' AutomationExecutionMetadata (Maybe AutomationType) Source #
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.
automationExecutionMetadata_changeRequestName :: Lens' AutomationExecutionMetadata (Maybe Text) Source #
The name of the Change Manager change request.
automationExecutionMetadata_currentAction :: Lens' AutomationExecutionMetadata (Maybe Text) Source #
The action of the step that is currently running.
automationExecutionMetadata_currentStepName :: Lens' AutomationExecutionMetadata (Maybe Text) Source #
The name of the step that is currently running.
automationExecutionMetadata_documentName :: Lens' AutomationExecutionMetadata (Maybe Text) Source #
The name of the Automation runbook used during execution.
automationExecutionMetadata_documentVersion :: Lens' AutomationExecutionMetadata (Maybe Text) Source #
The document version used during the execution.
automationExecutionMetadata_executedBy :: Lens' AutomationExecutionMetadata (Maybe Text) Source #
The IAM role ARN of the user who ran the automation.
automationExecutionMetadata_executionEndTime :: Lens' AutomationExecutionMetadata (Maybe UTCTime) Source #
The time the execution finished. This isn't populated if the execution is still in progress.
automationExecutionMetadata_executionStartTime :: Lens' AutomationExecutionMetadata (Maybe UTCTime) Source #
The time the execution started.
automationExecutionMetadata_failureMessage :: Lens' AutomationExecutionMetadata (Maybe Text) Source #
The list of execution outputs as defined in the Automation runbook.
automationExecutionMetadata_logFile :: Lens' AutomationExecutionMetadata (Maybe Text) Source #
An S3 bucket where execution information is stored.
automationExecutionMetadata_maxConcurrency :: Lens' AutomationExecutionMetadata (Maybe Text) Source #
The MaxConcurrency
value specified by the user when starting the
automation.
automationExecutionMetadata_maxErrors :: Lens' AutomationExecutionMetadata (Maybe Text) Source #
The MaxErrors
value specified by the user when starting the
automation.
automationExecutionMetadata_mode :: Lens' AutomationExecutionMetadata (Maybe ExecutionMode) Source #
The Automation execution mode.
automationExecutionMetadata_opsItemId :: Lens' AutomationExecutionMetadata (Maybe Text) Source #
The ID of an OpsItem that is created to represent a Change Manager change request.
automationExecutionMetadata_outputs :: Lens' AutomationExecutionMetadata (Maybe (HashMap Text [Text])) Source #
The list of execution outputs as defined in the Automation runbook.
automationExecutionMetadata_parentAutomationExecutionId :: Lens' AutomationExecutionMetadata (Maybe Text) Source #
The execution ID of the parent automation.
automationExecutionMetadata_resolvedTargets :: Lens' AutomationExecutionMetadata (Maybe ResolvedTargets) Source #
A list of targets that resolved during the execution.
automationExecutionMetadata_runbooks :: Lens' AutomationExecutionMetadata (Maybe (NonEmpty Runbook)) Source #
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.
automationExecutionMetadata_scheduledTime :: Lens' AutomationExecutionMetadata (Maybe UTCTime) Source #
The date and time the Automation operation is scheduled to start.
automationExecutionMetadata_target :: Lens' AutomationExecutionMetadata (Maybe Text) Source #
The list of execution outputs as defined in the Automation runbook.
automationExecutionMetadata_targetMaps :: Lens' AutomationExecutionMetadata (Maybe [HashMap Text [Text]]) Source #
The specified key-value mapping of document parameters to target resources.
automationExecutionMetadata_targetParameterName :: Lens' AutomationExecutionMetadata (Maybe Text) Source #
The list of execution outputs as defined in the Automation runbook.
automationExecutionMetadata_targets :: Lens' AutomationExecutionMetadata (Maybe [Target]) Source #
The targets defined by the user when starting the automation.
automationExecutionMetadata_triggeredAlarms :: Lens' AutomationExecutionMetadata (Maybe (NonEmpty AlarmStateInformation)) Source #
The CloudWatch alarm that was invoked by the automation.