OverrideStageCondition
Used to override a stage condition. For more information about conditions, see Stage conditions and How do stage conditions work?.
Request Syntax
{
"conditionType": "string",
"pipelineExecutionId": "string",
"pipelineName": "string",
"stageName": "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.
- conditionType
-
The type of condition to override for the stage, such as entry conditions, failure conditions, or success conditions.
Type: String
Valid Values:
BEFORE_ENTRY | ON_SUCCESSRequired: Yes
- pipelineExecutionId
-
The ID of the pipeline execution for the override.
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
- pipelineName
-
The name of the pipeline with the stage that will override the condition.
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 for the override.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[A-Za-z0-9.@\-_]+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.
- ConcurrentPipelineExecutionsLimitExceededException
-
The pipeline has reached the limit for concurrent pipeline executions.
HTTP Status Code: 400
- ConditionNotOverridableException
-
Unable to override because the condition does not allow overrides.
HTTP Status Code: 400
- ConflictException
-
Your request cannot be handled because the pipeline is busy handling ongoing activities. Try again later.
HTTP Status Code: 400
- NotLatestPipelineExecutionException
-
The stage has failed in a later run of the pipeline and the
pipelineExecutionIdassociated with the request is out of date.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
- 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:
