RollbackStage
Rolls back a stage execution.
Request Syntax
{
"pipelineName": "string",
"stageName": "string",
"targetPipelineExecutionId": "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.
- pipelineName
-
The name of the pipeline for which the stage will be rolled back.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[A-Za-z0-9.@\-_]+Required: Yes
- stageName
-
The name of the stage in the pipeline to be rolled back.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[A-Za-z0-9.@\-_]+Required: Yes
- targetPipelineExecutionId
-
The pipeline execution ID for the stage to be rolled back to.
Type: String
Pattern:
[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}Required: Yes
Response Syntax
{
"pipelineExecutionId": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- pipelineExecutionId
-
The execution ID of the pipeline execution for the stage that has been rolled back.
Type: String
Pattern:
[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
Errors
For information about the errors that are common to all actions, see Common Errors.
- ConflictException
-
Your request cannot be handled because the pipeline is busy handling ongoing activities. Try again later.
HTTP Status Code: 400
- PipelineExecutionNotFoundException
-
The pipeline execution was specified in an invalid format or cannot be found, or an execution ID does not belong to the specified pipeline.
HTTP Status Code: 400
- PipelineExecutionOutdatedException
-
The specified pipeline execution is outdated and cannot be used as a target pipeline execution for rollback.
HTTP Status Code: 400
- PipelineNotFoundException
-
The pipeline was specified in an invalid format or cannot be found.
HTTP Status Code: 400
- StageNotFoundException
-
The stage was specified in an invalid format or cannot be found.
HTTP Status Code: 400
- UnableToRollbackStageException
-
Unable to roll back the stage. The cause might be if the pipeline version has changed since the target pipeline execution was deployed, the stage is currently running, or an incorrect target pipeline execution ID was provided.
HTTP Status Code: 400
- ValidationException
-
The validation was specified in an invalid format.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
