UpdateRfc - AWS Managed Services

UpdateRfc

Updates settings for the specified RFC ID. Updates non-null values.

Request Syntax

{ "Description": "string", "ExecutionParameters": "string", "ExpectedOutcome": "string", "ImplementationPlan": "string", "Notification": { "Email": { "EmailRecipients": [ "string" ] } }, "RequestedEndTime": "string", "RequestedStartTime": "string", "RfcId": "string", "RollbackPlan": "string", "Title": "string", "WorstCaseScenario": "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.

Description

The new description of the RFC.

Type: String

Required: No

ExecutionParameters

The new parameters that are required to execute the RFC, submitted in JSON format.

Type: String

Required: No

ExpectedOutcome

A new description of the effects of the change.

Type: String

Required: No

ImplementationPlan

The new actions or steps required to implement the change (for change types that are not automated).

Type: String

Required: No

Notification

Notice that an RFC has been updated.

Type: RfcNotification object

Required: No

RequestedEndTime

The new end of the change window, expressed in ISO 8601 format. The default format is the basic format (YYYYMMDDThhmmssZ). For example, 2017/02/27 at 2:30 PM would be 20170227T143000Z. An RFC does not fail if the requested end time is exceeded.

Type: String

Required: No

RequestedStartTime

The new start of the change window, expressed in ISO 8601 format. The default format is the basic format (YYYYMMDDThhmmssZ). For example, 2017/02/27 at 2:10 PM would be 20170227T141000Z. For best results, set the requested start time to at least 20 minutes past the time that you expect to submit the RFC. Alternatively, you can use the ASAP option, which causes the RFC to be executed as soon as it is approved, to use this option, do not specify any start time. If the RFC does not pass syntax or other checks before the requested start time (if set), the RFC is canceled.

Type: String

Required: No

RfcId

The unique ID (UUID) of the RFC.

Type: String

Required: Yes

RollbackPlan

The new actions or steps required to undo the change.

Type: String

Required: No

Title

A new name for the RFC; this is displayed as the subject of the RFC in the AMS console.

Type: String

Required: No

WorstCaseScenario

A new description of the most unfavorable outcome of the change.

Type: String

Required: No

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerError

An unspecified server error occurred.

HTTP Status Code: 500

InvalidArgumentException

A specified argument is not valid.

HTTP Status Code: 400

InvalidRfcStateException

The RFC is not in a state that allows the requested operation. Actual status code: 409

HTTP Status Code: 400

ResourceNotFoundException

A specified resource could not be located. Actual status code: 404

HTTP Status Code: 400

See Also

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