Welcome

The change management API provides operations to create and manage requests for change (RFCs). RFCs can be created, updated, submitted, approved (or rejected), and canceled.

Creating a Request for Change

To create a request for change, begin by calling CreateRfc. After creating the basic RFC and before submitting it, you can add or update information (Description, ExpectedOutcome, ImplementationPlan, RollbackPlan, and WorstCaseScenario) by using the UpdateRfc operation (UpdateRfc).

When all necessary information has been added, use SubmitRfc to activate the RFC.

Note

Although only the change type (ChangeTypeId and ChangeTypeVersion) and Title are required to initially create an RFC, you must provide values for these fields (either in the original CreateRfc call or by using the corresponding UpdateRfc (UpdateRfc operation) before calling SubmitRfc:

• RequestedStartTime (CreateRfc and RequestedEndTime, if you want to schedule the RFC. If scheduling is unimportant, leave off these values and execution begins as soon as the RFC is approved. This is part of a feature known as ASAP, or un-scheduled RFC.

• ExecutionParameters that comply with the JSON ExecutionInputSchema of the change type that is associated with the RFC (CreateRfc or UpdateRfc)

For more information and examples, see Change Management in the AWS Managed Services User Guide.

Getting information about an RFC

The GetRfc operation shows most of the information about an RFC, including the approval status and execution status.

If an RFC is rejected or canceled, the reason for the action appears in the RfcReason.

Service Endpoint

The HTTP endpoint for the Change Management API is:

• https://amscm.us-east-1.amazonaws.com

This document was last published on November 11, 2024.