Implementieren Sie Operationen an der C2C-Steckverbinderschnittstelle

Managed Integrations for AWS IoT Device Management definiert vier Vorgänge, die Sie ausführen AWS Lambda müssen, um sich als Konnektor zu qualifizieren. Ihr C2C-Konnektor muss jeden der folgenden Vorgänge implementieren:

Einzelheiten des Aufrufs

Managed Integrations for ruft AWS IoT Device Management während der Aktion immer die Lambda-Funktion mit einer JSON-Zeichenfolgennutzlast auf. AWS Lambda invokeFunction Anforderungsvorgänge müssen in jeder Anforderungsnutzlast ein operationName Feld enthalten.

Einstellungen für den Aufruf:

Beispiel für eine Implementierung

Das Lambda, das Sie für Ihren Connector implementieren, analysiert eine operationName aus der Payload der Anfrage und implementiert die entsprechende Funktionalität für die Zuordnung zur Drittanbieter-Cloud:

public ConnectorResponse handleRequest(final ConnectorRequest request) 
        throws OperationFailedException {
    Operation operation;
    try {
        operation = Operation.valueOf(request.payload().operationName());
    } catch (IllegalArgumentException ex) {
        throw new ValidationException(
           "Unknown operation '%s'".formatted(request.payload().operationName()), 
           ex
        );
    }

    return switch (operation) {
        case ActivateUser -> activateUserManager.activateUser(request);
        case DiscoverDevices -> deviceDiscoveryManager.listDevices(request);
        case SendCommand -> sendCommandManager.sendCommand(request);
        case DeactivateUser -> deactivateUser.deactivateUser(request);
    };
}

Beispiele für das Anforderungsformat

In den folgenden Beispielen werden generische Konnektoranfragen von Managed Integrations detailliert beschrieben, in denen gemeinsame Felder für alle erforderlichen Schnittstellen vorhanden sind. Aus den Beispielen können Sie ersehen, dass es sowohl einen Anforderungsheader als auch eine Anforderungs-Payload gibt. Anforderungsheader sind auf jeder Bedienoberfläche üblich.

Beispiel für OAuth 2.0:

{
        "header": {
                "auth": { 
                        "token": "ashriu32yr97feqy7afsaf", 
                        "type": "OAuth2.0"
                }
        },
        "payload":{
                "operationName": "AWS.SendCommand",
                "operationVersion": "1.0",
                "connectorId": "exampleId",
        …
        }
}

Beispiel für eine allgemeine Autorisierung:

{
        "header": {
                "auth": { 
                        "secretsManager": {
                                "arn": "string",
                                "versionId": "string"
                        },
                        "type": "GeneralAuthorization"
                }
        },
        "payload":{
                "operationName": "AWS.SendCommand",
                "operationVersion": "1.0",
                "connectorId": "exampleId",
        …
        }
}

Standard-Anforderungsheader

Die Standard-Header-Felder variieren je nach Autorisierungstyp. Ihr Connector muss sowohl OAuth 2.0- als auch General Authorization-Anforderungsheader verarbeiten.

OAuth 2.0-Standard-Header:

{
    "header": {
        "auth": {
            "token": string,    // End user's Access Token
            "type": "OAuth2.0"
        }
    }
}

Standard-Header für die allgemeine Autorisierung:

{
    "header": {
        "auth": {
            "secretsManager": {
                "arn": "string",
                "versionId": "string"
            },
            "type": "GeneralAuthorization"
        }
    }
}

Payload anfordern

Zusätzlich zu den allgemeinen Headern hat jede Anfrage eine Nutzlast. Diese Payload wird zwar eindeutige Felder für jeden Operationstyp haben, aber jede Payload hat eine Reihe von Standardfeldern, die immer vorhanden sein werden.

Standard-Antwort-Header

Jeder Vorgang reagiert mit einer Antwort ACK auf verwaltete Integrationen für AWS IoT Device Management, die bestätigt, dass Ihr C2C-Connector die Anfrage erhalten und mit der Bearbeitung begonnen hat.

{
 	"header":{
 		"responseCode": 200 
 	},
 	"payload":{
 		"responseMessage": “Example response!”
 	}
}

{
    "header": {
        "responseCode": Integer
    }
}

Feld für den Antwort-Header

In den verschiedenen Connector-Schnittstellen und API-Schemas, die in diesem Dokument beschrieben werden, gibt es ein responseMessage Oder-Feld. Message Dies ist ein optionales Feld, das für den C2C-Konnektor Lambda verwendet wird, um mit jedem Kontext bezüglich der Anfrage und ihrer Ausführung zu antworten. Vorzugsweise 200 sollten alle Fehler, die zu einem anderen Statuscode führen, einen Nachrichtenwert enthalten, der den Fehler beschreibt.

Beantworten Sie Anfragen zum Betrieb des C2C-Connectors mit der API SendConnectorEvent

Managed Integrations for AWS IoT Device Management erwartet, dass sich Ihr Connector bei jedem AND-Vorgang asynchron verhält. AWS.SendCommand AWS.DiscoverDevices Das bedeutet, dass die erste Antwort auf diese Operationen lediglich „bestätigt“, dass Ihr C2C-Connector die Anfrage erhalten hat.

Bei Verwendung der SendConnectorEvent API wird von Ihrem Connector erwartet, dass er die Ereignistypen aus der folgenden Liste für AWS.DiscoverDevices und AWS.SendCommand Operationen sowie proaktive Geräteereignisse (z. B. manuelles Ein- und Ausschalten eines Lichts) sendet.

Beispiel für einen Arbeitsablauf

Wenn Ihr C2C-Connector eine DiscoverDevices Anfrage empfängt, AWS IoT Device Management erwartet Managed Integrations for, dass diese:

Der SendConnectorEvent API-Aufruf kann überall dort erfolgen, wo Sie Zugriff auf Ihre AWS-Konto Lambda-Anmeldeinformationen für den C2C-Connector haben. Die Geräteerkennung ist erst erfolgreich, wenn Managed Integrations for AWS IoT Device Management dieses Ereignis empfängt.

SendConnectorEvent API

Ihr Connector ruft diese verwalteten Integrationen für die AWS IoT Device Management API auf, um Geräteereignisse zu senden. Es werden nur 3 Arten von Ereignissen akzeptiert: