Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

UpdateServiceInstance

Update a service instance.

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

Note

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 AWS Proton components in the AWS Proton User Guide.

Request Syntax


{
   "clientToken": "string",
   "deploymentType": "string",
   "name": "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.

clientToken

The client token of the service instance to update.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 64.

Pattern: ^[!-~]*$

Required: No

deploymentType

The deployment type. It defines the mode for updating a service instance, as follows:

NONE

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

CURRENT_VERSION

In this mode, the service instance 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 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.

MAJOR_VERSION

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.

Type: String

Valid Values: NONE | CURRENT_VERSION | MINOR_VERSION | MAJOR_VERSION

Required: Yes

name

The name of the service instance to update.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\-]*$

Required: Yes

serviceName

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

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 formatted specification that defines the service instance update.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 51200.

Required: No

templateMajorVersion

The major version of the service template to update.

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 to update.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 20.

Pattern: ^(0|([1-9]{1}\d*))$

Required: No

Response Syntax


{
   "serviceInstance": { 
      "arn": "string",
      "createdAt": number,
      "deploymentStatus": "string",
      "deploymentStatusMessage": "string",
      "environmentName": "string",
      "lastAttemptedDeploymentId": "string",
      "lastClientRequestToken": "string",
      "lastDeploymentAttemptedAt": number,
      "lastDeploymentSucceededAt": number,
      "lastSucceededDeploymentId": "string",
      "name": "string",
      "serviceName": "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.

serviceInstance

The service instance summary data that's returned by AWS Proton.

Type: ServiceInstance 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