{"note":"OpenAPI conversion -- returning structured metadata","name":"amazonaws-com-iot-jobs-data","description":"AWS IoT Jobs Data Plane","version":"2017-09-29","base_url":"","endpoints":4,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api AWS IoT Jobs Data Plane\n@version 2017-09-29\n@auth AWS SigV4\n@endpoints 4\n@toc things(4)\n\n@endpoint GET /things/{thingName}/jobs/{jobId}\n@desc Gets details of a job execution.\n@required {jobId: str, thingName: str}\n@optional {includeJobDocument: bool, executionNumber: int(i64)}\n@returns(200) {execution: JobExecution?{jobId: str?, thingName: str?, status: str?, statusDetails: map<str,str>?, queuedAt: int(i64)?, startedAt: int(i64)?, lastUpdatedAt: int(i64)?, approximateSecondsBeforeTimedOut: int(i64)?, versionNumber: int(i64)?, executionNumber: int(i64)?, jobDocument: str?}}\n\n@endpoint GET /things/{thingName}/jobs\n@desc Gets the list of all jobs for a thing that are not in a terminal status.\n@required {thingName: str}\n@returns(200) {inProgressJobs: [JobExecutionSummary]?, queuedJobs: [JobExecutionSummary]?}\n\n@endpoint PUT /things/{thingName}/jobs/$next\n@desc Gets and starts the next pending (status IN_PROGRESS or QUEUED) job execution for a thing.\n@required {thingName: str}\n@optional {statusDetails: map<str,str>, stepTimeoutInMinutes: int(i64)}\n@returns(200) {execution: JobExecution?{jobId: str?, thingName: str?, status: str?, statusDetails: map<str,str>?, queuedAt: int(i64)?, startedAt: int(i64)?, lastUpdatedAt: int(i64)?, approximateSecondsBeforeTimedOut: int(i64)?, versionNumber: int(i64)?, executionNumber: int(i64)?, jobDocument: str?}}\n\n@endpoint POST /things/{thingName}/jobs/{jobId}\n@desc Updates the status of a job execution.\n@required {jobId: str, thingName: str, status: str}\n@optional {statusDetails: map<str,str>, stepTimeoutInMinutes: int(i64), expectedVersion: int(i64), includeJobExecutionState: bool, includeJobDocument: bool, executionNumber: int(i64)}\n@returns(200) {executionState: JobExecutionState?{status: str?, statusDetails: map<str,str>?, versionNumber: int(i64)?}, jobDocument: str?}\n\n@end\n"}