RegisterDefaultPatchBaselineCommand

Suggest an Edit

Defines the default patch baseline for the relevant operating system.

To reset the Amazon Web Services-predefined patch baseline as the default, specify the full patch baseline Amazon Resource Name (ARN) as the baseline ID value. For example, for CentOS, specify arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0574b43a65ea646ed instead of pb-0574b43a65ea646ed.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { SSMClient, RegisterDefaultPatchBaselineCommand } from "@aws-sdk/client-ssm"; // ES Modules import
// const { SSMClient, RegisterDefaultPatchBaselineCommand } = require("@aws-sdk/client-ssm"); // CommonJS import
const client = new SSMClient(config);
const input = { // RegisterDefaultPatchBaselineRequest
  BaselineId: "STRING_VALUE", // required
};
const command = new RegisterDefaultPatchBaselineCommand(input);
const response = await client.send(command);
// { // RegisterDefaultPatchBaselineResult
//   BaselineId: "STRING_VALUE",
// };

RegisterDefaultPatchBaselineCommand Input

See RegisterDefaultPatchBaselineCommandInput for more details

Parameter
Type
Description
BaselineId
Required
string | undefined

The ID of the patch baseline that should be the default patch baseline.

RegisterDefaultPatchBaselineCommand Output

See RegisterDefaultPatchBaselineCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
BaselineId
string | undefined

The ID of the default patch baseline.

Throws

Name
Fault
Details
DoesNotExistException
client

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

InternalServerError
server

An error occurred on the server side.

InvalidResourceId
client

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

SSMServiceException
Base exception class for all service exceptions from SSM service.