Offboard managed integrations hub

Overview of Hub SDK offboard process

The hub offboarding process removes a hub from AWS Cloud management system. When the cloud sends a DeleteManagedThing request, the process accomplishes two primary objectives:

Device-side actions:

Cloud-side actions:

Customers typically initiate hub offboarding when:

The process ensures a clean, secure transition between hub configurations, allowing seamless device management and account flexibility.

Prerequisites

Hub SDK offboard process

Follow these steps to offboard the hub:

Retrieve hub_managed_thing ID

The iotmi_config.json file is used to store the managed thing ID for a Managed integrations hub. This identifier is a critical piece of information that allows the hub to communicate with the AWS IoT Managed integrations service. The managed thing ID is stored within the rw (read-write) section of the JSON file, under the managed_thing_id field. This is seen in the following sample configuration:

{
      "ro": {
          "iot_provisioning_method": "FLEET_PROVISIONING",
          "iot_claim_cert_path": "PATH",
          "iot_claim_pk_path": "PATH",
          "UPC": "UPC",
          "sh_endpoint_url": "ENDPOINT_URL",
          "SN": "SN",
          "fp_template_name": "TEMPLATENAME"
      },
      "rw": {
          "iot_provisioning_state": "PROVISIONED",
          "client_id": "ID",
          "managed_thing_id": "ID",
          "iot_permanent_cert_path": "CERT_PATH",
          "iot_permanent_pk_path": "KEY",
          "metadata": {
              "last_updated_epoch_time": 1747766125
          }
      }
}

Send command to offboard hub

Use your account credentials and run the command with the managed_thing_id retrieved in the previous section:

aws iot-managed-integrations delete-managed-thing \
    --identifier HUB_MANAGED_THING_ID

Verify hub was offboarded

Use your account credentials and run the command with the managed_thing_id retrieved in the previous section:

aws iot-managed-integrations get-managed-thing \
    --identifier HUB_MANAGED_THING_ID

Success and failure scenarios

Success scenario

If the command to offboard the hub was successful, the following sample response is expected:

{
      "Message" : "Managed Thing resource not found."   
}

Additionally, the following sample iotmi_config.json would be observed if the hub offboarding command was successful. Verify that the rw section contains only iot_provisioning_state and optionally metadata. The absence of metadata is acceptable. iot_provisioning_state must be NOT_PROVISIONED.

{
      "ro": {
          "iot_provisioning_method": "FLEET_PROVISIONING",
          "iot_claim_cert_path": "PATH",
          "iot_claim_pk_path": "PATH",
          "UPC": "1234567890101",
          "sh_endpoint_url": "ENDPOINT_URL",
          "SN": "1234567890101",
          "fp_template_name": "test-template"
      },
      "rw": {
          "iot_provisioning_state": "NOT_PROVISIONED",
          "metadata": {
              "last_updated_epoch_time": 1747766125
          }
      }
}

Failure scenario

If the command to offboard the hub was unsuccessful, the following sample response is expected:

{
      "Arn" : "ARN",
      "CreatedAt" : 1.748968266655E9,
      "Id" : "ID",
      "ProvisioningStatus" : "DELETE_IN_PROGRESS",
      "Role" : "CONTROLLER",
      "SerialNumber" : "SERIAL_NO",
      "Tags" : { },
      "UniversalProductCode" : "UPC",
      "UpdatedAt" : 1.748968272107E9
}

{
      "ro": {
          "iot_provisioning_method": "FLEET_PROVISIONING",
          "iot_claim_cert_path": "PATH",
          "iot_claim_pk_path": "PATH",
          "UPC": "123456789101",
          "sh_endpoint_url": "ENDPOINT_URL",
          "SN": "123456789101",
          "fp_template_name": "test-template"
      },
      "rw": {
          "iot_provisioning_state": "PROVISIONED",
          "client_id": "ID",
          "managed_thing_id": "ID",
          "iot_permanent_cert_path": "PATH",
          "iot_permanent_pk_path": "PATH",
          "metadata": {
              "last_updated_epoch_time": 1747766125
          }
      }
}

(Optional) After offboarding Hub SDK