160. (Aws/Amazon) [Aws Iot Core] Aws Iot Core Job 작업 실행 상태 업데이트 UpdateJobExecution API 설명 정리

---

[개발 환경 설정]

​

개발 환경 : Aws / Amazon Web Services

​

 

---

[설명 정리]

​

// --------------------------------------------------------------------------------------
[개발 및 환경]
// --------------------------------------------------------------------------------------

- 인프라 : Aws / Amazon Web Services


- 기술 구분 : Aws / Aws Iot Core / Job / OTA


- 사전) Aws Iot Core 간략 설명 : 

  >> AWS IoT 는 IoT 디바이스를 다른 디바이스 및 AWS 클라우드 서비스에 연결하는 클라우드 서비스를 제공합니다.

  >> 디바이스가에 연결할 수 있는 경우 AWS IoT는 AWS 가 제공하는 클라우드 서비스에 디바이스를 AWS IoT 연결할 수 있습니다.

  >> AWS IoT Core 메시지 브로커는 MQTT 및 MQTT over WSS 프로토콜을 사용하여 메시지를 게시하고 구독하는 디바이스 및 클라이언트를 지원합니다. 
  
    - HTTPS 프로토콜을 사용하여 메시지를 게시하는 디바이스와 클라이언트도 지원합니다.


- 사전) AWS Iot Core Job 간략 설명 : 

  >> AWS 원격 작업 이란 작업자 또는 기술자의 물리적 존재 없이 원격으로 수행할 수 있는 업데이트 작업입니다 (무선 업데이트 (OTA) 수행)

  >> AWS IoT 작업 서비스는 AWS IoT 에 연결 되는 하나 이상의 디바이스로 전송 된 후 실행 되는 원격 작업 세트를 정의하는데 사용됩니다

    - 주목적 : 소프트웨어 및 펌웨어 업데이트를 디바이스 기기에게 알리는데 사용 (기기에게 작업 문서 전송)

    - 작업 문서 : AWS IoT Job 생성 시 대상이 되는 디바이스로 전송 되는 문서 (펌웨어 다운로드 URL 정보 등 포함)

// --------------------------------------------------------------------------------------






// --------------------------------------------------------------------------------------
[설 명]
// --------------------------------------------------------------------------------------

1. AWS IoT UpdateJobExecution 는 특정 디바이스에서 실행 중인 Job Execution(작업 실행)의 상태를 업데이트하는 데 사용되는 API 입니다


2. AWS IoT UpdateJobExecution 는 디바이스가 원격 작업의 진행 상황이나 결과를 AWS IoT Jobs 서비스에 보고할 때 사용됩니다


3. AWS IoT UpdateJobExecution API 호출 Request , Response 전문 예시 : 

    // ✅ Request 전문 예시
    POST /things/{thingName}/jobs/{jobId}
    Content-Type: application/json

    {
      "executionNumber": number, // 특정 작업 실행을 지정하는 번호
      "expectedVersion": number, // 현재 JobExecution 버전. 버전 불일치 시 업데이트 거부
      "includeJobDocument": boolean, // 응답에 작업 문서를 포함할지 여부
      "includeJobExecutionState": boolean, // 응답에 업데이트된 JobExecution 상태를 포함할지 여부
      "status": "string", // 새 상태 값
      "statusDetails": { // 상태 관련 추가 설명(키/값쌍)
          "string" : "string" 
      },
      "stepTimeoutInMinutes": number // 작업 단계에 대한 타임아웃(분 단위)
    }


    // ✅ Response 전문 예시
    HTTP/1.1 200
    Content-type: application/json

    {
      "executionState": { 
          "status": "string",
          "statusDetails": { 
            "string" : "string" 
          },
          "versionNumber": number
      },
      "jobDocument": "string"
    }


4. AWS IoT UpdateJobExecution 상태 값 status 예시 : 

  >> QUEUED : 대기 상태 - Job이 Thing(디바이스)에 할당은 되었지만, 아직 디바이스가 작업을 시작하지 않은 상태

  >> IN_PROGRESS : 작업 진행 중 - 디바이스가 Job을 수락하고 실행을 시작한 상태

  >> SUCCEEDED : 작업 성공 완료 (최종 상태) - Job이 정상적으로 끝났을 때

  >> FAILED : 작업 실패 (최종 상태) - 디바이스가 Job을 실행했지만 오류로 실패한 경우

  >> TIMED_OUT : 작업 시간 초과 (최종 상태) - 지정된 시간 내에 Job이 완료되지 않은 경우

  >> REJECTED : 디바이스가 작업을 거부 (최종 상태) - 디바이스가 Job을 의도적으로 실행하지 않기로 결정

  >> REMOVED : 작업 실행이 제거됨 (최종 상태) - Job이 디바이스에서 강제로 제거된 경우

  >> CANCELED : 작업 취소됨 (최종 상태) - Job이 실행 도중 또는 실행 전 취소된 경우


5. AWS IoT UpdateJobExecution 상태 값 status 흐름 :

  QUEUED (대기 상태)
    ↓
  IN_PROGRESS (작업 진행 중)
    ↓
  ┌─────────────┬──────────┬────────────┐
  SUCCEEDED   FAILED   TIMED_OUT   REJECTED


6. 자바스크립트 AWS IoT CreateJob 생성 예시 코드 : 

    <!-- [CDN 주소 설정] -->

    <script src="https://code.jquery.com/jquery-latest.min.js"></script>
    <script src="https://sdk.amazonaws.com/js/aws-sdk-2.1416.0.min.js"></script>


    // [전역 변수 선언]
    const region = 'ap-northeast-2'; // [AWS 리전]
    const accessKeyId = 'AK..A6'; // [IAM 액세스 키]
    const secretAccessKey = 'mP..5J'; // [IAM 시크릿 키]

    var innerFunction = null; // [내부 클로저 선언 실시]

    var THING_NAME = "TWOK_1234"; // 사물 명칭 이름
    var THING_ARN = "arn:aws:iot:ap-northeast-2:123456789012:thing/TWOK_1234"

    var DEVICE_TYPE = "DEVICE"
    var DEVICE_MODEL = "camera"
    var DEVICE_BRAND = "TWOK_COMPANY"
    var FRM_URL = "https://service.com/TEST_Firmware/V1.0.40_Bin"
    var FRM_MD5 = "e76052c97"
    var FRM_VERSION = "1.0.1"

    var JOB_ID = function(){ // ✅ 리턴 JobID : 호출 > JOB_ID()
        return `DEVICE_OTA_JOB_TEST_${THING_NAME}_1`
    }

    var JOB_DOC = function(){ // ✅ 리턴 JobDoc 문서 : 호출 > JOB_DOC()
        return `{
                "operation": "UPDATE",
                "description": "Request Update Firmware",
                "target": [
                    {
                    "deviceType": "${DEVICE_TYPE}",
                    "deviceThingList": [
                        "${THING_NAME}"
                    ],
                    "version": "${FRM_VERSION}",
                    "model": "${DEVICE_MODEL}",
                    "brand": "${DEVICE_BRAND}",
                    "firmwareUrl": "${FRM_URL}",
                    "firmwareFileMd5": "${FRM_MD5}"
                    }
                ],
                "jobExecutionsRolloutConfig": {
                    "maximumPerMinutes": 10
                }
                }`
    }


    // -----------------------------------------
    // [AWS.config 지정]
    // -----------------------------------------
    // IAM 계정 정보를 사용해 AWS.config 정보 업데이트 수행
    // -----------------------------------------            
    AWS.config.update({
        region: region,
        accessKeyId: accessKeyId,
        secretAccessKey: secretAccessKey
    });



    // -----------------------------------------
    // [AWS.Iot 객체 생성]
    // -----------------------------------------
    const aws = new AWS.Iot();


    // -----------------------------------------
    // [create Job 요청 파라미터 생성]
    // -----------------------------------------
    const JOB_DOC_JSON = JSON.parse(JOB_DOC()); // ✅ Parse JobDoc

    const job_param = {
        jobId: JOB_ID(),
        targets: [THING_ARN],   // 작업을 수행할 Thing 또는 Thing Group
        document: JSON.stringify(JOB_DOC_JSON), // ✅ document 필드는 string 타입으로 정의되어 있습니다
        description: "Firmware Update Job",
        targetSelection: "SNAPSHOT" // 또는 CONTINUOUS
        /*
        , timeoutConfig: { // 디바이스가 Job 을 IN_PROGRESS 상태로 만든 후 일정 시간이 자났음에도 SUCCEEDED , FAILED 상태가 업데이트 되지 않으면 자동 TIME_OUT 상태로 전환 기능
            inProgressTimeoutInMinutes: 60
        }
        // */
    };


    // -----------------------------------------
    // [createJob] : Aws Iot Core 에 원격 작업 생성 수행
    // -----------------------------------------
    // AWS 참고 사이트 : https://docs.aws.amazon.com/iot/latest/apireference/API_CreateJob.html
    // -----------------------------------------
    const [job_err, job_res] = await aws.createJob( job_param ).promise()                
        .then(data => [null, data])
        .catch(error => [error, null]);

// --------------------------------------------------------------------------------------






// --------------------------------------------------------------------------------------
[참고 사이트]
// --------------------------------------------------------------------------------------

[Aws Iot Core] 원격 작업 무선 업데이트 (OTA) job 개념 학습 및 펌웨어 업데이트 프로세스 정리

https://kkh0977.tistory.com/8133

https://blog.naver.com/kkh0977/223926549194?trackingCode=blog_bloghome_searchlist


[Aws Iot Core] AWS 원격 펌웨어 업데이트 job 알림 수신 jobs/notify 토픽과 jobs/notify-next 토픽 차이점 정리

https://kkh0977.tistory.com/8178

https://blog.naver.com/kkh0977/223954213087?trackingCode=blog_bloghome_searchlist


[Aws Iot Core] AWS 펌웨어 업데이트 Job Execution Rollout 설정 값 snapshot 과 continuous 차이점 정리

https://blog.naver.com/kkh0977/223960153729?trackingCode=blog_bloghome_searchlist


[Aws Iot Core] AWS 원격 펌웨어 업데이트 OTA 수동 job 생성 및 특정 사물 notify 펌웨어 업데이트 요청 방법 정리

https://blog.naver.com/kkh0977/223944636139?trackingCode=blog_bloghome_searchlist


[안드로이드 AWS Iot Core 원격 업데이트 Job 리스트 목록 확인]

https://blog.naver.com/kkh0977/223926528254?trackingCode=blog_bloghome_searchlist


[업무 이슈] Aws Iot Core 에서 Job 원격 펌웨어 업데이트 요청 시 상태가 완료 로 처리 되지 않는 이슈 발생

https://blog.naver.com/kkh0977/223944640508?trackingCode=blog_bloghome_searchlist


[업무 이슈] AWS Job 디바이스 펌웨어 업데이트 파일 순차 업데이트 미동작 이슈 - IN_PROGRESS, QUEUED 배열 펌웨어 처리

https://blog.naver.com/kkh0977/223955019266?trackingCode=blog_bloghome_searchlist


[업무 이슈] AWS Job 디바이스 펌웨어 업데이트 시 동일 버전 펌웨어 버전 체크 및 업데이트 진행 미완료 표시 - publish status

https://blog.naver.com/kkh0977/223955010876?trackingCode=blog_bloghome_searchlist

// --------------------------------------------------------------------------------------

 

---

[참고 사이트]

​

https://kkh0977.tistory.com/8133

83. (Aws/Amazon) [Aws Iot Core] 원격 작업 무선 업데이트 (OTA) job 개념 학습 및 펌웨어 업데이트 프로세

---