UpdateService - AWS Proton

UpdateService

Edit a service description or use a spec to add and delete service instances.

Note

Existing service instances and the service pipeline can't be edited using this API. They can only be deleted.

Use the description parameter to modify the description.

Edit the spec parameter to add or delete instances.

Request Syntax

{ "description": "string", "name": "string", "spec": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

description

The edited service description.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 500.

Required: No

name

The name of the service to edit.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\-]*$

Required: Yes

spec

Lists the service instances to add and the existing service instances to remain. Omit the existing service instances to delete from the list. Don't include edits to the existing service instances or pipeline. For more information, see Edit a service in the AWS Proton Administrator Guide or the AWS Proton User Guide.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 51200.

Required: No

Response Syntax

{ "service": { "arn": "string", "branchName": "string", "createdAt": number, "description": "string", "lastModifiedAt": number, "name": "string", "pipeline": { "arn": "string", "createdAt": number, "deploymentStatus": "string", "deploymentStatusMessage": "string", "lastDeploymentAttemptedAt": number, "lastDeploymentSucceededAt": number, "spec": "string", "templateMajorVersion": "string", "templateMinorVersion": "string", "templateName": "string" }, "repositoryConnectionArn": "string", "repositoryId": "string", "spec": "string", "status": "string", "statusMessage": "string", "templateName": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

service

The service detail data that's returned by AWS Proton.

Type: Service object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

There isn't sufficient access for performing this action.

HTTP Status Code: 400

ConflictException

The request couldn't be made due to a conflicting operation or resource.

HTTP Status Code: 400

InternalServerException

The request failed to register with the service.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource wasn't found.

HTTP Status Code: 400

ServiceQuotaExceededException

A quota was exceeded. For more information, see AWS Proton Quotas in the AWS Proton Administrator Guide.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

ValidationException

The input is invalid or an out-of-range value was supplied for the input parameter.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: