152. (Aws/Amazon) [Aws Iot Core] Aws Iot Core Job 원격 작업 JobDocument 확인 GetJobDocument 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 GetJobDocument 는 AWS Iot Core 에 생성 된 원격 작업 “job document” (작업 문서) 를 가져오는 API입니다

  >> AWS 사이트 : https://docs.aws.amazon.com/iot/latest/apireference/API_GetJobDocument.html


2. AWS IoT GetJobDocument API 호출 시 특정 작업(job)에 대해 설정된 문서(설정/명령/메타데이터 등)를 조회할 수 있습니다


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

  >> GET /jobs/jobId/job-document?beforeSubstitution=beforeSubstitution HTTP/1.1

  >> jobId : 조회하려는 작업의 고유 ID. 처음 작업을 생성할 때 지정한 값. 최소 길이 1, 최대 64자, 허용 문자 [a-zA-Z0-9_-]

  >> beforeSubstitution (optional) : 이 파라미터를 사용해, “substitution parameter”(치환 변수)가 실제 값으로 변환되기 이전(pre-substitution) 상태의 job document를 조회할지 여부 지정 가능


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

  HTTP/1.1 200
  Content-type: application/json

  {
    "document": "string"
  }


5. AWS IoT GetJobDocument 사용 주의할 점 / 제약점

  >> GetJobDocument API 를 호출하려면, IAM 정책으로 iot:GetJobDocument 권한이 필요합니다

  >> 지정한 jobId가 존재하지 않거나, 접근 권한이 없다면 오류 (예: ResourceNotFoundException, 권한 오류 등)가 반환됩니다


6. AWS IoT GetJobDocument 사용 예시 코드 (자바스크립트)

<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 시크릿 키]


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


// -----------------------------------------
// [Request : 요청 파라미터 생성]
// -----------------------------------------            
// GET /jobs/jobId/job-document?beforeSubstitution=beforeSubstitution HTTP/1.1
// -----------------------------------------
const params = {              
  jobId: "dbxnxnxnsssxddxddvb" // 원격 작업 아이디 지정
}; 


// -----------------------------------------
// [내부 클로저 선언 실시]
// -----------------------------------------
var innerFunction = async function() {

  try {
    
    // -----------------------------------------
    // [GetJobDocument] : Aws Iot 특정 원격 작업 JobDocument 정보 조회
    // -----------------------------------------
    // AWS 참고 사이트 : https://docs.aws.amazon.com/iot/latest/apireference/API_GetJobDocument.html
    // -----------------------------------------
    const [doc_err, doc_res] = await aws.getJobDocument( params ).promise()                
      .then(data => [null, data])
      .catch(error => [error, null]);

    if (doc_err) {
      console.error("[getJobDocument] : [Error] : ", doc_err);

    } else {
      console.log("[getJobDocument] : [Result] : ", JSON.stringify(doc_res));
    }

  }
  catch(exception){
    console.error("[innerFunction] : [Exception] : ", exception);
  }

};


// -----------------------------------------
// [내부 클로저 함수 호출]
// -----------------------------------------
innerFunction();

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






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

[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


[업무 이슈] 디바이스 Aws Job OTA 펌웨어 업데이트 시 STS 임시 자격 증명 S3 Presigned URL 프리 사인 주소 파싱 문제 발생

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

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

 

---

[참고 사이트]

​

https://kkh0977.tistory.com/8133

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

---