Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

DescribePatchBaselines

Lists the patch baselines in your AWS account.

Request Syntax


{
   "Filters": [ 
      { 
         "Key": "string",
         "Values": [ "string" ]
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Filters

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

Type: Array of PatchOrchestratorFilter objects

Array Members: Minimum number of 0 items. Maximum number of 5 items.

Required: No

MaxResults

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

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

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

Type: String

Required: No

Response Syntax


{
   "BaselineIdentities": [ 
      { 
         "BaselineDescription": "string",
         "BaselineId": "string",
         "BaselineName": "string",
         "DefaultBaseline": boolean,
         "OperatingSystem": "string"
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

BaselineIdentities

An array of PatchBaselineIdentity elements.

Type: Array of PatchBaselineIdentity objects

NextToken

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

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerError

An error occurred on the server side.

HTTP Status Code: 500

Examples

Example

This example illustrates one usage of DescribePatchBaselines.

Sample Request


POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 2
X-Amz-Target: AmazonSSM.DescribePatchBaselines
X-Amz-Date: 20240309T024139Z
User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240309/us-east-2/ssm/aws4_request, 
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE

{}

Sample Response


{
    "BaselineIdentities": [
        {
            "BaselineDescription": "Default Patch Baseline for Suse Provided by AWS.",
            "BaselineId": "arn:aws:ssm:us-east-2:111122223333:patchbaseline/pb-07d8884178EXAMPLE",
            "BaselineName": "AWS-SuseDefaultPatchBaseline",
            "DefaultBaseline": true,
            "OperatingSystem": "SUSE"
        },
        {
            "BaselineDescription": "Default Patch Baseline Provided by AWS.",
            "BaselineId": "arn:aws:ssm:us-east-2:111122223333:patchbaseline/pb-09ca3fb51fEXAMPLE",
            "BaselineName": "AWS-DefaultPatchBaseline",
            "DefaultBaseline": true,
            "OperatingSystem": "WINDOWS"
        },
        {
            "BaselineDescription": "Default Patch Baseline for Amazon Linux Provided by AWS.",
            "BaselineId": "arn:aws:ssm:us-east-2:111122223333:patchbaseline/pb-0c10e65780EXAMPLE",
            "BaselineName": "AWS-AmazonLinuxDefaultPatchBaseline",
            "DefaultBaseline": true,
            "OperatingSystem": "AMAZON_LINUX"
        },
        {
            "BaselineDescription": "Default Patch Baseline for Ubuntu Provided by AWS.",
            "BaselineId": "arn:aws:ssm:us-east-2:111122223333:patchbaseline/pb-0c7e89f711EXAMPLE",
            "BaselineName": "AWS-UbuntuDefaultPatchBaseline",
            "DefaultBaseline": true,
            "OperatingSystem": "UBUNTU"
        },
        {
            "BaselineDescription": "Default Patch Baseline for Redhat Enterprise Linux Provided by AWS.",
            "BaselineId": "arn:aws:ssm:us-east-2:111122223333:patchbaseline/pb-0cbb3a633dEXAMPLE",
            "BaselineName": "AWS-RedHatDefaultPatchBaseline",
            "DefaultBaseline": true,
            "OperatingSystem": "REDHAT_ENTERPRISE_LINUX"
        }
        // There may be more content here
    ]
}