github.com/aavshr/aws-sdk-go@v1.41.3/models/apis/iot1click-devices/2018-05-14/docs-2.json (about)

     1  {
     2    "version" : "2.0",
     3    "service" : "<p>Describes all of the AWS IoT 1-Click device-related API operations for the service.\n Also provides sample requests, responses, and errors for the supported web services\n protocols.</p>",
     4    "operations" : {
     5      "ClaimDevicesByClaimCode" : "<p>Adds device(s) to your account (i.e., claim one or more devices) if and only if you\n received a claim code with the device(s).</p>",
     6      "DescribeDevice" : "<p>Given a device ID, returns a DescribeDeviceResponse object describing the\n details of the device.</p>",
     7      "FinalizeDeviceClaim" : "<p>Given a device ID, finalizes the claim request for the associated device.</p><note>\n <p>Claiming a device consists of initiating a claim, then publishing a device event,\n and finalizing the claim. For a device of type button, a device event can\n be published by simply clicking the device.</p>\n </note>",
     8      "GetDeviceMethods" : "<p>Given a device ID, returns the invokable methods associated with the device.</p>",
     9      "InitiateDeviceClaim" : "<p>Given a device ID, initiates a claim request for the associated device.</p><note>\n <p>Claiming a device consists of initiating a claim, then publishing a device event,\n and finalizing the claim. For a device of type button, a device event can\n be published by simply clicking the device.</p>\n </note>",
    10      "InvokeDeviceMethod" : "<p>Given a device ID, issues a request to invoke a named device method (with possible\n parameters). See the \"Example POST\" code snippet below.</p>",
    11      "ListDeviceEvents" : "<p>Using a device ID, returns a DeviceEventsResponse object containing an\n array of events for the device.</p>",
    12      "ListDevices" : "<p>Lists the 1-Click compatible devices associated with your AWS account.</p>",
    13      "ListTagsForResource" : "<p>Lists the tags associated with the specified resource ARN.</p>",
    14      "TagResource" : "<p>Adds or updates the tags associated with the resource ARN. See <a href=\"https://docs.aws.amazon.com/iot-1-click/latest/developerguide/1click-appendix.html#1click-limits\">AWS IoT 1-Click Service Limits</a> for the maximum number of tags allowed per\n resource.</p>",
    15      "UnclaimDevice" : "<p>Disassociates a device from your AWS account using its device ID.</p>",
    16      "UntagResource" : "<p>Using tag keys, deletes the tags (key/value pairs) associated with the specified\n resource ARN.</p>",
    17      "UpdateDeviceState" : "<p>Using a Boolean value (true or false), this operation\n enables or disables the device given a device ID.</p>"
    18    },
    19    "shapes" : {
    20      "Attributes" : {
    21        "base" : null,
    22        "refs" : {
    23          "Device$Attributes" : "<p>The user specified attributes associated with the device for an event.</p>"
    24        }
    25      },
    26      "ClaimDevicesByClaimCodeResponse" : {
    27        "base" : null,
    28        "refs" : { }
    29      },
    30      "DescribeDeviceResponse" : {
    31        "base" : null,
    32        "refs" : { }
    33      },
    34      "Device" : {
    35        "base" : null,
    36        "refs" : {
    37          "DeviceEvent$Device" : "<p>An object representing the device associated with the event.</p>"
    38        }
    39      },
    40      "DeviceAttributes" : {
    41        "base" : "<p>\n DeviceAttributes is a string-to-string map specified by the user.</p>",
    42        "refs" : {
    43          "DeviceDescription$Attributes" : "<p>An array of zero or more elements of DeviceAttribute objects providing\n user specified device attributes.</p>"
    44        }
    45      },
    46      "DeviceClaimResponse" : {
    47        "base" : null,
    48        "refs" : { }
    49      },
    50      "DeviceDescription" : {
    51        "base" : null,
    52        "refs" : {
    53          "DescribeDeviceResponse$DeviceDescription" : "<p>Device details.</p>",
    54          "__listOfDeviceDescription$member" : null
    55        }
    56      },
    57      "DeviceEvent" : {
    58        "base" : null,
    59        "refs" : {
    60          "__listOfDeviceEvent$member" : null
    61        }
    62      },
    63      "DeviceEventsResponse" : {
    64        "base" : null,
    65        "refs" : { }
    66      },
    67      "DeviceMethod" : {
    68        "base" : null,
    69        "refs" : {
    70          "InvokeDeviceMethodRequest$DeviceMethod" : "<p>The device method to invoke.</p>",
    71          "__listOfDeviceMethod$member" : null
    72        }
    73      },
    74      "Empty" : {
    75        "base" : "<p>On success, an empty object is returned.</p>",
    76        "refs" : { }
    77      },
    78      "ForbiddenException" : {
    79        "base" : null,
    80        "refs" : { }
    81      },
    82      "GetDeviceMethodsResponse" : {
    83        "base" : null,
    84        "refs" : { }
    85      },
    86      "InternalFailureException" : {
    87        "base" : null,
    88        "refs" : { }
    89      },
    90      "InvalidRequestException" : {
    91        "base" : null,
    92        "refs" : { }
    93      },
    94      "InvokeDeviceMethodRequest" : {
    95        "base" : null,
    96        "refs" : { }
    97      },
    98      "InvokeDeviceMethodResponse" : {
    99        "base" : null,
   100        "refs" : { }
   101      },
   102      "ListDevicesResponse" : {
   103        "base" : null,
   104        "refs" : { }
   105      },
   106      "PreconditionFailedException" : {
   107        "base" : null,
   108        "refs" : { }
   109      },
   110      "RangeNotSatisfiableException" : {
   111        "base" : null,
   112        "refs" : { }
   113      },
   114      "ResourceConflictException" : {
   115        "base" : null,
   116        "refs" : { }
   117      },
   118      "ResourceNotFoundException" : {
   119        "base" : null,
   120        "refs" : { }
   121      },
   122      "UpdateDeviceStateRequest" : {
   123        "base" : null,
   124        "refs" : { }
   125      },
   126      "__boolean" : {
   127        "base" : null,
   128        "refs" : {
   129          "DeviceDescription$Enabled" : "<p>A Boolean value indicating whether or not the device is enabled.</p>",
   130          "UpdateDeviceStateRequest$Enabled" : "<p>If true, the device is enabled. If false, the device is\n disabled.</p>"
   131        }
   132      },
   133      "__doubleMin0Max100" : {
   134        "base" : null,
   135        "refs" : {
   136          "DeviceDescription$RemainingLife" : "<p>A value between 0 and 1 inclusive, representing the fraction of life remaining for the\n device.</p>"
   137        }
   138      },
   139      "__integer" : {
   140        "base" : null,
   141        "refs" : {
   142          "ClaimDevicesByClaimCodeResponse$Total" : "<p>The total number of devices associated with the claim code that has been processed in\n the claim request.</p>"
   143        }
   144      },
   145      "__listOfDeviceDescription" : {
   146        "base" : null,
   147        "refs" : {
   148          "ListDevicesResponse$Devices" : "<p>A list of devices.</p>"
   149        }
   150      },
   151      "__listOfDeviceEvent" : {
   152        "base" : null,
   153        "refs" : {
   154          "DeviceEventsResponse$Events" : "<p>An array of zero or more elements describing the event(s) associated with the\n device.</p>"
   155        }
   156      },
   157      "__listOfDeviceMethod" : {
   158        "base" : null,
   159        "refs" : {
   160          "GetDeviceMethodsResponse$DeviceMethods" : "<p>List of available device APIs.</p>"
   161        }
   162      },
   163      "__string" : {
   164        "base" : null,
   165        "refs" : {
   166          "Device$DeviceId" : "<p>The unique identifier of the device.</p>",
   167          "Device$Type" : "<p>The device type, such as \"button\".</p>",
   168          "DeviceAttributes$member" : null,
   169          "DeviceClaimResponse$State" : "<p>The device's final claim state.</p>",
   170          "DeviceDescription$Arn" : "<p>The ARN of the device.</p>",
   171          "DeviceDescription$DeviceId" : "<p>The unique identifier of the device.</p>",
   172          "DeviceDescription$Type" : "<p>The type of the device, such as \"button\".</p>",
   173          "DeviceEvent$StdEvent" : "<p>A serialized JSON object representing the device-type specific event.</p>",
   174          "DeviceEventsResponse$NextToken" : "<p>The token to retrieve the next set of results.</p>",
   175          "DeviceMethod$DeviceType" : "<p>The type of the device, such as \"button\".</p>",
   176          "DeviceMethod$MethodName" : "<p>The name of the method applicable to the deviceType.</p>",
   177          "ForbiddenException$Code" : "<p>403</p>",
   178          "ForbiddenException$Message" : "<p>The 403 error message returned by the web server.</p>",
   179          "InternalFailureException$Code" : "<p>500</p>",
   180          "InternalFailureException$Message" : "<p>The 500 error message returned by the web server.</p>",
   181          "InvalidRequestException$Code" : "<p>400</p>",
   182          "InvalidRequestException$Message" : "<p>The 400 error message returned by the web server.</p>",
   183          "InvokeDeviceMethodRequest$DeviceMethodParameters" : "<p>A JSON encoded string containing the device method request parameters.</p>",
   184          "InvokeDeviceMethodResponse$DeviceMethodResponse" : "<p>A JSON encoded string containing the device method response.</p>",
   185          "ListDevicesResponse$NextToken" : "<p>The token to retrieve the next set of results.</p>",
   186          "PreconditionFailedException$Code" : "<p>412</p>",
   187          "PreconditionFailedException$Message" : "<p>An error message explaining the error or its remedy.</p>",
   188          "RangeNotSatisfiableException$Code" : "<p>416</p>",
   189          "RangeNotSatisfiableException$Message" : "<p>The requested number of results specified by nextToken cannot be\n satisfied.</p>",
   190          "ResourceConflictException$Code" : "<p>409</p>",
   191          "ResourceConflictException$Message" : "<p>An error message explaining the error or its remedy.</p>",
   192          "ResourceNotFoundException$Code" : "<p>404</p>",
   193          "ResourceNotFoundException$Message" : "<p>The requested device could not be found.</p>"
   194        }
   195      },
   196      "__stringMin12Max40" : {
   197        "base" : null,
   198        "refs" : {
   199          "ClaimDevicesByClaimCodeResponse$ClaimCode" : "<p>The claim code provided by the device manufacturer.</p>"
   200        }
   201      }
   202    }
   203  }