Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1484319348.7 KB

Update a service instance.

There are a few modes for updating a service instance. The deploymentType field defines the mode.

You can't update a service instance while its deployment status, or the deployment status of a component attached to it, is IN_PROGRESS.

For more information about components, see Proton components in the Proton User Guide.

post/#X-Amz-Target=AwsProton20200720.UpdateServiceInstance

Headers

X-Amz-Target'AwsProton20200720.UpdateServiceInstance' required

Request body

clientTokenstring

The client token of the service instance to update.

deploymentType'NONE' | 'CURRENT_VERSION' | 'MINOR_VERSION' | 'MAJOR_VERSION' required
<p>The deployment type. It defines the mode for updating a service instance, as follows:</p> <dl> <dt/> <dd> <p> <code>NONE</code> </p> <p>In this mode, a deployment <i>doesn't</i> occur. Only the requested metadata parameters are updated.</p> </dd> <dt/> <dd> <p> <code>CURRENT_VERSION</code> </p> <p>In this mode, the service instance is deployed and updated with the new spec that you provide. Only requested parameters are updated. <i>Don’t</i> include major or minor version parameters when you use this deployment type.</p> </dd> <dt/> <dd> <p> <code>MINOR_VERSION</code> </p> <p>In this mode, the service instance is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.</p> </dd> <dt/> <dd> <p> <code>MAJOR_VERSION</code> </p> <p>In this mode, the service instance 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.</p> </dd> </dl>
namestring required

The name of the service instance to update.

serviceNamestring required

The name of the service that the service instance belongs to.

specstring password

The formatted specification that defines the service instance update.

templateMajorVersionstring

The major version of the service template to update.

templateMinorVersionstring

The minor version of the service template to update.

Response

Success