Skip to content

DeploymentSummary

Source code in docs_src/capo_appconfig/types/deployment_summary.py
class DeploymentSummary(TypedDict, closed=True):
    deployment_number: "capo_appconfig.types.integer.Integer"
    """<p>The sequence number of the deployment.</p>"""
    configuration_profile_id: NotRequired["capo_appconfig.types.id.Id"]
    """<p>The ID of the configuration profile that was deployed.</p>"""
    configuration_name: NotRequired["capo_appconfig.types.name.Name"]
    """<p>The name of the configuration.</p>"""
    configuration_version: NotRequired["capo_appconfig.types.version.Version"]
    """<p>The version of the configuration.</p>"""
    deployment_duration_in_minutes: (
        "capo_appconfig.types.minutes_between0_and24_hours.MinutesBetween0And24Hours"
    )
    """<p>Total amount of time the deployment lasted.</p>"""
    growth_type: NotRequired["capo_appconfig.types.growth_type.GrowthType"]
    """<p>The algorithm used to define how percentage grows over time.</p>"""
    growth_factor: NotRequired["capo_appconfig.types.percentage.Percentage"]
    """<p>The percentage of targets to receive a deployed configuration during each interval.</p>"""
    final_bake_time_in_minutes: (
        "capo_appconfig.types.minutes_between0_and24_hours.MinutesBetween0And24Hours"
    )
    """<p>The amount of time that AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.</p>"""
    state: NotRequired["capo_appconfig.types.deployment_state.DeploymentState"]
    """<p>The state of the deployment.</p>"""
    percentage_complete: NotRequired["capo_appconfig.types.percentage.Percentage"]
    """<p>The percentage of targets for which the deployment is available.</p>"""
    started_at: NotRequired["capo_appconfig.types.iso8601_date_time.Iso8601DateTime"]
    """<p>Time the deployment started.</p>"""
    completed_at: NotRequired["capo_appconfig.types.iso8601_date_time.Iso8601DateTime"]
    """<p>Time the deployment completed.</p>"""
    version_label: NotRequired["capo_appconfig.types.version_label.VersionLabel"]
    """<p>A user-defined label for an AppConfig hosted configuration version.</p>"""
    type: NotRequired["capo_appconfig.types.deployment_type.DeploymentType"]
    """<p>The type of deployment.</p>"""

completed_at instance-attribute

completed_at: NotRequired[Iso8601DateTime]

Time the deployment completed.

configuration_name instance-attribute

configuration_name: NotRequired[Name]

The name of the configuration.

configuration_profile_id instance-attribute

configuration_profile_id: NotRequired[Id]

The ID of the configuration profile that was deployed.

configuration_version instance-attribute

configuration_version: NotRequired[Version]

The version of the configuration.

deployment_duration_in_minutes instance-attribute

deployment_duration_in_minutes: MinutesBetween0And24Hours

Total amount of time the deployment lasted.

deployment_number instance-attribute

deployment_number: Integer

The sequence number of the deployment.

final_bake_time_in_minutes instance-attribute

final_bake_time_in_minutes: MinutesBetween0And24Hours

The amount of time that AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.

growth_factor instance-attribute

growth_factor: NotRequired[Percentage]

The percentage of targets to receive a deployed configuration during each interval.

growth_type instance-attribute

growth_type: NotRequired[GrowthType]

The algorithm used to define how percentage grows over time.

percentage_complete instance-attribute

percentage_complete: NotRequired[Percentage]

The percentage of targets for which the deployment is available.

started_at instance-attribute

started_at: NotRequired[Iso8601DateTime]

Time the deployment started.

state instance-attribute

state: NotRequired[DeploymentState]

The state of the deployment.

type instance-attribute

type: NotRequired[DeploymentType]

The type of deployment.

version_label instance-attribute

version_label: NotRequired[VersionLabel]

A user-defined label for an AppConfig hosted configuration version.