Table Of Contents

Feedback

User Guide

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

[ aws . ssm ]

describe-patch-baselines

Description

Lists the patch baselines in your AWS account.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

describe-patch-baselines 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: BaselineIdentities

Synopsis

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

Options

--filters (list)

Each element in the array is a structure containing:

Key: (string, "NAME_PREFIX" or "OWNER")

Value: (array of strings, exactly 1 entry, between 1 and 255 characters)

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 list all patch baselines

This example lists all patch baselines.

Command:

aws ssm describe-patch-baselines

Output:

{
  "BaselineIdentities": [
      {
          "BaselineId": "arn:aws:ssm:us-east-1:075727635805:patchbaseline/pb-03e3f588eec25344c",
          "BaselineName": "AWS-CentOSDefaultPatchBaseline",
          "OperatingSystem": "CENTOS",
          "BaselineDescription": "Default Patch Baseline for CentOS Provided by AWS.",
          "DefaultBaseline": true
      },
      {
          "BaselineId": "arn:aws:ssm:us-east-1:075727635805:patchbaseline/pb-07d8884178197b66b",
          "BaselineName": "AWS-SuseDefaultPatchBaseline",
          "OperatingSystem": "SUSE",
          "BaselineDescription": "Default Patch Baseline for Suse Provided by AWS.",
          "DefaultBaseline": true
      },
      ...
  ]
}

To list all AWS provided patch baselines

This example lists all patch baselines provided by AWS.

Command:

aws ssm describe-patch-baselines --filters "Key=OWNER,Values=[AWS]"

To list all patch baselines you own

This example lists all patch baselines with you as the owner.

Command:

aws ssm describe-patch-baselines --filters "Key=OWNER,Values=[Self]"

Output

BaselineIdentities -> (list)

An array of PatchBaselineIdentity elements.

(structure)

Defines the basic information about a patch baseline.

BaselineId -> (string)

The ID of the patch baseline.

BaselineName -> (string)

The name of the patch baseline.

OperatingSystem -> (string)

Defines the operating system the patch baseline applies to. The Default value is WINDOWS.

BaselineDescription -> (string)

The description of the patch baseline.

DefaultBaseline -> (boolean)

Whether this is the default baseline. Note that Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.

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.