DescribePatchBaselinesCommand

Suggest an Edit

Lists the patch baselines in your Amazon Web Services account.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { SSMClient, DescribePatchBaselinesCommand } from "@aws-sdk/client-ssm"; // ES Modules import
// const { SSMClient, DescribePatchBaselinesCommand } = require("@aws-sdk/client-ssm"); // CommonJS import
const client = new SSMClient(config);
const input = { // DescribePatchBaselinesRequest
  Filters: [ // PatchOrchestratorFilterList
    { // PatchOrchestratorFilter
      Key: "STRING_VALUE",
      Values: [ // PatchOrchestratorFilterValues
        "STRING_VALUE",
      ],
    },
  ],
  MaxResults: Number("int"),
  NextToken: "STRING_VALUE",
};
const command = new DescribePatchBaselinesCommand(input);
const response = await client.send(command);
// { // DescribePatchBaselinesResult
//   BaselineIdentities: [ // PatchBaselineIdentityList
//     { // PatchBaselineIdentity
//       BaselineId: "STRING_VALUE",
//       BaselineName: "STRING_VALUE",
//       OperatingSystem: "WINDOWS" || "AMAZON_LINUX" || "AMAZON_LINUX_2" || "AMAZON_LINUX_2022" || "UBUNTU" || "REDHAT_ENTERPRISE_LINUX" || "SUSE" || "CENTOS" || "ORACLE_LINUX" || "DEBIAN" || "MACOS" || "RASPBIAN" || "ROCKY_LINUX" || "ALMA_LINUX" || "AMAZON_LINUX_2023",
//       BaselineDescription: "STRING_VALUE",
//       DefaultBaseline: true || false,
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

DescribePatchBaselinesCommand Input

See DescribePatchBaselinesCommandInput for more details

Parameter
Type
Description
Filters
PatchOrchestratorFilter[] | undefined

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

Supported keys for DescribePatchBaselines include the following:

  • NAME_PREFIX

    Sample values: AWS- | My-

  • OWNER

    Sample values: AWS | Self

  • OPERATING_SYSTEM

    Sample values: AMAZON_LINUX | SUSE | WINDOWS

MaxResults
number | undefined

The maximum number of patch baselines to return (per page).

NextToken
string | undefined

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

DescribePatchBaselinesCommand Output

See DescribePatchBaselinesCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
BaselineIdentities
PatchBaselineIdentity[] | undefined

An array of PatchBaselineIdentity elements.

NextToken
string | undefined

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

Throws

Name
Fault
Details
InternalServerError
server

An error occurred on the server side.

SSMServiceException
Base exception class for all service exceptions from SSM service.