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

Class DescribeAvailablePatchesRequest

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.DescribeAvailablePatchesRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeAvailablePatchesRequest.Builder,DescribeAvailablePatchesRequest>
@Generated("software.amazon.awssdk:codegen") public final class DescribeAvailablePatchesRequest extends SsmRequest implements ToCopyableBuilder<DescribeAvailablePatchesRequest.Builder,DescribeAvailablePatchesRequest>

  • Method Details

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

      Windows Server

      Supported keys for Windows Server managed node patches include the following:

      • PATCH_SET

        Sample values: OS | APPLICATION

      • PRODUCT

        Sample values: WindowsServer2012 | Office 2010 | MicrosoftDefenderAntivirus

      • PRODUCT_FAMILY

        Sample values: Windows | Office

      • MSRC_SEVERITY

        Sample values: ServicePacks | Important | Moderate

      • CLASSIFICATION

        Sample values: ServicePacks | SecurityUpdates | DefinitionUpdates

      • PATCH_ID

        Sample values: KB123456 | KB4516046

      Linux

      When specifying filters for Linux patches, you must specify a key-pair for PRODUCT. For example, using the Command Line Interface (CLI), the following command fails:

      aws ssm describe-available-patches --filters Key=CVE_ID,Values=CVE-2018-3615

      However, the following command succeeds:

      aws ssm describe-available-patches --filters Key=PRODUCT,Values=AmazonLinux2018.03 Key=CVE_ID,Values=CVE-2018-3615

      Supported keys for Linux managed node patches include the following:

      • PRODUCT

        Sample values: AmazonLinux2018.03 | AmazonLinux2.0

      • NAME

        Sample values: kernel-headers | samba-python | php

      • SEVERITY

        Sample values: Critical | Important | Medium | Low

      • EPOCH

        Sample values: 0 | 1

      • VERSION

        Sample values: 78.6.1 | 4.10.16

      • RELEASE

        Sample values: 9.56.amzn1 | 1.amzn2

      • ARCH

        Sample values: i686 | x86_64

      • REPOSITORY

        Sample values: Core | Updates

      • ADVISORY_ID

        Sample values: ALAS-2018-1058 | ALAS2-2021-1594

      • CVE_ID

        Sample values: CVE-2018-3615 | CVE-2020-1472

      • BUGZILLA_ID

        Sample values: 1463241

      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.

      Windows Server

      Supported keys for Windows Server managed node patches include the following:

      • PATCH_SET

        Sample values: OS | APPLICATION

      • PRODUCT

        Sample values: WindowsServer2012 | Office 2010 | MicrosoftDefenderAntivirus

      • PRODUCT_FAMILY

        Sample values: Windows | Office

      • MSRC_SEVERITY

        Sample values: ServicePacks | Important | Moderate

      • CLASSIFICATION

        Sample values: ServicePacks | SecurityUpdates | DefinitionUpdates

      • PATCH_ID

        Sample values: KB123456 | KB4516046

      Linux

      When specifying filters for Linux patches, you must specify a key-pair for PRODUCT. For example, using the Command Line Interface (CLI), the following command fails:

      aws ssm describe-available-patches --filters Key=CVE_ID,Values=CVE-2018-3615

      However, the following command succeeds:

      aws ssm describe-available-patches --filters Key=PRODUCT,Values=AmazonLinux2018.03 Key=CVE_ID,Values=CVE-2018-3615

      Supported keys for Linux managed node patches include the following:

      • PRODUCT

        Sample values: AmazonLinux2018.03 | AmazonLinux2.0

      • NAME

        Sample values: kernel-headers | samba-python | php

      • SEVERITY

        Sample values: Critical | Important | Medium | Low

      • EPOCH

        Sample values: 0 | 1

      • VERSION

        Sample values: 78.6.1 | 4.10.16

      • RELEASE

        Sample values: 9.56.amzn1 | 1.amzn2

      • ARCH

        Sample values: i686 | x86_64

      • REPOSITORY

        Sample values: Core | Updates

      • ADVISORY_ID

        Sample values: ALAS-2018-1058 | ALAS2-2021-1594

      • CVE_ID

        Sample values: CVE-2018-3615 | CVE-2020-1472

      • BUGZILLA_ID

        Sample values: 1463241

    • maxResults

      public final Integer maxResults()

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

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

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

    • toBuilder

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

    • builder

      public static DescribeAvailablePatchesRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeAvailablePatchesRequest.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)
      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: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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.