Industrial IoT / SCADA · API / SDK

AWS IoT Greengrass API

AWS

Manage edge components and deployments for connected devices.

Official documentation Download development spec

V1 is outside the supported path in this guide. Official pages list different 2026 end-of-support dates (June 1 and October 7); both precede this review. Use V2 and verify migration details with AWS.

AWS IOT GREENGRASS V2 / DEVELOPER FIELD GUIDE

Choose an interface. Define a verifiable result.

Company or project context, ten technical entry points and a practical analysis of every reference.

2026-10-08 · Integration not tested

Company / project overview

Original summary of official company or project statements; use the source for the full original page.

AWS IoT Greengrass V2 · About
Product	AWS IoT Greengrass combines an open-source edge runtime with cloud management for device software.
Local operation	Components can process local data and communicate with local services or AWS IoT Core.
Lifecycle	This guide targets Version 2; official sources announce Version 1 end of support.

Complete official About page ↗

About reference — TA analysis
Audience	Buyers, partners and product owners shortlisting an AI provider.
Our assessment	Use positioning and company history for initial fit. Obtain project-specific deployment, support and commercial terms separately.

Official sources reviewed; no live API, inference or benchmark was run. Expected results are proposed internal contracts.

Top 10 technical entry points

Ten documented technical entry points selected by developer task; not ten separate SDKs or an official ranking.

Choose by the work you need to complete
Interface	Purpose and audience
01 · V2 getting startedAPI / SDK / developer guide	Install a core device and package a component.Edge developers
02 · Component developmentAPI / SDK / developer guide	Build modular software using recipes and artifacts.Component authors
03 · Component recipeAPI / SDK / developer guide	Declare component lifecycle, configuration and dependencies.Release engineers
04 · IPC SDK integrationAPI / SDK / developer guide	Communicate with nucleus and supported local services.Device SDK engineers
05 · Local publish/subscribeAPI / SDK / developer guide	Exchange messages among local components.Local event developers
06 · IoT Core MQTT IPCAPI / SDK / developer guide	Publish or subscribe to AWS IoT Core through IPC.Cloud telemetry teams
07 · Deployment guideAPI / SDK / developer guide	Roll components and configuration out to devices.Fleet operators
08 · CreateDeployment APIAPI / SDK / developer guide	Create a target deployment or new revision.Deployment API teams
09 · GetDeployment APIAPI / SDK / developer guide	Retrieve the deployment definition and metadata.Deployment status integrators
10 · ListInstalledComponents APIAPI / SDK / developer guide	Inspect reported installed components for a core device.Fleet inventory teams

Reference analysis

Capabilities summarize official documentation. Constraints and proposed tests are our engineering assessment.

API / SDK / developer guide

V2 getting started

V2 getting started · TA
Target audience	Edge developers
Documented capability	Install a core device and package a component.
Input → output	Device and component setup → development deployment.
Execution environment	Greengrass V2 core device plus selected AWS account/region
Our decision constraint	Tutorial setup is not a production provisioning design.
Our suggested validation	Check supported OS, identity and component startup on target.

Official reference · V2 getting started ↗

API / SDK / developer guide

Component development

Component development · TA
Target audience	Component authors
Documented capability	Build modular software using recipes and artifacts.
Input → output	Recipe and binaries → versioned component.
Execution environment	Greengrass V2 core device plus selected AWS account/region
Our decision constraint	Artifacts must match device platform and dependencies.
Our suggested validation	Exercise install/run/shutdown stages on a test device.

Official reference · Component development ↗

API / SDK / developer guide

Component recipe

Component recipe · TA
Target audience	Release engineers
Documented capability	Declare component lifecycle, configuration and dependencies.
Input → output	JSON/YAML recipe → component runtime definition.
Execution environment	Greengrass V2 core device plus selected AWS account/region
Our decision constraint	Lifecycle scripts can alter devices and need scoped permissions.
Our suggested validation	Validate platform selectors and missing dependency behavior.

Official reference · Component recipe ↗

API / SDK / developer guide

IPC SDK integration

IPC SDK integration · TA
Target audience	Device SDK engineers
Documented capability	Communicate with nucleus and supported local services.
Input → output	SDK IPC request → authorized local operation.
Execution environment	Greengrass V2 core device plus selected AWS account/region
Our decision constraint	IPC authorization differs from AWS cloud IAM.
Our suggested validation	Test allowed and denied IPC resources independently.

Official reference · IPC SDK integration ↗

API / SDK / developer guide

Local publish/subscribe

Local publish/subscribe · TA
Target audience	Local event developers
Documented capability	Exchange messages among local components.
Input → output	Topic and payload → local subscription delivery.
Execution environment	Greengrass V2 core device plus selected AWS account/region
Our decision constraint	Local delivery does not imply cloud synchronization.
Our suggested validation	Check topic permissions and subscriber receipt with correlation IDs.

Official reference · Local publish/subscribe ↗

API / SDK / developer guide

IoT Core MQTT IPC

IoT Core MQTT IPC · TA
Target audience	Cloud telemetry teams
Documented capability	Publish or subscribe to AWS IoT Core through IPC.
Input → output	MQTT topic/payload → cloud messaging operation.
Execution environment	Greengrass V2 core device plus selected AWS account/region
Our decision constraint	Network, component permissions and IoT policy all affect delivery.
Our suggested validation	Test disconnection and distinguish publish acceptance from consumer processing.

Official reference · IoT Core MQTT IPC ↗

API / SDK / developer guide

Deployment guide

Deployment guide · TA
Target audience	Fleet operators
Documented capability	Roll components and configuration out to devices.
Input → output	Target and desired component versions → deployment rollout.
Execution environment	Greengrass V2 core device plus selected AWS account/region
Our decision constraint	Offline devices may not immediately receive desired state.
Our suggested validation	Observe per-device completion and version reconciliation.

Official reference · Deployment guide ↗

API / SDK / developer guide

CreateDeployment API

CreateDeployment API · TA
Target audience	Deployment API teams
Documented capability	Create a target deployment or new revision.
Input → output	Target ARN and component map → deployment identifiers.
Execution environment	Greengrass V2 core device plus selected AWS account/region
Our decision constraint	A new deployment replaces the previous target deployment definition.
Our suggested validation	Review full component set and use documented idempotency token behavior.

Official reference · CreateDeployment API ↗

API / SDK / developer guide

GetDeployment API

GetDeployment API · TA
Target audience	Deployment status integrators
Documented capability	Retrieve the deployment definition and metadata.
Input → output	Deployment ID → deployment record.
Execution environment	Greengrass V2 core device plus selected AWS account/region
Our decision constraint	Deployment metadata alone does not prove every device is healthy.
Our suggested validation	Compare desired versions with per-device installed components.

Official reference · GetDeployment API ↗

API / SDK / developer guide

ListInstalledComponents API

ListInstalledComponents API · TA
Target audience	Fleet inventory teams
Documented capability	Inspect reported installed components for a core device.
Input → output	Core device and pagination → component inventory.
Execution environment	Greengrass V2 core device plus selected AWS account/region
Our decision constraint	Cloud-reported state can lag disconnected devices.
Our suggested validation	Preserve status freshness and consume all pages.

Official reference · ListInstalledComponents API ↗

V2 API reference

V2 API reference · Supporting reference analysis
TA	Cloud integration teams
Our validation advice	Separate V2 cloud management API operations from device-side IPC.

Official reference · V2 API reference ↗

V2 developer overview and V1 lifecycle

V2 developer overview and V1 lifecycle · Supporting reference analysis
TA	Existing deployment owners
Our validation advice	Migrate V1 assumptions to V2 and resolve account-specific lifecycle details with AWS.

Official reference · V2 developer overview and V1 lifecycle ↗

04 / INPUT · EXPECTED OUTPUT · ACCEPTANCE

Expected results before implementation

Illustrative per-device deployment receipt; not native AWS API output. No AWS request, component deployment or device operation was performed.

Illustrative contract · no API call or model execution · not measured provider output

Device matches desired version

Expected behavior — illustrative, not executed
Input	A configured V2 component rollout has completed on the target.
Expected result	ok with desired and observed component version.
Acceptance	Confirm device-side health and timestamp, not only deployment creation.

Empty inventory

Expected behavior — illustrative, not executed
Input	Valid device inventory request returns no components.
Expected result	ok with components: []; preserve freshness metadata.
Acceptance	Do not label the device healthy solely from an empty list.

Device offline

Expected behavior — illustrative, not executed
Input	Cloud accepts desired deployment while target is disconnected.
Expected result	pending/unconfirmed; keep last reported version separate.
Acceptance	Do not fabricate completion or fresh device status.

Component failed

Expected behavior — illustrative, not executed
Input	Artifact or lifecycle process fails on the device.
Expected result	error with component context and configured failure handling.
Acceptance	Verify actual resulting version and health after failure handling.

Map the expected result to your application

Map the actual SDK or service response into this proposed internal contract after integration. All IDs and values below are invented examples; no credentials or live requests are included.

Expected output JSON — illustrative, not measured · AWSGreengrass-expected-results.json

{
  "schema_version": "1.0.0",
  "example": true,
  "provider": "AWS IoT Greengrass V2",
  "status": "ok",
  "input_id": "sample-001",
  "data": {
    "deployment_id": "example-deployment",
    "core_device": "example-device",
    "desired_component": {
      "name": "example.component",
      "version": "1.0.0"
    },
    "reported_version": "1.0.0",
    "device_state": "example-healthy",
    "observed_at": null
  },
  "error": null,
  "verification": "illustrative-only;not-provider-response"
}

Download specification, example and acceptance plan

Engineering handoff — our proposed contract and gates
Result interpretation	Successful transport or execution does not establish model accuracy. Preserve valid empty results separately from operational failure.
Reproducibility	Record model, runtime, configuration and input identifiers; agree quality and latency criteria before representative tests. No measured performance is claimed.
Operation boundary	Illustrative per-device deployment receipt; not native AWS API output. No AWS request, component deployment or device operation was performed.

Development assessment

Edge software rollout tracker

Development concept · integration not tested

Provider capabilities above are based on official documentation or repositories. The proposed product, inputs, deliverable and acceptance criteria below are our development assessment.

Integration pilot

Validate runtime, schemas or hardware together before estimating a deployable product.

Proposed inputs: A test device or simulator, a tag map and documented units.
Proposed deliverable: Timestamped device values with freshness, unit and connection state.
Acceptance criterion: Verify scaling and timestamps against the source; a disconnected device must not appear healthy.
Dependencies: A gateway or service account, an equipment schema and access to a test environment.

Integration condition

V1 is outside the supported path in this guide. Official pages list different 2026 end-of-support dates (June 1 and October 7); both precede this review. Use V2 and verify migration details with AWS.

Development sequence

Confirm access to AWS IoT Greengrass API, license and the exact supported version.
Prepare the sample above and implement one documented operation for “Edge software rollout tracker”.
Normalize the result with source, time and explicit error state; keep the provider response for review.
Run the acceptance criterion before estimating rollout effort or committing a customer deliverable.

How to validate demand

Record product views, documentation clicks, specification downloads and contextual hub clicks. These are event counts, not unique people or completed integrations.

This feasibility assessment uses implementation conditions. No traffic-based rank or delivery-time promise is assigned.

AWS IoT Greengrass API

Choose an interface. Define a verifiable result.

Company / project overview

Top 10 technical entry points

Reference analysis

V2 API reference

V2 developer overview and V1 lifecycle

Expected results before implementation

Device matches desired version

Empty inventory

Device offline

Component failed

Map the expected result to your application

Edge software rollout tracker

Integration condition

Development sequence

How to validate demand

Related products