

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.

# API HTTP de l’appareil de tâches
<a name="jobs-http-device-api"></a>

Les appareils peuvent communiquer avec AWS IoT Jobs à l'aide de la signature HTTP version 4 sur le port 443. Il s'agit de la méthode utilisée par la CLI AWS SDKs et. Pour plus d'informations sur ces outils, voir [Référence des AWS CLI commandes : iot-jobs-data](https://docs.aws.amazon.com/cli/latest/reference/iot-jobs-data/index.html) ou [AWS SDKs et Outils](https://aws.amazon.com/tools/#sdk).

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, veuillez consulter [Opérations de l’API MQTT de l’appareil des tâches](jobs-mqtt-api.md).

## GetPendingJobExecutions
<a name="http-getpendingjobexecutions"></a>

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 [https://docs.aws.amazon.com/iot/latest/apireference/API_iot-jobs-data_GetPendingJobExecutions.html](https://docs.aws.amazon.com/iot/latest/apireference/API_iot-jobs-data_GetPendingJobExecutions.html). 

------
#### [ 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 [https://docs.aws.amazon.com/cli/latest/reference/iot-jobs-data/get-pending-job-executions.html](https://docs.aws.amazon.com/cli/latest/reference/iot-jobs-data/get-pending-job-executions.html).

------

## StartNextPendingJobExecution
<a name="http-startnextpendingjobexecution"></a>

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 [https://docs.aws.amazon.com/iot/latest/apireference/API_iot-jobs-data_StartNextPendingJobExecution.html](https://docs.aws.amazon.com/iot/latest/apireference/API_iot-jobs-data_StartNextPendingJobExecution.html).

------
#### [ 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 [https://docs.aws.amazon.com/cli/latest/reference/iot-jobs-data/start-next-pending-job-execution.html](https://docs.aws.amazon.com/cli/latest/reference/iot-jobs-data/start-next-pending-job-execution.html).

------

## DescribeJobExecution
<a name="http-describejobexecution"></a>

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 [https://docs.aws.amazon.com/iot/latest/apireference/API_iot-jobs-data_DescribeJobExecution.html](https://docs.aws.amazon.com/iot/latest/apireference/API_iot-jobs-data_DescribeJobExecution.html).

------
#### [ 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 [https://docs.aws.amazon.com/cli/latest/reference/iot-data/describe-job-execution.html](https://docs.aws.amazon.com/cli/latest/reference/iot-data/describe-job-execution.html).

------

## UpdateJobExecution
<a name="http-updatejobexecution"></a>

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 [https://docs.aws.amazon.com/iot/latest/apireference/API_iot-jobs-data_UpdateJobExecution.html](https://docs.aws.amazon.com/iot/latest/apireference/API_iot-jobs-data_UpdateJobExecution.html).

------
#### [ 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 [https://docs.aws.amazon.com/cli/latest/reference/iot-data/update-job-execution.html](https://docs.aws.amazon.com/cli/latest/reference/iot-data/update-job-execution.html).

------