158. (Aws/Amazon) [Aws Iot Core] Aws Iot 특정 디바이스 원격 작업 실행 세부 정보 조회 DescribeJobExecution 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 DescribeJobExecution 는 AWS IoT Jobs 에서 특정 디바이스 (Thing) 가 수행 중인 작업 실행 (Job Execution) 의 상태 및 정보를 반환하는 API입니다

  >> AWS 사이트 : https://docs.aws.amazon.com/iot/latest/apireference/API_iot-jobs-data_DescribeJobExecution.html

  >> DescribeJobExecution 은 특정 디바이스의 작업 실행 정보를 조회하는 REST API입니다


2. AWS IoT DescribeJobExecution API 를 통해 디바이스나 서버에서 현재 실행 중인 작업 상태를 확인할 수 있습니다


3. AWS IoT DescribeJobExecution API 요청 형식 및 주요 매개변수

  >> GET /things/thingName/jobs/jobId?executionNumber=executionNumber&includeJobDocument=includeJobDocument HTTP/1.1

  >> thingName : 작업 실행을 조회할 Thing(사물 이름)

  >> jobId : 조회할 작업의 고유 ID

  >> executionNumber : 특정 실행 인스턴스 번호 (지정하지 않으면 가장 최근 실행)

  >> includeJobDocument : 작업 문서 포함 여부 (true일 경우 반환)


4. AWS IoT DescribeJobExecution 응답 본문 예시 구문   

  >> 성공하면 HTTP 200 상태 코드와 함께 JSON 형태의 job execution 객체를 반환합니다

  >> 응답은 JSON 형식의 job execution 객체로 상태, 실행 세부 정보, 작업 문서 등을 반환합니다

    {
        "execution": {
            "approximateSecondsBeforeTimedOut": number,
            "executionNumber": number,
            "jobDocument": "string",
            "jobId": "string",
            "lastUpdatedAt": number,
            "queuedAt": number,
            "startedAt": number,
            "status": "string",
            "statusDetails": { "string": "string" },
            "thingName": "string",
            "versionNumber": number
        }
    }

  >> status : 작업 실행 상태 (IN_PROGRESS, QUEUED, SUCCEEDED 등)

  >> executionNumber : 해당 실행의 번호

  >> jobDocument : 작업 문서(JSON) — includeJobDocument가 true일 때

  >> queuedAt , startedAt : 큐에 들어간 시간 / 실행 시작 시간

  >> lastUpdatedAt : 마지막 상태 업데이트 시각

  >> approximateSecondsBeforeTimedOut : 종료 예정까지 남은 예상 시간


5. AWS IoT DescribeJobExecution 응답 에러 코드 정리 : 

  >> ResourceNotFoundException : 지정한 작업 또는 Thing이 존재하지 않음

  >> InvalidRequestException : 요청 형식 또는 파라미터 오류

  >> ThrottlingException : 요청 제한 초과

  >> ServiceUnavailableException : 서비스 사용 불가

  >> TerminalStateException : 작업이 이미 종료 상태임

  >> CertificateValidationException : 인증서 문제


6. AWS IoT DescribeJobExecution 를 호출하기 위한 주의사항 : 

  >> ListNamedShadowsForThing API를 호출하려면 데이터 플레인 권한인 iotjobsdata:DescribeJobExecution 권한이 필요한 IAM 정책이 있어야 합니다


7. AWS Iot Core 에 생성 된 특정 JobID 입력 및 Job 원격 작업 상세 정보 확인 자바스크립트 예시 코드 :

  <script src="https://sdk.amazonaws.com/js/aws-sdk-2.1416.0.min.js"></script>
  <script src="https://unpkg.com/aws-iot-device-sdk/browser/aws-iot-sdk-browser-bundle.js"></script>


  <script>

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

  const region = 'ap-northeast-2'; // [AWS 리전]
  const accessKeyId = 'AK..A6'; // [IAM 액세스 키]

  const secretAccessKey = 'mP..5J'; // [IAM 시크릿 키]

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

  window.onload = async function() {

    // -----------------------------------------
    // [AWS.config 지정]
    // -----------------------------------------
    AWS.config.update({        
      region: region,      
      accessKeyId: accessKeyId,
      secretAccessKey: secretAccessKey
    });


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


    // -----------------------------------------
    // [Request : 요청 파라미터 생성]
    // -----------------------------------------            
    // GET /jobs/jobId?beforeSubstitution=beforeSubstitution HTTP/1.1
    // -----------------------------------------
    const params = {              
        jobId: 'DEVICE_JOB_ID_1014_3' // 이 작업을 생성할 때 지정한 고유 식별자입니다 (최소 길이 1 ~ 최대 길이 64)
    }; 


    // -----------------------------------------
    // [DescribeJob] : Aws Iot 원격 작업 정보 조회
    // -----------------------------------------
    // AWS 참고 사이트 : https://docs.aws.amazon.com/iot/latest/apireference/API_DescribeJob.html
    // -----------------------------------------
    iot.describeJob( params , function(err, data) { 
      if (err) {
        console.error("[describeJob] : [Error] : ", err);

      } else {
        console.log("[describeJob] : [Success] : ", JSON.stringify(data));

      }

    });

  };

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

  </script>

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






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

[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 개념 학습 및 펌웨어 업데이트 프로세

---