2015-11-24 12:34:53 +01:00
{
"version" : "2.0" ,
"metadata" : {
2017-02-02 09:27:08 +01:00
"uid" : "iot-data-2015-05-28" ,
2015-11-24 12:34:53 +01:00
"apiVersion" : "2015-05-28" ,
"endpointPrefix" : "data.iot" ,
2016-02-02 09:54:52 +01:00
"protocol" : "rest-json" ,
2015-11-24 12:34:53 +01:00
"serviceFullName" : "AWS IoT Data Plane" ,
2018-07-11 08:25:50 +02:00
"serviceId" : "IoT Data Plane" ,
2015-11-24 12:34:53 +01:00
"signatureVersion" : "v4" ,
2016-02-02 09:54:52 +01:00
"signingName" : "iotdata"
2015-11-24 12:34:53 +01:00
} ,
"operations" : {
"DeleteThingShadow" : {
"name" : "DeleteThingShadow" ,
"http" : {
"method" : "DELETE" ,
"requestUri" : "/things/{thingName}/shadow"
} ,
2016-02-02 09:54:52 +01:00
"input" : { "shape" : "DeleteThingShadowRequest" } ,
"output" : { "shape" : "DeleteThingShadowResponse" } ,
2015-11-24 12:34:53 +01:00
"errors" : [
2016-02-02 09:54:52 +01:00
{ "shape" : "ResourceNotFoundException" } ,
{ "shape" : "InvalidRequestException" } ,
{ "shape" : "ThrottlingException" } ,
{ "shape" : "UnauthorizedException" } ,
{ "shape" : "ServiceUnavailableException" } ,
{ "shape" : "InternalFailureException" } ,
{ "shape" : "MethodNotAllowedException" } ,
{ "shape" : "UnsupportedDocumentEncodingException" }
2015-11-24 12:34:53 +01:00
] ,
"documentation" : "<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>"
} ,
"GetThingShadow" : {
"name" : "GetThingShadow" ,
"http" : {
"method" : "GET" ,
"requestUri" : "/things/{thingName}/shadow"
} ,
2016-02-02 09:54:52 +01:00
"input" : { "shape" : "GetThingShadowRequest" } ,
"output" : { "shape" : "GetThingShadowResponse" } ,
2015-11-24 12:34:53 +01:00
"errors" : [
2016-02-02 09:54:52 +01:00
{ "shape" : "InvalidRequestException" } ,
{ "shape" : "ResourceNotFoundException" } ,
{ "shape" : "ThrottlingException" } ,
{ "shape" : "UnauthorizedException" } ,
{ "shape" : "ServiceUnavailableException" } ,
{ "shape" : "InternalFailureException" } ,
{ "shape" : "MethodNotAllowedException" } ,
{ "shape" : "UnsupportedDocumentEncodingException" }
2015-11-24 12:34:53 +01:00
] ,
"documentation" : "<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>"
} ,
"Publish" : {
"name" : "Publish" ,
"http" : {
"method" : "POST" ,
"requestUri" : "/topics/{topic}"
} ,
2016-02-02 09:54:52 +01:00
"input" : { "shape" : "PublishRequest" } ,
2015-11-24 12:34:53 +01:00
"errors" : [
2016-02-02 09:54:52 +01:00
{ "shape" : "InternalFailureException" } ,
{ "shape" : "InvalidRequestException" } ,
{ "shape" : "UnauthorizedException" } ,
{ "shape" : "MethodNotAllowedException" }
2015-11-24 12:34:53 +01:00
] ,
"documentation" : "<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>"
} ,
"UpdateThingShadow" : {
"name" : "UpdateThingShadow" ,
"http" : {
"method" : "POST" ,
"requestUri" : "/things/{thingName}/shadow"
} ,
2016-02-02 09:54:52 +01:00
"input" : { "shape" : "UpdateThingShadowRequest" } ,
"output" : { "shape" : "UpdateThingShadowResponse" } ,
2015-11-24 12:34:53 +01:00
"errors" : [
2016-02-02 09:54:52 +01:00
{ "shape" : "ConflictException" } ,
{ "shape" : "RequestEntityTooLargeException" } ,
{ "shape" : "InvalidRequestException" } ,
{ "shape" : "ThrottlingException" } ,
{ "shape" : "UnauthorizedException" } ,
{ "shape" : "ServiceUnavailableException" } ,
{ "shape" : "InternalFailureException" } ,
{ "shape" : "MethodNotAllowedException" } ,
{ "shape" : "UnsupportedDocumentEncodingException" }
2015-11-24 12:34:53 +01:00
] ,
"documentation" : "<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>"
}
} ,
"shapes" : {
"ConflictException" : {
"type" : "structure" ,
"members" : {
"message" : {
"shape" : "ErrorMessage" ,
"documentation" : "<p>The message for the exception.</p>"
}
} ,
2016-02-02 09:54:52 +01:00
"documentation" : "<p>The specified version does not match the version of the document.</p>" ,
2015-11-24 12:34:53 +01:00
"error" : { "httpStatusCode" : 409 } ,
2016-02-02 09:54:52 +01:00
"exception" : true
2015-11-24 12:34:53 +01:00
} ,
"DeleteThingShadowRequest" : {
"type" : "structure" ,
"required" : [ "thingName" ] ,
"members" : {
"thingName" : {
"shape" : "ThingName" ,
2016-02-02 09:54:52 +01:00
"documentation" : "<p>The name of the thing.</p>" ,
2015-11-24 12:34:53 +01:00
"location" : "uri" ,
2016-02-02 09:54:52 +01:00
"locationName" : "thingName"
2015-11-24 12:34:53 +01:00
}
} ,
"documentation" : "<p>The input for the DeleteThingShadow operation.</p>"
} ,
"DeleteThingShadowResponse" : {
"type" : "structure" ,
"required" : [ "payload" ] ,
"members" : {
"payload" : {
"shape" : "JsonDocument" ,
"documentation" : "<p>The state information, in JSON format.</p>"
}
} ,
"documentation" : "<p>The output from the DeleteThingShadow operation.</p>" ,
"payload" : "payload"
} ,
"ErrorMessage" : { "type" : "string" } ,
"GetThingShadowRequest" : {
"type" : "structure" ,
"required" : [ "thingName" ] ,
"members" : {
"thingName" : {
"shape" : "ThingName" ,
2016-02-02 09:54:52 +01:00
"documentation" : "<p>The name of the thing.</p>" ,
2015-11-24 12:34:53 +01:00
"location" : "uri" ,
2016-02-02 09:54:52 +01:00
"locationName" : "thingName"
2015-11-24 12:34:53 +01:00
}
} ,
"documentation" : "<p>The input for the GetThingShadow operation.</p>"
} ,
"GetThingShadowResponse" : {
"type" : "structure" ,
"members" : {
"payload" : {
"shape" : "JsonDocument" ,
"documentation" : "<p>The state information, in JSON format.</p>"
}
} ,
"documentation" : "<p>The output from the GetThingShadow operation.</p>" ,
"payload" : "payload"
} ,
"InternalFailureException" : {
"type" : "structure" ,
"members" : {
"message" : {
"shape" : "errorMessage" ,
"documentation" : "<p>The message for the exception.</p>"
}
} ,
2016-02-02 09:54:52 +01:00
"documentation" : "<p>An unexpected error has occurred.</p>" ,
2015-11-24 12:34:53 +01:00
"error" : { "httpStatusCode" : 500 } ,
"exception" : true ,
2016-02-02 09:54:52 +01:00
"fault" : true
2015-11-24 12:34:53 +01:00
} ,
"InvalidRequestException" : {
"type" : "structure" ,
"members" : {
"message" : {
"shape" : "errorMessage" ,
"documentation" : "<p>The message for the exception.</p>"
}
} ,
2016-02-02 09:54:52 +01:00
"documentation" : "<p>The request is not valid.</p>" ,
2015-11-24 12:34:53 +01:00
"error" : { "httpStatusCode" : 400 } ,
2016-02-02 09:54:52 +01:00
"exception" : true
2015-11-24 12:34:53 +01:00
} ,
"JsonDocument" : { "type" : "blob" } ,
"MethodNotAllowedException" : {
"type" : "structure" ,
"members" : {
"message" : {
"shape" : "ErrorMessage" ,
"documentation" : "<p>The message for the exception.</p>"
}
} ,
2016-02-02 09:54:52 +01:00
"documentation" : "<p>The specified combination of HTTP verb and URI is not supported.</p>" ,
2015-11-24 12:34:53 +01:00
"error" : { "httpStatusCode" : 405 } ,
2016-02-02 09:54:52 +01:00
"exception" : true
2015-11-24 12:34:53 +01:00
} ,
"Payload" : { "type" : "blob" } ,
"PublishRequest" : {
"type" : "structure" ,
2016-02-02 09:54:52 +01:00
"required" : [ "topic" ] ,
2015-11-24 12:34:53 +01:00
"members" : {
"topic" : {
"shape" : "Topic" ,
2016-02-02 09:54:52 +01:00
"documentation" : "<p>The name of the MQTT topic.</p>" ,
2015-11-24 12:34:53 +01:00
"location" : "uri" ,
2016-02-02 09:54:52 +01:00
"locationName" : "topic"
2015-11-24 12:34:53 +01:00
} ,
"qos" : {
"shape" : "Qos" ,
2016-02-02 09:54:52 +01:00
"documentation" : "<p>The Quality of Service (QoS) level.</p>" ,
2015-11-24 12:34:53 +01:00
"location" : "querystring" ,
2016-02-02 09:54:52 +01:00
"locationName" : "qos"
2015-11-24 12:34:53 +01:00
} ,
"payload" : {
"shape" : "Payload" ,
"documentation" : "<p>The state information, in JSON format.</p>"
}
} ,
"documentation" : "<p>The input for the Publish operation.</p>" ,
"payload" : "payload"
} ,
"Qos" : {
"type" : "integer" ,
2016-02-02 09:54:52 +01:00
"max" : 1 ,
"min" : 0
2015-11-24 12:34:53 +01:00
} ,
"RequestEntityTooLargeException" : {
"type" : "structure" ,
"members" : {
"message" : {
"shape" : "ErrorMessage" ,
"documentation" : "<p>The message for the exception.</p>"
}
} ,
2016-02-02 09:54:52 +01:00
"documentation" : "<p>The payload exceeds the maximum size allowed.</p>" ,
2015-11-24 12:34:53 +01:00
"error" : { "httpStatusCode" : 413 } ,
2016-02-02 09:54:52 +01:00
"exception" : true
2015-11-24 12:34:53 +01:00
} ,
"ResourceNotFoundException" : {
"type" : "structure" ,
"members" : {
"message" : {
"shape" : "errorMessage" ,
"documentation" : "<p>The message for the exception.</p>"
}
} ,
2016-02-02 09:54:52 +01:00
"documentation" : "<p>The specified resource does not exist.</p>" ,
2015-11-24 12:34:53 +01:00
"error" : { "httpStatusCode" : 404 } ,
2016-02-02 09:54:52 +01:00
"exception" : true
2015-11-24 12:34:53 +01:00
} ,
"ServiceUnavailableException" : {
"type" : "structure" ,
"members" : {
"message" : {
"shape" : "errorMessage" ,
"documentation" : "<p>The message for the exception.</p>"
}
} ,
2016-02-02 09:54:52 +01:00
"documentation" : "<p>The service is temporarily unavailable.</p>" ,
2015-11-24 12:34:53 +01:00
"error" : { "httpStatusCode" : 503 } ,
"exception" : true ,
2016-02-02 09:54:52 +01:00
"fault" : true
2015-11-24 12:34:53 +01:00
} ,
"ThingName" : {
"type" : "string" ,
"max" : 128 ,
2016-02-02 09:54:52 +01:00
"min" : 1 ,
2015-11-24 12:34:53 +01:00
"pattern" : "[a-zA-Z0-9_-]+"
} ,
"ThrottlingException" : {
"type" : "structure" ,
"members" : {
"message" : {
"shape" : "errorMessage" ,
"documentation" : "<p>The message for the exception.</p>"
}
} ,
2016-02-02 09:54:52 +01:00
"documentation" : "<p>The rate exceeds the limit.</p>" ,
2015-11-24 12:34:53 +01:00
"error" : { "httpStatusCode" : 429 } ,
2016-02-02 09:54:52 +01:00
"exception" : true
2015-11-24 12:34:53 +01:00
} ,
"Topic" : { "type" : "string" } ,
"UnauthorizedException" : {
"type" : "structure" ,
"members" : {
"message" : {
"shape" : "errorMessage" ,
"documentation" : "<p>The message for the exception.</p>"
}
} ,
2016-02-02 09:54:52 +01:00
"documentation" : "<p>You are not authorized to perform this operation.</p>" ,
2015-11-24 12:34:53 +01:00
"error" : { "httpStatusCode" : 401 } ,
2016-02-02 09:54:52 +01:00
"exception" : true
2015-11-24 12:34:53 +01:00
} ,
"UnsupportedDocumentEncodingException" : {
"type" : "structure" ,
"members" : {
"message" : {
"shape" : "errorMessage" ,
"documentation" : "<p>The message for the exception.</p>"
}
} ,
2016-02-02 09:54:52 +01:00
"documentation" : "<p>The document encoding is not supported.</p>" ,
2015-11-24 12:34:53 +01:00
"error" : { "httpStatusCode" : 415 } ,
2016-02-02 09:54:52 +01:00
"exception" : true
2015-11-24 12:34:53 +01:00
} ,
"UpdateThingShadowRequest" : {
"type" : "structure" ,
"required" : [
"thingName" ,
"payload"
] ,
"members" : {
"thingName" : {
"shape" : "ThingName" ,
2016-02-02 09:54:52 +01:00
"documentation" : "<p>The name of the thing.</p>" ,
2015-11-24 12:34:53 +01:00
"location" : "uri" ,
2016-02-02 09:54:52 +01:00
"locationName" : "thingName"
2015-11-24 12:34:53 +01:00
} ,
"payload" : {
"shape" : "JsonDocument" ,
"documentation" : "<p>The state information, in JSON format.</p>"
}
} ,
"documentation" : "<p>The input for the UpdateThingShadow operation.</p>" ,
"payload" : "payload"
} ,
"UpdateThingShadowResponse" : {
"type" : "structure" ,
"members" : {
"payload" : {
"shape" : "JsonDocument" ,
"documentation" : "<p>The state information, in JSON format.</p>"
}
} ,
"documentation" : "<p>The output from the UpdateThingShadow operation.</p>" ,
"payload" : "payload"
} ,
"errorMessage" : { "type" : "string" }
} ,
2016-02-02 09:54:52 +01:00
"documentation" : "<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>"
2015-11-24 12:34:53 +01:00
}