openapi-directory/api/amazonaws.com/iot-jobs-data.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"version":"2017-09-29","x-release":"v4","title":"AWS IoT Jobs Data Plane","description":"<p>AWS 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 AWS IoT. 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.</p> <p> 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.</p> <p> AWS 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 AWS IoT. The Jobs service provides commands to track the progress of a job on a specific target and for all the targets of the job</p>","x-logo":{"url":"https://twitter.com/awscloud/profile_image?size=original","backgroundColor":"#FFFFFF"},"termsOfService":"https://aws.amazon.com/service-terms/","contact":{"name":"Mike Ralphson","email":"mike.ralphson@gmail.com","url":"https://github.com/mermade/aws2openapi","x-twitter":"PermittedSoc"},"license":{"name":"Apache 2.0 License","url":"http://www.apache.org/licenses/"},"x-providerName":"amazonaws.com","x-serviceName":"iot-jobs-data","x-origin":[{"contentType":"application/json","url":"https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/iot-jobs-data-2017-09-29.normal.json","converter":{"url":"https://github.com/mermade/aws2openapi","version":"1.0.0"},"x-apisguru-direct":true}],"x-apiClientRegistration":{"url":"https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct"},"x-apisguru-categories":["cloud"],"x-preferred":true},"externalDocs":{"description":"Amazon Web Services documentation","url":"https://aws.amazon.com/iot/"},"security":[{"hmac":[]}],"paths":{"/things/{thingName}/jobs/{jobId}":{"get":{"operationId":"DescribeJobExecution","description":"Gets details of a job execution.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeJobExecutionResponse"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}},"484":{"description":"CertificateValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateValidationException"}}}},"485":{"description":"TerminalStateException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TerminalStateException"}}}}},"parameters":[{"name":"thingName","in":"path","required":true,"schema":{"type":"string"}},{"name":"jobId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeJobExecutionRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"post":{"operationId":"UpdateJobExecution","description":"Updates the status of a job execution.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateJobExecutionResponse"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}},"484":{"description":"CertificateValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateValidationException"}}}},"485":{"description":"InvalidStateTransitionException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidStateTransitionException"}}}}},"parameters":[{"name":"thingName","in":"path","required":true,"schema":{"type":"string"}},{"name":"jobId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateJobExecutionRequest"}}},"required":true}}},"/things/{thingName}/jobs":{"get":{"operationId":"GetPendingJobExecutions","description":"Gets the list of all jobs for a thing that are not in a terminal status.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPendingJobExecutionsResponse"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}},"484":{"description":"CertificateValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateValidationException"}}}}},"parameters":[{"name":"thingName","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPendingJobExecutionsRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/things/{thingName}/jobs/$next":{"put":{"operationId":"StartNextPendingJobExecution","description":"Gets and starts the next pending (status IN_PROGRESS or QUEUED) job execution for a thing.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartNextPendingJobExecutionResponse"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}},"484":{"description":"CertificateValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertificateValidationException"}}}}},"parameters":[{"name":"thingName","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartNextPendingJobExecutionRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]}},"servers":[{"url":"https://data.jobs.iot.amazonaws.com/"},{"url":"http://data.jobs.iot.amazonaws.com/"}],"components":{"parameters":{"Action":{"name":"Action","in":"query","required":true,"schema":{"type":"string"}},"Version":{"name":"Version","in":"query","required":true,"schema":{"type":"string"}},"X-Amz-Content-Sha256":{"name":"X-Amz-Content-Sha256","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Date":{"name":"X-Amz-Date","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Algorithm":{"name":"X-Amz-Algorithm","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Credential":{"name":"X-Amz-Credential","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Security-Token":{"name":"X-Amz-Security-Token","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Signature":{"name":"X-Amz-Signature","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-SignedHeaders":{"name":"X-Amz-SignedHeaders","in":"header","required":false,"schema":{"type":"string"}}},"securitySchemes":{"hmac":{"type":"apiKey","name":"Authorization","in":"header","description":"Amazon Signature authorization v4","x-amazon-apigateway-authtype":"awsSigv4"}},"schemas":{"DescribeJobExecutionResponse":{"type":"object","properties":{"execution":{"$ref":"#/components/schemas/JobExecution"}}},"DescribeJobExecutionRequest":{"type":"object","properties":{}},"InvalidRequestException":{},"ResourceNotFoundException":{},"ThrottlingException":{},"ServiceUnavailableException":{},"CertificateValidationException":{},"TerminalStateException":{},"GetPendingJobExecutionsResponse":{"type":"object","properties":{"inProgressJobs":{"$ref":"#/components/schemas/JobExecutionSummaryList"},"queuedJobs":{"$ref":"#/components/schemas/JobExecutionSummaryList"}}},"GetPendingJobExecutionsRequest":{"type":"object","properties":{}},"StartNextPendingJobExecutionResponse":{"type":"object","properties":{"execution":{"$ref":"#/components/schemas/JobExecution"}}},"StartNextPendingJobExecutionRequest":{"type":"object","properties":{"statusDetails":{"$ref":"#/components/schemas/DetailsMap"},"stepTimeoutInMinutes":{"$ref":"#/components/schemas/StepTimeoutInMinutes"}}},"UpdateJobExecutionResponse":{"type":"object","properties":{"executionState":{"$ref":"#/components/schemas/JobExecutionState"},"jobDocument":{"$ref":"#/components/schemas/JobDocument"}}},"UpdateJobExecutionRequest":{"type":"object","required":["status"],"properties":{"status":{"$ref":"#/components/schemas/JobExecutionStatus"},"statusDetails":{"$ref":"#/components/schemas/DetailsMap"},"stepTimeoutInMinutes":{"$ref":"#/components/schemas/StepTimeoutInMinutes"},"expectedVersion":{"$ref":"#/components/schemas/ExpectedVersion"},"includeJobExecutionState":{"$ref":"#/components/schemas/IncludeExecutionState"},"includeJobDocument":{"$ref":"#/components/schemas/IncludeJobDocument"},"executionNumber":{"$ref":"#/components/schemas/ExecutionNumber"}}},"InvalidStateTransitionException":{},"ApproximateSecondsBeforeTimedOut":{"type":"integer"},"DescribeJobExecutionJobId":{"type":"string","pattern":"[a-zA-Z0-9_-]+|^\\$next"},"ThingName":{"type":"string","pattern":"[a-zA-Z0-9:_-]+","minLength":1,"maxLength":128},"IncludeJobDocument":{"type":"boolean"},"ExecutionNumber":{"type":"integer"},"JobExecution":{"type":"object","properties":{"jobId":{"$ref":"#/components/schemas/JobId"},"thingName":{"$ref":"#/components/schemas/ThingName"},"status":{"$ref":"#/components/schemas/JobExecutionStatus"},"statusDetails":{"$ref":"#/components/schemas/DetailsMap"},"queuedAt":{"$ref":"#/components/schemas/QueuedAt"},"startedAt":{"$ref":"#/components/schemas/StartedAt"},"lastUpdatedAt":{"$ref":"#/components/schemas/LastUpdatedAt"},"approximateSecondsBeforeTimedOut":{"$ref":"#/components/schemas/ApproximateSecondsBeforeTimedOut"},"versionNumber":{"$ref":"#/components/schemas/VersionNumber"},"executionNumber":{"$ref":"#/components/schemas/ExecutionNumber"},"jobDocument":{"$ref":"#/components/schemas/JobDocument"}},"description":"Contains data about a job execution."},"DetailsKey":{"type":"string","pattern":"[a-zA-Z0-9:_-]+","minLength":1,"maxLength":128},"DetailsValue":{"type":"string","pattern":"[^\\p\\{C\\}]*\\+","minLength":1,"maxLength":1024},"DetailsMap":{"type":"array","items":{"type":"object","properties":{"key":{"$ref":"#/components/schemas/DetailsKey"},"value":{"$ref":"#/components/schemas/DetailsValue"}}}},"ExpectedVersion":{"type":"integer"},"JobExecutionSummaryList":{"type":"array","items":{"$ref":"#/components/schemas/JobExecutionSummary"}},"IncludeExecutionState":{"type":"boolean"},"JobDocument":{"type":"string","maxLength":32768},"JobId":{"type":"string","pattern":"[a-zA-Z0-9_-]+","minLength":1,"maxLength":64},"JobExecutionStatus":{"type":"string","enum":["QUEUED","IN_PROGRESS","SUCCEEDED","FAILED","TIMED_OUT","REJECTED","REMOVED","CANCELED"]},"QueuedAt":{"type":"integer"},"StartedAt":{"type":"integer"},"LastUpdatedAt":{"type":"integer"},"VersionNumber":{"type":"integer"},"JobExecutionState":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/JobExecutionStatus"},"statusDetails":{"$ref":"#/components/schemas/DetailsMap"},"versionNumber":{"$ref":"#/components/schemas/VersionNumber"}},"description":"Contains data about the state of a job execution."},"JobExecutionSummary":{"type":"object","properties":{"jobId":{"$ref":"#/components/schemas/JobId"},"queuedAt":{"$ref":"#/components/schemas/QueuedAt"},"startedAt":{"$ref":"#/components/schemas/StartedAt"},"lastUpdatedAt":{"$ref":"#/components/schemas/LastUpdatedAt"},"versionNumber":{"$ref":"#/components/schemas/VersionNumber"},"executionNumber":{"$ref":"#/components/schemas/ExecutionNumber"}},"description":"Contains a subset of information about a job execution."},"StepTimeoutInMinutes":{"type":"integer"}}}}