EnableStageTransition
Enables artifacts in a pipeline to transition to a stage in a pipeline.
Request Syntax
{
"pipelineName": "string
",
"stageName": "string
",
"transitionType": "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 in which you want to enable the flow of artifacts from one stage to another.
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 where you want to enable the transition of artifacts, either into the stage (inbound) or from that stage to the next stage (outbound).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[A-Za-z0-9.@\-_]+
Required: Yes
- transitionType
-
Specifies whether artifacts are allowed to enter the stage and be processed by the actions in that stage (inbound) or whether already processed artifacts are allowed to transition to the next stage (outbound).
Type: String
Valid Values:
Inbound | Outbound
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.
- 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
Examples
Example
This example illustrates one usage of EnableStageTransition.
Sample Request
POST / HTTP/1.1
Host: codepipeline.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 85
X-Amz-Target: CodePipeline_20150709.EnableStageTransition
X-Amz-Date: 20160707T182342Z
User-Agent: aws-cli/1.7.38 Python/2.7.9 Windows/7
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI44QH8DHBEXAMPLE/20160707/us-east-1/codepipeline/aws4_request, SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-target, Signature=8d9b5998EXAMPLE
{
"pipelineName": "MyFirstPipeline",
"stageName": "Staging",
"transitionType": "Inbound"
}
Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: 620484b7-88cb-11e5-b497-75c49EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 0
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: