Erstellen Sie einen Job aus AWS verwalteten Vorlagen mithilfe der AWS CLI - AWS IoT Core
Auflisten von verwalteten VorlagenAbrufen von Details über eine verwaltete VorlageErstellen eines Auftrags mithilfe verwalteter VorlagenErstellen Sie eine benutzerdefinierte Auftragsvorlage aus verwalteten Vorlagen

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Erstellen Sie einen Job aus AWS verwalteten Vorlagen mithilfe der AWS CLI

Verwenden Sie die AWS CLI , um Informationen zu AWS verwalteten Vorlagen abzurufen und mithilfe dieser Vorlagen einen Job zu erstellen. Anschließend können Sie den Auftrag als Vorlage speichern und anschließend Ihre eigene benutzerdefinierte Vorlage erstellen.

Auflisten von verwalteten Vorlagen

Der list-managed-job-templates AWS CLI Befehl listet alle Jobvorlagen in Ihrem auf AWS-Konto.


 aws iot list-managed-job-templates

Wenn Sie diesen Befehl ausführen, werden standardmäßig alle verfügbaren AWS verwalteten Vorlagen und deren Details angezeigt.

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

Weitere Informationen finden Sie unter ListManagedJobTemplates.

Abrufen von Details über eine verwaltete Vorlage

Der describe-managed-job-template AWS CLI Befehl ruft Details zu einer angegebenen Jobvorlage ab. Geben Sie den Namen der Auftragsvorlage und eine optionale Vorlagenversion an. Wenn die Vorlagenversion nicht angegeben ist, wird die vordefinierte Standardversion zurückgegeben. Um beispielsweise Details über die AWS-Download-File-Vorlage zu sehen, führen Sie den folgenden Befehl aus.

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

Der Befehl zeigt die Vorlagendetails und den ARN, das zugehörige Auftragsdokument und den documentParameters-Parameter an, bei dem es sich um eine Liste von Schlüssel-Wert-Paaren von Eingabeparametern der Vorlage handelt. Weitere Informationen zu den verschiedenen Vorlagen und Eingabeparametern finden Sie unter Verwaltete Vorlagen für Remote-Aktionen und Auftragsdokumente.

Anmerkung

Das documentParameters Objekt, das zurückgegeben wird, wenn Sie diese API verwenden, darf nur verwendet werden, wenn Jobs aus AWS verwalteten Vorlagen erstellt werden. Das Objekt darf nicht für benutzerdefinierte ‚Auftragsvorlagen verwendet werden. Ein Beispiel, das zeigt, wie dieser Parameter verwendet wird, finden Sie unter Erstellen eines Auftrags mithilfe verwalteter Vorlagen.

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

Weitere Informationen finden Sie unter DescribeManagedJobTemplate.

Erstellen eines Auftrags mithilfe verwalteter Vorlagen

Der create-job AWS CLI Befehl kann verwendet werden, um einen Job aus einer Jobvorlage zu erstellen. Es zielt auf ein Gerät mit dem Namen thingOne und gibt den Amazon-Ressourcennamen (ARN) der verwalteten Vorlage an, die als Grundlage für den Auftrag verwendet werden soll. Sie können erweiterte Konfigurationen wie Timeout- und Abbruchkonfigurationen überschreiben, indem Sie die zugehörigen Parameter des Befehls create-job übergeben.

Das Beispiel zeigt, wie ein Auftrag erstellt wird, der die Vorlage AWS-Download-File verwendet. Außerdem wird gezeigt, wie die Eingabeparameter der Vorlage mithilfe des Parameters document-parameters angegeben werden.

Anmerkung

Verwenden Sie das document-parameters Objekt nur mit AWS verwalteten Vorlagen. Dieses Objekt darf nicht mit benutzerdefinierten Auftragsvorlagen verwendet werden.

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

Wobei:

  • regionist der AWS-Region.

  • account-idist die eindeutige AWS-Konto Zahl.

  • thingOne ist der Name des IoT-Objekts, für das der Auftrag bestimmt ist.

  • AWS-Download-File:1.0ist der Name der verwalteten Vorlage.

  • https://example.com/index.html ist die URL, von der die Datei heruntergeladen werden soll.

  • https://pathto/file/index ist der Pfad auf dem Gerät, in dem die heruntergeladene Datei gespeichert werden soll.

Führen Sie den folgenden Befehl aus, um einen Auftrag für die Vorlage AWS-Download-File zu erstellen.

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

Erstellen Sie eine benutzerdefinierte Auftragsvorlage aus verwalteten Vorlagen

  1. Erstellen Sie einen Auftrag mit einer verwalteten Vorlage, wie im vorherigen Abschnitt beschrieben.

  2. Erstellen Sie eine benutzerdefinierte Auftragsvorlage, indem Sie den ARN des Auftrags verwenden, den Sie erstellt haben. Weitere Informationen finden Sie unter Erstellen einer Auftragsvorlage anhand eines vorhandenen Auftrags.