Skip to content

DeploymentEvent

Source code in docs_src/capo_appconfig/types/deployment_event.py
class DeploymentEvent(TypedDict, closed=True):
    event_type: NotRequired[
        "capo_appconfig.types.deployment_event_type.DeploymentEventType"
    ]
    """<p>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.</p>"""
    triggered_by: NotRequired["capo_appconfig.types.triggered_by.TriggeredBy"]
    """<p>The entity that triggered the deployment event. Events can be triggered by a user, AppConfig, an Amazon CloudWatch alarm, or an internal error.</p>"""
    description: NotRequired["capo_appconfig.types.description.Description"]
    """<p>A description of the deployment event. Descriptions include, but are not limited to, the following:</p> <ul> <li> <p>The Amazon Web Services account or the Amazon CloudWatch alarm ARN that initiated a rollback.</p> </li> <li> <p>The percentage of hosts that received the deployment.</p> </li> <li> <p>A recommendation to attempt a new deployment (in the case of an internal error).</p> </li> </ul>"""
    action_invocations: NotRequired[
        "capo_appconfig.types.action_invocations.ActionInvocations"
    ]
    """<p>The list of extensions that were invoked as part of the deployment.</p>"""
    occurred_at: NotRequired["capo_appconfig.types.iso8601_date_time.Iso8601DateTime"]
    """<p>The date and time the event occurred.</p>"""

action_invocations instance-attribute

action_invocations: NotRequired[ActionInvocations]

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

description instance-attribute

description: NotRequired[Description]

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).

event_type instance-attribute

event_type: NotRequired[DeploymentEventType]

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.

occurred_at instance-attribute

occurred_at: NotRequired[Iso8601DateTime]

The date and time the event occurred.

triggered_by instance-attribute

triggered_by: NotRequired[TriggeredBy]

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