RegisterPatchBaselineForPatchGroup - AWS Systems Manager

RegisterPatchBaselineForPatchGroup

Registers a patch baseline for a patch group.

Request Syntax

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

BaselineId

The ID of the patch baseline to register with the patch group.

Type: String

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

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

Required: Yes

PatchGroup

The name of the patch group to be registered with the patch baseline.

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", "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 the patch group was registered with.

Type: String

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

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

PatchGroup

The name of the patch group registered with the patch baseline.

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.

AlreadyExistsException

Error returned if an attempt is made to register a patch group with a patch baseline that is already registered with a different patch baseline.

HTTP Status Code: 400

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 quotas in AWS Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

HTTP Status Code: 400

InternalServerError

An error occurred on the server side.

HTTP Status Code: 500

InvalidResourceId

The resource ID isn't valid. Verify that you entered the correct ID and try again.

HTTP Status Code: 400

ResourceLimitExceededException

Error returned when the caller has exceeded the default resource quotas. For example, too many maintenance windows or patch baselines have been created.

For information about resource quotas in Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of RegisterPatchBaselineForPatchGroup.

Sample Request

POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity Content-Length: 74 X-Amz-Target: AmazonSSM.RegisterPatchBaselineForPatchGroup X-Amz-Date: 20240309T060234Z 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", "BaselineId": "pb-0c10e65780EXAMPLE" }

Sample Response

{ "PatchGroup": "mypatchgroup", "BaselineId": "pb-0c10e65780EXAMPLE" }

See Also

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