Gets details of a job execution.
Requires permission to access the DescribeJobExecution action.
" }, "GetPendingJobExecutions":{ "name":"GetPendingJobExecutions", "http":{ "method":"GET", "requestUri":"/things/{thingName}/jobs" }, "input":{"shape":"GetPendingJobExecutionsRequest"}, "output":{"shape":"GetPendingJobExecutionsResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"ServiceUnavailableException"}, {"shape":"CertificateValidationException"} ], "documentation":"Gets the list of all jobs for a thing that are not in a terminal status.
Requires permission to access the GetPendingJobExecutions action.
" }, "StartCommandExecution":{ "name":"StartCommandExecution", "http":{ "method":"POST", "requestUri":"/command-executions" }, "input":{"shape":"StartCommandExecutionRequest"}, "output":{"shape":"StartCommandExecutionResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"InternalServerException"} ], "documentation":"Using the command created with the CreateCommand API, start a command execution on a specific device.
Gets and starts the next pending (status IN_PROGRESS or QUEUED) job execution for a thing.
Requires permission to access the StartNextPendingJobExecution action.
" }, "UpdateJobExecution":{ "name":"UpdateJobExecution", "http":{ "method":"POST", "requestUri":"/things/{thingName}/jobs/{jobId}" }, "input":{"shape":"UpdateJobExecutionRequest"}, "output":{"shape":"UpdateJobExecutionResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"ServiceUnavailableException"}, {"shape":"CertificateValidationException"}, {"shape":"InvalidStateTransitionException"} ], "documentation":"Updates the status of a job execution.
Requires permission to access the UpdateJobExecution action.
" } }, "shapes":{ "ApproximateSecondsBeforeTimedOut":{"type":"long"}, "BinaryBlob":{"type":"blob"}, "BinaryParameterValue":{ "type":"blob", "min":1 }, "BooleanParameterValue":{"type":"boolean"}, "CertificateValidationException":{ "type":"structure", "members":{ "message":{ "shape":"errorMessage", "documentation":"Additional information about the exception.
" } }, "documentation":"The certificate is invalid.
", "error":{"httpStatusCode":400}, "exception":true }, "ClientRequestTokenV2":{ "type":"string", "max":64, "min":1, "pattern":"^[\\x21-\\x7E]+$" }, "CommandArn":{"type":"string"}, "CommandExecutionId":{ "type":"string", "max":64, "min":1, "pattern":"[a-zA-Z0-9_-]+" }, "CommandExecutionParameterMap":{ "type":"map", "key":{"shape":"CommandParameterName"}, "value":{"shape":"CommandParameterValue"}, "min":1 }, "CommandExecutionTimeoutInSeconds":{ "type":"long", "min":1 }, "CommandParameterName":{ "type":"string", "max":192, "min":1, "pattern":"^[.$a-zA-Z0-9_-]+$" }, "CommandParameterValue":{ "type":"structure", "members":{ "S":{ "shape":"StringParameterValue", "documentation":"An attribute of type String. For example:
\"S\": \"Hello\"
An attribute of type Boolean. For example:
\"BOOL\": true
An attribute of type Integer (Thirty-Two Bits).
" }, "L":{ "shape":"LongParameterValue", "documentation":"An attribute of type Long.
" }, "D":{ "shape":"DoubleParameterValue", "documentation":"An attribute of type Double (Sixty-Four Bits).
" }, "BIN":{ "shape":"BinaryParameterValue", "documentation":"An attribute of type Binary.
" }, "UL":{ "shape":"UnsignedLongParameterValue", "documentation":"An attribute of type Unsigned Long.
" } }, "documentation":"The list of values used to describe a specific command parameter.
" }, "ConflictException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"}, "resourceId":{ "shape":"resourceId", "documentation":"A conflict occurred while performing the API request on the resource ID.
" } }, "documentation":"A conflict has occurred when performing the API request.
", "error":{"httpStatusCode":409}, "exception":true }, "DescribeJobExecutionJobId":{ "type":"string", "pattern":"[a-zA-Z0-9_-]+|^\\$next" }, "DescribeJobExecutionRequest":{ "type":"structure", "required":[ "jobId", "thingName" ], "members":{ "jobId":{ "shape":"DescribeJobExecutionJobId", "documentation":"The unique identifier assigned to this job when it was created.
", "location":"uri", "locationName":"jobId" }, "thingName":{ "shape":"ThingName", "documentation":"The thing name associated with the device the job execution is running on.
", "location":"uri", "locationName":"thingName" }, "includeJobDocument":{ "shape":"IncludeJobDocument", "documentation":"Optional. Unless set to false, the response contains the job document. The default is true.
", "location":"querystring", "locationName":"includeJobDocument" }, "executionNumber":{ "shape":"ExecutionNumber", "documentation":"Optional. A number that identifies a particular job execution on a particular device. If not specified, the latest job execution is returned.
", "location":"querystring", "locationName":"executionNumber" } } }, "DescribeJobExecutionResponse":{ "type":"structure", "members":{ "execution":{ "shape":"JobExecution", "documentation":"Contains data about a job execution.
" } } }, "DetailsKey":{ "type":"string", "max":128, "min":1, "pattern":"[a-zA-Z0-9:_-]+" }, "DetailsMap":{ "type":"map", "key":{"shape":"DetailsKey"}, "value":{"shape":"DetailsValue"} }, "DetailsValue":{ "type":"string", "min":1, "pattern":"[^\\p{C}]+" }, "DoubleParameterValue":{"type":"double"}, "ExecutionNumber":{"type":"long"}, "ExpectedVersion":{"type":"long"}, "GetPendingJobExecutionsRequest":{ "type":"structure", "required":["thingName"], "members":{ "thingName":{ "shape":"ThingName", "documentation":"The name of the thing that is executing the job.
", "location":"uri", "locationName":"thingName" } } }, "GetPendingJobExecutionsResponse":{ "type":"structure", "members":{ "inProgressJobs":{ "shape":"JobExecutionSummaryList", "documentation":"A list of JobExecutionSummary objects with status IN_PROGRESS.
" }, "queuedJobs":{ "shape":"JobExecutionSummaryList", "documentation":"A list of JobExecutionSummary objects with status QUEUED.
" } } }, "IncludeExecutionState":{"type":"boolean"}, "IncludeJobDocument":{"type":"boolean"}, "IntegerParameterValue":{"type":"integer"}, "InternalServerException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"An internal server error occurred when performing the API request.
", "error":{"httpStatusCode":500}, "exception":true, "fault":true }, "InvalidRequestException":{ "type":"structure", "members":{ "message":{ "shape":"errorMessage", "documentation":"The message for the exception.
" } }, "documentation":"The contents of the request were invalid.
", "error":{"httpStatusCode":400}, "exception":true }, "InvalidStateTransitionException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"An update attempted to change the job execution to a state that is invalid because of the job execution's current state (for example, an attempt to change a request in state SUCCESS to state IN_PROGRESS). In this case, the body of the error message also contains the executionState field.
", "error":{"httpStatusCode":409}, "exception":true }, "JobDocument":{ "type":"string", "max":32768 }, "JobExecution":{ "type":"structure", "members":{ "jobId":{ "shape":"JobId", "documentation":"The unique identifier you assigned to this job when it was created.
" }, "thingName":{ "shape":"ThingName", "documentation":"The name of the thing that is executing the job.
" }, "status":{ "shape":"JobExecutionStatus", "documentation":"The status of the job execution. Can be one of: \"QUEUED\", \"IN_PROGRESS\", \"FAILED\", \"SUCCESS\", \"CANCELED\", \"TIMED_OUT\", \"REJECTED\", or \"REMOVED\".
" }, "statusDetails":{ "shape":"DetailsMap", "documentation":"A collection of name/value pairs that describe the status of the job execution.
The maximum length of the value in the name/value pair is 1,024 characters.
" }, "queuedAt":{ "shape":"QueuedAt", "documentation":"The time, in seconds since the epoch, when the job execution was enqueued.
" }, "startedAt":{ "shape":"StartedAt", "documentation":"The time, in seconds since the epoch, when the job execution was started.
" }, "lastUpdatedAt":{ "shape":"LastUpdatedAt", "documentation":"The time, in seconds since the epoch, when the job execution was last updated.
" }, "approximateSecondsBeforeTimedOut":{ "shape":"ApproximateSecondsBeforeTimedOut", "documentation":"The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT. The actual job execution timeout can occur up to 60 seconds later than the estimated duration.
The version of the job execution. Job execution versions are incremented each time they are updated by a device.
" }, "executionNumber":{ "shape":"ExecutionNumber", "documentation":"A number that identifies a particular job execution on a particular device. It can be used later in commands that return or update job execution information.
" }, "jobDocument":{ "shape":"JobDocument", "documentation":"The content of the job document.
" } }, "documentation":"Contains data about a job execution.
" }, "JobExecutionState":{ "type":"structure", "members":{ "status":{ "shape":"JobExecutionStatus", "documentation":"The status of the job execution. Can be one of: \"QUEUED\", \"IN_PROGRESS\", \"FAILED\", \"SUCCESS\", \"CANCELED\", \"TIMED_OUT\", \"REJECTED\", or \"REMOVED\".
" }, "statusDetails":{ "shape":"DetailsMap", "documentation":"A collection of name/value pairs that describe the status of the job execution.
The maximum length of the value in the name/value pair is 1,024 characters.
" }, "versionNumber":{ "shape":"VersionNumber", "documentation":"The version of the job execution. Job execution versions are incremented each time they are updated by a device.
" } }, "documentation":"Contains data about the state of a job execution.
" }, "JobExecutionStatus":{ "type":"string", "enum":[ "QUEUED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "TIMED_OUT", "REJECTED", "REMOVED", "CANCELED" ] }, "JobExecutionSummary":{ "type":"structure", "members":{ "jobId":{ "shape":"JobId", "documentation":"The unique identifier you assigned to this job when it was created.
" }, "queuedAt":{ "shape":"QueuedAt", "documentation":"The time, in seconds since the epoch, when the job execution was enqueued.
" }, "startedAt":{ "shape":"StartedAt", "documentation":"The time, in seconds since the epoch, when the job execution started.
" }, "lastUpdatedAt":{ "shape":"LastUpdatedAt", "documentation":"The time, in seconds since the epoch, when the job execution was last updated.
" }, "versionNumber":{ "shape":"VersionNumber", "documentation":"The version of the job execution. Job execution versions are incremented each time IoT Jobs receives an update from a device.
" }, "executionNumber":{ "shape":"ExecutionNumber", "documentation":"A number that identifies a particular job execution on a particular device.
" } }, "documentation":"Contains a subset of information about a job execution.
" }, "JobExecutionSummaryList":{ "type":"list", "member":{"shape":"JobExecutionSummary"} }, "JobId":{ "type":"string", "max":64, "min":1, "pattern":"[a-zA-Z0-9_-]+" }, "LastUpdatedAt":{"type":"long"}, "LongParameterValue":{"type":"long"}, "QueuedAt":{"type":"long"}, "ResourceNotFoundException":{ "type":"structure", "members":{ "message":{ "shape":"errorMessage", "documentation":"The message for the exception.
" } }, "documentation":"The specified resource does not exist.
", "error":{"httpStatusCode":404}, "exception":true }, "ServiceQuotaExceededException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"The service quota has been exceeded for this request.
", "error":{"httpStatusCode":402}, "exception":true }, "ServiceUnavailableException":{ "type":"structure", "members":{ "message":{ "shape":"errorMessage", "documentation":"The message for the exception.
" } }, "documentation":"The service is temporarily unavailable.
", "error":{"httpStatusCode":503}, "exception":true, "fault":true }, "StartCommandExecutionRequest":{ "type":"structure", "required":[ "targetArn", "commandArn" ], "members":{ "targetArn":{ "shape":"TargetArn", "documentation":"The Amazon Resource Number (ARN) of the device where the command execution is occurring.
" }, "commandArn":{ "shape":"CommandArn", "documentation":"The Amazon Resource Number (ARN) of the command. For example, arn:aws:iot:<region>:<accountid>:command/<commandName>
A list of parameters that are required by the StartCommandExecution API when performing the command on a device.
Specifies the amount of time in second the device has to finish the command execution. A timer is started as soon as the command execution is created. If the command execution status is not set to another terminal state before the timer expires, it will automatically update to TIMED_OUT.
The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you retry the request using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.
", "idempotencyToken":true } } }, "StartCommandExecutionResponse":{ "type":"structure", "members":{ "executionId":{ "shape":"CommandExecutionId", "documentation":"A unique identifier for the command execution.
" } } }, "StartNextPendingJobExecutionRequest":{ "type":"structure", "required":["thingName"], "members":{ "thingName":{ "shape":"ThingName", "documentation":"The name of the thing associated with the device.
", "location":"uri", "locationName":"thingName" }, "statusDetails":{ "shape":"DetailsMap", "documentation":"A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.
The maximum length of the value in the name/value pair is 1,024 characters.
" }, "stepTimeoutInMinutes":{ "shape":"StepTimeoutInMinutes", "documentation":"Specifies the amount of time this device has to finish execution of this job. If the job execution status is not set to a terminal state before this timer expires, or before the timer is reset (by calling UpdateJobExecution, setting the status to IN_PROGRESS, and specifying a new timeout value in field stepTimeoutInMinutes) the job execution status will be automatically set to TIMED_OUT. Note that setting the step timeout has no effect on the in progress timeout that may have been specified when the job was created (CreateJob using field timeoutConfig).
Valid values for this parameter range from 1 to 10080 (1 minute to 7 days).
" } } }, "StartNextPendingJobExecutionResponse":{ "type":"structure", "members":{ "execution":{ "shape":"JobExecution", "documentation":"A JobExecution object.
" } } }, "StartedAt":{"type":"long"}, "StepTimeoutInMinutes":{"type":"long"}, "StringParameterValue":{ "type":"string", "min":1 }, "TargetArn":{ "type":"string", "max":2048 }, "TerminalStateException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"The job is in a terminal state.
", "error":{"httpStatusCode":410}, "exception":true }, "ThingName":{ "type":"string", "max":128, "min":1, "pattern":"[a-zA-Z0-9:_-]+" }, "ThrottlingException":{ "type":"structure", "members":{ "message":{ "shape":"errorMessage", "documentation":"The message associated with the exception.
" }, "payload":{ "shape":"BinaryBlob", "documentation":"The payload associated with the exception.
" } }, "documentation":"The rate exceeds the limit.
", "error":{"httpStatusCode":429}, "exception":true }, "UnsignedLongParameterValue":{ "type":"string", "max":20, "min":1, "pattern":"^[0-9]*$" }, "UpdateJobExecutionRequest":{ "type":"structure", "required":[ "jobId", "thingName", "status" ], "members":{ "jobId":{ "shape":"JobId", "documentation":"The unique identifier assigned to this job when it was created.
", "location":"uri", "locationName":"jobId" }, "thingName":{ "shape":"ThingName", "documentation":"The name of the thing associated with the device.
", "location":"uri", "locationName":"thingName" }, "status":{ "shape":"JobExecutionStatus", "documentation":"The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update.
" }, "statusDetails":{ "shape":"DetailsMap", "documentation":"Optional. A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.
The maximum length of the value in the name/value pair is 1,024 characters.
" }, "stepTimeoutInMinutes":{ "shape":"StepTimeoutInMinutes", "documentation":"Specifies the amount of time this device has to finish execution of this job. If the job execution status is not set to a terminal state before this timer expires, or before the timer is reset (by again calling UpdateJobExecution, setting the status to IN_PROGRESS, and specifying a new timeout value in this field) the job execution status will be automatically set to TIMED_OUT. Note that setting or resetting the step timeout has no effect on the in progress timeout that may have been specified when the job was created (CreateJob using field timeoutConfig).
Valid values for this parameter range from 1 to 10080 (1 minute to 7 days). A value of -1 is also valid and will cancel the current step timer (created by an earlier use of UpdateJobExecutionRequest).
Optional. The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.)
" }, "includeJobExecutionState":{ "shape":"IncludeExecutionState", "documentation":"Optional. When included and set to true, the response contains the JobExecutionState data. The default is false.
" }, "includeJobDocument":{ "shape":"IncludeJobDocument", "documentation":"Optional. When set to true, the response contains the job document. The default is false.
" }, "executionNumber":{ "shape":"ExecutionNumber", "documentation":"Optional. A number that identifies a particular job execution on a particular device.
" } } }, "UpdateJobExecutionResponse":{ "type":"structure", "members":{ "executionState":{ "shape":"JobExecutionState", "documentation":"A JobExecutionState object.
" }, "jobDocument":{ "shape":"JobDocument", "documentation":"The contents of the Job Documents.
" } } }, "ValidationException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"A validation error occurred when performing the API request.
", "error":{"httpStatusCode":400}, "exception":true }, "VersionNumber":{"type":"long"}, "errorMessage":{"type":"string"}, "resourceId":{"type":"string"} }, "documentation":"IoT Jobs is a service that allows you to define a set of jobs — remote operations that are sent to and executed on one or more devices connected to Amazon Web Services IoT Core. For example, you can define a job that instructs a set of devices to download and install application or firmware updates, reboot, rotate certificates, or perform remote troubleshooting operations.
Find the endpoint address for actions in the IoT jobs data plane by running this CLI command:
aws iot describe-endpoint --endpoint-type iot:Jobs
The service name used by Amazon Web Services Signature Version 4 to sign requests is: iot-jobs-data.
To create a job, you make a job document which is a description of the remote operations to be performed, and you specify a list of targets that should perform the operations. The targets can be individual things, thing groups or both.
IoT Jobs sends a message to inform the targets that a job is available. The target starts the execution of the job by downloading the job document, performing the operations it specifies, and reporting its progress to Amazon Web Services IoT Core. The Jobs service provides commands to track the progress of a job on a specific target and for all the targets of the job
" }