159. (Aws/Amazon) [Aws Iot Core] Aws Iot Core JobId 원격 작업 아이디 설명 및 규격 , 제한 사항 정리

---

[개발 환경 설정]

​

개발 환경 : 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 JobId 는 원격 작업 (Job) 을 생성할 때 지정하는 값으로 해당 작업의 아이디를 의미합니다


2. AWS IoT JobId 는 계정 내에서 고유한 작업 식별자를 입력해야하며, 기본적으로 UUID 사용을 권장하며 영숫자, 하이픈(-), 밑줄(_) 도 사용할 수 있습니다


3. AWS IoT JobId 지정 제약 조건 : 

  >> 문자 길이 (Length) : 최소 1자 ~ 최대 64자

    - https://docs.aws.amazon.com/iot/latest/apireference/API_CreateJob.html

  >> 허용되는 문자 (Pattern) : 공백, 마침표, 슬래시, 콜론, 괄호 등 특수 문자는 허용되지 않음 (대소문자와 숫자, -, _만 사용 가능)

    - 알파벳 대문자 및 소문자 (A-Z, a-z)

    - 숫자 (0-9)

    - 하이픈 (-)

    - 언더스코어 (_)


4. AWS IoT CreateJob API 호출 Request , Response 전문 예시 : 

    // ✅ Request 전문 예시
    PUT /jobs/jobId HTTP/1.1
    Content-type: application/json

    {
        "abortConfig": { // -----------> 작업 중단 조건을 정의
            "criteriaList": [ 
                { 
                    "action": "string",
                    "failureType": "string",
                    "minNumberOfExecutedThings": number,
                    "thresholdPercentage": number
                }
            ]
        },
        "description": "string", // -------------> 작업 설명(선택 사항)
        "destinationPackageVersions": [ "string" ], // -------------> OTA 업데이트 시 배포할 패키지 버전 목록
        "document": "string", // ----------> 작업 실행 문서(JSON)
        "documentParameters": { // ------------> 문서 내에서 참조할 파라미터 키-값 
            "string" : "string" 
        },
        "documentSource": "string", // ----------> 작업 문서의 S3 URL 또는 외부 소스 경로
        "jobExecutionsRetryConfig": { // -----------> 실패 시 재시도 정책
            "criteriaList": [ 
                { 
                    "failureType": "string",
                    "numberOfRetries": number
                }
            ]
        },
        "jobExecutionsRolloutConfig": { // -----------> 롤아웃 속도 설정
            "exponentialRate": { 
                "baseRatePerMinute": number,
                "incrementFactor": number,
                "rateIncreaseCriteria": { 
                    "numberOfNotifiedThings": number,
                    "numberOfSucceededThings": number
                }
            },
            "maximumPerMinute": number
        },
        "jobTemplateArn": "string", // -----------> 기존 Job 템플릿 ARN을 참조해 작업 생성
        "namespaceId": "string", // --------------> Job을 네임스페이스로 구분할 때 사용
        "presignedUrlConfig": { // ---------------> S3에서 파일 다운로드 시 사용할 서명 URL 설정
            "expiresInSec": number,
            "roleArn": "string"
        },
        "schedulingConfig": { // -----------------> 작업 스케줄링 설정
            "endBehavior": "string",
            "endTime": "string",
            "maintenanceWindows": [ 
                { 
                    "durationInMinutes": number,
                    "startTime": "string"
                }
            ],
            "startTime": "string"
        },
        "tags": [ // -----------> Key-Value 태그 목록
            { 
                "Key": "string",
                "Value": "string"
            }
        ],
        "targets": [ "string" ], // ------------> 작업 대상 (Thing ARN, Thing Group ARN 등)
        "targetSelection": "string", // ---------> 대상 선택 (SNAPSHOT: 생성 시점의 대상만 포함 / CONTINUOUS: 동적 그룹 변경 시 자동 반영)
        "timeoutConfig": { // -------------> 실행 시간 제한
            "inProgressTimeoutInMinutes": number
        }
    }


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

    {
    "description": "string",
    "jobArn": "string",
    "jobId": "string"
    }


5. 자바스크립트 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

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

---