Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . ssm ]

describe-available-patches

Description

Lists all patches eligible to be included in a patch baseline.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

describe-available-patches is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: Patches

Synopsis

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

Options

--filters (list)

Filters used to scope down the returned patches.

Shorthand Syntax:

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

JSON Syntax:

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

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

To get available patches

This example gets all available patches for Windows Server 2019 that have a MSRC severity of Critical.

Command:

aws ssm describe-available-patches --filters "Key=PRODUCT,Values=WindowsServer2019" "Key=MSRC_SEVERITY,Values=Critical"

Output:

{
  "Patches": [
      {
          "Id": "fe6bd8c2-3752-4c8b-ab3e-1a7ed08767ba",
          "ReleaseDate": 1544047205.0,
          "Title": "2018-11 Update for Windows Server 2019 for x64-based Systems (KB4470788)",
          "Description": "Install this update to resolve issues in Windows. For a complete listing of the issues that are included in this update, see the associated Microsoft Knowledge Base article for more information. After you install this item, you may have to restart your computer.",
          "ContentUrl": "https://support.microsoft.com/en-us/kb/4470788",
          "Vendor": "Microsoft",
          "ProductFamily": "Windows",
          "Product": "WindowsServer2019",
          "Classification": "SecurityUpdates",
          "MsrcSeverity": "Critical",
          "KbNumber": "KB4470788",
          "MsrcNumber": "",
          "Language": "All"
      },
      {
          "Id": "c96115e1-5587-4115-b851-22baa46a3f11",
          "ReleaseDate": 1549994410.0,
          "Title": "2019-02 Security Update for Adobe Flash Player for Windows Server 2019 for x64-based Systems (KB4487038)",
          "Description": "A security issue has been identified in a Microsoft software product that could affect your system. You can help protect your system by installing this update from Microsoft. For a complete listing of the issues that are included in this update, see the associated Microsoft Knowledge Base article. After you install this update, you may have to restart your system.",
          "ContentUrl": "https://support.microsoft.com/en-us/kb/4487038",
          "Vendor": "Microsoft",
          "ProductFamily": "Windows",
          "Product": "WindowsServer2019",
          "Classification": "SecurityUpdates",
          "MsrcSeverity": "Critical",
          "KbNumber": "KB4487038",
          "MsrcNumber": "",
          "Language": "All"
      },
      ...
  ]
}

To get details of a specific patch

This example returns details for the specified patch.

Command:

aws ssm describe-available-patches --filters "Key=PATCH_ID,Values=KB4480979"

Output:

{
  "Patches": [
      {
          "Id": "680861e3-fb75-432e-818e-d72e5f2be719",
          "ReleaseDate": 1546970408.0,
          "Title": "2019-01 Security Update for Adobe Flash Player for Windows Server 2016 for x64-based Systems (KB4480979)",
          "Description": "A security issue has been identified in a Microsoft software product that could affect your system. You can help protect your system by installing this update from Microsoft. For a complete listing of the issues that are included in this update, see the associated Microsoft Knowledge Base article. After you install this update, you may have to restart your system.",
          "ContentUrl": "https://support.microsoft.com/en-us/kb/4480979",
          "Vendor": "Microsoft",
          "ProductFamily": "Windows",
          "Product": "WindowsServer2016",
          "Classification": "SecurityUpdates",
          "MsrcSeverity": "Critical",
          "KbNumber": "KB4480979",
          "MsrcNumber": "",
          "Language": "All"
      }
  ]
}

Output

Patches -> (list)

An array of patches. Each entry in the array is a patch structure.

(structure)

Represents metadata about a patch.

Id -> (string)

The ID of the patch (this is different than the Microsoft Knowledge Base ID).

ReleaseDate -> (timestamp)

The date the patch was released.

Title -> (string)

The title of the patch.

Description -> (string)

The description of the patch.

ContentUrl -> (string)

The URL where more information can be obtained about the patch.

Vendor -> (string)

The name of the vendor providing the patch.

ProductFamily -> (string)

The product family the patch is applicable for (for example, Windows).

Product -> (string)

The specific product the patch is applicable for (for example, WindowsServer2016).

Classification -> (string)

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

MsrcSeverity -> (string)

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

KbNumber -> (string)

The Microsoft Knowledge Base ID of the patch.

MsrcNumber -> (string)

The ID of the MSRC bulletin the patch is related to.

Language -> (string)

The language of the patch if it's language-specific.

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.