list_proxy_instance_patches

ManagementApi.list_proxy_instance_patches(role_id, state=None, limit=None, offset=None, sortby=None, sortorder=None, filter_expression=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

List Squid proxy instance patches

Returns SSM patches 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)

  • state (str) – SSM patch state filter. Defaults to Missing. All skips the SSM State filter. Invalid values return IPV-1041.

  • limit (str) – Page size as a string. Defaults to 100. Must be a positive integer. Values above 1000 return IPV-1050.

  • offset (str) – 1-based item offset as a string (1 is the first patch, not a page number). Defaults to 1. Last page when next_available is no.

  • sortby (str) – Sort field after the SSM list is loaded. Defaults to ReleaseDate. Invalid values return IPV-1041.

  • sortorder (str) – Sort direction. Defaults to desc. Only asc and desc are allowed (IPV-1041 otherwise).

  • filter_expression (str) – Comma-separated key:value filters applied in-memory (e.g. Severity:Medium,State:Missing).

  • _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:

ProxyInstancePatchesListResponse

Returns:

Returns the result object.

Request and Response Examples

HTTP: GET /proxy/instance/patches

Success (HTTP 200)

Patches for this page plus InstanceId, FilterState, count, total_count, and next_available. next_available is no on the last page.

Request / response example

{
  "InstanceId": "i-0123456789abcdef0",
  "FilterState": "Missing",
  "Patches": [
    {
      "PatchId": "KB5021234",
      "Title": "Security Update",
      "Severity": "Critical",
      "Classification": "SecurityUpdates",
      "State": "Missing",
      "ReleaseDate": "2026-08-01"
    }
  ],
  "count": 1,
  "total_count": 1,
  "next_available": "no"
}

Errors

Documented error codes: AUTH-1001, AUTH-1003, AUTH-1030, IPV-1002, GE-1060, IPV-1041, IPV-1050, 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), IPV-1041 (State, sortby, sortorder, non-integer or non-positive limit/offset), IPV-1050 (limit over 1000).

Caller lacks system-settings.view

{
  "Message": "AUTH-1030 - User is not authorized to list proxy instance patches filtered by state with pagination due to the following missing permission(s) - {'System Settings': ['view']}"
}

State is not allowed

{
  "Message": "IPV-1041 - Invalid parameter - State, allowed values/keys are ['Missing', 'InstalledPendingReboot', 'Installed', 'Failed', 'All']"
}

limit over 1000

{
  "Message": "IPV-1050 - Out of range for items per page, Limit is 1000"
}

offset is not a positive integer

{
  "Message": "IPV-1041 - Invalid parameter - offset, allowed values/keys are a positive integer"
}

HTTP 500

Managed Squid proxy disabled, ASG/instance resolution, and other GE-1034 cases. AWS client errors 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 DescribeInstancePatches operation: i-0123456789abcdef0 is not valid."
}

Uncaught handler failure

{
  "Message": "RTE-1001 - 'ReleaseDate'."
}