Post x amz targetawsproton20200720.createservice

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1484319348.7 KB

Create an Proton service. An Proton service is an instantiation of a service template and often includes several service instances and pipeline. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-services.html">Services</a> in the Proton User Guide.

post/#X-Amz-Target=AwsProton20200720.CreateService

Headers

X-Amz-Target'AwsProton20200720.CreateService' required

Request body

branchNamestring

The name of the code repository branch that holds the code that's deployed in Proton. Don't include this parameter if your service template doesn't include a service pipeline.

descriptionstring password

A description of the Proton service.

namestring required

The service name.

repositoryConnectionArnstring

The Amazon Resource Name (ARN) of the repository connection. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/setting-up-for-service.html#setting-up-vcontrol">Setting up an AWS CodeStar connection</a> in the Proton User Guide. Don't include this parameter if your service template doesn't include a service pipeline.

repositoryIdstring

The ID of the code repository. Don't include this parameter if your service template doesn't include a service pipeline.

specstring password required

A link to a spec file that provides inputs as defined in the service template bundle schema file. The spec file is in YAML format. Don’t include pipeline inputs in the spec if your service template doesn’t include a service pipeline. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-create-svc.html">Create a service</a> in the Proton User Guide.

templateMajorVersionstring required

The major version of the service template that was used to create the service.

templateMinorVersionstring

The minor version of the service template that was used to create the service.

templateNamestring required

The name of the service template that's used to create the service.

Response

Success