Package software.amazon.awssdk.services.ssm.model

Class AutomationExecutionMetadata

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

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

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

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

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

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

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

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