Skip to content

Diagnostics

Source code in docs_src/capo_codedeploy/types/diagnostics.py
class Diagnostics(TypedDict, closed=True):
    error_code: NotRequired[
        "capo_codedeploy.types.lifecycle_error_code.LifecycleErrorCode"
    ]
    """<p>The associated error code:</p> <ul> <li> <p>Success: The specified script ran.</p> </li> <li> <p>ScriptMissing: The specified script was not found in the specified location.</p> </li> <li> <p>ScriptNotExecutable: The specified script is not a recognized executable file type.</p> </li> <li> <p>ScriptTimedOut: The specified script did not finish running in the specified time period.</p> </li> <li> <p>ScriptFailed: The specified script failed to run as expected.</p> </li> <li> <p>UnknownError: The specified script did not run for an unknown reason.</p> </li> </ul>"""
    script_name: NotRequired["capo_codedeploy.types.script_name.ScriptName"]
    """<p>The name of the script.</p>"""
    message: NotRequired["capo_codedeploy.types.lifecycle_message.LifecycleMessage"]
    """<p>The message associated with the error.</p>"""
    log_tail: NotRequired["capo_codedeploy.types.log_tail.LogTail"]
    """<p>The last portion of the diagnostic log.</p> <p>If available, CodeDeploy returns up to the last 4 KB of the diagnostic log.</p>"""

error_code instance-attribute

error_code: NotRequired[LifecycleErrorCode]

The associated error code:

  • Success: The specified script ran.

  • ScriptMissing: The specified script was not found in the specified location.

  • ScriptNotExecutable: The specified script is not a recognized executable file type.

  • ScriptTimedOut: The specified script did not finish running in the specified time period.

  • ScriptFailed: The specified script failed to run as expected.

  • UnknownError: The specified script did not run for an unknown reason.

log_tail instance-attribute

log_tail: NotRequired[LogTail]

The last portion of the diagnostic log.

If available, CodeDeploy returns up to the last 4 KB of the diagnostic log.

message instance-attribute

message: NotRequired[LifecycleMessage]

The message associated with the error.

script_name instance-attribute

script_name: NotRequired[ScriptName]

The name of the script.