Buat pekerjaan dari template AWS terkelola dengan menggunakan AWS CLI

Gunakan AWS CLI untuk mendapatkan informasi tentang templat AWS terkelola dan buat pekerjaan dengan menggunakan templat ini. Anda kemudian dapat menyimpan pekerjaan sebagai template dan kemudian membuat template kustom Anda sendiri.

Daftar template terkelola

list-managed-job-templates AWS CLI Perintah ini mencantumkan semua template pekerjaan di Anda Akun AWS.

 aws iot list-managed-job-templates
                

Secara default, menjalankan perintah ini menampilkan semua template AWS terkelola yang tersedia dan detailnya.

{
    "managedJobTemplates": [
        {
            "templateArn": "arn:aws:iot:region::jobtemplate/AWS-Reboot:1.0",
            "templateName": "AWS-Reboot",
            "description": "A managed job template for rebooting the device.",
            "environments": [
                "LINUX"
            ],
            "templateVersion": "1.0"
        },
        {
            "templateArn": "arn:aws:iot:region::jobtemplate/AWS-Remove-Application:1.0",
            "templateName": "AWS-Remove-Application",
            "description": "A managed job template for uninstalling one or more applications.",
            "environments": [
                "LINUX"
            ],
            "templateVersion": "1.0"
        },
        {
            "templateArn": "arn:aws:iot:region::jobtemplate/AWS-Stop-Application:1.0",
            "templateName": "AWS-Stop-Application",
            "description": "A managed job template for stopping one or more system services.",
            "environments": [
                "LINUX"
            ],
            "templateVersion": "1.0"
        },

        ...

        {
            "templateArn": "arn:aws:iot:us-east-1::jobtemplate/AWS-Restart-Application:1.0",
            "templateName": "AWS-Restart-Application",
            "description": "A managed job template for restarting one or more system services.",
            "environments": [
                "LINUX"
            ],
            "templateVersion": "1.0"
        }
    ]
}                

Untuk informasi lebih lanjut, lihat ListManagedJobTemplates.

Dapatkan detail tentang template terkelola

describe-managed-job-template AWS CLI Perintah mendapatkan rincian tentang template pekerjaan tertentu. Tentukan nama template pekerjaan dan versi templat opsional. Jika versi template tidak ditentukan, versi default yang telah ditentukan akan dikembalikan. Berikut ini menunjukkan contoh menjalankan perintah untuk mendapatkan rincian tentang AWS-Download-File template.

aws iot describe-managed-job-template \
    --template-name AWS-Download-File
                

Perintah menampilkan detail template dan ARN, dokumen pekerjaannya, dan documentParameters parameternya, yang merupakan daftar pasangan nilai kunci dari parameter input template. Untuk informasi tentang berbagai templat dan parameter input, lihatTindakan jarak jauh template terkelola dan dokumen pekerjaan.

catatan

documentParametersObjek yang dikembalikan saat Anda menggunakan API ini hanya boleh digunakan saat membuat pekerjaan dari templat AWS terkelola. Objek tidak boleh digunakan untuk template pekerjaan khusus. Untuk contoh yang menunjukkan cara menggunakan parameter ini, lihatBuat pekerjaan dengan menggunakan templat terkelola.

{
    "templateName": "AWS-Download-File",
    "templateArn": "arn:aws:iot:region::jobtemplate/AWS-Download-File:1.0",
    "description": "A managed job template for downloading a file.",
    "templateVersion": "1.0",
    "environments": [
        "LINUX"
    ],
    "documentParameters": [
        {
            "key": "downloadUrl",
            "description": "URL of file to download.",
            "regex": "(.*?)",
            "example": "http://www.example.com/index.html",
            "optional": false
        },
        {
            "key": "filePath",
            "description": "Path on the device where downloaded file is written.",
            "regex": "(.*?)",
            "example": "/path/to/file",
            "optional": false
        },
        {
            "key": "runAsUser",
            "description": "Execute handler as another user. If not specified, then handler is executed as the same user as device client.",
            "regex": "(.){0,256}",
            "example": "user1",
            "optional": true
        },
        {
            "key": "pathToHandler",
            "description": "Path to handler on the device. If not specified, then device client will use the current working directory.",
            "regex": "(.){0,4096}",
            "example": "/path/to/handler/script",
            "optional": true
        }
    ],
    "document": "{\"version\":\"1.0\",\"steps\":[{\"action\":{\"name\":\"Download-File\",\"type\":\"runHandler\",\"input\":{\"handler\":\"download-file.sh\",\"args\":[\"${aws:iot:parameter:downloadUrl}\",\"${aws:iot:parameter:filePath}\"],\"path\":\"${aws:iot:parameter:pathToHandler}\"},\"runAsUser\":\"${aws:iot:parameter:runAsUser}\"}}]}"
}
                

Untuk informasi lebih lanjut, lihat DescribeManagedJobTemplate.

Buat pekerjaan dengan menggunakan templat terkelola

create-job AWS CLI Perintah ini dapat digunakan untuk membuat pekerjaan dari template pekerjaan. Ini menargetkan perangkat bernama thingOne dan menentukan Nama Sumber Daya Amazon (ARN) dari template terkelola 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

Contoh menunjukkan cara membuat pekerjaan yang menggunakan AWS-Download-File template. Ini juga menunjukkan cara menentukan parameter input template dengan menggunakan document-parameters parameter.

catatan

Gunakan document-parameters objek hanya dengan template AWS terkelola. Objek ini tidak boleh digunakan dengan template pekerjaan khusus.

aws iot create-job \
   --targets arn:aws:iot:region:account-id:thing/thingOne \ 
   --job-id "new-managed-template-job" \ 
   --job-template-arn arn:aws:iot:region::jobtemplate/AWS-Download-File:1.0 \
   --document-parameters downloadUrl=https://example.com/index.html,filePath=path/to/file                

di mana:

• wilayah adalah Wilayah AWS.

• Account-ID adalah nomor unik Akun AWS .

• thingOneadalah nama hal IoT yang menjadi sasaran pekerjaan.

• AWS-Download-File:1.0 adalah nama template yang dikelola.

• https://example.com/index.htmladalah URL untuk mengunduh file dari.

• https://pathto/file/indexadalah jalur pada perangkat untuk menyimpan file yang diunduh.

Jalankan perintah berikut untuk membuat pekerjaan untuk template,AWS-Download-File.

{
    "jobArn": "arn:aws:iot:region:account-id:job/new-managed-template-job",
    "jobId": "new-managed-template-job",
    "description": "A managed job template for downloading a file."
}

Buat templat pekerjaan khusus dari templat terkelola

1. Buat pekerjaan menggunakan template terkelola seperti yang dijelaskan di bagian sebelumnya.

2. Buat template pekerjaan khusus dengan menggunakan ARN dari pekerjaan yang Anda buat. Untuk informasi selengkapnya, lihat Buat template pekerjaan dari pekerjaan yang ada.