Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . proton ]

update-service-template-version

Description

Update a major or minor version of a service template.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-service-template-version
[--compatible-environment-templates <value>]
[--description <value>]
--major-version <value>
--minor-version <value>
[--status <value>]
[--supported-component-sources <value>]
--template-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--compatible-environment-templates (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.

(structure)

Compatible environment template data.

majorVersion -> (string)

The major version of the compatible environment template.

templateName -> (string)

The compatible environment template name.

Shorthand Syntax:

majorVersion=string,templateName=string ...

JSON Syntax:

[
  {
    "majorVersion": "string",
    "templateName": "string"
  }
  ...
]

--description (string)

A description of a service template version to update.

--major-version (string)

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

--minor-version (string)

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

--status (string)

The status of the service template minor version to update.

Possible values:

  • REGISTRATION_IN_PROGRESS
  • REGISTRATION_FAILED
  • DRAFT
  • PUBLISHED

--supported-component-sources (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 Administrator Guide .

(string)

Syntax:

"string" "string" ...

Where valid values are:
  DIRECTLY_DEFINED

--template-name (string)

The name of the service template.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

serviceTemplateVersion -> (structure)

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.

(structure)

Compatible environment template data.

majorVersion -> (string)

The major version of the compatible environment template.

templateName -> (string)

The compatible environment template name.

createdAt -> (timestamp)

The time when the version of a service template was created.

description -> (string)

A description of the version of a service template.

lastModifiedAt -> (timestamp)

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 Administrator Guide .

(string)

templateName -> (string)

The name of the version of a service template.