/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include Detailed information about the current state of an individual 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 AutomationExecution& WithAutomationExecutionId(const Aws::String& value) { SetAutomationExecutionId(value); return *this;} inline AutomationExecution& WithAutomationExecutionId(Aws::String&& value) { SetAutomationExecutionId(std::move(value)); return *this;} inline AutomationExecution& WithAutomationExecutionId(const char* value) { SetAutomationExecutionId(value); return *this;} ///@} ///@{ /** *The name of the Automation runbook used during the 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 AutomationExecution& WithDocumentName(const Aws::String& value) { SetDocumentName(value); return *this;} inline AutomationExecution& WithDocumentName(Aws::String&& value) { SetDocumentName(std::move(value)); return *this;} inline AutomationExecution& WithDocumentName(const char* value) { SetDocumentName(value); return *this;} ///@} ///@{ /** *The version of the document to use during 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 AutomationExecution& WithDocumentVersion(const Aws::String& value) { SetDocumentVersion(value); return *this;} inline AutomationExecution& WithDocumentVersion(Aws::String&& value) { SetDocumentVersion(std::move(value)); return *this;} inline AutomationExecution& WithDocumentVersion(const char* value) { SetDocumentVersion(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 AutomationExecution& WithExecutionStartTime(const Aws::Utils::DateTime& value) { SetExecutionStartTime(value); return *this;} inline AutomationExecution& WithExecutionStartTime(Aws::Utils::DateTime&& value) { SetExecutionStartTime(std::move(value)); return *this;} ///@} ///@{ /** *The time the execution finished.
*/ 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 AutomationExecution& WithExecutionEndTime(const Aws::Utils::DateTime& value) { SetExecutionEndTime(value); return *this;} inline AutomationExecution& WithExecutionEndTime(Aws::Utils::DateTime&& value) { SetExecutionEndTime(std::move(value)); return *this;} ///@} ///@{ /** *The execution status of the Automation.
*/ 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 AutomationExecution& WithAutomationExecutionStatus(const AutomationExecutionStatus& value) { SetAutomationExecutionStatus(value); return *this;} inline AutomationExecution& WithAutomationExecutionStatus(AutomationExecutionStatus&& value) { SetAutomationExecutionStatus(std::move(value)); return *this;} ///@} ///@{ /** *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.
*/ inline const Aws::VectorA 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.
*/ inline bool GetStepExecutionsTruncated() const{ return m_stepExecutionsTruncated; } inline bool StepExecutionsTruncatedHasBeenSet() const { return m_stepExecutionsTruncatedHasBeenSet; } inline void SetStepExecutionsTruncated(bool value) { m_stepExecutionsTruncatedHasBeenSet = true; m_stepExecutionsTruncated = value; } inline AutomationExecution& WithStepExecutionsTruncated(bool value) { SetStepExecutionsTruncated(value); return *this;} ///@} ///@{ /** *The key-value map of execution parameters, which were supplied when calling * StartAutomationExecution.
*/ inline const Aws::MapThe list of execution outputs as defined in the Automation runbook.
*/ inline const Aws::MapA message describing why an execution has failed, if the status is set to * Failed.
*/ 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 AutomationExecution& WithFailureMessage(const Aws::String& value) { SetFailureMessage(value); return *this;} inline AutomationExecution& WithFailureMessage(Aws::String&& value) { SetFailureMessage(std::move(value)); return *this;} inline AutomationExecution& WithFailureMessage(const char* value) { SetFailureMessage(value); return *this;} ///@} ///@{ /** *The 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 AutomationExecution& WithMode(const ExecutionMode& value) { SetMode(value); return *this;} inline AutomationExecution& WithMode(ExecutionMode&& value) { SetMode(std::move(value)); return *this;} ///@} ///@{ /** *The AutomationExecutionId 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 AutomationExecution& WithParentAutomationExecutionId(const Aws::String& value) { SetParentAutomationExecutionId(value); return *this;} inline AutomationExecution& WithParentAutomationExecutionId(Aws::String&& value) { SetParentAutomationExecutionId(std::move(value)); return *this;} inline AutomationExecution& WithParentAutomationExecutionId(const char* value) { SetParentAutomationExecutionId(value); return *this;} ///@} ///@{ /** *The Amazon Resource Name (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 AutomationExecution& WithExecutedBy(const Aws::String& value) { SetExecutedBy(value); return *this;} inline AutomationExecution& WithExecutedBy(Aws::String&& value) { SetExecutedBy(std::move(value)); return *this;} inline AutomationExecution& WithExecutedBy(const char* value) { SetExecutedBy(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 AutomationExecution& WithCurrentStepName(const Aws::String& value) { SetCurrentStepName(value); return *this;} inline AutomationExecution& WithCurrentStepName(Aws::String&& value) { SetCurrentStepName(std::move(value)); return *this;} inline AutomationExecution& 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 AutomationExecution& WithCurrentAction(const Aws::String& value) { SetCurrentAction(value); return *this;} inline AutomationExecution& WithCurrentAction(Aws::String&& value) { SetCurrentAction(std::move(value)); return *this;} inline AutomationExecution& WithCurrentAction(const char* value) { SetCurrentAction(value); return *this;} ///@} ///@{ /** *The parameter name.
*/ 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 AutomationExecution& WithTargetParameterName(const Aws::String& value) { SetTargetParameterName(value); return *this;} inline AutomationExecution& WithTargetParameterName(Aws::String&& value) { SetTargetParameterName(std::move(value)); return *this;} inline AutomationExecution& WithTargetParameterName(const char* value) { SetTargetParameterName(value); return *this;} ///@} ///@{ /** *The specified targets.
*/ inline const Aws::VectorThe specified key-value mapping of document parameters to target * resources.
*/ inline const Aws::VectorA list of resolved targets in the rate control 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 AutomationExecution& WithResolvedTargets(const ResolvedTargets& value) { SetResolvedTargets(value); return *this;} inline AutomationExecution& WithResolvedTargets(ResolvedTargets&& value) { SetResolvedTargets(std::move(value)); return *this;} ///@} ///@{ /** *The MaxConcurrency value specified by the user when the
* execution started.
The MaxErrors value specified by the user when the execution started.
*/ inline const Aws::String& GetMaxErrors() const{ return m_maxErrors; } inline bool MaxErrorsHasBeenSet() const { return m_maxErrorsHasBeenSet; } inline void SetMaxErrors(const Aws::String& value) { m_maxErrorsHasBeenSet = true; m_maxErrors = value; } inline void SetMaxErrors(Aws::String&& value) { m_maxErrorsHasBeenSet = true; m_maxErrors = std::move(value); } inline void SetMaxErrors(const char* value) { m_maxErrorsHasBeenSet = true; m_maxErrors.assign(value); } inline AutomationExecution& WithMaxErrors(const Aws::String& value) { SetMaxErrors(value); return *this;} inline AutomationExecution& WithMaxErrors(Aws::String&& value) { SetMaxErrors(std::move(value)); return *this;} inline AutomationExecution& WithMaxErrors(const char* value) { SetMaxErrors(value); return *this;} ///@} ///@{ /** *The target of the execution.
*/ 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 AutomationExecution& WithTarget(const Aws::String& value) { SetTarget(value); return *this;} inline AutomationExecution& WithTarget(Aws::String&& value) { SetTarget(std::move(value)); return *this;} inline AutomationExecution& WithTarget(const char* value) { SetTarget(value); return *this;} ///@} ///@{ /** *The combination of Amazon Web Services Regions and/or Amazon Web Services * accounts where you want to run the Automation.
*/ inline const Aws::VectorAn aggregate of step execution statuses displayed in the Amazon Web Services * Systems Manager console for a multi-Region and multi-account Automation * execution.
*/ inline const ProgressCounters& GetProgressCounters() const{ return m_progressCounters; } inline bool ProgressCountersHasBeenSet() const { return m_progressCountersHasBeenSet; } inline void SetProgressCounters(const ProgressCounters& value) { m_progressCountersHasBeenSet = true; m_progressCounters = value; } inline void SetProgressCounters(ProgressCounters&& value) { m_progressCountersHasBeenSet = true; m_progressCounters = std::move(value); } inline AutomationExecution& WithProgressCounters(const ProgressCounters& value) { SetProgressCounters(value); return *this;} inline AutomationExecution& WithProgressCounters(ProgressCounters&& value) { SetProgressCounters(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 AutomationExecution& WithAlarmConfiguration(const AlarmConfiguration& value) { SetAlarmConfiguration(value); return *this;} inline AutomationExecution& 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 AutomationExecution& WithScheduledTime(const Aws::Utils::DateTime& value) { SetScheduledTime(value); return *this;} inline AutomationExecution& WithScheduledTime(Aws::Utils::DateTime&& value) { SetScheduledTime(std::move(value)); return *this;} ///@} ///@{ /** *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.
*/ 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 AutomationExecution& WithOpsItemId(const Aws::String& value) { SetOpsItemId(value); return *this;} inline AutomationExecution& WithOpsItemId(Aws::String&& value) { SetOpsItemId(std::move(value)); return *this;} inline AutomationExecution& 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 AutomationExecution& WithAssociationId(const Aws::String& value) { SetAssociationId(value); return *this;} inline AutomationExecution& WithAssociationId(Aws::String&& value) { SetAssociationId(std::move(value)); return *this;} inline AutomationExecution& 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 AutomationExecution& WithChangeRequestName(const Aws::String& value) { SetChangeRequestName(value); return *this;} inline AutomationExecution& WithChangeRequestName(Aws::String&& value) { SetChangeRequestName(std::move(value)); return *this;} inline AutomationExecution& WithChangeRequestName(const char* value) { SetChangeRequestName(value); return *this;} ///@} ///@{ /** *Variables defined for the automation.
*/ inline const Aws::Map