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

Class GetMaintenanceWindowExecutionTaskResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.ssm.model.SsmResponse
software.amazon.awssdk.services.ssm.model.GetMaintenanceWindowExecutionTaskResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetMaintenanceWindowExecutionTaskResponse.Builder,GetMaintenanceWindowExecutionTaskResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetMaintenanceWindowExecutionTaskResponse extends SsmResponse implements ToCopyableBuilder<GetMaintenanceWindowExecutionTaskResponse.Builder,GetMaintenanceWindowExecutionTaskResponse>

  • Method Details

    • windowExecutionId

      public final String windowExecutionId()

      The ID of the maintenance window execution that includes the task.

      Returns:
      The ID of the maintenance window execution that includes the task.

    • taskExecutionId

      public final String taskExecutionId()

      The ID of the specific task execution in the maintenance window task that was retrieved.

      Returns:
      The ID of the specific task execution in the maintenance window task that was retrieved.

    • taskArn

      public final String taskArn()

      The Amazon Resource Name (ARN) of the task that ran.

      Returns:
      The Amazon Resource Name (ARN) of the task that ran.

    • serviceRole

      public final String serviceRole()

      The role that was assumed when running the task.

      Returns:
      The role that was assumed when running the task.

    • type

      public final MaintenanceWindowTaskType type()

      The type of task that was run.

      If the service returns an enum value that is not available in the current SDK version, type will return MaintenanceWindowTaskType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type of task that was run.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of task that was run.

      If the service returns an enum value that is not available in the current SDK version, type will return MaintenanceWindowTaskType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type of task that was run.
      See Also:

    • hasTaskParameters

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

    • taskParameters

      public final List<Map<String,MaintenanceWindowTaskParameterValueExpression>> taskParameters()

      The parameters passed to the task when it was run.

      TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

      The map has the following format:

      • Key: string, between 1 and 255 characters

      • Value: an array of strings, each between 1 and 255 characters

      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 hasTaskParameters() method.

      Returns:
      The parameters passed to the task when it was run.

      TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

      The map has the following format:

      • Key: string, between 1 and 255 characters

      • Value: an array of strings, each between 1 and 255 characters

    • priority

      public final Integer priority()

      The priority of the task.

      Returns:
      The priority of the task.

    • maxConcurrency

      public final String maxConcurrency()

      The defined maximum number of task executions that could be run in parallel.

      Returns:
      The defined maximum number of task executions that could be run in parallel.

    • maxErrors

      public final String maxErrors()

      The defined maximum number of task execution errors allowed before scheduling of the task execution would have been stopped.

      Returns:
      The defined maximum number of task execution errors allowed before scheduling of the task execution would have been stopped.

    • status

      public final MaintenanceWindowExecutionStatus status()

      The status of the task.

      If the service returns an enum value that is not available in the current SDK version, status will return MaintenanceWindowExecutionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of the task.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the task.

      If the service returns an enum value that is not available in the current SDK version, status will return MaintenanceWindowExecutionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of the task.
      See Also:

    • statusDetails

      public final String statusDetails()

      The details explaining the status. Not available for all status values.

      Returns:
      The details explaining the status. Not available for all status values.

    • startTime

      public final Instant startTime()

      The time the task execution started.

      Returns:
      The time the task execution started.

    • endTime

      public final Instant endTime()

      The time the task execution completed.

      Returns:
      The time the task execution completed.

    • alarmConfiguration

      public final AlarmConfiguration alarmConfiguration()

      The details for the CloudWatch alarm you applied to your maintenance window task.

      Returns:
      The details for the CloudWatch alarm you applied to your maintenance window task.

    • 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 alarms that were invoked by the maintenance window task.

      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 alarms that were invoked by the maintenance window task.

    • toBuilder

      public GetMaintenanceWindowExecutionTaskResponse.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<GetMaintenanceWindowExecutionTaskResponse.Builder,GetMaintenanceWindowExecutionTaskResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetMaintenanceWindowExecutionTaskResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetMaintenanceWindowExecutionTaskResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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