describe-instance-patches¶

Description¶

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

Synopsis¶

  describe-instance-patches
--instance-id <value>
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options¶

--instance-id (string)

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

--filters (list)

An array of structures. Each entry in the array is a structure containing a Key, Value combination. Valid values for Key are Classification | KBId | Severity | State .

(structure)

Defines a filter used in Patch Manager APIs.

Key -> (string)

The key for the filter.

Values -> (list)

The value for the filter.

(string)

Shorthand Syntax:

Key=string,Values=string,string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Values": ["string", ...]
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Example 1: To get the patch state details for an instance

The following describe-instance-patches example retrieves details about the patches for the specified instance.

aws ssm describe-instance-patches \
    --instance-id "i-1234567890abcdef0"

Output:

{
    "Patches": [
        {
            "Title": "2019-01 Security Update for Adobe Flash Player for Windows Server 2016 for x64-based Systems (KB4480979)",
            "KBId": "KB4480979",
            "Classification": "SecurityUpdates",
            "Severity": "Critical",
            "State": "Installed",
            "InstalledTime": 1546992000.0
        },
        {
            "Title": "",
            "KBId": "KB4481031",
            "Classification": "",
            "Severity": "",
            "State": "InstalledOther",
            "InstalledTime": 1549584000.0
        },
        ...
    ],
    "NextToken": "--token string truncated--"
}

Example 2: To get a list of patches in the Missing state for an instance

The following describe-instance-patches example retrieves information about patches that are in the Missing state for the specified instance.

aws ssm describe-instance-patches \
    --instance-id "i-1234567890abcdef0" \
    --filters Key=State,Values=Missing

Output:

{
  "Patches": [
      {
          "Title": "Windows Malicious Software Removal Tool x64 - February 2019 (KB890830)",
          "KBId": "KB890830",
          "Classification": "UpdateRollups",
          "Severity": "Unspecified",
          "State": "Missing",
          "InstalledTime": 0.0
      },
      ...
  ],
  "NextToken": "--token string truncated--"
}

For more information, see About Patch Compliance States in the AWS Systems Manager User Guide.

Output¶

Patches -> (list)

Each entry in the array is a structure containing:

Title (string)

KBId (string)

Classification (string)

Severity (string)

State (string, such as “INSTALLED” or “FAILED”)

InstalledTime (DateTime)

InstalledBy (string)

(structure)

Information about the state of a patch on a particular instance as it relates to the patch baseline used to patch the instance.

Title -> (string)

The title of the patch.

KBId -> (string)

The operating system-specific ID of the patch.

Classification -> (string)

The classification of the patch (for example, SecurityUpdates, Updates, CriticalUpdates).

Severity -> (string)

The severity of the patch (for example, Critical, Important, Moderate).

State -> (string)

The state of the patch on the instance, such as INSTALLED or FAILED.

For descriptions of each patch state, see About patch compliance in the AWS Systems Manager User Guide .

InstalledTime -> (timestamp)

The date/time the patch was installed on the instance. Note that not all operating systems provide this level of information.

CVEIds -> (string)

The IDs of one or more Common Vulnerabilities and Exposure (CVE) issues that are resolved by the patch.

NextToken -> (string)

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Table of Contents

Feedback

User Guide