UpdateEnvironmentTemplateVersion - AWS Proton
Request SyntaxRequest ParametersResponse SyntaxResponse ElementsErrorsSee Also

AWS has decided to discontinue AWS Proton, with support ending on October 7, 2026. New customers will not be able to sign up after October 7, 2025, but existing customers can continue to use the service until October 7, 2026.For more information, see AWS Proton Service Deprecation and Migration Guide.

UpdateEnvironmentTemplateVersion

Update a major or minor version of an environment template.

Request Syntax

{
   "description": "string",
   "majorVersion": "string",
   "minorVersion": "string",
   "status": "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.

description

A description of environment 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 an environment 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 an environment 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 environment template minor version to update.

Type: String

Valid Values: REGISTRATION_IN_PROGRESS | REGISTRATION_FAILED | DRAFT | PUBLISHED

Required: No

templateName

The name of the environment 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

{
   "environmentTemplateVersion": { 
      "arn": "string",
      "createdAt": number,
      "description": "string",
      "lastModifiedAt": number,
      "majorVersion": "string",
      "minorVersion": "string",
      "recommendedMinorVersion": "string",
      "schema": "string",
      "status": "string",
      "statusMessage": "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.

environmentTemplateVersion

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

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