GetPatchBaselineForPatchGroup
Retrieves the patch baseline that should be used for the specified patch group.
Request Syntax
{
"OperatingSystem": "string",
"PatchGroup": "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.
- OperatingSystem
-
Returns the operating system rule specified for patch groups using the patch baseline.
Type: String
Valid Values:
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_2023Required: No
- PatchGroup
-
The name of the patch group whose patch baseline should be retrieved.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$Required: Yes
Response Syntax
{
"BaselineId": "string",
"OperatingSystem": "string",
"PatchGroup": "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.
- BaselineId
-
The ID of the patch baseline that should be used for the patch group.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 128.
Pattern:
^[a-zA-Z0-9_\-:/]{20,128}$ - OperatingSystem
-
The operating system rule specified for patch groups using the patch baseline.
Type: String
Valid Values:
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 - PatchGroup
-
The name of the patch group.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$
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 GetPatchBaselineForPatchGroup.
Sample Request
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 66
X-Amz-Target: AmazonSSM.GetPatchBaselineForPatchGroup
X-Amz-Date: 20240309T060906Z
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
{
"PatchGroup": "mypatchgroup",
"OperatingSystem": "WINDOWS"
}Sample Response
{
"BaselineId": "pb-0c10e65780EXAMPLE",
"OperatingSystem": "WINDOWS",
"PatchGroup": "mypatchgroup"
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
