Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Interface DeploymentEvent

An object that describes a deployment event.


  • DeploymentEvent


ActionInvocations?: ActionInvocation[]

The list of extensions that were invoked as part of the deployment.

Description?: string

A description of the deployment event. Descriptions include, but are not limited to, the following:

  • The Amazon Web Services account or the Amazon CloudWatch alarm ARN that initiated a rollback.

  • The percentage of hosts that received the deployment.

  • A recommendation to attempt a new deployment (in the case of an internal error).

EventType?: string

The type of deployment event. Deployment event types include the start, stop, or completion of a deployment; a percentage update; the start or stop of a bake period; and the start or completion of a rollback.

OccurredAt?: Date

The date and time the event occurred.

TriggeredBy?: string

The entity that triggered the deployment event. Events can be triggered by a user, AppConfig, an Amazon CloudWatch alarm, or an internal error.