ec2.instances.get-patch-state

OS patch state: pending security updates, reboot needed or scheduled, kernel

GET /ec2/api/instances/{id}/patch-stateIAM ec2:DescribeInstancesRead

`data` is null for an instance that does not run the patch reporter (launched without `osPatching`). App boxes always run it.

Request syntax

GET /ec2/api/instances/{id}/patch-state

Path parameters

  • idRequired

    string

    Constraints: /^i-[0-9a-f]{6,32}$/

Response

200: `data` is the patch state (status, pendingUpdates, pendingSecurityUpdates, rebootRequired, rebootPackages, kernelRunning, kernelInstalled, osRelease, reportedAt, agentOutdated), or null.

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow ec2:DescribeInstances on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud ec2 instances get-patch-state id

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_ec2_instances_get-patch-state.