Cancel Service Instance Deployment

proton_cancel_service_instance_deployment

R Documentation

Attempts to cancel a service instance deployment on an UpdateServiceInstance action, if the deployment is IN_PROGRESS

Description

Attempts to cancel a service instance deployment on an update_service_instance action, if the deployment is IN_PROGRESS. For more information, see Update a service instance in the Proton User guide.

The following list includes potential cancellation scenarios.

• If the cancellation attempt succeeds, the resulting deployment state is CANCELLED.

• If the cancellation attempt fails, the resulting deployment state is FAILED.

• If the current update_service_instance action succeeds before the cancellation attempt starts, the resulting deployment state is SUCCEEDED and the cancellation attempt has no effect.

Usage

proton_cancel_service_instance_deployment(serviceInstanceName,
  serviceName)

Arguments

serviceInstanceName

[required] The name of the service instance with the deployment to cancel.

serviceName

[required] The name of the service with the service instance deployment to cancel.

Value

A list with the following syntax:

list(
  serviceInstance = 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",
    environmentName = "string",
    lastAttemptedDeploymentId = "string",
    lastClientRequestToken = "string",
    lastDeploymentAttemptedAt = as.POSIXct(
      "2015-01-01"
    ),
    lastDeploymentSucceededAt = as.POSIXct(
      "2015-01-01"
    ),
    lastSucceededDeploymentId = "string",
    name = "string",
    serviceName = "string",
    spec = "string",
    templateMajorVersion = "string",
    templateMinorVersion = "string",
    templateName = "string"
  )
)

Request syntax

svc$cancel_service_instance_deployment(
  serviceInstanceName = "string",
  serviceName = "string"
)