HookProgressEvent ¶

class HookProgressEvent(TypedDict, closed=True):
    hook_type_name: NotRequired["capo_cloudcontrol.types.type_name.TypeName"]
    """<p>The type name of the Hook being invoked.</p>"""
    hook_type_version_id: NotRequired[
        "capo_cloudcontrol.types.type_version_id.TypeVersionId"
    ]
    """<p>The type version of the Hook being invoked.</p>"""
    hook_type_arn: NotRequired["capo_cloudcontrol.types.hook_type_arn.HookTypeArn"]
    """<p>The ARN of the Hook being invoked.</p>"""
    invocation_point: NotRequired[
        "capo_cloudcontrol.types.hook_invocation_point.HookInvocationPoint"
    ]
    """<p>States whether the Hook is invoked before or after resource provisioning.</p>"""
    hook_status: NotRequired["capo_cloudcontrol.types.hook_status.HookStatus"]
    """<p>The status of the Hook invocation. The following are potential statuses:</p> <ul> <li> <p> <code>HOOK_PENDING</code>: The Hook was added to the invocation plan, but not yet invoked.</p> </li> <li> <p> <code>HOOK_IN_PROGRESS</code>: The Hook was invoked, but hasn't completed.</p> </li> <li> <p> <code>HOOK_COMPLETE_SUCCEEDED</code>: The Hook invocation is complete with a successful result.</p> </li> <li> <p> <code>HOOK_COMPLETE_FAILED</code>: The Hook invocation is complete with a failed result.</p> </li> <li> <p> <code>HOOK_FAILED</code>: The Hook invocation didn't complete successfully.</p> </li> </ul>"""
    hook_event_time: NotRequired["capo_cloudcontrol.types.timestamp.Timestamp"]
    """<p>The time that the Hook invocation request initiated.</p>"""
    hook_status_message: NotRequired[
        "capo_cloudcontrol.types.status_message.StatusMessage"
    ]
    """<p>The message explaining the current Hook status.</p>"""
    failure_mode: NotRequired[
        "capo_cloudcontrol.types.hook_failure_mode.HookFailureMode"
    ]
    """<p>The failure mode of the invocation. The following are the potential statuses:</p> <ul> <li> <p> <code>FAIL</code>: This will fail the Hook invocation and the request associated with it.</p> </li> <li> <p> <code>WARN</code>: This will fail the Hook invocation, but not the request associated with it.</p> </li> </ul>"""