Sélectionner vos préférences de cookies

Nous utilisons des cookies essentiels et des outils similaires qui sont nécessaires au fonctionnement de notre site et à la fourniture de nos services. Nous utilisons des cookies de performance pour collecter des statistiques anonymes afin de comprendre comment les clients utilisent notre site et d’apporter des améliorations. Les cookies essentiels ne peuvent pas être désactivés, mais vous pouvez cliquer sur « Personnaliser » ou « Refuser » pour refuser les cookies de performance.

Si vous êtes d’accord, AWS et les tiers approuvés utiliseront également des cookies pour fournir des fonctionnalités utiles au site, mémoriser vos préférences et afficher du contenu pertinent, y compris des publicités pertinentes. Pour accepter ou refuser tous les cookies non essentiels, cliquez sur « Accepter » ou « Refuser ». Pour effectuer des choix plus détaillés, cliquez sur « Personnaliser ».

Préférences
Contactez-nous
Commentaire
AWS Documentation
Créer un compte AWS

Appareil Jobs HTTP API

PDF
Mode de mise au point
Appareil Jobs HTTP API - AWS IoT Core

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Les appareils peuvent communiquer avec AWS IoT Jobs à l'aide de HTTP Signature version 4 sur le port 443. C'est la méthode utilisée par le AWS SDKs etCLI. Pour plus d'informations sur ces outils, voir Référence des AWS CLI commandes : iot-jobs-data ou AWS SDKset Outils.

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

Obtient la liste de tous les travaux qui ne sont pas dans un état terminal, pour une chose spécifiée.

HTTPS request
GET /things/thingName/jobs

Réponse :

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

Pour de plus amples 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 de plus amples informations, veuillez consulter get-pending-job-executions.

Obtient la liste de tous les travaux qui ne sont pas dans un état terminal, pour une chose spécifiée.

HTTPS request
GET /things/thingName/jobs

Réponse :

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

Pour de plus amples 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 de plus amples informations, veuillez consulter get-pending-job-executions.

anchoranchor
GET /things/thingName/jobs

Réponse :

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

Pour de plus amples informations, veuillez consulter GetPendingJobExecutions.

Obtient et démarre l’exécution de tâche en attente suivante pour un objet (avec un statut IN_PROGRESS ou QUEUED).

  • Toutes les exécutions de tâche avec le statut IN_PROGRESS sont renvoyées 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 est QUEUED, son statut est modifié en IN_PROGRESS et les détails du statut de l’exécution de la tâche sont définis comme indiqué.

  • Si la prochaine exécution de tâche en attente est déjà IN_PROGRESS, les informations détaillées de son statut ne sont pas modifiées.

  • Si aucune exécution de tâche n’est en attente, la réponse n’inclut pas le champ execution.

  • Le cas échéant, vous pouvez créer un minuteur d’étape en définissant une valeur pour la propriété stepTimeoutInMinutes. 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 demande :

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

Pour de plus amples 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 de plus amples informations, veuillez consulter start-next-pending-job-execution.

Obtient et démarre l’exécution de tâche en attente suivante pour un objet (avec un statut IN_PROGRESS ou QUEUED).

  • Toutes les exécutions de tâche avec le statut IN_PROGRESS sont renvoyées 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 est QUEUED, son statut est modifié en IN_PROGRESS et les détails du statut de l’exécution de la tâche sont définis comme indiqué.

  • Si la prochaine exécution de tâche en attente est déjà IN_PROGRESS, les informations détaillées de son statut ne sont pas modifiées.

  • Si aucune exécution de tâche n’est en attente, la réponse n’inclut pas le champ execution.

  • Le cas échéant, vous pouvez créer un minuteur d’étape en définissant une valeur pour la propriété stepTimeoutInMinutes. 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 demande :

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

Pour de plus amples 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 de plus amples informations, veuillez consulter start-next-pending-job-execution.

anchoranchor

L’exemple suivant montre la syntaxe de demande :

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

Pour de plus amples informations, veuillez consulter StartNextPendingJobExecution.

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

Vous pouvez définir le jobId sur $next pour revenir à 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 de plus amples 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 de plus amples informations, veuillez consulter describe-job-execution.

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

Vous pouvez définir le jobId sur $next pour revenir à 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 de plus amples 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 de plus amples informations, veuillez consulter describe-job-execution.

anchoranchor

Requête :

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

Réponse :

{
"execution" : JobExecution,
}

Pour de plus amples informations, veuillez consulter DescribeJobExecution.

Met à jour le statut d'une exécution de tâche. Le cas échéant, vous pouvez créer un minuteur d’étape en définissant une valeur pour la propriété stepTimeoutInMinutes. 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 de plus amples 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 de plus amples informations, veuillez consulter update-job-execution.

Met à jour le statut d'une exécution de tâche. Le cas échéant, vous pouvez créer un minuteur d’étape en définissant une valeur pour la propriété stepTimeoutInMinutes. 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 de plus amples 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 de plus amples informations, veuillez consulter update-job-execution.

anchoranchor

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 de plus amples informations, veuillez consulter UpdateJobExecution.

ConfidentialitéConditions d'utilisation du sitePréférences de cookies
© 2025, Amazon Web Services, Inc. ou ses affiliés. Tous droits réservés.