Proton / Client / create_service_template_version

create_service_template_version#

Proton.Client.create_service_template_version(**kwargs)#

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

response = client.create_service_template_version(
    clientToken='string',
    compatibleEnvironmentTemplates=[
        {
            'majorVersion': 'string',
            'templateName': 'string'
        },
    ],
    description='string',
    majorVersion='string',
    source={
        's3': {
            'bucket': 'string',
            'key': 'string'
        }
    },
    supportedComponentSources=[
        'DIRECTLY_DEFINED',
    ],
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    templateName='string'
)

Parameters:

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

This field is autopopulated if not provided.
compatibleEnvironmentTemplates (list) –
[REQUIRED]

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.
- (dict) –
  
  Compatible environment template data.
  - majorVersion (string) – [REQUIRED]
    
    The major version of the compatible environment template.
  - templateName (string) – [REQUIRED]
    
    The compatible environment template name.
description (string) – A description of the new version of a service template.
majorVersion (string) –
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.
source (dict) –
[REQUIRED]

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

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: s3.
- s3 (dict) –
  
  An S3 source object that includes the template bundle S3 path and name for a template minor version.
  - bucket (string) – [REQUIRED]
    
    The name of the S3 bucket that contains a template bundle.
  - key (string) – [REQUIRED]
    
    The path to the S3 bucket that contains a template bundle.
supportedComponentSources (list) –
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 Proton components in the Proton User Guide.
- (string) –
tags (list) –
An optional list of metadata items that you can associate with the Proton service template version. A tag is a key-value pair.

For more information, see Proton resources and tagging in the Proton User Guide.
- (dict) –
  
  A description of a resource tag.
  - key (string) – [REQUIRED]
    
    The key of the resource tag.
  - value (string) – [REQUIRED]
    
    The value of the resource tag.
templateName (string) –
[REQUIRED]

The name of the service template.

Return type:

dict

Returns:

Response Syntax

{
    'serviceTemplateVersion': {
        'arn': 'string',
        'compatibleEnvironmentTemplates': [
            {
                'majorVersion': 'string',
                'templateName': 'string'
            },
        ],
        'createdAt': datetime(2015, 1, 1),
        'description': 'string',
        'lastModifiedAt': datetime(2015, 1, 1),
        'majorVersion': 'string',
        'minorVersion': 'string',
        'recommendedMinorVersion': 'string',
        'schema': 'string',
        'status': 'REGISTRATION_IN_PROGRESS'|'REGISTRATION_FAILED'|'DRAFT'|'PUBLISHED',
        'statusMessage': 'string',
        'supportedComponentSources': [
            'DIRECTLY_DEFINED',
        ],
        'templateName': 'string'
    }
}

Response Structure

(dict) –
- serviceTemplateVersion (dict) –
  
  The service template version summary of detail data that’s returned by Proton.
  - arn (string) –
    
    The Amazon Resource Name (ARN) of the version of a service template.
  - compatibleEnvironmentTemplates (list) –
    
    An array of compatible environment template names for the major version of a service template.
    - (dict) –
      
      Compatible environment template data.
      - majorVersion (string) –
        
        The major version of the compatible environment template.
      - templateName (string) –
        
        The compatible environment template name.
  - createdAt (datetime) –
    
    The time when the version of a service template was created.
  - description (string) –
    
    A description of the version of a service template.
  - lastModifiedAt (datetime) –
    
    The time when the version of a service template was last modified.
  - majorVersion (string) –
    
    The latest major version that’s associated with the version of a service template.
  - minorVersion (string) –
    
    The minor version of a service template.
  - recommendedMinorVersion (string) –
    
    The recommended minor version of the service template.
  - schema (string) –
    
    The schema of the version of a service template.
  - status (string) –
    
    The service template version status.
  - statusMessage (string) –
    
    A service template version status message.
  - supportedComponentSources (list) –
    
    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 Proton components in the Proton User Guide.
    - (string) –
  - templateName (string) –
    
    The name of the version of a service template.

create_service_template_version#

Request Syntax

Note

Response Syntax

Response Structure

Exceptions