UpdatePlanExecutionStep
Updates a specific step in an in-progress plan execution. This operation allows you to modify the step's comment or action.
Request Parameters
- actionToTake
-
The updated action to take for the step. This can be used to skip or retry a step.
Type: String
Valid Values:
switchToUngraceful | skipRequired: Yes
- comment
-
An optional comment about the plan execution.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Required: Yes
- executionId
-
The unique identifier of the plan execution containing the step to update.
Type: String
Required: Yes
- planArn
-
The Amazon Resource Name (ARN) of the plan containing the execution step 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
- stepName
-
The name of the execution step to update.
Type: String
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
- 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 AWS SDKs, see the following:
