API HTTP de l'appareil Jobs

Les appareils peuvent communiquer avecAWS IoTTâches utilisant la version 4 de la signature HTTP sur le port 443. C'est la méthode utilisée parAWSSDK et CLI. Pour plus d'informations sur ces outils, voirAWS CLIRéférence de commande :iot-jobs-dataouAWSSDK et outils.

Les commandes suivantes sont disponibles pour les appareils exécutant les tâches. Pour plus d'informations sur l'utilisation des opérations d'API avec le protocole MQTT, voirOpérations de l'API MQTT de l'appareil de tâches.

GetPendingJobExecutions

Obtient la liste de toutes les tâches qui ne sont pas dans un état terminal, pour un objet spécifié.

HTTPS request

GET /things/thingName/jobs

Réponse :

{
"inProgressJobs" : [ JobExecutionSummary ... ], 
"queuedJobs" : [ JobExecutionSummary ... ]
}

Pour plus d'informations, veuillez consulter GetPendingJobExecutions.

CLI syntax

aws iot-jobs-data get-pending-job-executions \
--thing-name <value>  \
[--cli-input-json <value>] \
[--generate-cli-skeleton]

Format cli-input-json :

{
"thingName": "string"
}

Pour plus d'informations, veuillez consulter get-pending-job-executions.

StartNextPendingJobExecution

Obtient et démarre la prochaine exécution de tâche en attente pour un objet (avec un statut deIN_PROGRESSouQUEUED).

• Toutes les exécutions de tâches avec statutIN_PROGRESSsont renvoyés en premier.

• Les exécutions de tâche sont renvoyées dans l'ordre selon lequel elles ont été créées.

• Si la prochaine exécution de tâche en attente estQUEUED, son statut passe àIN_PROGRESSet les détails de l'état d'exécution de la tâche sont définis comme spécifié.

• Si la prochaine exécution de la tâche en attente est déjàIN_PROGRESS, les détails de son statut ne changent pas.

• Si aucune exécution de tâche n'est en attente, la réponse n'inclut pasexecutionterrain.

• Vous pouvez éventuellement créer un chronomètre en définissant une valeur pourstepTimeoutInMinutespropriété. Si vous ne mettez pas à jour la valeur de cette propriété en exécutant UpdateJobExecution, l'exécution de la tâche expire lorsque le minuteur d'étape expire.

HTTPS request

L'exemple suivant montre la syntaxe de la demande :

PUT /things/thingName/jobs/$next
{
"statusDetails": { 
    "string": "string" 
    ... 
},
"stepTimeoutInMinutes": long
}

Pour plus d'informations, veuillez consulter StartNextPendingJobExecution.

CLI syntax

Résumé :

aws iot-jobs-data  start-next-pending-job-execution \
--thing-name <value> \
{--step-timeout-in-minutes <value>] \
[--status-details <value>]  \
[--cli-input-json <value>] \
[--generate-cli-skeleton]

Format cli-input-json :

{
"thingName": "string",
"statusDetails": {
"string": "string"
},
"stepTimeoutInMinutes": long
}

Pour plus d'informations, veuillez consulter start-next-pending-job-execution.

DescribeJobExecution

Permet d'obtenir des informations détaillées sur une exécution de tâche.

Vous pouvez définir lejobIdpour$nextpour renvoyer la prochaine exécution de tâche en attente pour un objet. Le statut de l'exécution de tâche doit être QUEUED ou IN_PROGRESS.

HTTPS request

Requête :

GET /things/thingName/jobs/jobId?executionNumber=executionNumber&includeJobDocument=includeJobDocument

Réponse :

{
"execution" : JobExecution,
}

Pour plus d'informations, veuillez consulter DescribeJobExecution.

CLI syntax

Résumé :

aws iot-jobs-data  describe-job-execution \
--job-id <value> \
--thing-name <value> \
[--include-job-document | --no-include-job-document] \
[--execution-number <value>]  \
[--cli-input-json <value>] \
[--generate-cli-skeleton]

Format cli-input-json :

{
"jobId": "string",
"thingName": "string",
"includeJobDocument": boolean,
"executionNumber": long
}

Pour plus d'informations, veuillez consulter describe-job-execution.

UpdateJobExecution

Met à jour le statut d'une exécution de tâche. Vous pouvez éventuellement créer un chronomètre en définissant une valeur pourstepTimeoutInMinutespropriété. Si vous ne mettez pas à jour la valeur de cette propriété en exécutant à nouveau UpdateJobExecution, l'exécution de la tâche expire lorsque le minuteur d'étape expire.

HTTPS request

Requête :

POST /things/thingName/jobs/jobId
{
"status": "job-execution-state",
"statusDetails": { 
    "string": "string"
    ...
},
"expectedVersion": "number",
"includeJobExecutionState": boolean,
"includeJobDocument": boolean,
"stepTimeoutInMinutes": long,
"executionNumber": long 
}

Pour plus d'informations, veuillez consulter UpdateJobExecution.

CLI syntax

Résumé :

aws iot-jobs-data  update-job-execution \
--job-id <value> \
--thing-name <value> \
--status <value> \
[--status-details <value>] \
[--expected-version <value>] \
[--include-job-execution-state | --no-include-job-execution-state] \
[--include-job-document | --no-include-job-document] \
[--execution-number <value>]  \
[--cli-input-json <value>] \
[--step-timeout-in-minutes <value>] \
[--generate-cli-skeleton]

Format cli-input-json :

{
"jobId": "string",
"thingName": "string",
"status": "string",
"statusDetails": {
"string": "string"
},
"stepTimeoutInMinutes": number,
"expectedVersion": long,
"includeJobExecutionState": boolean,
"includeJobDocument": boolean,
"executionNumber": long
}

Pour plus d'informations, veuillez consulter update-job-execution.