1. Docs
2. Reference
3. REST API Docs
4. Schema
5. ListDeploymentSnapshot

ListDeploymentResponse is the response from the API when listing Deployments.

Properties

• id string required
  Unique identifier for this deployment.
• projectName string optional
  ProjectName is the name of the project.
• created string required
  Created defines when the Deployment was created.
• stackName string optional
  StackName is the name of the stack.
• modified string required
  Created defines when the corresponding WorkflowRun was modified.
• paused boolean optional
  Paused indicates whether or not deployments are paused for this program.
• pulumiOperation enum required
  PulumiOperation is the operation that was performed.
  Values:

  update — Update

  preview — Preview

  destroy — Destroy

  refresh — Refresh

  detect-drift — DetectDrift

  remediate-drift — RemediateDrift

• status enum required
  The current execution status of the deployment. not-started means the deployment is waiting in the queue. The Pulumi Cloud console shows it as Queued, or as Paused when deployments are paused for the stack or the organization. accepted means the deployment has been taken off the queue for execution but has not started running yet. The console shows it alongside running. Webhook payloads report both not-started and accepted as queued. running means at least one step has started and no step has failed. failed covers, for example, a failed step, a timeout, or a cancellation, whether the deployment was queued or running. skipped means the deployment was removed from the queue without running, either because operationContext.options.skipIntermediateDeployments is enabled for it and a newer deployment of the same operation is queued right behind it for the same stack, or because it was still queued seven days after it was created. Once the deployment’s job has started, this matches the job’s status.
  Values:

  not-started — NotStarted

  The work has been created but has not started yet.

  accepted — Accepted

  The work has been picked up for execution but has not started running yet.

  running — Running

  The work is executing.

  failed — Failed

  The work finished without completing successfully. Failures, timeouts, and cancellations are all reported as failed, and there is no separate status for canceled work. This is a terminal status.

  succeeded — Succeeded

  The work completed successfully. This is a terminal status.

  skipped — Skipped

  The work was dropped without ever running. Only deployments report this status. This is a terminal status.

• updates array[DeploymentNestedUpdate] required
  Updates
• ↳ id string required
  Unique identifier for this update.
• ↳ updateID string required
  Identifier of the underlying Pulumi CLI update operation.
• ↳ version integer required
  The version number of the update.
• ↳ startTime integer required
  The Unix timestamp when the update started.
• ↳ endTime integer required
  The Unix timestamp when the update ended.
• ↳ result enum required
  The outcome of this individual Pulumi update. This reports the result of one update rather than the status of the deployment as a whole, and it uses a different set of values from the deployment’s status.
  Values:

  not-started — NotStarted

  The update has not started.

  in-progress — InProgress

  The update has not yet completed.

  succeeded — Succeeded

  The update completed successfully.

  failed — Failed

  The update has failed.

• ↳ kind enum required
  The kind of update operation.
  Values:

  update — Update

  A Pulumi program update.

  preview — Preview

  A preview of an update, without impacting resources.

  refresh — Refresh

  A refresh operation.

  rename — Rename

  A rename of the stack or project name.

  destroy — Destroy

  An update which removes all resources.

  import — Import

  An update that entails importing a raw checkpoint file.

  resource-import — ResourceImport

  An update that entails importing one or more resources.

  Pupdate — PreviewUpdate

  A preview of an update operation.

  Prefresh — PreviewRefresh

  A preview of a refresh operation.

  Pdestroy — PreviewDestroy

  A preview of a destroy operation.

  Pimport — PreviewImport

  A preview of an import operation.

  Prename — PreviewRename

  A preview of a rename operation.

• ↳ message string required
  A message associated with the update.
• ↳ environment map[string]string required
  The environment variables associated with the update.
• version integer required
  Version is the ordinal ID for the stack
• jobs array[DeploymentJob] required
  The list of jobs in this deployment
• ↳ status enum required
  The current execution status of this job. A deployment reports the status of its job, so this is normally the same value as the deployment’s own status.
  Values:

  not-started — NotStarted

  The work has been created but has not started yet.

  accepted — Accepted

  The work has been picked up for execution but has not started running yet.

  running — Running

  The work is executing.

  failed — Failed

  The work finished without completing successfully. Failures, timeouts, and cancellations are all reported as failed, and there is no separate status for canceled work. This is a terminal status.

  succeeded — Succeeded

  The work completed successfully. This is a terminal status.

  skipped — Skipped

  The work was dropped without ever running. Only deployments report this status. This is a terminal status.

• ↳ started string optional
  The timestamp when the job started.
• ↳ lastUpdated string optional
  The timestamp when the job was last updated.
• ↳ steps array[StepRun] required
  The list of steps in the deployment job.
• requestedBy UserInfo required
  RequestedBy contains the user information about the user who created the Deployment
• ↳ name string required
  The user’s display name.
• ↳ githubLogin string required
  The user’s login name.
• ↳ avatarUrl string required
  The URL of the user’s avatar image.
• ↳ email string optional
  The user’s email address. It is only populated on selected endpoints and is omitted from most responses. Treat it as sensitive information.
• initiator string optional
  Initiator is the initiation source of the deployment.
• agentPool ListDeploymentSnapshotAgentPool optional
  The agent pool used for this deployment, if any
• ↳ id string required
  The agent pool identifier
• ↳ name string required
  The agent pool name