AutomationExecution (AWS Java SDK :: Services :: AWS Simple Systems Management (SSM) 2.17.237 API)

java.lang.Object
- software.amazon.awssdk.services.ssm.model.AutomationExecution

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AutomationExecution.Builder,AutomationExecution>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class AutomationExecution
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AutomationExecution.Builder,AutomationExecution>
```
Detailed information about the current state of an individual Automation execution.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface AutomationExecution.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`AutomationExecution.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`associationId()` The ID of a State Manager association used in the Automation operation.
`String`	`automationExecutionId()` The execution ID.
`AutomationExecutionStatus`	`automationExecutionStatus()` The execution status of the Automation.
`String`	`automationExecutionStatusAsString()` The execution status of the Automation.
`AutomationSubtype`	`automationSubtype()` The subtype of the Automation operation.
`String`	`automationSubtypeAsString()` The subtype of the Automation operation.
`static AutomationExecution.Builder`	`builder()`
`String`	`changeRequestName()` The name of the Change Manager change request.
`String`	`currentAction()` The action of the step that is currently running.
`String`	`currentStepName()` The name of the step that is currently running.
`String`	`documentName()` The name of the Automation runbook used during the execution.
`String`	`documentVersion()` The version of the document to use during execution.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`executedBy()` The Amazon Resource Name (ARN) of the user who ran the automation.
`Instant`	`executionEndTime()` The time the execution finished.
`Instant`	`executionStartTime()` The time the execution started.
`String`	`failureMessage()` A message describing why an execution has failed, if the status is set to Failed.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasOutputs()` For responses, this returns true if the service returned a value for the Outputs property.
`boolean`	`hasParameters()` For responses, this returns true if the service returned a value for the Parameters property.
`boolean`	`hasRunbooks()` For responses, this returns true if the service returned a value for the Runbooks property.
`boolean`	`hasStepExecutions()` For responses, this returns true if the service returned a value for the StepExecutions property.
`boolean`	`hasTargetLocations()` For responses, this returns true if the service returned a value for the TargetLocations property.
`boolean`	`hasTargetMaps()` For responses, this returns true if the service returned a value for the TargetMaps property.
`boolean`	`hasTargets()` For responses, this returns true if the service returned a value for the Targets property.
`String`	`maxConcurrency()` The `MaxConcurrency` value specified by the user when the execution started.
`String`	`maxErrors()` The MaxErrors value specified by the user when the execution started.
`ExecutionMode`	`mode()` The automation execution mode.
`String`	`modeAsString()` The automation execution mode.
`String`	`opsItemId()` The ID of an OpsItem that is created to represent a Change Manager change request.
`Map<String,List<String>>`	`outputs()` The list of execution outputs as defined in the Automation runbook.
`Map<String,List<String>>`	`parameters()` The key-value map of execution parameters, which were supplied when calling StartAutomationExecution.
`String`	`parentAutomationExecutionId()` The AutomationExecutionId of the parent automation.
`ProgressCounters`	`progressCounters()` An aggregate of step execution statuses displayed in the Amazon Web Services Systems Manager console for a multi-Region and multi-account Automation execution.
`ResolvedTargets`	`resolvedTargets()` A list of resolved targets in the rate control execution.
`List<Runbook>`	`runbooks()` Information about the Automation runbooks that are run as part of a runbook workflow.
`Instant`	`scheduledTime()` The date and time the Automation operation is scheduled to start.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AutomationExecution.Builder>`	`serializableBuilderClass()`
`List<StepExecution>`	`stepExecutions()` A list of details about the current state of all steps that comprise an execution.
`Boolean`	`stepExecutionsTruncated()` A boolean value that indicates if the response contains the full list of the Automation step executions.
`String`	`target()` The target of the execution.
`List<TargetLocation>`	`targetLocations()` The combination of Amazon Web Services Regions and/or Amazon Web Services accounts where you want to run the Automation.
`List<Map<String,List<String>>>`	`targetMaps()` The specified key-value mapping of document parameters to target resources.
`String`	`targetParameterName()` The parameter name.
`List<Target>`	`targets()` The specified targets.
`AutomationExecution.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - automationExecutionId
```
public final String automationExecutionId()
```
    The execution ID.
    
    Returns:
    
    The execution ID.
  - documentName
```
public final String documentName()
```
    The name of the Automation runbook used during the execution.
    
    Returns:
    
    The name of the Automation runbook used during the execution.
  - documentVersion
```
public final String documentVersion()
```
    The version of the document to use during execution.
    
    Returns:
    
    The version of the document to use during execution.
  - executionStartTime
```
public final Instant executionStartTime()
```
    The time the execution started.
    
    Returns:
    
    The time the execution started.
  - executionEndTime
```
public final Instant executionEndTime()
```
    The time the execution finished.
    
    Returns:
    
    The time the execution finished.
  - automationExecutionStatus
```
public final AutomationExecutionStatus automationExecutionStatus()
```
    The execution status of the Automation.
    
    If the service returns an enum value that is not available in the current SDK version, automationExecutionStatus will return AutomationExecutionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from automationExecutionStatusAsString().
    
    Returns:
    
    The execution status of the Automation.
    
    See Also:
    
    AutomationExecutionStatus
  - automationExecutionStatusAsString
```
public final String automationExecutionStatusAsString()
```
    The execution status of the Automation.
    
    If the service returns an enum value that is not available in the current SDK version, automationExecutionStatus will return AutomationExecutionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from automationExecutionStatusAsString().
    
    Returns:
    
    The execution status of the Automation.
    
    See Also:
    
    AutomationExecutionStatus
  - hasStepExecutions
```
public final boolean hasStepExecutions()
```
    For responses, this returns true if the service returned a value for the StepExecutions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - stepExecutions
```
public final List<StepExecution> stepExecutions()
```
    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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasStepExecutions() method.
    
    Returns:
    
    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.
  - stepExecutionsTruncated
```
public final Boolean stepExecutionsTruncated()
```
    A 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.
    
    Returns:
    
    A 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.
  - hasParameters
```
public final boolean hasParameters()
```
    For responses, this returns true if the service returned a value for the Parameters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - parameters
```
public final Map<String,List<String>> parameters()
```
    The key-value map of execution parameters, which were supplied when calling StartAutomationExecution.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasParameters() method.
    
    Returns:
    
    The key-value map of execution parameters, which were supplied when calling StartAutomationExecution.
  - hasOutputs
```
public final boolean hasOutputs()
```
    For responses, this returns true if the service returned a value for the Outputs property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - outputs
```
public final Map<String,List<String>> outputs()
```
    The list of execution outputs as defined in the Automation runbook.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOutputs() method.
    
    Returns:
    
    The list of execution outputs as defined in the Automation runbook.
  - failureMessage
```
public final String failureMessage()
```
    A message describing why an execution has failed, if the status is set to Failed.
    
    Returns:
    
    A message describing why an execution has failed, if the status is set to Failed.
  - mode
```
public final ExecutionMode mode()
```
    The automation execution mode.
    
    If the service returns an enum value that is not available in the current SDK version, mode will return ExecutionMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modeAsString().
    
    Returns:
    
    The automation execution mode.
    
    See Also:
    
    ExecutionMode
  - modeAsString
```
public final String modeAsString()
```
    The automation execution mode.
    
    If the service returns an enum value that is not available in the current SDK version, mode will return ExecutionMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modeAsString().
    
    Returns:
    
    The automation execution mode.
    
    See Also:
    
    ExecutionMode
  - parentAutomationExecutionId
```
public final String parentAutomationExecutionId()
```
    The AutomationExecutionId of the parent automation.
    
    Returns:
    
    The AutomationExecutionId of the parent automation.
  - executedBy
```
public final String executedBy()
```
    The Amazon Resource Name (ARN) of the user who ran the automation.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the user who ran the automation.
  - currentStepName
```
public final String currentStepName()
```
    The name of the step that is currently running.
    
    Returns:
    
    The name of the step that is currently running.
  - currentAction
```
public final String currentAction()
```
    The action of the step that is currently running.
    
    Returns:
    
    The action of the step that is currently running.
  - targetParameterName
```
public final String targetParameterName()
```
    The parameter name.
    
    Returns:
    
    The parameter name.
  - hasTargets
```
public final boolean hasTargets()
```
    For responses, this returns true if the service returned a value for the Targets property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - targets
```
public final List<Target> targets()
```
    The specified targets.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTargets() method.
    
    Returns:
    
    The specified targets.
  - hasTargetMaps
```
public final boolean hasTargetMaps()
```
    For responses, this returns true if the service returned a value for the TargetMaps property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - targetMaps
```
public final List<Map<String,List<String>>> targetMaps()
```
    The specified key-value mapping of document parameters to target resources.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTargetMaps() method.
    
    Returns:
    
    The specified key-value mapping of document parameters to target resources.
  - resolvedTargets
```
public final ResolvedTargets resolvedTargets()
```
    A list of resolved targets in the rate control execution.
    
    Returns:
    
    A list of resolved targets in the rate control execution.
  - maxConcurrency
```
public final String maxConcurrency()
```
    The MaxConcurrency value specified by the user when the execution started.
    
    Returns:
    
    The MaxConcurrency value specified by the user when the execution started.
  - maxErrors
```
public final String maxErrors()
```
    The MaxErrors value specified by the user when the execution started.
    
    Returns:
    
    The MaxErrors value specified by the user when the execution started.
  - target
```
public final String target()
```
    The target of the execution.
    
    Returns:
    
    The target of the execution.
  - hasTargetLocations
```
public final boolean hasTargetLocations()
```
    For responses, this returns true if the service returned a value for the TargetLocations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - targetLocations
```
public final List<TargetLocation> targetLocations()
```
    The combination of Amazon Web Services Regions and/or Amazon Web Services accounts where you want to run the Automation.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTargetLocations() method.
    
    Returns:
    
    The combination of Amazon Web Services Regions and/or Amazon Web Services accounts where you want to run the Automation.
  - progressCounters
```
public final ProgressCounters progressCounters()
```
    An aggregate of step execution statuses displayed in the Amazon Web Services Systems Manager console for a multi-Region and multi-account Automation execution.
    
    Returns:
    
    An aggregate of step execution statuses displayed in the Amazon Web Services Systems Manager console for a multi-Region and multi-account Automation execution.
  - automationSubtype
```
public final AutomationSubtype automationSubtype()
```
    The subtype of the Automation operation. Currently, the only supported value is ChangeRequest.
    
    If the service returns an enum value that is not available in the current SDK version, automationSubtype will return AutomationSubtype.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from automationSubtypeAsString().
    
    Returns:
    
    The subtype of the Automation operation. Currently, the only supported value is ChangeRequest.
    
    See Also:
    
    AutomationSubtype
  - automationSubtypeAsString
```
public final String automationSubtypeAsString()
```
    The subtype of the Automation operation. Currently, the only supported value is ChangeRequest.
    
    If the service returns an enum value that is not available in the current SDK version, automationSubtype will return AutomationSubtype.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from automationSubtypeAsString().
    
    Returns:
    
    The subtype of the Automation operation. Currently, the only supported value is ChangeRequest.
    
    See Also:
    
    AutomationSubtype
  - scheduledTime
```
public final Instant scheduledTime()
```
    The date and time the Automation operation is scheduled to start.
    
    Returns:
    
    The date and time the Automation operation is scheduled to start.
  - hasRunbooks
```
public final boolean hasRunbooks()
```
    For responses, this returns true if the service returned a value for the Runbooks property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - runbooks
```
public final List<Runbook> runbooks()
```
    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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRunbooks() method.
    
    Returns:
    
    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.
  - opsItemId
```
public final String opsItemId()
```
    The ID of an OpsItem that is created to represent a Change Manager change request.
    
    Returns:
    
    The ID of an OpsItem that is created to represent a Change Manager change request.
  - associationId
```
public final String associationId()
```
    The ID of a State Manager association used in the Automation operation.
    
    Returns:
    
    The ID of a State Manager association used in the Automation operation.
  - changeRequestName
```
public final String changeRequestName()
```
    The name of the Change Manager change request.
    
    Returns:
    
    The name of the Change Manager change request.
  - toBuilder
```
public AutomationExecution.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AutomationExecution.Builder,AutomationExecution>
  - builder
```
public static AutomationExecution.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AutomationExecution.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class AutomationExecution

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

automationExecutionId

documentName

documentVersion

executionStartTime

executionEndTime

automationExecutionStatus

automationExecutionStatusAsString

hasStepExecutions

stepExecutions

stepExecutionsTruncated

hasParameters

parameters

hasOutputs

outputs

failureMessage

mode

modeAsString

parentAutomationExecutionId

executedBy

currentStepName

currentAction

targetParameterName

hasTargets

targets

hasTargetMaps

targetMaps

resolvedTargets

maxConcurrency

maxErrors

target

hasTargetLocations

targetLocations

progressCounters

automationSubtype

automationSubtypeAsString

scheduledTime

hasRunbooks

runbooks

opsItemId

associationId

changeRequestName

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields