Proton / Client / get_service_template_version

get_service_template_version#

Proton.Client.get_service_template_version(**kwargs)#

Get detailed data for a major or minor version of a service template.

See also: AWS API Documentation

Request Syntax

response = client.get_service_template_version(
    majorVersion='string',
    minorVersion='string',
    templateName='string'
)
Parameters:
  • majorVersion (string) –

    [REQUIRED]

    To get service template major version detail data, include major Version.

  • minorVersion (string) –

    [REQUIRED]

    To get service template minor version detail data, include minorVersion.

  • templateName (string) –

    [REQUIRED]

    The name of the service template a version of which you want to get detailed data for.

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 detailed data of the requested service template version.

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

  • Proton.Client.exceptions.InternalServerException