Proton / Client / create_environment_template_version

create_environment_template_version#

Proton.Client.create_environment_template_version(**kwargs)#

Create a new major or minor version of an environment template. A major version of an environment template is a version that isn’t backwards compatible. A minor version of an environment template is a version that’s backwards compatible within its major version.

See also: AWS API Documentation

Request Syntax

response = client.create_environment_template_version(
    clientToken='string',
    description='string',
    majorVersion='string',
    source={
        's3': {
            'bucket': 'string',
            'key': 'string'
        }
    },
    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 environment template version that the first request created.

    This field is autopopulated if not provided.

  • description (string) – A description of the new version of an environment template.

  • majorVersion (string) –

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

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

  • source (dict) –

    [REQUIRED]

    An object that includes the template bundle S3 bucket path and name for the new version of an 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.

  • tags (list) –

    An optional list of metadata items that you can associate with the Proton environment 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 environment template.

Return type:

dict

Returns:

Response Syntax

{
    'environmentTemplateVersion': {
        'arn': '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',
        'templateName': 'string'
    }
}

Response Structure

  • (dict) –

    • environmentTemplateVersion (dict) –

      The environment template detail data that’s returned by Proton.

      • arn (string) –

        The Amazon Resource Name (ARN) of the version of an environment template.

      • createdAt (datetime) –

        The time when the version of an environment template was created.

      • description (string) –

        A description of the minor version of an environment template.

      • lastModifiedAt (datetime) –

        The time when the version of an environment template was last modified.

      • majorVersion (string) –

        The latest major version that’s associated with the version of an environment template.

      • minorVersion (string) –

        The minor version of an environment template.

      • recommendedMinorVersion (string) –

        The recommended minor version of the environment template.

      • schema (string) –

        The schema of the version of an environment template.

      • status (string) –

        The status of the version of an environment template.

      • statusMessage (string) –

        The status message of the version of an environment template.

      • templateName (string) –

        The name of the version of an environment template.

Exceptions