AutomationExecutionMetadata (AWS SDK for Java

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

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<AutomationExecutionMetadata.Builder,AutomationExecutionMetadata>

@Generated(value="software.amazon.awssdk:codegen")
public final class AutomationExecutionMetadata
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AutomationExecutionMetadata.Builder,AutomationExecutionMetadata>

Details about a specific Automation execution.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface AutomationExecutionMetadata.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`automationExecutionId()` The execution ID.
`AutomationExecutionStatus`	`automationExecutionStatus()` The status of the execution.
`String`	`automationExecutionStatusAsString()` The status of the execution.
`AutomationType`	`automationType()` Use this filter with DescribeAutomationExecution.
`String`	`automationTypeAsString()` Use this filter with DescribeAutomationExecution.
`static AutomationExecutionMetadata.Builder`	`builder()`
`String`	`currentAction()` The action of the currently executing step.
`String`	`currentStepName()` The name of the currently executing step.
`String`	`documentName()` The name of the Automation document used during execution.
`String`	`documentVersion()` The document version used during the execution.
`boolean`	`equals(Object obj)`
`String`	`executedBy()` The IAM role ARN of the user who executed the Automation.
`Instant`	`executionEndTime()` The time the execution finished.
`Instant`	`executionStartTime()` The time the execution started.>
`String`	`failureMessage()` The list of execution outputs as defined in the Automation document.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`logFile()` An Amazon S3 bucket where execution information is stored.
`String`	`maxConcurrency()` The MaxConcurrency value specified by the user when starting the Automation.
`String`	`maxErrors()` The MaxErrors value specified by the user when starting the Automation.
`ExecutionMode`	`mode()` The Automation execution mode.
`String`	`modeAsString()` The Automation execution mode.
`Map<String,List<String>>`	`outputs()` The list of execution outputs as defined in the Automation document.
`String`	`parentAutomationExecutionId()` The ExecutionId of the parent Automation.
`ResolvedTargets`	`resolvedTargets()` A list of targets that resolved during the execution.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AutomationExecutionMetadata.Builder>`	`serializableBuilderClass()`
`String`	`target()` The list of execution outputs as defined in the Automation document.
`List<Map<String,List<String>>>`	`targetMaps()` The specified key-value mapping of document parameters to target resources.
`String`	`targetParameterName()` The list of execution outputs as defined in the Automation document.
`List<Target>`	`targets()` The targets defined by the user when starting the Automation.
`AutomationExecutionMetadata.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

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

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

- Method Detail
  - automationExecutionId
```
public String automationExecutionId()
```
    The execution ID.
    
    Returns:
    
    The execution ID.
  - documentName
```
public String documentName()
```
    The name of the Automation document used during execution.
    
    Returns:
    
    The name of the Automation document used during execution.
  - documentVersion
```
public String documentVersion()
```
    The document version used during the execution.
    
    Returns:
    
    The document version used during the execution.
  - automationExecutionStatus
```
public AutomationExecutionStatus automationExecutionStatus()
```
    The status of the execution. Valid values include: Running, Succeeded, Failed, Timed out, or Cancelled.
    
    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 status of the execution. Valid values include: Running, Succeeded, Failed, Timed out, or Cancelled.
    
    See Also:
    
    AutomationExecutionStatus
  - automationExecutionStatusAsString
```
public String automationExecutionStatusAsString()
```
    The status of the execution. Valid values include: Running, Succeeded, Failed, Timed out, or Cancelled.
    
    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 status of the execution. Valid values include: Running, Succeeded, Failed, Timed out, or Cancelled.
    
    See Also:
    
    AutomationExecutionStatus
  - executionStartTime
```
public Instant executionStartTime()
```
    The time the execution started.>
    
    Returns:
    
    The time the execution started.>
  - executionEndTime
```
public Instant executionEndTime()
```
    The time the execution finished. This is not populated if the execution is still in progress.
    
    Returns:
    
    The time the execution finished. This is not populated if the execution is still in progress.
  - executedBy
```
public String executedBy()
```
    The IAM role ARN of the user who executed the Automation.
    
    Returns:
    
    The IAM role ARN of the user who executed the Automation.
  - logFile
```
public String logFile()
```
    An Amazon S3 bucket where execution information is stored.
    
    Returns:
    
    An Amazon S3 bucket where execution information is stored.
  - outputs
```
public Map<String,List<String>> outputs()
```
    The list of execution outputs as defined in the Automation document.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The list of execution outputs as defined in the Automation document.
  - mode
```
public 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 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 String parentAutomationExecutionId()
```
    The ExecutionId of the parent Automation.
    
    Returns:
    
    The ExecutionId of the parent Automation.
  - currentStepName
```
public String currentStepName()
```
    The name of the currently executing step.
    
    Returns:
    
    The name of the currently executing step.
  - currentAction
```
public String currentAction()
```
    The action of the currently executing step.
    
    Returns:
    
    The action of the currently executing step.
  - failureMessage
```
public String failureMessage()
```
    The list of execution outputs as defined in the Automation document.
    
    Returns:
    
    The list of execution outputs as defined in the Automation document.
  - targetParameterName
```
public String targetParameterName()
```
    The list of execution outputs as defined in the Automation document.
    
    Returns:
    
    The list of execution outputs as defined in the Automation document.
  - targets
```
public List<Target> targets()
```
    The targets defined by the user when starting the Automation.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The targets defined by the user when starting the Automation.
  - targetMaps
```
public 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.
    
    Returns:
    
    The specified key-value mapping of document parameters to target resources.
  - resolvedTargets
```
public ResolvedTargets resolvedTargets()
```
    A list of targets that resolved during the execution.
    
    Returns:
    
    A list of targets that resolved during the execution.
  - maxConcurrency
```
public String maxConcurrency()
```
    The MaxConcurrency value specified by the user when starting the Automation.
    
    Returns:
    
    The MaxConcurrency value specified by the user when starting the Automation.
  - maxErrors
```
public String maxErrors()
```
    The MaxErrors value specified by the user when starting the Automation.
    
    Returns:
    
    The MaxErrors value specified by the user when starting the Automation.
  - target
```
public String target()
```
    The list of execution outputs as defined in the Automation document.
    
    Returns:
    
    The list of execution outputs as defined in the Automation document.
  - automationType
```
public AutomationType automationType()
```
    Use this filter with DescribeAutomationExecution. Specify either Local of CrossAccount. CrossAccount is an Automation that executes in multiple AWS Regions and accounts. For more information, see Concurrently Executing Automations in Multiple AWS Regions and Accounts in the AWS Systems Manager User Guide.
    
    If the service returns an enum value that is not available in the current SDK version, automationType will return AutomationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from automationTypeAsString().
    
    Returns:
    
    Use this filter with DescribeAutomationExecution. Specify either Local of CrossAccount. CrossAccount is an Automation that executes in multiple AWS Regions and accounts. For more information, see Concurrently Executing Automations in Multiple AWS Regions and Accounts in the AWS Systems Manager User Guide.
    
    See Also:
    
    AutomationType
  - automationTypeAsString
```
public String automationTypeAsString()
```
    Use this filter with DescribeAutomationExecution. Specify either Local of CrossAccount. CrossAccount is an Automation that executes in multiple AWS Regions and accounts. For more information, see Concurrently Executing Automations in Multiple AWS Regions and Accounts in the AWS Systems Manager User Guide.
    
    If the service returns an enum value that is not available in the current SDK version, automationType will return AutomationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from automationTypeAsString().
    
    Returns:
    
    Use this filter with DescribeAutomationExecution. Specify either Local of CrossAccount. CrossAccount is an Automation that executes in multiple AWS Regions and accounts. For more information, see Concurrently Executing Automations in Multiple AWS Regions and Accounts in the AWS Systems Manager User Guide.
    
    See Also:
    
    AutomationType
  - toBuilder
```
public AutomationExecutionMetadata.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AutomationExecutionMetadata.Builder,AutomationExecutionMetadata>
    
    Returns:
    
    a builder for type T
  - builder
```
public static AutomationExecutionMetadata.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AutomationExecutionMetadata.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class AutomationExecutionMetadata

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

automationExecutionStatus

automationExecutionStatusAsString

executionStartTime

executionEndTime

executedBy

logFile

outputs

mode

modeAsString

parentAutomationExecutionId

currentStepName

currentAction

failureMessage

targetParameterName

targets

targetMaps

resolvedTargets

maxConcurrency

maxErrors

target

automationType

automationTypeAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields