get_proxy_instance_status¶

ManagementApi.get_proxy_instance_status(role_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Get Squid proxy instance patch compliance status

Returns EC2 state and SSM patch compliance for the InService Squid proxy instance. Requires system-settings.view. Only available when managed Squid proxy is enabled.

Parameters:

role_id (str) – Amorphic role ID the request is authorized against. Must be a role the user belongs to. Also recorded in audit logs. (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ProxyInstanceStatusResponse

Returns:

Returns the result object.

Request and Response Examples¶

HTTP: GET /proxy/instance/patchstatus

Success (HTTP 200)¶

InstanceId and InstanceState always. PatchSummary after a scan; otherwise Message. LastCommand only when a prior operation was recorded.

No SSM patch scan reported yet

{
  "InstanceId": "i-0123456789abcdef0",
  "InstanceState": "running",
  "Message": "Patch summary is not reported for this instance. Please scan the instance first to see the summary."
}

Scan reported and a last command is stored

{
  "InstanceId": "i-0123456789abcdef0",
  "InstanceState": "running",
  "PatchSummary": {
    "Installed": 120,
    "Missing": 3,
    "Failed": 0,
    "InstalledPendingReboot": 1
  },
  "LastScanTime": "2026-08-13T14:30:00Z",
  "LastCommand": {
    "OperationId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "CommandId": "11111111-2222-3333-4444-555555555555",
    "Operation": "Scan",
    "Status": "Succeeded",
    "StatusDetail": "Scan completed",
    "InitiatedAt": "2026-08-13 14:25:00",
    "TriggeredBy": "jane.doe",
    "RebootTriggered": false,
    "CompletionTime": "2026-08-13 14:30:00"
  }
}

Errors¶

Documented error codes: AUTH-1001, AUTH-1003, AUTH-1030, IPV-1002, GE-1060, GE-1034, RTE-1001.

HTTP 400

Validation or authorization failure. Body is {“Message”: “<CODE> - <text>”}. Codes: AUTH-1001, AUTH-1003, AUTH-1030 (missing system-settings.view), IPV-1002 (role_id), GE-1060 (invalid user).

Caller lacks system-settings.view

{
  "Message": "AUTH-1030 - User is not authorized to get proxy instance patch compliance status, patch summary, and last patch command status due to the following missing permission(s) - {'System Settings': ['view']}"
}

HTTP 500

Managed Squid proxy disabled and ASG/instance resolution use GE-1034. AWS client errors (including SSM patch-state and patch-info reads other than ParameterNotFound) return str(error). Other uncaught errors use {“Message”: “RTE-1001 - <exception>.”}.

Managed Squid proxy is not enabled

{
  "Message": "GE-1034 - Proxy instance patch management is applicable only when managed Squid proxy is enabled."
}

SSM ClientError (no code prefix)

{
  "Message": "An error occurred (InvalidInstanceId) when calling the DescribeInstancePatchStates operation: i-0123456789abcdef0 is not valid."
}

Uncaught handler failure

{
  "Message": "RTE-1001 - 'NoneType' object is not subscriptable."
}