UpdateServicePipeline
Update the service pipeline.
There are four modes for updating a service pipeline. The deploymentType
field defines the mode.
-
NONEIn this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.
-
CURRENT_VERSIONIn this mode, the service pipeline is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include major or minor version parameters when you use this
deployment-type. -
MINOR_VERSIONIn this mode, the service pipeline is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can specify a different minor version of the current major version in use.
-
MAJOR_VERSIONIn this mode, the service pipeline is deployed and updated with the published, recommended (latest) major and minor version of the current template by default. You can specify a different major version that's higher than the major version in use and a minor version.
Request Syntax
{
"deploymentType": "string",
"serviceName": "string",
"spec": "string",
"templateMajorVersion": "string",
"templateMinorVersion": "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.
- deploymentType
-
The deployment type.
There are four modes for updating a service pipeline. The
deploymentTypefield defines the mode.-
NONEIn this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.
-
CURRENT_VERSIONIn this mode, the service pipeline is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include major or minor version parameters when you use this
deployment-type. -
MINOR_VERSIONIn this mode, the service pipeline is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can specify a different minor version of the current major version in use.
-
MAJOR_VERSIONIn this mode, the service pipeline is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can specify a different major version that's higher than the major version in use and a minor version.
Type: String
Valid Values:
NONE | CURRENT_VERSION | MINOR_VERSION | MAJOR_VERSIONRequired: Yes
- serviceName
-
The name of the service to that the pipeline is associated with.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
^[0-9A-Za-z]+[0-9A-Za-z_\-]*$Required: Yes
- spec
-
The spec for the service pipeline to update.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 51200.
Required: Yes
- templateMajorVersion
-
The major version of the service template that was used to create the service that the pipeline is associated with.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 20.
Pattern:
^(0|([1-9]{1}\d*))$Required: No
- templateMinorVersion
-
The minor version of the service template that was used to create the service that the pipeline is associated with.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 20.
Pattern:
^(0|([1-9]{1}\d*))$Required: No
Response Syntax
{
"pipeline": {
"arn": "string",
"createdAt": number,
"deploymentStatus": "string",
"deploymentStatusMessage": "string",
"lastAttemptedDeploymentId": "string",
"lastDeploymentAttemptedAt": number,
"lastDeploymentSucceededAt": number,
"lastSucceededDeploymentId": "string",
"spec": "string",
"templateMajorVersion": "string",
"templateMinorVersion": "string",
"templateName": "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.
- pipeline
-
The pipeline details that are returned by AWS Proton.
Type: ServicePipeline object
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
There isn't sufficient access for performing this action.
HTTP Status Code: 400
- ConflictException
-
The request couldn't be made due to a conflicting operation or resource.
HTTP Status Code: 400
- InternalServerException
-
The request failed to register with the service.
HTTP Status Code: 500
- ResourceNotFoundException
-
The requested resource wasn't found.
HTTP Status Code: 400
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 400
- ValidationException
-
The input is invalid or an out-of-range value was supplied for the input parameter.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
