@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AutomationExecutionMetadata extends Object implements Serializable, Cloneable, StructuredPojo
Details about a specific Automation execution.
Constructor and Description |
---|
AutomationExecutionMetadata() |
Modifier and Type | Method and Description |
---|---|
AutomationExecutionMetadata |
addOutputsEntry(String key,
List<String> value) |
AutomationExecutionMetadata |
clearOutputsEntries()
Removes all the entries added into Outputs.
|
AutomationExecutionMetadata |
clone() |
boolean |
equals(Object obj) |
String |
getAutomationExecutionId()
The execution ID.
|
String |
getAutomationExecutionStatus()
The status of the execution.
|
String |
getAutomationType()
Use this filter with DescribeAutomationExecutions.
|
String |
getCurrentAction()
The action of the step that is currently running.
|
String |
getCurrentStepName()
The name of the step that is currently running.
|
String |
getDocumentName()
The name of the Automation document used during execution.
|
String |
getDocumentVersion()
The document version used during the execution.
|
String |
getExecutedBy()
The IAM role ARN of the user who ran the Automation.
|
Date |
getExecutionEndTime()
The time the execution finished.
|
Date |
getExecutionStartTime()
The time the execution started.>
|
String |
getFailureMessage()
The list of execution outputs as defined in the Automation document.
|
String |
getLogFile()
An Amazon S3 bucket where execution information is stored.
|
String |
getMaxConcurrency()
The MaxConcurrency value specified by the user when starting the Automation.
|
String |
getMaxErrors()
The MaxErrors value specified by the user when starting the Automation.
|
String |
getMode()
The Automation execution mode.
|
Map<String,List<String>> |
getOutputs()
The list of execution outputs as defined in the Automation document.
|
String |
getParentAutomationExecutionId()
The ExecutionId of the parent Automation.
|
ResolvedTargets |
getResolvedTargets()
A list of targets that resolved during the execution.
|
String |
getTarget()
The list of execution outputs as defined in the Automation document.
|
List<Map<String,List<String>>> |
getTargetMaps()
The specified key-value mapping of document parameters to target resources.
|
String |
getTargetParameterName()
The list of execution outputs as defined in the Automation document.
|
List<Target> |
getTargets()
The targets defined by the user when starting the Automation.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAutomationExecutionId(String automationExecutionId)
The execution ID.
|
void |
setAutomationExecutionStatus(AutomationExecutionStatus automationExecutionStatus)
The status of the execution.
|
void |
setAutomationExecutionStatus(String automationExecutionStatus)
The status of the execution.
|
void |
setAutomationType(AutomationType automationType)
Use this filter with DescribeAutomationExecutions.
|
void |
setAutomationType(String automationType)
Use this filter with DescribeAutomationExecutions.
|
void |
setCurrentAction(String currentAction)
The action of the step that is currently running.
|
void |
setCurrentStepName(String currentStepName)
The name of the step that is currently running.
|
void |
setDocumentName(String documentName)
The name of the Automation document used during execution.
|
void |
setDocumentVersion(String documentVersion)
The document version used during the execution.
|
void |
setExecutedBy(String executedBy)
The IAM role ARN of the user who ran the Automation.
|
void |
setExecutionEndTime(Date executionEndTime)
The time the execution finished.
|
void |
setExecutionStartTime(Date executionStartTime)
The time the execution started.>
|
void |
setFailureMessage(String failureMessage)
The list of execution outputs as defined in the Automation document.
|
void |
setLogFile(String logFile)
An Amazon S3 bucket where execution information is stored.
|
void |
setMaxConcurrency(String maxConcurrency)
The MaxConcurrency value specified by the user when starting the Automation.
|
void |
setMaxErrors(String maxErrors)
The MaxErrors value specified by the user when starting the Automation.
|
void |
setMode(ExecutionMode mode)
The Automation execution mode.
|
void |
setMode(String mode)
The Automation execution mode.
|
void |
setOutputs(Map<String,List<String>> outputs)
The list of execution outputs as defined in the Automation document.
|
void |
setParentAutomationExecutionId(String parentAutomationExecutionId)
The ExecutionId of the parent Automation.
|
void |
setResolvedTargets(ResolvedTargets resolvedTargets)
A list of targets that resolved during the execution.
|
void |
setTarget(String target)
The list of execution outputs as defined in the Automation document.
|
void |
setTargetMaps(Collection<Map<String,List<String>>> targetMaps)
The specified key-value mapping of document parameters to target resources.
|
void |
setTargetParameterName(String targetParameterName)
The list of execution outputs as defined in the Automation document.
|
void |
setTargets(Collection<Target> targets)
The targets defined by the user when starting the Automation.
|
String |
toString()
Returns a string representation of this object.
|
AutomationExecutionMetadata |
withAutomationExecutionId(String automationExecutionId)
The execution ID.
|
AutomationExecutionMetadata |
withAutomationExecutionStatus(AutomationExecutionStatus automationExecutionStatus)
The status of the execution.
|
AutomationExecutionMetadata |
withAutomationExecutionStatus(String automationExecutionStatus)
The status of the execution.
|
AutomationExecutionMetadata |
withAutomationType(AutomationType automationType)
Use this filter with DescribeAutomationExecutions.
|
AutomationExecutionMetadata |
withAutomationType(String automationType)
Use this filter with DescribeAutomationExecutions.
|
AutomationExecutionMetadata |
withCurrentAction(String currentAction)
The action of the step that is currently running.
|
AutomationExecutionMetadata |
withCurrentStepName(String currentStepName)
The name of the step that is currently running.
|
AutomationExecutionMetadata |
withDocumentName(String documentName)
The name of the Automation document used during execution.
|
AutomationExecutionMetadata |
withDocumentVersion(String documentVersion)
The document version used during the execution.
|
AutomationExecutionMetadata |
withExecutedBy(String executedBy)
The IAM role ARN of the user who ran the Automation.
|
AutomationExecutionMetadata |
withExecutionEndTime(Date executionEndTime)
The time the execution finished.
|
AutomationExecutionMetadata |
withExecutionStartTime(Date executionStartTime)
The time the execution started.>
|
AutomationExecutionMetadata |
withFailureMessage(String failureMessage)
The list of execution outputs as defined in the Automation document.
|
AutomationExecutionMetadata |
withLogFile(String logFile)
An Amazon S3 bucket where execution information is stored.
|
AutomationExecutionMetadata |
withMaxConcurrency(String maxConcurrency)
The MaxConcurrency value specified by the user when starting the Automation.
|
AutomationExecutionMetadata |
withMaxErrors(String maxErrors)
The MaxErrors value specified by the user when starting the Automation.
|
AutomationExecutionMetadata |
withMode(ExecutionMode mode)
The Automation execution mode.
|
AutomationExecutionMetadata |
withMode(String mode)
The Automation execution mode.
|
AutomationExecutionMetadata |
withOutputs(Map<String,List<String>> outputs)
The list of execution outputs as defined in the Automation document.
|
AutomationExecutionMetadata |
withParentAutomationExecutionId(String parentAutomationExecutionId)
The ExecutionId of the parent Automation.
|
AutomationExecutionMetadata |
withResolvedTargets(ResolvedTargets resolvedTargets)
A list of targets that resolved during the execution.
|
AutomationExecutionMetadata |
withTarget(String target)
The list of execution outputs as defined in the Automation document.
|
AutomationExecutionMetadata |
withTargetMaps(Collection<Map<String,List<String>>> targetMaps)
The specified key-value mapping of document parameters to target resources.
|
AutomationExecutionMetadata |
withTargetMaps(Map<String,List<String>>... targetMaps)
The specified key-value mapping of document parameters to target resources.
|
AutomationExecutionMetadata |
withTargetParameterName(String targetParameterName)
The list of execution outputs as defined in the Automation document.
|
AutomationExecutionMetadata |
withTargets(Collection<Target> targets)
The targets defined by the user when starting the Automation.
|
AutomationExecutionMetadata |
withTargets(Target... targets)
The targets defined by the user when starting the Automation.
|
public void setAutomationExecutionId(String automationExecutionId)
The execution ID.
automationExecutionId
- The execution ID.public String getAutomationExecutionId()
The execution ID.
public AutomationExecutionMetadata withAutomationExecutionId(String automationExecutionId)
The execution ID.
automationExecutionId
- The execution ID.public void setDocumentName(String documentName)
The name of the Automation document used during execution.
documentName
- The name of the Automation document used during execution.public String getDocumentName()
The name of the Automation document used during execution.
public AutomationExecutionMetadata withDocumentName(String documentName)
The name of the Automation document used during execution.
documentName
- The name of the Automation document used during execution.public void setDocumentVersion(String documentVersion)
The document version used during the execution.
documentVersion
- The document version used during the execution.public String getDocumentVersion()
The document version used during the execution.
public AutomationExecutionMetadata withDocumentVersion(String documentVersion)
The document version used during the execution.
documentVersion
- The document version used during the execution.public void setAutomationExecutionStatus(String automationExecutionStatus)
The status of the execution. Valid values include: Running, Succeeded, Failed, Timed out, or Cancelled.
automationExecutionStatus
- The status of the execution. Valid values include: Running, Succeeded, Failed, Timed out, or Cancelled.AutomationExecutionStatus
public String getAutomationExecutionStatus()
The status of the execution. Valid values include: Running, Succeeded, Failed, Timed out, or Cancelled.
AutomationExecutionStatus
public AutomationExecutionMetadata withAutomationExecutionStatus(String automationExecutionStatus)
The status of the execution. Valid values include: Running, Succeeded, Failed, Timed out, or Cancelled.
automationExecutionStatus
- The status of the execution. Valid values include: Running, Succeeded, Failed, Timed out, or Cancelled.AutomationExecutionStatus
public void setAutomationExecutionStatus(AutomationExecutionStatus automationExecutionStatus)
The status of the execution. Valid values include: Running, Succeeded, Failed, Timed out, or Cancelled.
automationExecutionStatus
- The status of the execution. Valid values include: Running, Succeeded, Failed, Timed out, or Cancelled.AutomationExecutionStatus
public AutomationExecutionMetadata withAutomationExecutionStatus(AutomationExecutionStatus automationExecutionStatus)
The status of the execution. Valid values include: Running, Succeeded, Failed, Timed out, or Cancelled.
automationExecutionStatus
- The status of the execution. Valid values include: Running, Succeeded, Failed, Timed out, or Cancelled.AutomationExecutionStatus
public void setExecutionStartTime(Date executionStartTime)
The time the execution started.>
executionStartTime
- The time the execution started.>public Date getExecutionStartTime()
The time the execution started.>
public AutomationExecutionMetadata withExecutionStartTime(Date executionStartTime)
The time the execution started.>
executionStartTime
- The time the execution started.>public void setExecutionEndTime(Date executionEndTime)
The time the execution finished. This is not populated if the execution is still in progress.
executionEndTime
- The time the execution finished. This is not populated if the execution is still in progress.public Date getExecutionEndTime()
The time the execution finished. This is not populated if the execution is still in progress.
public AutomationExecutionMetadata withExecutionEndTime(Date executionEndTime)
The time the execution finished. This is not populated if the execution is still in progress.
executionEndTime
- The time the execution finished. This is not populated if the execution is still in progress.public void setExecutedBy(String executedBy)
The IAM role ARN of the user who ran the Automation.
executedBy
- The IAM role ARN of the user who ran the Automation.public String getExecutedBy()
The IAM role ARN of the user who ran the Automation.
public AutomationExecutionMetadata withExecutedBy(String executedBy)
The IAM role ARN of the user who ran the Automation.
executedBy
- The IAM role ARN of the user who ran the Automation.public void setLogFile(String logFile)
An Amazon S3 bucket where execution information is stored.
logFile
- An Amazon S3 bucket where execution information is stored.public String getLogFile()
An Amazon S3 bucket where execution information is stored.
public AutomationExecutionMetadata withLogFile(String logFile)
An Amazon S3 bucket where execution information is stored.
logFile
- An Amazon S3 bucket where execution information is stored.public Map<String,List<String>> getOutputs()
The list of execution outputs as defined in the Automation document.
public void setOutputs(Map<String,List<String>> outputs)
The list of execution outputs as defined in the Automation document.
outputs
- The list of execution outputs as defined in the Automation document.public AutomationExecutionMetadata withOutputs(Map<String,List<String>> outputs)
The list of execution outputs as defined in the Automation document.
outputs
- The list of execution outputs as defined in the Automation document.public AutomationExecutionMetadata addOutputsEntry(String key, List<String> value)
public AutomationExecutionMetadata clearOutputsEntries()
public void setMode(String mode)
The Automation execution mode.
mode
- The Automation execution mode.ExecutionMode
public String getMode()
The Automation execution mode.
ExecutionMode
public AutomationExecutionMetadata withMode(String mode)
The Automation execution mode.
mode
- The Automation execution mode.ExecutionMode
public void setMode(ExecutionMode mode)
The Automation execution mode.
mode
- The Automation execution mode.ExecutionMode
public AutomationExecutionMetadata withMode(ExecutionMode mode)
The Automation execution mode.
mode
- The Automation execution mode.ExecutionMode
public void setParentAutomationExecutionId(String parentAutomationExecutionId)
The ExecutionId of the parent Automation.
parentAutomationExecutionId
- The ExecutionId of the parent Automation.public String getParentAutomationExecutionId()
The ExecutionId of the parent Automation.
public AutomationExecutionMetadata withParentAutomationExecutionId(String parentAutomationExecutionId)
The ExecutionId of the parent Automation.
parentAutomationExecutionId
- The ExecutionId of the parent Automation.public void setCurrentStepName(String currentStepName)
The name of the step that is currently running.
currentStepName
- The name of the step that is currently running.public String getCurrentStepName()
The name of the step that is currently running.
public AutomationExecutionMetadata withCurrentStepName(String currentStepName)
The name of the step that is currently running.
currentStepName
- The name of the step that is currently running.public void setCurrentAction(String currentAction)
The action of the step that is currently running.
currentAction
- The action of the step that is currently running.public String getCurrentAction()
The action of the step that is currently running.
public AutomationExecutionMetadata withCurrentAction(String currentAction)
The action of the step that is currently running.
currentAction
- The action of the step that is currently running.public void setFailureMessage(String failureMessage)
The list of execution outputs as defined in the Automation document.
failureMessage
- The list of execution outputs as defined in the Automation document.public String getFailureMessage()
The list of execution outputs as defined in the Automation document.
public AutomationExecutionMetadata withFailureMessage(String failureMessage)
The list of execution outputs as defined in the Automation document.
failureMessage
- The list of execution outputs as defined in the Automation document.public void setTargetParameterName(String targetParameterName)
The list of execution outputs as defined in the Automation document.
targetParameterName
- The list of execution outputs as defined in the Automation document.public String getTargetParameterName()
The list of execution outputs as defined in the Automation document.
public AutomationExecutionMetadata withTargetParameterName(String targetParameterName)
The list of execution outputs as defined in the Automation document.
targetParameterName
- The list of execution outputs as defined in the Automation document.public List<Target> getTargets()
The targets defined by the user when starting the Automation.
public void setTargets(Collection<Target> targets)
The targets defined by the user when starting the Automation.
targets
- The targets defined by the user when starting the Automation.public AutomationExecutionMetadata withTargets(Target... targets)
The targets defined by the user when starting the Automation.
NOTE: This method appends the values to the existing list (if any). Use
setTargets(java.util.Collection)
or withTargets(java.util.Collection)
if you want to override
the existing values.
targets
- The targets defined by the user when starting the Automation.public AutomationExecutionMetadata withTargets(Collection<Target> targets)
The targets defined by the user when starting the Automation.
targets
- The targets defined by the user when starting the Automation.public List<Map<String,List<String>>> getTargetMaps()
The specified key-value mapping of document parameters to target resources.
public void setTargetMaps(Collection<Map<String,List<String>>> targetMaps)
The specified key-value mapping of document parameters to target resources.
targetMaps
- The specified key-value mapping of document parameters to target resources.public AutomationExecutionMetadata withTargetMaps(Map<String,List<String>>... targetMaps)
The specified key-value mapping of document parameters to target resources.
NOTE: This method appends the values to the existing list (if any). Use
setTargetMaps(java.util.Collection)
or withTargetMaps(java.util.Collection)
if you want to
override the existing values.
targetMaps
- The specified key-value mapping of document parameters to target resources.public AutomationExecutionMetadata withTargetMaps(Collection<Map<String,List<String>>> targetMaps)
The specified key-value mapping of document parameters to target resources.
targetMaps
- The specified key-value mapping of document parameters to target resources.public void setResolvedTargets(ResolvedTargets resolvedTargets)
A list of targets that resolved during the execution.
resolvedTargets
- A list of targets that resolved during the execution.public ResolvedTargets getResolvedTargets()
A list of targets that resolved during the execution.
public AutomationExecutionMetadata withResolvedTargets(ResolvedTargets resolvedTargets)
A list of targets that resolved during the execution.
resolvedTargets
- A list of targets that resolved during the execution.public void setMaxConcurrency(String maxConcurrency)
The MaxConcurrency value specified by the user when starting the Automation.
maxConcurrency
- The MaxConcurrency value specified by the user when starting the Automation.public String getMaxConcurrency()
The MaxConcurrency value specified by the user when starting the Automation.
public AutomationExecutionMetadata withMaxConcurrency(String maxConcurrency)
The MaxConcurrency value specified by the user when starting the Automation.
maxConcurrency
- The MaxConcurrency value specified by the user when starting the Automation.public void setMaxErrors(String maxErrors)
The MaxErrors value specified by the user when starting the Automation.
maxErrors
- The MaxErrors value specified by the user when starting the Automation.public String getMaxErrors()
The MaxErrors value specified by the user when starting the Automation.
public AutomationExecutionMetadata withMaxErrors(String maxErrors)
The MaxErrors value specified by the user when starting the Automation.
maxErrors
- The MaxErrors value specified by the user when starting the Automation.public void setTarget(String target)
The list of execution outputs as defined in the Automation document.
target
- The list of execution outputs as defined in the Automation document.public String getTarget()
The list of execution outputs as defined in the Automation document.
public AutomationExecutionMetadata withTarget(String target)
The list of execution outputs as defined in the Automation document.
target
- The list of execution outputs as defined in the Automation document.public void setAutomationType(String automationType)
Use this filter with DescribeAutomationExecutions. Specify either Local or CrossAccount. CrossAccount is an Automation that runs in multiple AWS Regions and accounts. For more information, see Executing Automations in Multiple AWS Regions and Accounts in the AWS Systems Manager User Guide.
automationType
- Use this filter with DescribeAutomationExecutions. Specify either Local or CrossAccount.
CrossAccount is an Automation that runs in multiple AWS Regions and accounts. For more information, see Executing Automations in Multiple AWS Regions and Accounts in the AWS Systems Manager User
Guide.AutomationType
public String getAutomationType()
Use this filter with DescribeAutomationExecutions. Specify either Local or CrossAccount. CrossAccount is an Automation that runs in multiple AWS Regions and accounts. For more information, see Executing Automations in Multiple AWS Regions and Accounts in the AWS Systems Manager User Guide.
AutomationType
public AutomationExecutionMetadata withAutomationType(String automationType)
Use this filter with DescribeAutomationExecutions. Specify either Local or CrossAccount. CrossAccount is an Automation that runs in multiple AWS Regions and accounts. For more information, see Executing Automations in Multiple AWS Regions and Accounts in the AWS Systems Manager User Guide.
automationType
- Use this filter with DescribeAutomationExecutions. Specify either Local or CrossAccount.
CrossAccount is an Automation that runs in multiple AWS Regions and accounts. For more information, see Executing Automations in Multiple AWS Regions and Accounts in the AWS Systems Manager User
Guide.AutomationType
public void setAutomationType(AutomationType automationType)
Use this filter with DescribeAutomationExecutions. Specify either Local or CrossAccount. CrossAccount is an Automation that runs in multiple AWS Regions and accounts. For more information, see Executing Automations in Multiple AWS Regions and Accounts in the AWS Systems Manager User Guide.
automationType
- Use this filter with DescribeAutomationExecutions. Specify either Local or CrossAccount.
CrossAccount is an Automation that runs in multiple AWS Regions and accounts. For more information, see Executing Automations in Multiple AWS Regions and Accounts in the AWS Systems Manager User
Guide.AutomationType
public AutomationExecutionMetadata withAutomationType(AutomationType automationType)
Use this filter with DescribeAutomationExecutions. Specify either Local or CrossAccount. CrossAccount is an Automation that runs in multiple AWS Regions and accounts. For more information, see Executing Automations in Multiple AWS Regions and Accounts in the AWS Systems Manager User Guide.
automationType
- Use this filter with DescribeAutomationExecutions. Specify either Local or CrossAccount.
CrossAccount is an Automation that runs in multiple AWS Regions and accounts. For more information, see Executing Automations in Multiple AWS Regions and Accounts in the AWS Systems Manager User
Guide.AutomationType
public String toString()
toString
in class Object
Object.toString()
public AutomationExecutionMetadata clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.