Class AutomationExecution

java.lang.Object
software.amazon.awssdk.services.ssm.model.AutomationExecution
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AutomationExecution.Builder,AutomationExecution>
@Generated("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:

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • 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.

    • alarmConfiguration

      public final AlarmConfiguration alarmConfiguration()

      The details for the CloudWatch alarm applied to your automation.

      Returns:
      The details for the CloudWatch alarm applied to your automation.

    • hasTriggeredAlarms

      public final boolean hasTriggeredAlarms()
      For responses, this returns true if the service returned a value for the TriggeredAlarms 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.

    • triggeredAlarms

      public final List<AlarmStateInformation> triggeredAlarms()

      The CloudWatch alarm that was invoked by 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 hasTriggeredAlarms() method.

      Returns:
      The CloudWatch alarm that was invoked by the automation.

    • targetLocationsURL

      public final String targetLocationsURL()

      A publicly accessible URL for a file that contains the TargetLocations body. Currently, only files in presigned Amazon S3 buckets are supported

      Returns:
      A publicly accessible URL for a file that contains the TargetLocations body. Currently, only files in presigned Amazon S3 buckets are supported

    • 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:

    • 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:

    • 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.

    • hasVariables

      public final boolean hasVariables()
      For responses, this returns true if the service returned a value for the Variables 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.

    • variables

      public final Map<String,List<String>> variables()

      Variables defined for 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 hasVariables() method.

      Returns:
      Variables defined for the automation.

    • toBuilder

      public AutomationExecution.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<AutomationExecution.Builder,AutomationExecution>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.