Créez une tâche à partir de modèles AWS gérés à l'aide du AWS CLI

Utilisez le AWS CLI pour obtenir des informations sur les modèles AWS gérés et créer une tâche à l'aide de ces modèles. Vous pouvez ensuite enregistrer le travail en tant que modèle, puis créer votre propre modèle personnalisé.

Répertorier les modèles gérés

La list-managed-job-templates AWS CLI commande répertorie tous les modèles de tâches de votre Compte AWS.

 aws iot list-managed-job-templates
                

Par défaut, l'exécution de cette commande affiche tous les modèles AWS gérés disponibles et leurs détails.

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

Pour plus d'informations, consultez ListManagedJobTemplates.

Récupère des détails sur un modèle géré

La describe-managed-job-template AWS CLI commande obtient des informations sur un modèle de tâche spécifié. Spécifiez le nom du modèle de tâche et une version de modèle facultative. Si la version du modèle n’est pas spécifiée, la version par défaut prédéfinie est renvoyée. L’exemple suivant montre comment exécuter la commande pour obtenir des détails sur le modèle AWS-Download-File.

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

La commande affiche les détails et l’ARN du modèle, son document de tâche et le paramètre documentParameters, qui est une liste de paires clé-valeur de paramètres d’entrée du modèle. Pour plus d’informations sur les différents modèles et paramètres d’entrée, consultez Modèles gérés d’actions à distance et de documents de tâche.

Note

L'documentParametersobjet renvoyé lorsque vous utilisez cette API ne doit être utilisé que lors de la création de tâches à partir de modèles AWS gérés. L’objet ne doit pas être utilisé pour des modèles de tâches personnalisés. Pour obtenir un exemple pratique illustrant la façon d'utiliser ce paramètre, consultez Création d’une tâche à l’aide de modèles gérés.

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

Pour plus d'informations, consultez DescribeManagedJobTemplate.

Création d’une tâche à l’aide de modèles gérés

La create-job AWS CLI commande peut être utilisée pour créer une tâche à partir d'un modèle de tâche. Il cible un appareil nommé thingOne et spécifie l’Amazon Resource Name (ARN) du modèle géré à utiliser comme base de la tâche. Vous pouvez annuler les configurations avancées, telles que les configurations de temporisation et d’annulation, en transmettant les paramètres associés à la commande create-job.

L’exemple montre comment créer une tâche qui utilise le modèle AWS-Download-File. Il montre également comment spécifier les paramètres d’entrée du modèle à l’aide du paramètre document-parameters.

Note

Utilisez l'document-parametersobjet uniquement avec des modèles AWS gérés. Cet objet ne doit pas être utilisé avec des modèles de tâches personnalisés.

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                

où :

• la région est la Région AWS.

• account-id est le numéro unique Compte AWS .

• thingOne est le nom de l’objet IoT auquel le poste est destiné.

• AWS-Download-File:1.0 est le nom du modèle géré.

• https://example.com/index.html est l’URL à partir de laquelle télécharger le fichier.

• https://pathto/file/index est le chemin sur l’appareil pour stocker le fichier téléchargé.

Exécutez la commande suivante pour créer une tâche pour le modèle 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."
}

Création d’un modèle de travail personnalisé à partir de modèles gérés

1. Créez une tâche à l’aide d’un modèle géré comme indiqué dans la section précédente.

2. Créez un modèle de tâche personnalisé en utilisant l’ARN de la tâche que vous avez créée. Pour de plus amples informations, veuillez consulter Création d’un modèle de tâche à partir d’une tâche existante.