1{ 2 "version": "2.0", 3 "service": "<p>The AWS IoT 1-Click Project API Reference</p>", 4 "operations": { 5 "AssociateDeviceWithPlacement": "<p>Associates a physical device with a placement.</p>", 6 "CreatePlacement": "<p>Creates an empty placement.</p>", 7 "CreateProject": "<p>Creates an empty project with a placement template. A project contains zero or more placements that adhere to the placement template defined in the project.</p>", 8 "DeletePlacement": "<p>Deletes a placement. To delete a placement, it must not have any devices associated with it.</p> <note> <p>When you delete a placement, all associated data becomes irretrievable.</p> </note>", 9 "DeleteProject": "<p>Deletes a project. To delete a project, it must not have any placements associated with it.</p> <note> <p>When you delete a project, all associated data becomes irretrievable.</p> </note>", 10 "DescribePlacement": "<p>Describes a placement in a project.</p>", 11 "DescribeProject": "<p>Returns an object describing a project.</p>", 12 "DisassociateDeviceFromPlacement": "<p>Removes a physical device from a placement.</p>", 13 "GetDevicesInPlacement": "<p>Returns an object enumerating the devices in a placement.</p>", 14 "ListPlacements": "<p>Lists the placement(s) of a project.</p>", 15 "ListProjects": "<p>Lists the AWS IoT 1-Click project(s) associated with your AWS account and region.</p>", 16 "UpdatePlacement": "<p>Updates a placement with the given attributes. To clear an attribute, pass an empty value (i.e., \"\").</p>", 17 "UpdateProject": "<p>Updates a project associated with your AWS account and region. With the exception of device template names, you can pass just the values that need to be updated because the update request will change only the values that are provided. To clear a value, pass the empty string (i.e., <code>\"\"</code>).</p>" 18 }, 19 "shapes": { 20 "AssociateDeviceWithPlacementRequest": { 21 "base": null, 22 "refs": { 23 } 24 }, 25 "AssociateDeviceWithPlacementResponse": { 26 "base": null, 27 "refs": { 28 } 29 }, 30 "AttributeDefaultValue": { 31 "base": null, 32 "refs": { 33 "DefaultPlacementAttributeMap$value": null 34 } 35 }, 36 "AttributeName": { 37 "base": null, 38 "refs": { 39 "DefaultPlacementAttributeMap$key": null, 40 "PlacementAttributeMap$key": null 41 } 42 }, 43 "AttributeValue": { 44 "base": null, 45 "refs": { 46 "PlacementAttributeMap$value": null 47 } 48 }, 49 "Code": { 50 "base": null, 51 "refs": { 52 "InternalFailureException$code": null, 53 "InvalidRequestException$code": null, 54 "ResourceConflictException$code": null, 55 "ResourceNotFoundException$code": null, 56 "TooManyRequestsException$code": null 57 } 58 }, 59 "CreatePlacementRequest": { 60 "base": null, 61 "refs": { 62 } 63 }, 64 "CreatePlacementResponse": { 65 "base": null, 66 "refs": { 67 } 68 }, 69 "CreateProjectRequest": { 70 "base": null, 71 "refs": { 72 } 73 }, 74 "CreateProjectResponse": { 75 "base": null, 76 "refs": { 77 } 78 }, 79 "DefaultPlacementAttributeMap": { 80 "base": null, 81 "refs": { 82 "PlacementTemplate$defaultAttributes": "<p>The default attributes (key/value pairs) to be applied to all placements using this template.</p>" 83 } 84 }, 85 "DeletePlacementRequest": { 86 "base": null, 87 "refs": { 88 } 89 }, 90 "DeletePlacementResponse": { 91 "base": null, 92 "refs": { 93 } 94 }, 95 "DeleteProjectRequest": { 96 "base": null, 97 "refs": { 98 } 99 }, 100 "DeleteProjectResponse": { 101 "base": null, 102 "refs": { 103 } 104 }, 105 "DescribePlacementRequest": { 106 "base": null, 107 "refs": { 108 } 109 }, 110 "DescribePlacementResponse": { 111 "base": null, 112 "refs": { 113 } 114 }, 115 "DescribeProjectRequest": { 116 "base": null, 117 "refs": { 118 } 119 }, 120 "DescribeProjectResponse": { 121 "base": null, 122 "refs": { 123 } 124 }, 125 "Description": { 126 "base": null, 127 "refs": { 128 "CreateProjectRequest$description": "<p>An optional description for the project.</p>", 129 "ProjectDescription$description": "<p>The description of the project.</p>", 130 "UpdateProjectRequest$description": "<p>An optional user-defined description for the project.</p>" 131 } 132 }, 133 "DeviceCallbackKey": { 134 "base": null, 135 "refs": { 136 "DeviceCallbackOverrideMap$key": null 137 } 138 }, 139 "DeviceCallbackOverrideMap": { 140 "base": null, 141 "refs": { 142 "DeviceTemplate$callbackOverrides": "<p>An optional Lambda function to invoke instead of the default Lambda function provided by the placement template.</p>" 143 } 144 }, 145 "DeviceCallbackValue": { 146 "base": null, 147 "refs": { 148 "DeviceCallbackOverrideMap$value": null 149 } 150 }, 151 "DeviceId": { 152 "base": null, 153 "refs": { 154 "AssociateDeviceWithPlacementRequest$deviceId": "<p>The ID of the physical device to be associated with the given placement in the project. Note that a mandatory 4 character prefix is required for all <code>deviceId</code> values.</p>", 155 "DeviceMap$value": null 156 } 157 }, 158 "DeviceMap": { 159 "base": null, 160 "refs": { 161 "GetDevicesInPlacementResponse$devices": "<p>An object containing the devices (zero or more) within the placement.</p>" 162 } 163 }, 164 "DeviceTemplate": { 165 "base": "<p>An object representing a device for a placement template (see <a>PlacementTemplate</a>).</p>", 166 "refs": { 167 "DeviceTemplateMap$value": null 168 } 169 }, 170 "DeviceTemplateMap": { 171 "base": null, 172 "refs": { 173 "PlacementTemplate$deviceTemplates": "<p>An object specifying the <a>DeviceTemplate</a> for all placements using this (<a>PlacementTemplate</a>) template.</p>" 174 } 175 }, 176 "DeviceTemplateName": { 177 "base": null, 178 "refs": { 179 "AssociateDeviceWithPlacementRequest$deviceTemplateName": "<p>The device template name to associate with the device ID.</p>", 180 "DeviceMap$key": null, 181 "DeviceTemplateMap$key": null, 182 "DisassociateDeviceFromPlacementRequest$deviceTemplateName": "<p>The device ID that should be removed from the placement.</p>" 183 } 184 }, 185 "DeviceType": { 186 "base": null, 187 "refs": { 188 "DeviceTemplate$deviceType": "<p>The device type, which currently must be <code>\"button\"</code>.</p>" 189 } 190 }, 191 "DisassociateDeviceFromPlacementRequest": { 192 "base": null, 193 "refs": { 194 } 195 }, 196 "DisassociateDeviceFromPlacementResponse": { 197 "base": null, 198 "refs": { 199 } 200 }, 201 "GetDevicesInPlacementRequest": { 202 "base": null, 203 "refs": { 204 } 205 }, 206 "GetDevicesInPlacementResponse": { 207 "base": null, 208 "refs": { 209 } 210 }, 211 "InternalFailureException": { 212 "base": "<p/>", 213 "refs": { 214 } 215 }, 216 "InvalidRequestException": { 217 "base": "<p/>", 218 "refs": { 219 } 220 }, 221 "ListPlacementsRequest": { 222 "base": null, 223 "refs": { 224 } 225 }, 226 "ListPlacementsResponse": { 227 "base": null, 228 "refs": { 229 } 230 }, 231 "ListProjectsRequest": { 232 "base": null, 233 "refs": { 234 } 235 }, 236 "ListProjectsResponse": { 237 "base": null, 238 "refs": { 239 } 240 }, 241 "MaxResults": { 242 "base": null, 243 "refs": { 244 "ListPlacementsRequest$maxResults": "<p>The maximum number of results to return per request. If not set, a default value of 100 is used.</p>", 245 "ListProjectsRequest$maxResults": "<p>The maximum number of results to return per request. If not set, a default value of 100 is used.</p>" 246 } 247 }, 248 "Message": { 249 "base": null, 250 "refs": { 251 "InternalFailureException$message": null, 252 "InvalidRequestException$message": null, 253 "ResourceConflictException$message": null, 254 "ResourceNotFoundException$message": null, 255 "TooManyRequestsException$message": null 256 } 257 }, 258 "NextToken": { 259 "base": null, 260 "refs": { 261 "ListPlacementsRequest$nextToken": "<p>The token to retrieve the next set of results.</p>", 262 "ListPlacementsResponse$nextToken": "<p>The token used to retrieve the next set of results - will be effectively empty if there are no further results.</p>", 263 "ListProjectsRequest$nextToken": "<p>The token to retrieve the next set of results.</p>", 264 "ListProjectsResponse$nextToken": "<p>The token used to retrieve the next set of results - will be effectively empty if there are no further results.</p>" 265 } 266 }, 267 "PlacementAttributeMap": { 268 "base": null, 269 "refs": { 270 "CreatePlacementRequest$attributes": "<p>Optional user-defined key/value pairs providing contextual data (such as location or function) for the placement.</p>", 271 "PlacementDescription$attributes": "<p>The user-defined attributes associated with the placement.</p>", 272 "UpdatePlacementRequest$attributes": "<p>The user-defined object of attributes used to update the placement. The maximum number of key/value pairs is 50.</p>" 273 } 274 }, 275 "PlacementDescription": { 276 "base": "<p>An object describing a project's placement.</p>", 277 "refs": { 278 "DescribePlacementResponse$placement": "<p>An object describing the placement.</p>" 279 } 280 }, 281 "PlacementName": { 282 "base": null, 283 "refs": { 284 "AssociateDeviceWithPlacementRequest$placementName": "<p>The name of the placement in which to associate the device.</p>", 285 "CreatePlacementRequest$placementName": "<p>The name of the placement to be created.</p>", 286 "DeletePlacementRequest$placementName": "<p>The name of the empty placement to delete.</p>", 287 "DescribePlacementRequest$placementName": "<p>The name of the placement within a project.</p>", 288 "DisassociateDeviceFromPlacementRequest$placementName": "<p>The name of the placement that the device should be removed from.</p>", 289 "GetDevicesInPlacementRequest$placementName": "<p>The name of the placement to get the devices from.</p>", 290 "PlacementDescription$placementName": "<p>The name of the placement.</p>", 291 "PlacementSummary$placementName": "<p>The name of the placement being summarized.</p>", 292 "UpdatePlacementRequest$placementName": "<p>The name of the placement to update.</p>" 293 } 294 }, 295 "PlacementSummary": { 296 "base": "<p>An object providing summary information for a particular placement.</p>", 297 "refs": { 298 "PlacementSummaryList$member": null 299 } 300 }, 301 "PlacementSummaryList": { 302 "base": null, 303 "refs": { 304 "ListPlacementsResponse$placements": "<p>An object listing the requested placements.</p>" 305 } 306 }, 307 "PlacementTemplate": { 308 "base": "<p>An object defining the template for a placement.</p>", 309 "refs": { 310 "CreateProjectRequest$placementTemplate": "<p>The schema defining the placement to be created. A placement template defines placement default attributes and device templates. You cannot add or remove device templates after the project has been created. However, you can update <code>callbackOverrides</code> for the device templates using the <code>UpdateProject</code> API.</p>", 311 "ProjectDescription$placementTemplate": "<p>An object describing the project's placement specifications.</p>", 312 "UpdateProjectRequest$placementTemplate": "<p>An object defining the project update. Once a project has been created, you cannot add device template names to the project. However, for a given <code>placementTemplate</code>, you can update the associated <code>callbackOverrides</code> for the device definition using this API.</p>" 313 } 314 }, 315 "ProjectDescription": { 316 "base": "<p>An object providing detailed information for a particular project associated with an AWS account and region.</p>", 317 "refs": { 318 "DescribeProjectResponse$project": "<p>An object describing the project.</p>" 319 } 320 }, 321 "ProjectName": { 322 "base": null, 323 "refs": { 324 "AssociateDeviceWithPlacementRequest$projectName": "<p>The name of the project containing the placement in which to associate the device.</p>", 325 "CreatePlacementRequest$projectName": "<p>The name of the project in which to create the placement.</p>", 326 "CreateProjectRequest$projectName": "<p>The name of the project to create.</p>", 327 "DeletePlacementRequest$projectName": "<p>The project containing the empty placement to delete.</p>", 328 "DeleteProjectRequest$projectName": "<p>The name of the empty project to delete.</p>", 329 "DescribePlacementRequest$projectName": "<p>The project containing the placement to be described.</p>", 330 "DescribeProjectRequest$projectName": "<p>The name of the project to be described.</p>", 331 "DisassociateDeviceFromPlacementRequest$projectName": "<p>The name of the project that contains the placement.</p>", 332 "GetDevicesInPlacementRequest$projectName": "<p>The name of the project containing the placement.</p>", 333 "ListPlacementsRequest$projectName": "<p>The project containing the placements to be listed.</p>", 334 "PlacementDescription$projectName": "<p>The name of the project containing the placement.</p>", 335 "PlacementSummary$projectName": "<p>The name of the project containing the placement.</p>", 336 "ProjectDescription$projectName": "<p>The name of the project for which to obtain information from.</p>", 337 "ProjectSummary$projectName": "<p>The name of the project being summarized.</p>", 338 "UpdatePlacementRequest$projectName": "<p>The name of the project containing the placement to be updated.</p>", 339 "UpdateProjectRequest$projectName": "<p>The name of the project to be updated.</p>" 340 } 341 }, 342 "ProjectSummary": { 343 "base": "<p>An object providing summary information for a particular project for an associated AWS account and region.</p>", 344 "refs": { 345 "ProjectSummaryList$member": null 346 } 347 }, 348 "ProjectSummaryList": { 349 "base": null, 350 "refs": { 351 "ListProjectsResponse$projects": "<p>An object containing the list of projects.</p>" 352 } 353 }, 354 "ResourceConflictException": { 355 "base": "<p/>", 356 "refs": { 357 } 358 }, 359 "ResourceNotFoundException": { 360 "base": "<p/>", 361 "refs": { 362 } 363 }, 364 "Time": { 365 "base": null, 366 "refs": { 367 "PlacementDescription$createdDate": "<p>The date when the placement was initially created, in UNIX epoch time format.</p>", 368 "PlacementDescription$updatedDate": "<p>The date when the placement was last updated, in UNIX epoch time format. If the placement was not updated, then <code>createdDate</code> and <code>updatedDate</code> are the same.</p>", 369 "PlacementSummary$createdDate": "<p>The date when the placement was originally created, in UNIX epoch time format.</p>", 370 "PlacementSummary$updatedDate": "<p>The date when the placement was last updated, in UNIX epoch time format. If the placement was not updated, then <code>createdDate</code> and <code>updatedDate</code> are the same.</p>", 371 "ProjectDescription$createdDate": "<p>The date when the project was originally created, in UNIX epoch time format.</p>", 372 "ProjectDescription$updatedDate": "<p>The date when the project was last updated, in UNIX epoch time format. If the project was not updated, then <code>createdDate</code> and <code>updatedDate</code> are the same.</p>", 373 "ProjectSummary$createdDate": "<p>The date when the project was originally created, in UNIX epoch time format.</p>", 374 "ProjectSummary$updatedDate": "<p>The date when the project was last updated, in UNIX epoch time format. If the project was not updated, then <code>createdDate</code> and <code>updatedDate</code> are the same.</p>" 375 } 376 }, 377 "TooManyRequestsException": { 378 "base": "<p/>", 379 "refs": { 380 } 381 }, 382 "UpdatePlacementRequest": { 383 "base": null, 384 "refs": { 385 } 386 }, 387 "UpdatePlacementResponse": { 388 "base": null, 389 "refs": { 390 } 391 }, 392 "UpdateProjectRequest": { 393 "base": null, 394 "refs": { 395 } 396 }, 397 "UpdateProjectResponse": { 398 "base": null, 399 "refs": { 400 } 401 } 402 } 403} 404