Proton / Client / update_service_template_version

update_service_template_version

Proton.Client.update_service_template_version(**kwargs)

Update a major or minor version of a service template.

See also: AWS API Documentation

Request Syntax

response = client.update_service_template_version(
    compatibleEnvironmentTemplates=[
        {
            'majorVersion': 'string',
            'templateName': 'string'
        },
    ],
    description='string',
    majorVersion='string',
    minorVersion='string',
    status='REGISTRATION_IN_PROGRESS'|'REGISTRATION_FAILED'|'DRAFT'|'PUBLISHED',
    supportedComponentSources=[
        'DIRECTLY_DEFINED',
    ],
    templateName='string'
)

Parameters:

• compatibleEnvironmentTemplates (list) –

  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.

  • (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 a service template version to update.

• majorVersion (string) –

  [REQUIRED]

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

• minorVersion (string) –

  [REQUIRED]

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

• status (string) – The status of the service template minor version to update.

• supportedComponentSources (list) –

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

  • (string) –

• 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 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.

Exceptions

• Proton.Client.exceptions.ValidationException

• Proton.Client.exceptions.AccessDeniedException

• Proton.Client.exceptions.ThrottlingException

• Proton.Client.exceptions.ConflictException

• Proton.Client.exceptions.ResourceNotFoundException

• Proton.Client.exceptions.InternalServerException