UpdateServicePipelineCommand

Update the service pipeline.

There are four modes for updating a service pipeline. The deploymentType field defines the mode.

NONE

In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.

CURRENT_VERSION

In 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_VERSION

In 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_VERSION

In 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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { ProtonClient, UpdateServicePipelineCommand } from "@aws-sdk/client-proton"; // ES Modules import
// const { ProtonClient, UpdateServicePipelineCommand } = require("@aws-sdk/client-proton"); // CommonJS import
const client = new ProtonClient(config);
const input = { // UpdateServicePipelineInput
  serviceName: "STRING_VALUE", // required
  spec: "STRING_VALUE", // required
  deploymentType: "STRING_VALUE", // required
  templateMajorVersion: "STRING_VALUE",
  templateMinorVersion: "STRING_VALUE",
};
const command = new UpdateServicePipelineCommand(input);
const response = await client.send(command);
// { // UpdateServicePipelineOutput
//   pipeline: { // ServicePipeline
//     arn: "STRING_VALUE", // required
//     createdAt: new Date("TIMESTAMP"), // required
//     lastDeploymentAttemptedAt: new Date("TIMESTAMP"), // required
//     lastDeploymentSucceededAt: new Date("TIMESTAMP"), // required
//     templateName: "STRING_VALUE", // required
//     templateMajorVersion: "STRING_VALUE", // required
//     templateMinorVersion: "STRING_VALUE", // required
//     deploymentStatus: "STRING_VALUE", // required
//     deploymentStatusMessage: "STRING_VALUE",
//     spec: "STRING_VALUE",
//     lastAttemptedDeploymentId: "STRING_VALUE",
//     lastSucceededDeploymentId: "STRING_VALUE",
//   },
// };

UpdateServicePipelineCommand Input

Parameter
Type
Description
deploymentType
Required
DeploymentUpdateType | undefined

The deployment type.

There are four modes for updating a service pipeline. The deploymentType field defines the mode.

NONE

In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.

CURRENT_VERSION

In 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_VERSION

In 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_VERSION

In 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.

serviceName
Required
string | undefined

The name of the service to that the pipeline is associated with.

spec
Required
string | undefined

The spec for the service pipeline to update.

templateMajorVersion
string | undefined

The major version of the service template that was used to create the service that the pipeline is associated with.

templateMinorVersion
string | undefined

The minor version of the service template that was used to create the service that the pipeline is associated with.

UpdateServicePipelineCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
pipeline
Required
ServicePipeline | undefined

The pipeline details that are returned by Proton.

Throws

Name
Fault
Details
AccessDeniedException
client

There isn't sufficient access for performing this action.

ConflictException
client

The request couldn't be made due to a conflicting operation or resource.

InternalServerException
server

The request failed to register with the service.

ResourceNotFoundException
client

The requested resource wasn't found.

ThrottlingException
client

The request was denied due to request throttling.

ValidationException
client

The input is invalid or an out-of-range value was supplied for the input parameter.

ProtonServiceException
Base exception class for all service exceptions from Proton service.