Skip to main content

DeviceList

devices object[]required
  • Array [
  • idstringrequired

    Record identifier. Always equal to imei.

    imeiImeirequired

    15-digit IMEI.

    Possible values: >= 15 characters and <= 15 characters, Value must match regular expression ^\d{15}$

    Example: 123456789012345
    provisioningStatusProvisioningStatusrequired

    Possible values: [pending, active, inactive, decommissioned]

    businessUnitBusinessUnitrequired

    Business unit key.

    Possible values: [addv, lfc]

    Example: addv
    environmentEnvironmentrequired

    Selects the downstream sink where this device's incoming telemetry is delivered. The value is not restricted to a fixed list; each business unit uses labels that map to routing in the data platform.

    Examples:
    Example: prod
    thingArnstring

    ARN of the IoT Thing. Set by Fleet Provisioning; absent while pending.

    Example: arn:aws:iot:eu-west-1:123456789012:thing/123456789012345
    createdAtstring<date-time>required
    updatedAtstring<date-time>required

    Also used as an optimistic lock; concurrent writes return 409.

    provisionedAtstring<date-time>

    Set by Fleet Provisioning; absent while pending.

  • ]
  • nextTokenstring

    Present when more results exist. Pass it back as the nextToken query parameter.

    DeviceList
    {
    "devices": [
    {
    "id": "123456789012345",
    "imei": "123456789012345",
    "provisioningStatus": "active",
    "businessUnit": "addv",
    "environment": "prod",
    "thingArn": "arn:aws:iot:eu-west-1:123456789012:thing/123456789012345",
    "createdAt": "2026-03-02T09:15:00.000Z",
    "updatedAt": "2026-03-04T11:20:31.000Z",
    "provisionedAt": "2026-03-04T11:20:31.000Z"
    }
    ],
    "nextToken": "string"
    }
    DEVELOPMENT-AEE0BEE-202611111822