AutomationExecutionMetadata (AWS Java SDK :: Services :: AWS Simple Systems Management (SSM) 2.17.46 API)

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`	`associationId()` The ID of a State Manager association used in the Automation operation.
`String`	`automationExecutionId()` The execution ID.
`AutomationExecutionStatus`	`automationExecutionStatus()` The status of the execution.
`String`	`automationExecutionStatusAsString()` The status of the execution.
`AutomationSubtype`	`automationSubtype()` The subtype of the Automation operation.
`String`	`automationSubtypeAsString()` The subtype of the Automation operation.
`AutomationType`	`automationType()` Use this filter with DescribeAutomationExecutions.
`String`	`automationTypeAsString()` Use this filter with DescribeAutomationExecutions.
`static AutomationExecutionMetadata.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 execution.
`String`	`documentVersion()` The document version used during the execution.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`executedBy()` The IAM role ARN of the user who ran 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 runbook.
`<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`	`hasRunbooks()` For responses, this returns true if the service returned a value for the Runbooks 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`	`logFile()` An 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.
`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.
`String`	`parentAutomationExecutionId()` The execution ID of the parent automation.
`ResolvedTargets`	`resolvedTargets()` A list of targets that resolved during the execution.
`List<Runbook>`	`runbooks()` Information about the Automation runbooks that are run during a runbook workflow in Change Manager.
`Instant`	`scheduledTime()` The date and time the Automation operation is scheduled to start.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AutomationExecutionMetadata.Builder>`	`serializableBuilderClass()`
`String`	`target()` The list of execution outputs as defined in the Automation runbook.
`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 runbook.
`List<Target>`	`targets()` The targets defined by the user when starting the automation.
`AutomationExecutionMetadata.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 execution.
    
    Returns:
    
    The name of the Automation runbook used during execution.
  - documentVersion
```
public final String documentVersion()
```
    The document version used during the execution.
    
    Returns:
    
    The document version used during the execution.
  - automationExecutionStatus
```
public final AutomationExecutionStatus automationExecutionStatus()
```
    The status of the execution.
    
    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.
    
    See Also:
    
    AutomationExecutionStatus
  - automationExecutionStatusAsString
```
public final String automationExecutionStatusAsString()
```
    The status of the execution.
    
    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.
    
    See Also:
    
    AutomationExecutionStatus
  - 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. This isn't populated if the execution is still in progress.
    
    Returns:
    
    The time the execution finished. This isn't populated if the execution is still in progress.
  - executedBy
```
public final String executedBy()
```
    The IAM role ARN of the user who ran the automation.
    
    Returns:
    
    The IAM role ARN of the user who ran the automation.
  - logFile
```
public final String logFile()
```
    An S3 bucket where execution information is stored.
    
    Returns:
    
    An S3 bucket where execution information is stored.
  - 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.
  - 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 execution ID of the parent automation.
    
    Returns:
    
    The execution ID of the parent 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.
  - failureMessage
```
public final String failureMessage()
```
    The list of execution outputs as defined in the Automation runbook.
    
    Returns:
    
    The list of execution outputs as defined in the Automation runbook.
  - targetParameterName
```
public final String targetParameterName()
```
    The list of execution outputs as defined in the Automation runbook.
    
    Returns:
    
    The list of execution outputs as defined in the Automation runbook.
  - 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 targets defined by the user when starting 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 hasTargets() method.
    
    Returns:
    
    The targets defined by the user when starting the automation.
  - 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 targets that resolved during the execution.
    
    Returns:
    
    A list of targets that resolved during the execution.
  - maxConcurrency
```
public final 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 final 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 final String target()
```
    The list of execution outputs as defined in the Automation runbook.
    
    Returns:
    
    The list of execution outputs as defined in the Automation runbook.
  - automationType
```
public final AutomationType automationType()
```
    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 Automation workflows in multiple Amazon Web Services Regions and accounts in the Amazon Web Services 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 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 Automation workflows in multiple Amazon Web Services Regions and accounts in the Amazon Web Services Systems Manager User Guide.
    
    See Also:
    
    AutomationType
  - automationTypeAsString
```
public final String automationTypeAsString()
```
    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 Automation workflows in multiple Amazon Web Services Regions and accounts in the Amazon Web Services 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 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 Automation workflows in multiple Amazon Web Services Regions and accounts in the Amazon Web Services Systems Manager User Guide.
    
    See Also:
    
    AutomationType
  - 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 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.
    
    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 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.
  - 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 AutomationExecutionMetadata.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AutomationExecutionMetadata.Builder,AutomationExecutionMetadata>
  - builder
```
public static AutomationExecutionMetadata.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AutomationExecutionMetadata.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 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

hasOutputs

outputs

mode

modeAsString

parentAutomationExecutionId

currentStepName

currentAction

failureMessage

targetParameterName

hasTargets

targets

hasTargetMaps

targetMaps

resolvedTargets

maxConcurrency

maxErrors

target

automationType

automationTypeAsString

automationSubtype

automationSubtypeAsString

scheduledTime

hasRunbooks

runbooks

opsItemId

associationId

changeRequestName

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields