Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

UpdateServiceTemplateVersion

Update a major or minor version of a service template.

Request Syntax


{
   "compatibleEnvironmentTemplates": [ 
      { 
         "majorVersion": "string",
         "templateName": "string"
      }
   ],
   "description": "string",
   "majorVersion": "string",
   "minorVersion": "string",
   "status": "string",
   "supportedComponentSources": [ "string" ],
   "templateName": "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.

compatibleEnvironmentTemplates

An array of environment template objects that are compatible with this service template version. A service instance based on this service template version can run in environments based on compatible templates.

Type: Array of CompatibleEnvironmentTemplateInput objects

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Required: No

description

A description of a service template version to update.

Type: String

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

Required: No

majorVersion

To update a major version of a service template, include major Version.

Type: String

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

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

Required: Yes

minorVersion

To update a minor version of a service template, include minorVersion.

Type: String

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

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

Required: Yes

status

The status of the service template minor version to update.

Type: String

Valid Values: REGISTRATION_IN_PROGRESS | REGISTRATION_FAILED | DRAFT | PUBLISHED

Required: No

supportedComponentSources

An array of supported component sources. Components with supported sources can be attached to service instances based on this service template version.

Note

A change to supportedComponentSources doesn't impact existing component attachments to instances based on this template version. A change only affects later associations.

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

Type: Array of strings

Valid Values: DIRECTLY_DEFINED

Required: No

templateName

The name of the service template.

Type: String

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

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

Required: Yes

Response Syntax


{
   "serviceTemplateVersion": { 
      "arn": "string",
      "compatibleEnvironmentTemplates": [ 
         { 
            "majorVersion": "string",
            "templateName": "string"
         }
      ],
      "createdAt": number,
      "description": "string",
      "lastModifiedAt": number,
      "majorVersion": "string",
      "minorVersion": "string",
      "recommendedMinorVersion": "string",
      "schema": "string",
      "status": "string",
      "statusMessage": "string",
      "supportedComponentSources": [ "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.

serviceTemplateVersion

The service template version detail data that's returned by AWS Proton.

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