Buat templat pekerjaan khusus dengan menggunakan AWS CLI

Topik ini menjelaskan cara membuat, menghapus, dan mengambil detail tentang template pekerjaan dengan menggunakan. AWS CLI

Buat template pekerjaan dari awal

AWS CLI Perintah berikut menunjukkan cara membuat pekerjaan menggunakan dokumen pekerjaan (job-document.json) yang disimpan dalam bucket S3 dan peran dengan izin untuk mengunduh file dari Amazon S3 (S3). DownloadRole

aws iot create-job-template  \
      --job-template-id 010  \
      --document-source https://s3.amazonaws.com/my-s3-bucket/job-document.json  \
      --timeout-config inProgressTimeoutInMinutes=100 \
      --job-executions-rollout-config "{ \"exponentialRate\": { \"baseRatePerMinute\": 50, \"incrementFactor\": 2, \"rateIncreaseCriteria\": { \"numberOfNotifiedThings\": 1000, \"numberOfSucceededThings\": 1000}}, \"maximumPerMinute\": 1000}" \
      --abort-config "{ \"criteriaList\": [ { \"action\": \"CANCEL\", \"failureType\": \"FAILED\", \"minNumberOfExecutedThings\": 100, \"thresholdPercentage\": 20}, { \"action\": \"CANCEL\", \"failureType\": \"TIMED_OUT\", \"minNumberOfExecutedThings\": 200, \"thresholdPercentage\": 50}]}" \          
      --presigned-url-config "{\"roleArn\":\"arn:aws:iam::123456789012:role/S3DownloadRole\", \"expiresInSec\":3600}" 
            

timeout-configParameter opsional menentukan jumlah waktu yang dimiliki setiap perangkat untuk menyelesaikan menjalankan pekerjaan. Timer dimulai ketika status eksekusi pekerjaan diatur keIN_PROGRESS. Jika status eksekusi pekerjaan tidak disetel ke status terminal lain sebelum waktu kedaluwarsa, status tersebut disetel keTIMED_OUT.

Timer yang sedang berlangsung tidak dapat diperbarui dan berlaku untuk semua peluncuran pekerjaan untuk pekerjaan tersebut. Setiap kali peluncuran pekerjaan tetap dalam IN_PROGRESS status lebih lama dari interval ini, peluncuran pekerjaan gagal dan beralih ke TIMED_OUT status terminal. AWS IoT juga menerbitkan pemberitahuan MQTT.

Untuk informasi selengkapnya tentang membuat konfigurasi tentang peluncuran dan pembatalan pekerjaan, lihat Peluncuran pekerjaan dan membatalkan konfigurasi.

catatan

Dokumen Job yang ditetapkan sebagai file Amazon S3 diambil pada saat Anda membuat pekerjaan. Jika Anda mengubah konten file Amazon S3 yang Anda gunakan sebagai sumber dokumen pekerjaan Anda setelah Anda membuat pekerjaan, apa yang dikirim ke target pekerjaan tidak berubah.

Buat template pekerjaan dari pekerjaan yang ada

AWS CLI Perintah berikut membuat template pekerjaan dengan menentukan Amazon Resource Name (ARN) dari pekerjaan yang ada. Template pekerjaan baru menggunakan semua konfigurasi yang ditentukan dalam pekerjaan. Secara opsional, Anda dapat mengubah konfigurasi apa pun di pekerjaan yang ada dengan menggunakan salah satu parameter opsional.

aws iot create-job-template  \
      --job-arn arn:aws:iot:region:123456789012:job/job-name  \      
      --timeout-config inProgressTimeoutInMinutes=100
            

Dapatkan detail tentang template pekerjaan

AWS CLI Perintah berikut mendapatkan rincian tentang template pekerjaan tertentu.

aws iot describe-job-template \
      --job-template-id template-id
                

Perintah menampilkan output berikut.

{
   "abortConfig": { 
      "criteriaList": [ 
         { 
            "action": "string",
            "failureType": "string",
            "minNumberOfExecutedThings": number,
            "thresholdPercentage": number
         }
      ]
   },
   "createdAt": number,
   "description": "string",
   "document": "string",
   "documentSource": "string",
   "jobExecutionsRolloutConfig": { 
      "exponentialRate": { 
         "baseRatePerMinute": number,
         "incrementFactor": number,
         "rateIncreaseCriteria": { 
            "numberOfNotifiedThings": number,
            "numberOfSucceededThings": number
         }
      },
      "maximumPerMinute": number
   },
   "jobTemplateArn": "string",
   "jobTemplateId": "string",
   "presignedUrlConfig": { 
      "expiresInSec": number,
      "roleArn": "string"
   },
   "timeoutConfig": { 
      "inProgressTimeoutInMinutes": number
   }
}
                

Daftar templat pekerjaan

AWS CLI Perintah berikut mencantumkan semua template pekerjaan di Anda Akun AWS.

 aws iot list-job-templates
                

Perintah menampilkan output berikut.

{
   "jobTemplates": [ 
      { 
         "createdAt": number,
         "description": "string",
         "jobTemplateArn": "string",
         "jobTemplateId": "string"
      }
   ],
   "nextToken": "string"
}
                

Untuk mengambil halaman hasil tambahan, gunakan nilai nextToken bidang.

Hapus template pekerjaan

AWS CLI Perintah berikut menghapus template pekerjaan tertentu.

aws iot delete-job-template \
      --job-template-id template-id
                

Perintah tidak menampilkan output.

Buat pekerjaan dari template pekerjaan khusus

AWS CLI Perintah berikut membuat pekerjaan dari template pekerjaan kustom. Ini menargetkan perangkat bernama thingOne dan menentukan Amazon Resource Name (ARN) dari template pekerjaan untuk digunakan sebagai dasar untuk pekerjaan itu. Anda dapat mengganti konfigurasi lanjutan, seperti batas waktu dan membatalkan konfigurasi, dengan meneruskan parameter terkait perintah. create-job

Awas

document-parametersObjek harus digunakan dengan create-job perintah hanya saat membuat pekerjaan dari template yang AWS dikelola. Objek ini tidak boleh digunakan dengan template pekerjaan khusus. Untuk contoh yang menunjukkan cara membuat pekerjaan menggunakan parameter ini, lihatBuat pekerjaan dengan menggunakan templat terkelola.

aws iot create-job \ 
      --targets arn:aws:iot:region:123456789012:thing/thingOne  \
      --job-template-arn arn:aws:iot:region:123456789012:jobtemplate/template-id