Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateServiceTemplateVersion

Create a new major or minor version of a service template. A major version of a service template is a version that isn't backward compatible. A minor version of a service template is a version that's backward compatible within its major version.

Request Syntax


{
   "clientToken": "string",
   "compatibleEnvironmentTemplates": [ 
      { 
         "majorVersion": "string",
         "templateName": "string"
      }
   ],
   "description": "string",
   "majorVersion": "string",
   "source": { ... },
   "supportedComponentSources": [ "string" ],
   "tags": [ 
      { 
         "key": "string",
         "value": "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.

clientToken

When included, if two identical requests are made with the same client token, AWS Proton returns the service template version that the first request created.

Type: String

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

Pattern: ^[!-~]*$

Required: No

compatibleEnvironmentTemplates

An array of environment template objects that are compatible with the new 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: Yes

description

A description of the new version of a service template.

Type: String

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

Required: No

majorVersion

To create a new minor version of the service template, include a major Version.

To create a new major and minor version of the service template, exclude major Version.

Type: String

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

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

Required: No

source

An object that includes the template bundle S3 bucket path and name for the new version of a service template.

Type: TemplateVersionSourceInput object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

supportedComponentSources

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

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

tags

An optional list of metadata items that you can associate with the AWS Proton service template version. A tag is a key-value pair.

For more information, see AWS Proton resources and tagging in the AWS Proton User Guide.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

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 summary of 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

ServiceQuotaExceededException

A quota was exceeded. For more information, see AWS Proton Quotas in the AWS Proton User Guide.

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