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

Amazonka.SSM.Types.AutomationExecutionMetadata

Description

Synopsis

Documentation

data AutomationExecutionMetadata Source #

Details about a specific Automation execution.

See: newAutomationExecutionMetadata smart constructor.

Constructors

AutomationExecutionMetadata'

Fields

alarmConfiguration :: Maybe AlarmConfiguration
The details for the CloudWatch alarm applied to your automation.
associationId :: Maybe Text
The ID of a State Manager association used in the Automation operation.
automationExecutionId :: Maybe Text
The execution ID.
automationExecutionStatus :: Maybe AutomationExecutionStatus
The status of the execution.
automationSubtype :: Maybe AutomationSubtype
The subtype of the Automation operation. Currently, the only supported value is ChangeRequest.
automationType :: Maybe 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.
changeRequestName :: Maybe Text
The name of the Change Manager change request.
currentAction :: Maybe Text
The action of the step that is currently running.
currentStepName :: Maybe Text
The name of the step that is currently running.
documentName :: Maybe Text
The name of the Automation runbook used during execution.
documentVersion :: Maybe Text
The document version used during the execution.
executedBy :: Maybe Text
The IAM role ARN of the user who ran the automation.
executionEndTime :: Maybe POSIX
The time the execution finished. This isn't populated if the execution is still in progress.
executionStartTime :: Maybe POSIX
The time the execution started.
failureMessage :: Maybe Text
The list of execution outputs as defined in the Automation runbook.
logFile :: Maybe Text
An S3 bucket where execution information is stored.
maxConcurrency :: Maybe Text
The MaxConcurrency value specified by the user when starting the automation.
maxErrors :: Maybe Text
The MaxErrors value specified by the user when starting the automation.
mode :: Maybe ExecutionMode
The Automation execution mode.
opsItemId :: Maybe Text
The ID of an OpsItem that is created to represent a Change Manager change request.
outputs :: Maybe (HashMap Text [Text])
The list of execution outputs as defined in the Automation runbook.
parentAutomationExecutionId :: Maybe Text
The execution ID of the parent automation.
resolvedTargets :: Maybe ResolvedTargets
A list of targets that resolved during the execution.
runbooks :: Maybe (NonEmpty Runbook)
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.
scheduledTime :: Maybe POSIX
The date and time the Automation operation is scheduled to start.
target :: Maybe Text
The list of execution outputs as defined in the Automation runbook.
targetMaps :: Maybe [HashMap Text [Text]]
The specified key-value mapping of document parameters to target resources.
targetParameterName :: Maybe Text
The list of execution outputs as defined in the Automation runbook.
targets :: Maybe [Target]
The targets defined by the user when starting the automation.
triggeredAlarms :: Maybe (NonEmpty AlarmStateInformation)
The CloudWatch alarm that was invoked by the automation.

Instances

Instances details

FromJSON AutomationExecutionMetadata Source #
Instance details Defined in Amazonka.SSM.Types.AutomationExecutionMetadata Methods parseJSON :: Value -> Parser AutomationExecutionMetadata # parseJSONList :: Value -> Parser [AutomationExecutionMetadata] #
Generic AutomationExecutionMetadata Source #
Instance details Defined in Amazonka.SSM.Types.AutomationExecutionMetadata Associated Types type Rep AutomationExecutionMetadata :: Type -> Type # Methods from :: AutomationExecutionMetadata -> Rep AutomationExecutionMetadata x # to :: Rep AutomationExecutionMetadata x -> AutomationExecutionMetadata #
Read AutomationExecutionMetadata Source #
Instance details Defined in Amazonka.SSM.Types.AutomationExecutionMetadata Methods readsPrec :: Int -> ReadS AutomationExecutionMetadata # readList :: ReadS [AutomationExecutionMetadata] # readPrec :: ReadPrec AutomationExecutionMetadata # readListPrec :: ReadPrec [AutomationExecutionMetadata] #
Show AutomationExecutionMetadata Source #
Instance details Defined in Amazonka.SSM.Types.AutomationExecutionMetadata Methods showsPrec :: Int -> AutomationExecutionMetadata -> ShowS # show :: AutomationExecutionMetadata -> String # showList :: [AutomationExecutionMetadata] -> ShowS #
NFData AutomationExecutionMetadata Source #
Instance details Defined in Amazonka.SSM.Types.AutomationExecutionMetadata Methods rnf :: AutomationExecutionMetadata -> () #
Eq AutomationExecutionMetadata Source #
Instance details Defined in Amazonka.SSM.Types.AutomationExecutionMetadata Methods (==) :: AutomationExecutionMetadata -> AutomationExecutionMetadata -> Bool # (/=) :: AutomationExecutionMetadata -> AutomationExecutionMetadata -> Bool #
Hashable AutomationExecutionMetadata Source #
Instance details Defined in Amazonka.SSM.Types.AutomationExecutionMetadata Methods hashWithSalt :: Int -> AutomationExecutionMetadata -> Int # hash :: AutomationExecutionMetadata -> Int #
type Rep AutomationExecutionMetadata Source #
Instance details Defined in Amazonka.SSM.Types.AutomationExecutionMetadata type Rep AutomationExecutionMetadata = D1 ('MetaData "AutomationExecutionMetadata" "Amazonka.SSM.Types.AutomationExecutionMetadata" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "AutomationExecutionMetadata'" '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 "automationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AutomationType)) :: 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 "logFile") '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 "parentAutomationExecutionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: (((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 "target") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((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)))))))))

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.