github.com/aavshr/aws-sdk-go@v1.41.3/models/apis/iot-data/2015-05-28/api-2.json (about)

     1  {
     2    "version":"2.0",
     3    "metadata":{
     4      "apiVersion":"2015-05-28",
     5      "endpointPrefix":"data.iot",
     6      "protocol":"rest-json",
     7      "serviceFullName":"AWS IoT Data Plane",
     8      "serviceId":"IoT Data Plane",
     9      "signatureVersion":"v4",
    10      "signingName":"iotdata",
    11      "uid":"iot-data-2015-05-28"
    12    },
    13    "operations":{
    14      "DeleteThingShadow":{
    15        "name":"DeleteThingShadow",
    16        "http":{
    17          "method":"DELETE",
    18          "requestUri":"/things/{thingName}/shadow"
    19        },
    20        "input":{"shape":"DeleteThingShadowRequest"},
    21        "output":{"shape":"DeleteThingShadowResponse"},
    22        "errors":[
    23          {"shape":"ResourceNotFoundException"},
    24          {"shape":"InvalidRequestException"},
    25          {"shape":"ThrottlingException"},
    26          {"shape":"UnauthorizedException"},
    27          {"shape":"ServiceUnavailableException"},
    28          {"shape":"InternalFailureException"},
    29          {"shape":"MethodNotAllowedException"},
    30          {"shape":"UnsupportedDocumentEncodingException"}
    31        ]
    32      },
    33      "GetRetainedMessage":{
    34        "name":"GetRetainedMessage",
    35        "http":{
    36          "method":"GET",
    37          "requestUri":"/retainedMessage/{topic}"
    38        },
    39        "input":{"shape":"GetRetainedMessageRequest"},
    40        "output":{"shape":"GetRetainedMessageResponse"},
    41        "errors":[
    42          {"shape":"InvalidRequestException"},
    43          {"shape":"ResourceNotFoundException"},
    44          {"shape":"ThrottlingException"},
    45          {"shape":"UnauthorizedException"},
    46          {"shape":"ServiceUnavailableException"},
    47          {"shape":"InternalFailureException"},
    48          {"shape":"MethodNotAllowedException"}
    49        ]
    50      },
    51      "GetThingShadow":{
    52        "name":"GetThingShadow",
    53        "http":{
    54          "method":"GET",
    55          "requestUri":"/things/{thingName}/shadow"
    56        },
    57        "input":{"shape":"GetThingShadowRequest"},
    58        "output":{"shape":"GetThingShadowResponse"},
    59        "errors":[
    60          {"shape":"InvalidRequestException"},
    61          {"shape":"ResourceNotFoundException"},
    62          {"shape":"ThrottlingException"},
    63          {"shape":"UnauthorizedException"},
    64          {"shape":"ServiceUnavailableException"},
    65          {"shape":"InternalFailureException"},
    66          {"shape":"MethodNotAllowedException"},
    67          {"shape":"UnsupportedDocumentEncodingException"}
    68        ]
    69      },
    70      "ListNamedShadowsForThing":{
    71        "name":"ListNamedShadowsForThing",
    72        "http":{
    73          "method":"GET",
    74          "requestUri":"/api/things/shadow/ListNamedShadowsForThing/{thingName}"
    75        },
    76        "input":{"shape":"ListNamedShadowsForThingRequest"},
    77        "output":{"shape":"ListNamedShadowsForThingResponse"},
    78        "errors":[
    79          {"shape":"ResourceNotFoundException"},
    80          {"shape":"InvalidRequestException"},
    81          {"shape":"ThrottlingException"},
    82          {"shape":"UnauthorizedException"},
    83          {"shape":"ServiceUnavailableException"},
    84          {"shape":"InternalFailureException"},
    85          {"shape":"MethodNotAllowedException"}
    86        ]
    87      },
    88      "ListRetainedMessages":{
    89        "name":"ListRetainedMessages",
    90        "http":{
    91          "method":"GET",
    92          "requestUri":"/retainedMessage"
    93        },
    94        "input":{"shape":"ListRetainedMessagesRequest"},
    95        "output":{"shape":"ListRetainedMessagesResponse"},
    96        "errors":[
    97          {"shape":"InvalidRequestException"},
    98          {"shape":"ThrottlingException"},
    99          {"shape":"UnauthorizedException"},
   100          {"shape":"ServiceUnavailableException"},
   101          {"shape":"InternalFailureException"},
   102          {"shape":"MethodNotAllowedException"}
   103        ]
   104      },
   105      "Publish":{
   106        "name":"Publish",
   107        "http":{
   108          "method":"POST",
   109          "requestUri":"/topics/{topic}"
   110        },
   111        "input":{"shape":"PublishRequest"},
   112        "errors":[
   113          {"shape":"InternalFailureException"},
   114          {"shape":"InvalidRequestException"},
   115          {"shape":"UnauthorizedException"},
   116          {"shape":"MethodNotAllowedException"}
   117        ]
   118      },
   119      "UpdateThingShadow":{
   120        "name":"UpdateThingShadow",
   121        "http":{
   122          "method":"POST",
   123          "requestUri":"/things/{thingName}/shadow"
   124        },
   125        "input":{"shape":"UpdateThingShadowRequest"},
   126        "output":{"shape":"UpdateThingShadowResponse"},
   127        "errors":[
   128          {"shape":"ConflictException"},
   129          {"shape":"RequestEntityTooLargeException"},
   130          {"shape":"InvalidRequestException"},
   131          {"shape":"ThrottlingException"},
   132          {"shape":"UnauthorizedException"},
   133          {"shape":"ServiceUnavailableException"},
   134          {"shape":"InternalFailureException"},
   135          {"shape":"MethodNotAllowedException"},
   136          {"shape":"UnsupportedDocumentEncodingException"}
   137        ]
   138      }
   139    },
   140    "shapes":{
   141      "ConflictException":{
   142        "type":"structure",
   143        "members":{
   144          "message":{"shape":"errorMessage"}
   145        },
   146        "error":{"httpStatusCode":409},
   147        "exception":true
   148      },
   149      "DeleteThingShadowRequest":{
   150        "type":"structure",
   151        "required":["thingName"],
   152        "members":{
   153          "thingName":{
   154            "shape":"ThingName",
   155            "location":"uri",
   156            "locationName":"thingName"
   157          },
   158          "shadowName":{
   159            "shape":"ShadowName",
   160            "location":"querystring",
   161            "locationName":"name"
   162          }
   163        }
   164      },
   165      "DeleteThingShadowResponse":{
   166        "type":"structure",
   167        "required":["payload"],
   168        "members":{
   169          "payload":{"shape":"JsonDocument"}
   170        },
   171        "payload":"payload"
   172      },
   173      "GetRetainedMessageRequest":{
   174        "type":"structure",
   175        "required":["topic"],
   176        "members":{
   177          "topic":{
   178            "shape":"Topic",
   179            "location":"uri",
   180            "locationName":"topic"
   181          }
   182        }
   183      },
   184      "GetRetainedMessageResponse":{
   185        "type":"structure",
   186        "members":{
   187          "topic":{"shape":"Topic"},
   188          "payload":{"shape":"Payload"},
   189          "qos":{"shape":"Qos"},
   190          "lastModifiedTime":{"shape":"Timestamp"}
   191        }
   192      },
   193      "GetThingShadowRequest":{
   194        "type":"structure",
   195        "required":["thingName"],
   196        "members":{
   197          "thingName":{
   198            "shape":"ThingName",
   199            "location":"uri",
   200            "locationName":"thingName"
   201          },
   202          "shadowName":{
   203            "shape":"ShadowName",
   204            "location":"querystring",
   205            "locationName":"name"
   206          }
   207        }
   208      },
   209      "GetThingShadowResponse":{
   210        "type":"structure",
   211        "members":{
   212          "payload":{"shape":"JsonDocument"}
   213        },
   214        "payload":"payload"
   215      },
   216      "InternalFailureException":{
   217        "type":"structure",
   218        "members":{
   219          "message":{"shape":"errorMessage"}
   220        },
   221        "error":{"httpStatusCode":500},
   222        "exception":true,
   223        "fault":true
   224      },
   225      "InvalidRequestException":{
   226        "type":"structure",
   227        "members":{
   228          "message":{"shape":"errorMessage"}
   229        },
   230        "error":{"httpStatusCode":400},
   231        "exception":true
   232      },
   233      "JsonDocument":{"type":"blob"},
   234      "ListNamedShadowsForThingRequest":{
   235        "type":"structure",
   236        "required":["thingName"],
   237        "members":{
   238          "thingName":{
   239            "shape":"ThingName",
   240            "location":"uri",
   241            "locationName":"thingName"
   242          },
   243          "nextToken":{
   244            "shape":"NextToken",
   245            "location":"querystring",
   246            "locationName":"nextToken"
   247          },
   248          "pageSize":{
   249            "shape":"PageSize",
   250            "location":"querystring",
   251            "locationName":"pageSize"
   252          }
   253        }
   254      },
   255      "ListNamedShadowsForThingResponse":{
   256        "type":"structure",
   257        "members":{
   258          "results":{"shape":"NamedShadowList"},
   259          "nextToken":{"shape":"NextToken"},
   260          "timestamp":{"shape":"Timestamp"}
   261        }
   262      },
   263      "ListRetainedMessagesRequest":{
   264        "type":"structure",
   265        "members":{
   266          "nextToken":{
   267            "shape":"NextToken",
   268            "location":"querystring",
   269            "locationName":"nextToken"
   270          },
   271          "maxResults":{
   272            "shape":"MaxResults",
   273            "location":"querystring",
   274            "locationName":"maxResults"
   275          }
   276        }
   277      },
   278      "ListRetainedMessagesResponse":{
   279        "type":"structure",
   280        "members":{
   281          "retainedTopics":{"shape":"RetainedMessageList"},
   282          "nextToken":{"shape":"NextToken"}
   283        }
   284      },
   285      "MaxResults":{
   286        "type":"integer",
   287        "max":200,
   288        "min":1
   289      },
   290      "MethodNotAllowedException":{
   291        "type":"structure",
   292        "members":{
   293          "message":{"shape":"errorMessage"}
   294        },
   295        "error":{"httpStatusCode":405},
   296        "exception":true
   297      },
   298      "NamedShadowList":{
   299        "type":"list",
   300        "member":{"shape":"ShadowName"}
   301      },
   302      "NextToken":{"type":"string"},
   303      "PageSize":{
   304        "type":"integer",
   305        "max":100,
   306        "min":1
   307      },
   308      "Payload":{"type":"blob"},
   309      "PayloadSize":{"type":"long"},
   310      "PublishRequest":{
   311        "type":"structure",
   312        "required":["topic"],
   313        "members":{
   314          "topic":{
   315            "shape":"Topic",
   316            "location":"uri",
   317            "locationName":"topic"
   318          },
   319          "qos":{
   320            "shape":"Qos",
   321            "location":"querystring",
   322            "locationName":"qos"
   323          },
   324          "retain":{
   325            "shape":"Retain",
   326            "location":"querystring",
   327            "locationName":"retain"
   328          },
   329          "payload":{"shape":"Payload"}
   330        },
   331        "payload":"payload"
   332      },
   333      "Qos":{
   334        "type":"integer",
   335        "max":1,
   336        "min":0
   337      },
   338      "RequestEntityTooLargeException":{
   339        "type":"structure",
   340        "members":{
   341          "message":{"shape":"errorMessage"}
   342        },
   343        "error":{"httpStatusCode":413},
   344        "exception":true
   345      },
   346      "ResourceNotFoundException":{
   347        "type":"structure",
   348        "members":{
   349          "message":{"shape":"errorMessage"}
   350        },
   351        "error":{"httpStatusCode":404},
   352        "exception":true
   353      },
   354      "Retain":{"type":"boolean"},
   355      "RetainedMessageList":{
   356        "type":"list",
   357        "member":{"shape":"RetainedMessageSummary"}
   358      },
   359      "RetainedMessageSummary":{
   360        "type":"structure",
   361        "members":{
   362          "topic":{"shape":"Topic"},
   363          "payloadSize":{"shape":"PayloadSize"},
   364          "qos":{"shape":"Qos"},
   365          "lastModifiedTime":{"shape":"Timestamp"}
   366        }
   367      },
   368      "ServiceUnavailableException":{
   369        "type":"structure",
   370        "members":{
   371          "message":{"shape":"errorMessage"}
   372        },
   373        "error":{"httpStatusCode":503},
   374        "exception":true,
   375        "fault":true
   376      },
   377      "ShadowName":{
   378        "type":"string",
   379        "max":64,
   380        "min":1,
   381        "pattern":"[a-zA-Z0-9:_-]+"
   382      },
   383      "ThingName":{
   384        "type":"string",
   385        "max":128,
   386        "min":1,
   387        "pattern":"[a-zA-Z0-9:_-]+"
   388      },
   389      "ThrottlingException":{
   390        "type":"structure",
   391        "members":{
   392          "message":{"shape":"errorMessage"}
   393        },
   394        "error":{"httpStatusCode":429},
   395        "exception":true
   396      },
   397      "Timestamp":{"type":"long"},
   398      "Topic":{"type":"string"},
   399      "UnauthorizedException":{
   400        "type":"structure",
   401        "members":{
   402          "message":{"shape":"errorMessage"}
   403        },
   404        "error":{"httpStatusCode":401},
   405        "exception":true
   406      },
   407      "UnsupportedDocumentEncodingException":{
   408        "type":"structure",
   409        "members":{
   410          "message":{"shape":"errorMessage"}
   411        },
   412        "error":{"httpStatusCode":415},
   413        "exception":true
   414      },
   415      "UpdateThingShadowRequest":{
   416        "type":"structure",
   417        "required":[
   418          "thingName",
   419          "payload"
   420        ],
   421        "members":{
   422          "thingName":{
   423            "shape":"ThingName",
   424            "location":"uri",
   425            "locationName":"thingName"
   426          },
   427          "shadowName":{
   428            "shape":"ShadowName",
   429            "location":"querystring",
   430            "locationName":"name"
   431          },
   432          "payload":{"shape":"JsonDocument"}
   433        },
   434        "payload":"payload"
   435      },
   436      "UpdateThingShadowResponse":{
   437        "type":"structure",
   438        "members":{
   439          "payload":{"shape":"JsonDocument"}
   440        },
   441        "payload":"payload"
   442      },
   443      "errorMessage":{"type":"string"}
   444    }
   445  }