As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
API HTTP do dispositivo do Jobs
Os dispositivos podem se comunicar com trabalhos de AWS IoT usando o HTTP Signature Versão 4 na porta 443. Este é o método usado pelos SDKs da AWS e pela CLI. Para obter mais informações sobre essas ferramentas, consulte , Referência de comandos da AWS CLI iot-jobs-data ou SDKs e ferramentas da AWS.
Os seguintes comandos estão disponíveis para dispositivos que executam os trabalhos. Para obter informações sobre o uso de operações de API com o protocolo MQTT, consulte Operações da API MQTT do dispositivo de trabalhos.
Obtém a lista de todos os trabalhos que não estão em um status terminal, para um objeto específica.
- HTTPS request
GET /things/thingName/jobs
Resposta:
{
"inProgressJobs" : [ JobExecutionSummary ... ],
"queuedJobs" : [ JobExecutionSummary ... ]
}
Para obter mais informações, consulte GetPendingJobExecutions.
- CLI syntax
aws iot-jobs-data get-pending-job-executions \
--thing-name <value> \
[--cli-input-json <value>] \
[--generate-cli-skeleton]
cli-input-json format:
{
"thingName": "string"
}
Para obter mais informações, consulte get-pending-job-executions.
Obtém e começa a próxima execução de trabalho pendente para um objeto (com um status de IN_PROGRESS ou QUEUED).
-
Todas as execuções de trabalho com o status IN_PROGRESS são retornadas primeiro.
-
As execuções de trabalho são retornadas na ordem em que foram criadas.
-
Se a execução do próximo trabalho pendente for QUEUED, seu status será alterado para IN_PROGRESS e os detalhes do status da execução do trabalho serão definidos conforme especificado.
-
Se a execução do próximo trabalho pendente já for IN_PROGRESS, os detalhes de seu status não se alteram.
-
Se nenhuma execução de trabalho estiver pendente, a resposta não incluirá o campo execution.
-
Se desejar, você pode criar um temporizador de etapa definindo um valor para a propriedade stepTimeoutInMinutes. Se você não atualizar o valor dessa propriedade executando UpdateJobExecution, a execução do trabalho atingirá o tempo limite quando o temporizador de etapa expirar.
- HTTPS request
O exemplo a seguir mostra a sintaxe da solicitação:
PUT /things/thingName/jobs/$next
{
"statusDetails": {
"string": "string"
...
},
"stepTimeoutInMinutes": long
}
Para obter mais informações, consulte StartNextPendingJobExecution.
- CLI syntax
Resumo:
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]
cli-input-json format:
{
"thingName": "string",
"statusDetails": {
"string": "string"
},
"stepTimeoutInMinutes": long
}
Para obter mais informações, consulte start-next-pending-job-execution.
Obtém informações detalhadas sobre uma execução de trabalho.
Você pode definir o jobId como $next para retornar a próxima execução de trabalho pendente para um objeto. O status da execução do trabalho deve ser QUEUED ou IN_PROGRESS.
- HTTPS request
Solicitação:
GET /things/thingName/jobs/jobId?executionNumber=executionNumber&includeJobDocument=includeJobDocument
Resposta:
{
"execution" : JobExecution,
}
Para obter mais informações, consulte DescribeJobExecution.
- CLI syntax
Resumo:
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]
cli-input-json format:
{
"jobId": "string",
"thingName": "string",
"includeJobDocument": boolean,
"executionNumber": long
}
Para obter mais informações, consulte describe-job-execution.
Atualiza o status de uma execução de trabalho. Se desejar, você pode criar um temporizador de etapa definindo um valor para a propriedade stepTimeoutInMinutes. Se você não atualizar o valor dessa propriedade executando UpdateJobExecution novamente, a execução do trabalho atingirá o tempo limite quando o temporizador de etapa expirar.
- HTTPS request
Solicitação:
POST /things/thingName/jobs/jobId
{
"status": "job-execution-state",
"statusDetails": {
"string": "string"
...
},
"expectedVersion": "number",
"includeJobExecutionState": boolean,
"includeJobDocument": boolean,
"stepTimeoutInMinutes": long,
"executionNumber": long
}
Para obter mais informações, consulte UpdateJobExecution.
- CLI syntax
-
Resumo:
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]
cli-input-json format:
{
"jobId": "string",
"thingName": "string",
"status": "string",
"statusDetails": {
"string": "string"
},
"stepTimeoutInMinutes": number,
"expectedVersion": long,
"includeJobExecutionState": boolean,
"includeJobDocument": boolean,
"executionNumber": long
}
Para obter mais informações, consulte update-job-execution.
