Update Service

proton_update_service

R Documentation

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

Description

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

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.

You can't delete a service instance (remove it from the spec) if it has an attached component.

For more information about components, see Proton components in the Proton User Guide.

Usage

proton_update_service(description, name, spec)

Arguments

description

The edited service description.

name

[required] The name of the service to edit.

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 Proton User Guide.

Value

A list with the following syntax:

list(
  service = list(
    arn = "string",
    branchName = "string",
    createdAt = as.POSIXct(
      "2015-01-01"
    ),
    description = "string",
    lastModifiedAt = as.POSIXct(
      "2015-01-01"
    ),
    name = "string",
    pipeline = list(
      arn = "string",
      createdAt = as.POSIXct(
        "2015-01-01"
      ),
      deploymentStatus = "IN_PROGRESS"|"FAILED"|"SUCCEEDED"|"DELETE_IN_PROGRESS"|"DELETE_FAILED"|"DELETE_COMPLETE"|"CANCELLING"|"CANCELLED",
      deploymentStatusMessage = "string",
      lastAttemptedDeploymentId = "string",
      lastDeploymentAttemptedAt = as.POSIXct(
        "2015-01-01"
      ),
      lastDeploymentSucceededAt = as.POSIXct(
        "2015-01-01"
      ),
      lastSucceededDeploymentId = "string",
      spec = "string",
      templateMajorVersion = "string",
      templateMinorVersion = "string",
      templateName = "string"
    ),
    repositoryConnectionArn = "string",
    repositoryId = "string",
    spec = "string",
    status = "CREATE_IN_PROGRESS"|"CREATE_FAILED_CLEANUP_IN_PROGRESS"|"CREATE_FAILED_CLEANUP_COMPLETE"|"CREATE_FAILED_CLEANUP_FAILED"|"CREATE_FAILED"|"ACTIVE"|"DELETE_IN_PROGRESS"|"DELETE_FAILED"|"UPDATE_IN_PROGRESS"|"UPDATE_FAILED_CLEANUP_IN_PROGRESS"|"UPDATE_FAILED_CLEANUP_COMPLETE"|"UPDATE_FAILED_CLEANUP_FAILED"|"UPDATE_FAILED"|"UPDATE_COMPLETE_CLEANUP_FAILED",
    statusMessage = "string",
    templateName = "string"
  )
)

Request syntax

svc$update_service(
  description = "string",
  name = "string",
  spec = "string"
)