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

Class DescribeInstancePatchesRequest

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

  • Method Details

    • instanceId

      public final String instanceId()

      The ID of the managed node whose patch state information should be retrieved.

      Returns:
      The ID of the managed node whose patch state information should be retrieved.

    • hasFilters

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

    • filters

      public final List<PatchOrchestratorFilter> filters()

      Each element in the array is a structure containing a key-value pair.

      Supported keys for DescribeInstancePatchesinclude the following:

      • Classification

        Sample values: Security | SecurityUpdates

      • KBId

        Sample values: KB4480056 | java-1.7.0-openjdk.x86_64

      • Severity

        Sample values: Important | Medium | Low

      • State

        Sample values: Installed | InstalledOther | InstalledPendingReboot

        For lists of all State values, see Patch compliance state values in the Amazon Web Services Systems Manager User Guide.

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

      Returns:
      Each element in the array is a structure containing a key-value pair.

      Supported keys for DescribeInstancePatchesinclude the following:

      • Classification

        Sample values: Security | SecurityUpdates

      • KBId

        Sample values: KB4480056 | java-1.7.0-openjdk.x86_64

      • Severity

        Sample values: Important | Medium | Low

      • State

        Sample values: Installed | InstalledOther | InstalledPendingReboot

        For lists of all State values, see Patch compliance state values in the Amazon Web Services Systems Manager User Guide.

    • nextToken

      public final String nextToken()

      The token for the next set of items to return. (You received this token from a previous call.)

      Returns:
      The token for the next set of items to return. (You received this token from a previous call.)

    • maxResults

      public final Integer maxResults()

      The maximum number of patches to return (per page).

      Returns:
      The maximum number of patches to return (per page).

    • toBuilder

      public DescribeInstancePatchesRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<DescribeInstancePatchesRequest.Builder,DescribeInstancePatchesRequest>
      Specified by:
      toBuilder in class SsmRequest

    • builder

      public static DescribeInstancePatchesRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo