UpdatePlanExecution
Updates an in-progress plan execution. This operation allows you to modify certain aspects of the execution, such as adding a comment or changing the action.
Request Parameters
- action
-
The action specified for a plan execution, for example, Switch to Graceful or Pause.
Type: String
Valid Values:
switchToGraceful | switchToUngraceful | pause | resumeRequired: Yes
- comment
-
An optional comment about the plan execution.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Required: No
- executionId
-
The execution identifier of a plan execution.
Type: String
Required: Yes
- planArn
-
The Amazon Resource Name (ARN) of the plan with the execution to update.
Type: String
Pattern:
arn:aws[a-zA-Z-]*:arc-region-switch::[0-9]{12}:plan/([a-zA-Z0-9](?:[a-zA-Z0-9-]{0,30}[a-zA-Z0-9])?):([a-z0-9]{6})Required: Yes
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
HTTP Status Code: 403
- IllegalStateException
-
The operation failed because the current state of the resource doesn't allow the operation to proceed.
HTTP Status Code: 400
HTTP Status Code: 400
- ResourceNotFoundException
-
The specified resource was not found.
HTTP Status Code: 404
HTTP Status Code: 404
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: