/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include Details about a specific Automation execution.See Also:
AWS
* API Reference
The execution ID.
*/ inline const Aws::String& GetAutomationExecutionId() const{ return m_automationExecutionId; } inline bool AutomationExecutionIdHasBeenSet() const { return m_automationExecutionIdHasBeenSet; } inline void SetAutomationExecutionId(const Aws::String& value) { m_automationExecutionIdHasBeenSet = true; m_automationExecutionId = value; } inline void SetAutomationExecutionId(Aws::String&& value) { m_automationExecutionIdHasBeenSet = true; m_automationExecutionId = std::move(value); } inline void SetAutomationExecutionId(const char* value) { m_automationExecutionIdHasBeenSet = true; m_automationExecutionId.assign(value); } inline AutomationExecutionMetadata& WithAutomationExecutionId(const Aws::String& value) { SetAutomationExecutionId(value); return *this;} inline AutomationExecutionMetadata& WithAutomationExecutionId(Aws::String&& value) { SetAutomationExecutionId(std::move(value)); return *this;} inline AutomationExecutionMetadata& WithAutomationExecutionId(const char* value) { SetAutomationExecutionId(value); return *this;} ///@} ///@{ /** *The name of the Automation runbook used during execution.
*/ inline const Aws::String& GetDocumentName() const{ return m_documentName; } inline bool DocumentNameHasBeenSet() const { return m_documentNameHasBeenSet; } inline void SetDocumentName(const Aws::String& value) { m_documentNameHasBeenSet = true; m_documentName = value; } inline void SetDocumentName(Aws::String&& value) { m_documentNameHasBeenSet = true; m_documentName = std::move(value); } inline void SetDocumentName(const char* value) { m_documentNameHasBeenSet = true; m_documentName.assign(value); } inline AutomationExecutionMetadata& WithDocumentName(const Aws::String& value) { SetDocumentName(value); return *this;} inline AutomationExecutionMetadata& WithDocumentName(Aws::String&& value) { SetDocumentName(std::move(value)); return *this;} inline AutomationExecutionMetadata& WithDocumentName(const char* value) { SetDocumentName(value); return *this;} ///@} ///@{ /** *The document version used during the execution.
*/ inline const Aws::String& GetDocumentVersion() const{ return m_documentVersion; } inline bool DocumentVersionHasBeenSet() const { return m_documentVersionHasBeenSet; } inline void SetDocumentVersion(const Aws::String& value) { m_documentVersionHasBeenSet = true; m_documentVersion = value; } inline void SetDocumentVersion(Aws::String&& value) { m_documentVersionHasBeenSet = true; m_documentVersion = std::move(value); } inline void SetDocumentVersion(const char* value) { m_documentVersionHasBeenSet = true; m_documentVersion.assign(value); } inline AutomationExecutionMetadata& WithDocumentVersion(const Aws::String& value) { SetDocumentVersion(value); return *this;} inline AutomationExecutionMetadata& WithDocumentVersion(Aws::String&& value) { SetDocumentVersion(std::move(value)); return *this;} inline AutomationExecutionMetadata& WithDocumentVersion(const char* value) { SetDocumentVersion(value); return *this;} ///@} ///@{ /** *The status of the execution.
*/ inline const AutomationExecutionStatus& GetAutomationExecutionStatus() const{ return m_automationExecutionStatus; } inline bool AutomationExecutionStatusHasBeenSet() const { return m_automationExecutionStatusHasBeenSet; } inline void SetAutomationExecutionStatus(const AutomationExecutionStatus& value) { m_automationExecutionStatusHasBeenSet = true; m_automationExecutionStatus = value; } inline void SetAutomationExecutionStatus(AutomationExecutionStatus&& value) { m_automationExecutionStatusHasBeenSet = true; m_automationExecutionStatus = std::move(value); } inline AutomationExecutionMetadata& WithAutomationExecutionStatus(const AutomationExecutionStatus& value) { SetAutomationExecutionStatus(value); return *this;} inline AutomationExecutionMetadata& WithAutomationExecutionStatus(AutomationExecutionStatus&& value) { SetAutomationExecutionStatus(std::move(value)); return *this;} ///@} ///@{ /** *The time the execution started.
*/ inline const Aws::Utils::DateTime& GetExecutionStartTime() const{ return m_executionStartTime; } inline bool ExecutionStartTimeHasBeenSet() const { return m_executionStartTimeHasBeenSet; } inline void SetExecutionStartTime(const Aws::Utils::DateTime& value) { m_executionStartTimeHasBeenSet = true; m_executionStartTime = value; } inline void SetExecutionStartTime(Aws::Utils::DateTime&& value) { m_executionStartTimeHasBeenSet = true; m_executionStartTime = std::move(value); } inline AutomationExecutionMetadata& WithExecutionStartTime(const Aws::Utils::DateTime& value) { SetExecutionStartTime(value); return *this;} inline AutomationExecutionMetadata& WithExecutionStartTime(Aws::Utils::DateTime&& value) { SetExecutionStartTime(std::move(value)); return *this;} ///@} ///@{ /** *The time the execution finished. This isn't populated if the execution is * still in progress.
*/ inline const Aws::Utils::DateTime& GetExecutionEndTime() const{ return m_executionEndTime; } inline bool ExecutionEndTimeHasBeenSet() const { return m_executionEndTimeHasBeenSet; } inline void SetExecutionEndTime(const Aws::Utils::DateTime& value) { m_executionEndTimeHasBeenSet = true; m_executionEndTime = value; } inline void SetExecutionEndTime(Aws::Utils::DateTime&& value) { m_executionEndTimeHasBeenSet = true; m_executionEndTime = std::move(value); } inline AutomationExecutionMetadata& WithExecutionEndTime(const Aws::Utils::DateTime& value) { SetExecutionEndTime(value); return *this;} inline AutomationExecutionMetadata& WithExecutionEndTime(Aws::Utils::DateTime&& value) { SetExecutionEndTime(std::move(value)); return *this;} ///@} ///@{ /** *The IAM role ARN of the user who ran the automation.
*/ inline const Aws::String& GetExecutedBy() const{ return m_executedBy; } inline bool ExecutedByHasBeenSet() const { return m_executedByHasBeenSet; } inline void SetExecutedBy(const Aws::String& value) { m_executedByHasBeenSet = true; m_executedBy = value; } inline void SetExecutedBy(Aws::String&& value) { m_executedByHasBeenSet = true; m_executedBy = std::move(value); } inline void SetExecutedBy(const char* value) { m_executedByHasBeenSet = true; m_executedBy.assign(value); } inline AutomationExecutionMetadata& WithExecutedBy(const Aws::String& value) { SetExecutedBy(value); return *this;} inline AutomationExecutionMetadata& WithExecutedBy(Aws::String&& value) { SetExecutedBy(std::move(value)); return *this;} inline AutomationExecutionMetadata& WithExecutedBy(const char* value) { SetExecutedBy(value); return *this;} ///@} ///@{ /** *An S3 bucket where execution information is stored.
*/ inline const Aws::String& GetLogFile() const{ return m_logFile; } inline bool LogFileHasBeenSet() const { return m_logFileHasBeenSet; } inline void SetLogFile(const Aws::String& value) { m_logFileHasBeenSet = true; m_logFile = value; } inline void SetLogFile(Aws::String&& value) { m_logFileHasBeenSet = true; m_logFile = std::move(value); } inline void SetLogFile(const char* value) { m_logFileHasBeenSet = true; m_logFile.assign(value); } inline AutomationExecutionMetadata& WithLogFile(const Aws::String& value) { SetLogFile(value); return *this;} inline AutomationExecutionMetadata& WithLogFile(Aws::String&& value) { SetLogFile(std::move(value)); return *this;} inline AutomationExecutionMetadata& WithLogFile(const char* value) { SetLogFile(value); return *this;} ///@} ///@{ /** *The list of execution outputs as defined in the Automation runbook.
*/ inline const Aws::MapThe Automation execution mode.
*/ inline const ExecutionMode& GetMode() const{ return m_mode; } inline bool ModeHasBeenSet() const { return m_modeHasBeenSet; } inline void SetMode(const ExecutionMode& value) { m_modeHasBeenSet = true; m_mode = value; } inline void SetMode(ExecutionMode&& value) { m_modeHasBeenSet = true; m_mode = std::move(value); } inline AutomationExecutionMetadata& WithMode(const ExecutionMode& value) { SetMode(value); return *this;} inline AutomationExecutionMetadata& WithMode(ExecutionMode&& value) { SetMode(std::move(value)); return *this;} ///@} ///@{ /** *The execution ID of the parent automation.
*/ inline const Aws::String& GetParentAutomationExecutionId() const{ return m_parentAutomationExecutionId; } inline bool ParentAutomationExecutionIdHasBeenSet() const { return m_parentAutomationExecutionIdHasBeenSet; } inline void SetParentAutomationExecutionId(const Aws::String& value) { m_parentAutomationExecutionIdHasBeenSet = true; m_parentAutomationExecutionId = value; } inline void SetParentAutomationExecutionId(Aws::String&& value) { m_parentAutomationExecutionIdHasBeenSet = true; m_parentAutomationExecutionId = std::move(value); } inline void SetParentAutomationExecutionId(const char* value) { m_parentAutomationExecutionIdHasBeenSet = true; m_parentAutomationExecutionId.assign(value); } inline AutomationExecutionMetadata& WithParentAutomationExecutionId(const Aws::String& value) { SetParentAutomationExecutionId(value); return *this;} inline AutomationExecutionMetadata& WithParentAutomationExecutionId(Aws::String&& value) { SetParentAutomationExecutionId(std::move(value)); return *this;} inline AutomationExecutionMetadata& WithParentAutomationExecutionId(const char* value) { SetParentAutomationExecutionId(value); return *this;} ///@} ///@{ /** *The name of the step that is currently running.
*/ inline const Aws::String& GetCurrentStepName() const{ return m_currentStepName; } inline bool CurrentStepNameHasBeenSet() const { return m_currentStepNameHasBeenSet; } inline void SetCurrentStepName(const Aws::String& value) { m_currentStepNameHasBeenSet = true; m_currentStepName = value; } inline void SetCurrentStepName(Aws::String&& value) { m_currentStepNameHasBeenSet = true; m_currentStepName = std::move(value); } inline void SetCurrentStepName(const char* value) { m_currentStepNameHasBeenSet = true; m_currentStepName.assign(value); } inline AutomationExecutionMetadata& WithCurrentStepName(const Aws::String& value) { SetCurrentStepName(value); return *this;} inline AutomationExecutionMetadata& WithCurrentStepName(Aws::String&& value) { SetCurrentStepName(std::move(value)); return *this;} inline AutomationExecutionMetadata& WithCurrentStepName(const char* value) { SetCurrentStepName(value); return *this;} ///@} ///@{ /** *The action of the step that is currently running.
*/ inline const Aws::String& GetCurrentAction() const{ return m_currentAction; } inline bool CurrentActionHasBeenSet() const { return m_currentActionHasBeenSet; } inline void SetCurrentAction(const Aws::String& value) { m_currentActionHasBeenSet = true; m_currentAction = value; } inline void SetCurrentAction(Aws::String&& value) { m_currentActionHasBeenSet = true; m_currentAction = std::move(value); } inline void SetCurrentAction(const char* value) { m_currentActionHasBeenSet = true; m_currentAction.assign(value); } inline AutomationExecutionMetadata& WithCurrentAction(const Aws::String& value) { SetCurrentAction(value); return *this;} inline AutomationExecutionMetadata& WithCurrentAction(Aws::String&& value) { SetCurrentAction(std::move(value)); return *this;} inline AutomationExecutionMetadata& WithCurrentAction(const char* value) { SetCurrentAction(value); return *this;} ///@} ///@{ /** *The list of execution outputs as defined in the Automation runbook.
*/ inline const Aws::String& GetFailureMessage() const{ return m_failureMessage; } inline bool FailureMessageHasBeenSet() const { return m_failureMessageHasBeenSet; } inline void SetFailureMessage(const Aws::String& value) { m_failureMessageHasBeenSet = true; m_failureMessage = value; } inline void SetFailureMessage(Aws::String&& value) { m_failureMessageHasBeenSet = true; m_failureMessage = std::move(value); } inline void SetFailureMessage(const char* value) { m_failureMessageHasBeenSet = true; m_failureMessage.assign(value); } inline AutomationExecutionMetadata& WithFailureMessage(const Aws::String& value) { SetFailureMessage(value); return *this;} inline AutomationExecutionMetadata& WithFailureMessage(Aws::String&& value) { SetFailureMessage(std::move(value)); return *this;} inline AutomationExecutionMetadata& WithFailureMessage(const char* value) { SetFailureMessage(value); return *this;} ///@} ///@{ /** *The list of execution outputs as defined in the Automation runbook.
*/ inline const Aws::String& GetTargetParameterName() const{ return m_targetParameterName; } inline bool TargetParameterNameHasBeenSet() const { return m_targetParameterNameHasBeenSet; } inline void SetTargetParameterName(const Aws::String& value) { m_targetParameterNameHasBeenSet = true; m_targetParameterName = value; } inline void SetTargetParameterName(Aws::String&& value) { m_targetParameterNameHasBeenSet = true; m_targetParameterName = std::move(value); } inline void SetTargetParameterName(const char* value) { m_targetParameterNameHasBeenSet = true; m_targetParameterName.assign(value); } inline AutomationExecutionMetadata& WithTargetParameterName(const Aws::String& value) { SetTargetParameterName(value); return *this;} inline AutomationExecutionMetadata& WithTargetParameterName(Aws::String&& value) { SetTargetParameterName(std::move(value)); return *this;} inline AutomationExecutionMetadata& WithTargetParameterName(const char* value) { SetTargetParameterName(value); return *this;} ///@} ///@{ /** *The targets defined by the user when starting the automation.
*/ inline const Aws::VectorThe specified key-value mapping of document parameters to target * resources.
*/ inline const Aws::VectorA list of targets that resolved during the execution.
*/ inline const ResolvedTargets& GetResolvedTargets() const{ return m_resolvedTargets; } inline bool ResolvedTargetsHasBeenSet() const { return m_resolvedTargetsHasBeenSet; } inline void SetResolvedTargets(const ResolvedTargets& value) { m_resolvedTargetsHasBeenSet = true; m_resolvedTargets = value; } inline void SetResolvedTargets(ResolvedTargets&& value) { m_resolvedTargetsHasBeenSet = true; m_resolvedTargets = std::move(value); } inline AutomationExecutionMetadata& WithResolvedTargets(const ResolvedTargets& value) { SetResolvedTargets(value); return *this;} inline AutomationExecutionMetadata& WithResolvedTargets(ResolvedTargets&& value) { SetResolvedTargets(std::move(value)); return *this;} ///@} ///@{ /** *The MaxConcurrency value specified by the user when starting the
* automation.
The MaxErrors value specified by the user when starting the
* automation.
The list of execution outputs as defined in the Automation runbook.
*/ inline const Aws::String& GetTarget() const{ return m_target; } inline bool TargetHasBeenSet() const { return m_targetHasBeenSet; } inline void SetTarget(const Aws::String& value) { m_targetHasBeenSet = true; m_target = value; } inline void SetTarget(Aws::String&& value) { m_targetHasBeenSet = true; m_target = std::move(value); } inline void SetTarget(const char* value) { m_targetHasBeenSet = true; m_target.assign(value); } inline AutomationExecutionMetadata& WithTarget(const Aws::String& value) { SetTarget(value); return *this;} inline AutomationExecutionMetadata& WithTarget(Aws::String&& value) { SetTarget(std::move(value)); return *this;} inline AutomationExecutionMetadata& WithTarget(const char* value) { SetTarget(value); return *this;} ///@} ///@{ /** *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 * automations in multiple Amazon Web Services Regions and accounts in the * Amazon Web Services Systems Manager User Guide.
*/ inline const AutomationType& GetAutomationType() const{ return m_automationType; } inline bool AutomationTypeHasBeenSet() const { return m_automationTypeHasBeenSet; } inline void SetAutomationType(const AutomationType& value) { m_automationTypeHasBeenSet = true; m_automationType = value; } inline void SetAutomationType(AutomationType&& value) { m_automationTypeHasBeenSet = true; m_automationType = std::move(value); } inline AutomationExecutionMetadata& WithAutomationType(const AutomationType& value) { SetAutomationType(value); return *this;} inline AutomationExecutionMetadata& WithAutomationType(AutomationType&& value) { SetAutomationType(std::move(value)); return *this;} ///@} ///@{ /** *The details for the CloudWatch alarm applied to your automation.
*/ inline const AlarmConfiguration& GetAlarmConfiguration() const{ return m_alarmConfiguration; } inline bool AlarmConfigurationHasBeenSet() const { return m_alarmConfigurationHasBeenSet; } inline void SetAlarmConfiguration(const AlarmConfiguration& value) { m_alarmConfigurationHasBeenSet = true; m_alarmConfiguration = value; } inline void SetAlarmConfiguration(AlarmConfiguration&& value) { m_alarmConfigurationHasBeenSet = true; m_alarmConfiguration = std::move(value); } inline AutomationExecutionMetadata& WithAlarmConfiguration(const AlarmConfiguration& value) { SetAlarmConfiguration(value); return *this;} inline AutomationExecutionMetadata& WithAlarmConfiguration(AlarmConfiguration&& value) { SetAlarmConfiguration(std::move(value)); return *this;} ///@} ///@{ /** *The CloudWatch alarm that was invoked by the automation.
*/ inline const Aws::VectorA publicly accessible URL for a file that contains the
* TargetLocations body. Currently, only files in presigned Amazon S3
* buckets are supported
The subtype of the Automation operation. Currently, the only supported value
* is ChangeRequest.
The date and time the Automation operation is scheduled to start.
*/ inline const Aws::Utils::DateTime& GetScheduledTime() const{ return m_scheduledTime; } inline bool ScheduledTimeHasBeenSet() const { return m_scheduledTimeHasBeenSet; } inline void SetScheduledTime(const Aws::Utils::DateTime& value) { m_scheduledTimeHasBeenSet = true; m_scheduledTime = value; } inline void SetScheduledTime(Aws::Utils::DateTime&& value) { m_scheduledTimeHasBeenSet = true; m_scheduledTime = std::move(value); } inline AutomationExecutionMetadata& WithScheduledTime(const Aws::Utils::DateTime& value) { SetScheduledTime(value); return *this;} inline AutomationExecutionMetadata& WithScheduledTime(Aws::Utils::DateTime&& value) { SetScheduledTime(std::move(value)); return *this;} ///@} ///@{ /** *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.
*/ inline const Aws::VectorThe ID of an OpsItem that is created to represent a Change Manager change * request.
*/ inline const Aws::String& GetOpsItemId() const{ return m_opsItemId; } inline bool OpsItemIdHasBeenSet() const { return m_opsItemIdHasBeenSet; } inline void SetOpsItemId(const Aws::String& value) { m_opsItemIdHasBeenSet = true; m_opsItemId = value; } inline void SetOpsItemId(Aws::String&& value) { m_opsItemIdHasBeenSet = true; m_opsItemId = std::move(value); } inline void SetOpsItemId(const char* value) { m_opsItemIdHasBeenSet = true; m_opsItemId.assign(value); } inline AutomationExecutionMetadata& WithOpsItemId(const Aws::String& value) { SetOpsItemId(value); return *this;} inline AutomationExecutionMetadata& WithOpsItemId(Aws::String&& value) { SetOpsItemId(std::move(value)); return *this;} inline AutomationExecutionMetadata& WithOpsItemId(const char* value) { SetOpsItemId(value); return *this;} ///@} ///@{ /** *The ID of a State Manager association used in the Automation operation.
*/ inline const Aws::String& GetAssociationId() const{ return m_associationId; } inline bool AssociationIdHasBeenSet() const { return m_associationIdHasBeenSet; } inline void SetAssociationId(const Aws::String& value) { m_associationIdHasBeenSet = true; m_associationId = value; } inline void SetAssociationId(Aws::String&& value) { m_associationIdHasBeenSet = true; m_associationId = std::move(value); } inline void SetAssociationId(const char* value) { m_associationIdHasBeenSet = true; m_associationId.assign(value); } inline AutomationExecutionMetadata& WithAssociationId(const Aws::String& value) { SetAssociationId(value); return *this;} inline AutomationExecutionMetadata& WithAssociationId(Aws::String&& value) { SetAssociationId(std::move(value)); return *this;} inline AutomationExecutionMetadata& WithAssociationId(const char* value) { SetAssociationId(value); return *this;} ///@} ///@{ /** *The name of the Change Manager change request.
*/ inline const Aws::String& GetChangeRequestName() const{ return m_changeRequestName; } inline bool ChangeRequestNameHasBeenSet() const { return m_changeRequestNameHasBeenSet; } inline void SetChangeRequestName(const Aws::String& value) { m_changeRequestNameHasBeenSet = true; m_changeRequestName = value; } inline void SetChangeRequestName(Aws::String&& value) { m_changeRequestNameHasBeenSet = true; m_changeRequestName = std::move(value); } inline void SetChangeRequestName(const char* value) { m_changeRequestNameHasBeenSet = true; m_changeRequestName.assign(value); } inline AutomationExecutionMetadata& WithChangeRequestName(const Aws::String& value) { SetChangeRequestName(value); return *this;} inline AutomationExecutionMetadata& WithChangeRequestName(Aws::String&& value) { SetChangeRequestName(std::move(value)); return *this;} inline AutomationExecutionMetadata& WithChangeRequestName(const char* value) { SetChangeRequestName(value); return *this;} ///@} private: Aws::String m_automationExecutionId; bool m_automationExecutionIdHasBeenSet = false; Aws::String m_documentName; bool m_documentNameHasBeenSet = false; Aws::String m_documentVersion; bool m_documentVersionHasBeenSet = false; AutomationExecutionStatus m_automationExecutionStatus; bool m_automationExecutionStatusHasBeenSet = false; Aws::Utils::DateTime m_executionStartTime; bool m_executionStartTimeHasBeenSet = false; Aws::Utils::DateTime m_executionEndTime; bool m_executionEndTimeHasBeenSet = false; Aws::String m_executedBy; bool m_executedByHasBeenSet = false; Aws::String m_logFile; bool m_logFileHasBeenSet = false; Aws::Map