Skip to content

ApplicationStatusReason

Source code in docs_src/capo_ec2/types/application_status_reason.py
class ApplicationStatusReason(TypedDict, closed=True):
    code: NotRequired["capo_ec2.types.string.String"]
    """<p>The reason code for the application status check result. Possible values:</p> <ul> <li> <p> <code>ResponseCodeMatched</code> – The HTTP status code returned by the health check matched the configured <code>StatusCodeMatcher</code>.</p> </li> <li> <p> <code>ResponseCodeMismatch</code> – The HTTP status code returned by the health check did not match the configured <code>StatusCodeMatcher</code>.</p> </li> <li> <p> <code>ConnectionTimeout</code> – The connection to the target timed out.</p> </li> <li> <p> <code>ResponseTimeout</code> – The health check timed out while waiting for a response from the target.</p> </li> <li> <p> <code>ConnectionRefused</code> – The target refused the health check connection.</p> </li> <li> <p> <code>ConnectionReset</code> – The target reset the health check connection before returning a response.</p> </li> </ul> <p>Current health check results use the values in the preceding list. Legacy results that do not contain structured reason metadata can instead contain a producer error type, such as <code>Http Status Code</code> or <code>HttpConnectTimeoutException</code>.</p> <p>For <code>ResponseCodeMatched</code> and <code>ResponseCodeMismatch</code>, the <code>statusCode</code> field contains the returned HTTP status code. The <code>protocol</code> field contains the protocol used for the health check.</p>"""
    status_code: NotRequired["capo_ec2.types.integer.Integer"]
    """<p>The HTTP status code returned by the health check.</p>"""
    protocol: NotRequired["capo_ec2.types.string.String"]
    """<p>The protocol used for the health check. Possible values: <code>HTTP</code> and <code>HTTPS</code>.</p>"""

code instance-attribute

code: NotRequired[String]

The reason code for the application status check result. Possible values:

  • ResponseCodeMatched – The HTTP status code returned by the health check matched the configured StatusCodeMatcher.

  • ResponseCodeMismatch – The HTTP status code returned by the health check did not match the configured StatusCodeMatcher.

  • ConnectionTimeout – The connection to the target timed out.

  • ResponseTimeout – The health check timed out while waiting for a response from the target.

  • ConnectionRefused – The target refused the health check connection.

  • ConnectionReset – The target reset the health check connection before returning a response.

Current health check results use the values in the preceding list. Legacy results that do not contain structured reason metadata can instead contain a producer error type, such as Http Status Code or HttpConnectTimeoutException.

For ResponseCodeMatched and ResponseCodeMismatch, the statusCode field contains the returned HTTP status code. The protocol field contains the protocol used for the health check.

protocol instance-attribute

protocol: NotRequired[String]

The protocol used for the health check. Possible values: HTTP and HTTPS.

status_code instance-attribute

status_code: NotRequired[Integer]

The HTTP status code returned by the health check.