Menu
AWS Systems Manager
API Reference (API Version 2014-11-06)

DescribeEffectivePatchesForPatchBaseline

Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline. Note that this API applies only to Windows patch baselines.

Request Syntax

{ "BaselineId": "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.

BaselineId

The ID of the patch baseline to retrieve the effective patches for.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_\-:/]{20,128}$

Required: Yes

MaxResults

The maximum number of patches 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

{ "EffectivePatches": [ { "Patch": { "Classification": "string", "ContentUrl": "string", "Description": "string", "Id": "string", "KbNumber": "string", "Language": "string", "MsrcNumber": "string", "MsrcSeverity": "string", "Product": "string", "ProductFamily": "string", "ReleaseDate": number, "Title": "string", "Vendor": "string" }, "PatchStatus": { "ApprovalDate": number, "ComplianceLevel": "string", "DeploymentStatus": "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.

EffectivePatches

An array of patches and patch status.

Type: Array of EffectivePatch 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.

DoesNotExistException

Error returned when the ID specified for a resource, such as a Maintenance Window or Patch baseline, doesn't exist.

For information about resource limits in Systems Manager, see AWS Systems Manager Limits.

HTTP Status Code: 400

InternalServerError

An error occurred on the server side.

HTTP Status Code: 400

InvalidResourceId

The resource ID is not valid. Verify that you entered the correct ID and try again.

HTTP Status Code: 400

UnsupportedOperatingSystem

The operating systems you specified is not supported, or the operation is not supported for the operating system. Valid operating systems include: Windows, AmazonLinux, RedhatEnterpriseLinux, and Ubuntu.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: