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

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

{"openapi":"3.0.0","info":{"version":"2015-05-28","x-release":"v4","title":"AWS IoT Data Plane","description":"<fullname>AWS IoT</fullname> <p>AWS IoT-Data enables secure, bi-directional communication between Internet-connected things (such as sensors, actuators, embedded devices, or smart appliances) and the AWS cloud. It implements a broker for applications and things to publish messages over HTTP (Publish) and retrieve, update, and delete thing shadows. A thing shadow is a persistent representation of your things and their state in the AWS cloud.</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-data","x-origin":[{"contentType":"application/json","url":"https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/iot-data-2015-05-28.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/"},"x-hasEquivalentPaths":true,"security":[{"hmac":[]}],"paths":{"/things/{thingName}/shadow":{"delete":{"operationId":"DeleteThingShadow","description":"<p>Deletes the thing shadow for the specified thing.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/iot/latest/developerguide/API_DeleteThingShadow.html\">DeleteThingShadow</a> in the <i>AWS IoT Developer Guide</i>.</p>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteThingShadowResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"484":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}},"485":{"description":"InternalFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalFailureException"}}}},"486":{"description":"MethodNotAllowedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowedException"}}}},"487":{"description":"UnsupportedDocumentEncodingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedDocumentEncodingException"}}}}},"parameters":[{"name":"thingName","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteThingShadowRequest"}}},"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"}],"get":{"operationId":"GetThingShadow","description":"<p>Gets the thing shadow for the specified thing.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/iot/latest/developerguide/API_GetThingShadow.html\">GetThingShadow</a> in the <i>AWS IoT Developer Guide</i>.</p>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetThingShadowResponse"}}}},"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":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"484":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}},"485":{"description":"InternalFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalFailureException"}}}},"486":{"description":"MethodNotAllowedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowedException"}}}},"487":{"description":"UnsupportedDocumentEncodingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedDocumentEncodingException"}}}}},"parameters":[{"name":"thingName","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetThingShadowRequest"}}},"required":true}},"post":{"operationId":"UpdateThingShadow","description":"<p>Updates the thing shadow for the specified thing.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/iot/latest/developerguide/API_UpdateThingShadow.html\">UpdateThingShadow</a> in the <i>AWS IoT Developer Guide</i>.</p>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateThingShadowResponse"}}}},"480":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"481":{"description":"RequestEntityTooLargeException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestEntityTooLargeException"}}}},"482":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"483":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"484":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"485":{"description":"ServiceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableException"}}}},"486":{"description":"InternalFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalFailureException"}}}},"487":{"description":"MethodNotAllowedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowedException"}}}},"488":{"description":"UnsupportedDocumentEncodingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedDocumentEncodingException"}}}}},"parameters":[{"name":"thingName","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateThingShadowRequest"}}},"required":true}}},"/topics/{topic}":{"post":{"operationId":"Publish","description":"<p>Publishes state information.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/iot/latest/developerguide/protocols.html#http\">HTTP Protocol</a> in the <i>AWS IoT Developer Guide</i>.</p>","responses":{"200":{"description":"Success"},"480":{"description":"InternalFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalFailureException"}}}},"481":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"482":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"483":{"description":"MethodNotAllowedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowedException"}}}}},"parameters":[{"name":"topic","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublishRequest"}}},"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.iot.amazonaws.com/"},{"url":"http://data.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":{"DeleteThingShadowResponse":{"type":"object","required":["payload"],"properties":{"payload":{"$ref":"#/components/schemas/JsonDocument"}},"description":"The output from the DeleteThingShadow operation."},"DeleteThingShadowRequest":{"type":"object","properties":{},"description":"The input for the DeleteThingShadow operation."},"ResourceNotFoundException":{"type":"object","properties":{"message":{"$ref":"#/components/schemas/errorMessage"}},"description":"The specified resource does not exist."},"InvalidRequestException":{"type":"object","properties":{"message":{"$ref":"#/components/schemas/errorMessage"}},"description":"The request is not valid."},"ThrottlingException":{"type":"object","properties":{"message":{"$ref":"#/components/schemas/errorMessage"}},"description":"The rate exceeds the limit."},"UnauthorizedException":{"type":"object","properties":{"message":{"$ref":"#/components/schemas/errorMessage"}},"description":"You are not authorized to perform this operation."},"ServiceUnavailableException":{"type":"object","properties":{"message":{"$ref":"#/components/schemas/errorMessage"}},"description":"The service is temporarily unavailable."},"InternalFailureException":{"type":"object","properties":{"message":{"$ref":"#/components/schemas/errorMessage"}},"description":"An unexpected error has occurred."},"MethodNotAllowedException":{"type":"object","properties":{"message":{"$ref":"#/components/schemas/ErrorMessage"}},"description":"The specified combination of HTTP verb and URI is not supported."},"UnsupportedDocumentEncodingException":{"type":"object","properties":{"message":{"$ref":"#/components/schemas/errorMessage"}},"description":"The document encoding is not supported."},"GetThingShadowResponse":{"type":"object","properties":{"payload":{"$ref":"#/components/schemas/JsonDocument"}},"description":"The output from the GetThingShadow operation."},"GetThingShadowRequest":{"type":"object","properties":{},"description":"The input for the GetThingShadow operation."},"PublishRequest":{"type":"object","properties":{"payload":{"$ref":"#/components/schemas/Payload"}},"description":"The input for the Publish operation."},"UpdateThingShadowResponse":{"type":"object","properties":{"payload":{"$ref":"#/components/schemas/JsonDocument"}},"description":"The output from the UpdateThingShadow operation."},"UpdateThingShadowRequest":{"type":"object","required":["payload"],"properties":{"payload":{"$ref":"#/components/schemas/JsonDocument"}},"description":"The input for the UpdateThingShadow operation."},"ConflictException":{"type":"object","properties":{"message":{"$ref":"#/components/schemas/ErrorMessage"}},"description":"The specified version does not match the version of the document."},"RequestEntityTooLargeException":{"type":"object","properties":{"message":{"$ref":"#/components/schemas/ErrorMessage"}},"description":"The payload exceeds the maximum size allowed."},"ErrorMessage":{"type":"string"},"ThingName":{"type":"string","pattern":"[a-zA-Z0-9_-]+","minLength":1,"maxLength":128},"JsonDocument":{"type":"string"},"errorMessage":{"type":"string"},"Payload":{"type":"string"},"Topic":{"type":"string"},"Qos":{"type":"integer","minimum":0,"maximum":1}}}}