C2C 커넥터 인터페이스 작업 구현

용 관리형 통합은 커넥터로 검증하기 위해 처리 AWS Lambda 해야 하는 4가지 작업을 AWS IoT Device Management 정의합니다. C2C 커넥터는 다음 각 작업을 구현해야 합니다.

호출 세부 정보

용 관리형 통합은 AWS IoT Device Management 작업을 통해 항상 JSON 문자열 페이로드를 사용하여 Lambda 함수를 호출합니다 AWS Lambda invokeFunction. 요청 작업은 모든 요청 페이로드에 operationName 필드를 포함해야 합니다.

호출 설정:

구현 예제

커넥터에 대해 구현하는 Lambda는 요청 페이로드operationName에서를 구문 분석하고 해당 기능을 구현하여 타사 클라우드에 매핑합니다.

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);
    };
}

요청 형식 예제

다음 예제에서는 모든 필수 인터페이스에 대한 공통 필드가 있는 Managed Integrations의 일반 커넥터 요청을 자세히 설명합니다. 예제에서 요청 헤더와 요청 페이로드가 모두 있는 것을 볼 수 있습니다. 요청 헤더는 모든 작업 인터페이스에서 일반적입니다.

OAuth 2.0 예제:

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

일반 권한 부여 예제:

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

기본 요청 헤더

기본 헤더 필드는 권한 부여 유형에 따라 다릅니다. 커넥터는 OAuth 2.0 및 일반 승인 요청 헤더를 모두 처리해야 합니다.

OAuth 2.0 기본 헤더:

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

일반 권한 부여 기본 헤더:

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

페이로드 요청

일반 헤더 외에도 모든 요청에는 페이로드가 있습니다. 이 페이로드에는 모든 작업 유형에 대한 고유한 필드가 있지만 각 페이로드에는 항상 존재하는 기본 필드 세트가 있습니다.

기본 응답 헤더

모든 작업은 C2C 커넥터가 요청을 수신하고 처리를 시작했음을 확인하는 AWS IoT Device Management의 ACK 관리형 통합에 로 응답합니다.

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

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

응답 헤더 필드

이 문서에 설명된 다양한 커넥터 인터페이스 및 API 스키마 전체에 responseMessage 또는 Message 필드가 있습니다. 이 필드는 C2C 커넥터 Lambda가 요청 및 실행과 관련된 컨텍스트로 응답하는 데 사용되는 선택적 필드입니다. 가급적이면 이외의 상태 코드를 초래하는 모든 오류에는 오류를 설명하는 메시지 값이 포함되어야 200 합니다.

SendConnectorEvent API를 사용하여 C2C 커넥터 작업 요청에 응답

용 관리형 통합은 모든 AWS.SendCommand 및 AWS.DiscoverDevices 작업에 대해 커넥터가 비동기적으로 작동할 것으로 AWS IoT Device Management 예상합니다. 즉, 이러한 작업에 대한 초기 응답은 단순히 C2C 커넥터가 요청을 수신했음을 “확인”한다는 의미입니다.

SendConnectorEvent API를 사용하면 커넥터는 AWS.DiscoverDevices 및 AWS.SendCommand 작업에 대해 아래 목록에서 이벤트 유형과 사전 예방적 디바이스 이벤트(예: 수동으로 켜고 끄는 등)를 전송해야 합니다.

워크플로 예제

C2C 커넥터가 DiscoverDevices 요청을 수신하면 용 관리형 통합은 다음을 AWS IoT Device Management 기대합니다.

SendConnectorEvent API 호출은 C2C 커넥터 Lambda AWS 계정 자격 증명에 액세스할 수 있는 모든 곳에서 발생할 수 있습니다. AWS IoT Device Management 검색 흐름이 성공하지 못합니다.

SendConnectorEvent API

커넥터는 AWS IoT Device Management API에 대해이 관리형 통합을 호출하여 디바이스 이벤트를 전송합니다. 3가지 유형의 이벤트만 허용됩니다.