Crea un lavoro da modelli AWS gestiti utilizzando il AWS CLI

Utilizza il AWS CLI per ottenere informazioni sui modelli AWS gestiti e creare un lavoro utilizzando questi modelli. Puoi quindi salvare il processo come modello e creare un modello personalizzato.

Elenca i modelli gestiti

Il list-managed-job-templates AWS CLI comando elenca tutti i modelli di lavoro presenti nel tuo Account AWS.

 aws iot list-managed-job-templates
                

Per impostazione predefinita, l'esecuzione di questo comando visualizza tutti i modelli AWS gestiti disponibili e i relativi dettagli.

{
    "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"
        }
    ]
}                

Per ulteriori informazioni, vedere ListManagedJobTemplates.

Recupero dei dettagli di un modello di processo

Il describe-managed-job-template AWS CLI comando ottiene dettagli su un modello di lavoro specificato. Specificare il nome del modello di processo e una versione opzionale del modello. Se la versione del modello non è specificata, viene restituita la versione predefinita. Di seguito viene illustrato un esempio di esecuzione del comando per recuperare i dettagli del modello AWS-Download-File.

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

Il comando visualizza i dettagli del modello e l'ARN, il relativo documento di processo e il parametro documentParameters, che è un elenco di coppie di valori chiave dei parametri di input del modello. Per ulteriori informazioni sui diversi modelli e sui parametri di input, consulta Azioni remote dei modelli gestiti e documenti di processo.

Nota

L'documentParametersoggetto restituito quando si utilizza questa API deve essere utilizzato solo durante la creazione di lavori da modelli AWS gestiti. L'oggetto non deve essere utilizzato per modelli di processo personalizzati. Per un esempio che mostra come utilizzare questo parametro, consulta Creazione di un processo utilizzando modelli gestiti.

{
    "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}\"}}]}"
}
                

Per ulteriori informazioni, vedere DescribeManagedJobTemplate.

Creazione di un processo utilizzando modelli gestiti

Il create-job AWS CLI comando può essere utilizzato per creare un lavoro da un modello di lavoro. Si rivolge a un dispositivo denominato thingOne e specifica l'Amazon Resource Name (ARN) del modello gestito da utilizzare come base per il processo. È possibile sovrascrivere le configurazioni avanzate, ad esempio le configurazioni di timeout e annullamento, passando i parametri associati del comando create-job.

L'esempio mostra come creare un processo che utilizza il modello AWS-Download-File. Viene inoltre illustrato come specificare i parametri di input del modello utilizzando il parametro document-parameters.

Nota

Utilizzate l'document-parametersoggetto solo con modelli AWS gestiti. Non deve essere utilizzato con modelli di processo personalizzati.

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                

dove:

• la regione è Regione AWS.

• account-id è il numero univoco Account AWS .

• thingOne è il nome dell'oggetto IoT di destinazione del processo.

• AWS-Download-File:1.0 è il nome del modello gestito.

• https://example.com/index.html è l'URL da cui scaricare il file.

• https://pathto/file/index è il percorso del dispositivo per memorizzare il file scaricato.

Esegui il comando seguente per creare un processo per il modello, 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."
}

Creazione di modelli di processo personalizzati partendo da modelli gestiti

1. Crea un processo utilizzando un modello gestito come descritto nella sezione precedente.

2. Crea un modello di processo personalizzato utilizzando l'ARN del processo creato. Per ulteriori informazioni, consulta Creazione di un modello del processo da un processo esistente.