The following is an example response from the request using the CreatedBy filter attribute.
{
"Output": {
"__type": "com.amazonaws.services.managedservices.cm.model#ListRfcSummariesResponse", "NextToken": null,
"ChangeTypeId": "ct-3izj492hm8s02", "ChangeTypeVersion": "4.0",
"CreatedBy": "arn:aws:sts::123456789012:assumed-role/FullAccess/John-Isengard", "CreatedTime": "20191025T232624Z",
"LastCorrespondenceTime": null,
"LastModifiedTime": "20191025T232624Z", "LastSubmittedTime": null,
"RequestedExecutionTimeRange": { "EndTime": null,
"StartTime": null },
"RfcId": "14b7029f-0a16-a83e-09d6-cd4fc9598ba9", "Status": {
See Also
"CreatedTime": "20191017T183530Z", "LastCorrespondenceTime": null,
"LastModifiedTime": "20191017T184158Z", "LastSubmittedTime": "20191017T183604Z", "RequestedExecutionTimeRange": {
"EndTime": null, "StartTime": null },
"RfcId": "32b6ed80-6efd-b096-9a2b-ff273c3a52f6", "Status": {
"Id": "Success", "Name": "Success"
},
"Title": "testExecutionResponse"
} ] }}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
RejectRfc
RejectRfc
Marks the specified RFC as rejected. The alternate operation to ApproveRfc.
An RFC with a CT of "Execution mode: Manual" requires approval; rarely it requires customer
response, either approval or rejection. If your response is explicitly required, the Approval Status:
CustomerApproval Pending RFC status is in the RFC execution output, but you receive no other notice. You must explicitly reject or approve the RFC by running this operation or the ApproveRfc operation.
Request Syntax
{ "Reason": "string", "RfcId": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 101).
The request accepts the following data in JSON format.
Reason (p. 55)
The reason for the rejection.
If an RFC is rejected or canceled, the reason for the action appears in the RfcReason.
Type: String Required: Yes RfcId (p. 55)
The unique ID (UUID) of the RFC to reject.
Type: String Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
See Also
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:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
SubmitRfc
SubmitRfc
Submits the specified RFC, and optionally specifies whether to observe default execution settings.
Request Syntax
{ "RestrictedExecutionTimesOverrideId": "string", "RfcId": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 101).
The request accepts the following data in JSON format.
RestrictedExecutionTimesOverrideId (p. 57)
The ID of a value that indicates how the change should observe default execution settings. Possible values: NoOverrides | OverrideRestrictedTimeRanges. The default is NoOverrides.
Type: String Required: No RfcId (p. 57)
The unique ID (UUID) of the RFC to submit.
Type: String Required: Yes
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 (p. 103).
InternalServerError
An unspecified server error occurred.
See Also
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:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
UpdateRestrictedExecutionTimes
UpdateRestrictedExecutionTimes
Replaces the existing times when change execution is restricted.
Request Syntax
{ "RestrictedExecutionTimes": [ {
"TimeRange": {
"EndTime": "string", "StartTime": "string"
} } ]}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 101).
The request accepts the following data in JSON format.
RestrictedExecutionTimes (p. 59) The new restricted time ranges.
Type: Array of RestrictedExecutionTime (p. 79) objects Required: Yes
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 (p. 103).
InternalServerError
An unspecified server error occurred.
HTTP Status Code: 500 InvalidArgumentException
See Also
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
UpdateRfc
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 (p. 101).
The request accepts the following data in JSON format.
Description (p. 61)
The new description of the RFC.
Type: String Required: No
ExecutionParameters (p. 61)
The new parameters that are required to execute the RFC, submitted in JSON format.
Type: String Required: No
ExpectedOutcome (p. 61)
Request Parameters
Type: String Required: No Notification (p. 61)
Notice that an RFC has been updated.
Type: RfcNotification (p. 93) object Required: No
RequestedEndTime (p. 61)
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 (p. 61)
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 (p. 61)
The unique ID (UUID) of the RFC.
Type: String Required: Yes RollbackPlan (p. 61)
The new actions or steps required to undo the change.
Type: String Required: No Title (p. 61)
A new name for the RFC; this is displayed as the subject of the RFC in the AMS console.
Type: String Required: No
WorstCaseScenario (p. 61)
A new description of the most unfavorable outcome of the change.
Type: String Required: No
Response Elements
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 (p. 103).
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:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3