Skip to content

Retrieves information about the patches on the specified managed node and their state relative to the patch baseline being used for the node

Description

Retrieves information about the patches on the specified managed node and their state relative to the patch baseline being used for the node.

Usage

ssm_describe_instance_patches(InstanceId, Filters, NextToken,
  MaxResults)

Arguments

  • InstanceId

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

  • Filters

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

    Supported keys for describe_instance_patchesinclude 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

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

  • MaxResults

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

Value

A list with the following syntax:

list(
  Patches = list(
    list(
      Title = "string",
      KBId = "string",
      Classification = "string",
      Severity = "string",
      State = "INSTALLED"|"INSTALLED_OTHER"|"INSTALLED_PENDING_REBOOT"|"INSTALLED_REJECTED"|"MISSING"|"NOT_APPLICABLE"|"FAILED"|"AVAILABLE_SECURITY_UPDATE",
      InstalledTime = as.POSIXct(
        "2015-01-01"
      ),
      CVEIds = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_instance_patches(
  InstanceId = "string",
  Filters = list(
    list(
      Key = "string",
      Values = list(
        "string"
      )
    )
  ),
  NextToken = "string",
  MaxResults = 123
)