github.com/aavshr/aws-sdk-go@v1.41.3/models/apis/braket/2019-09-01/docs-2.json (about) 1 { 2 "version": "2.0", 3 "service": "<p>The Amazon Braket API Reference provides information about the operations and structures supported in Amazon Braket.</p>", 4 "operations": { 5 "CancelQuantumTask": "<p>Cancels the specified task.</p>", 6 "CreateQuantumTask": "<p>Creates a quantum task.</p>", 7 "GetDevice": "<p>Retrieves the devices available in Amazon Braket.</p>", 8 "GetQuantumTask": "<p>Retrieves the specified quantum task.</p>", 9 "ListTagsForResource": "<p>Shows the tags associated with this resource.</p>", 10 "SearchDevices": "<p>Searches for devices using the specified filters.</p>", 11 "SearchQuantumTasks": "<p>Searches for tasks that match the specified filter values.</p>", 12 "TagResource": "<p>Add a tag to the specified resource.</p>", 13 "UntagResource": "<p>Remove tags from a resource.</p>" 14 }, 15 "shapes": { 16 "AccessDeniedException": { 17 "base": "<p>You do not have sufficient access to perform this action.</p>", 18 "refs": { 19 } 20 }, 21 "CancelQuantumTaskRequest": { 22 "base": null, 23 "refs": { 24 } 25 }, 26 "CancelQuantumTaskResponse": { 27 "base": null, 28 "refs": { 29 } 30 }, 31 "CancellationStatus": { 32 "base": null, 33 "refs": { 34 "CancelQuantumTaskResponse$cancellationStatus": "<p>The status of the cancellation request.</p>" 35 } 36 }, 37 "ConflictException": { 38 "base": "<p>An error occurred due to a conflict.</p>", 39 "refs": { 40 } 41 }, 42 "CreateQuantumTaskRequest": { 43 "base": null, 44 "refs": { 45 } 46 }, 47 "CreateQuantumTaskRequestDeviceParametersString": { 48 "base": null, 49 "refs": { 50 "CreateQuantumTaskRequest$deviceParameters": "<p>The parameters for the device to run the task on.</p>" 51 } 52 }, 53 "CreateQuantumTaskRequestOutputS3BucketString": { 54 "base": null, 55 "refs": { 56 "CreateQuantumTaskRequest$outputS3Bucket": "<p>The S3 bucket to store task result files in.</p>" 57 } 58 }, 59 "CreateQuantumTaskRequestOutputS3KeyPrefixString": { 60 "base": null, 61 "refs": { 62 "CreateQuantumTaskRequest$outputS3KeyPrefix": "<p>The key prefix for the location in the S3 bucket to store task results in.</p>" 63 } 64 }, 65 "CreateQuantumTaskRequestShotsLong": { 66 "base": null, 67 "refs": { 68 "CreateQuantumTaskRequest$shots": "<p>The number of shots to use for the task.</p>" 69 } 70 }, 71 "CreateQuantumTaskResponse": { 72 "base": null, 73 "refs": { 74 } 75 }, 76 "DeviceArn": { 77 "base": null, 78 "refs": { 79 "CreateQuantumTaskRequest$deviceArn": "<p>The ARN of the device to run the task on.</p>", 80 "DeviceSummary$deviceArn": "<p>The ARN of the device.</p>", 81 "GetDeviceRequest$deviceArn": "<p>The ARN of the device to retrieve.</p>", 82 "GetDeviceResponse$deviceArn": "<p>The ARN of the device.</p>", 83 "GetQuantumTaskResponse$deviceArn": "<p>The ARN of the device the task was run on.</p>", 84 "QuantumTaskSummary$deviceArn": "<p>The ARN of the device the task ran on.</p>" 85 } 86 }, 87 "DeviceOfflineException": { 88 "base": "<p>The specified device is currently offline.</p>", 89 "refs": { 90 } 91 }, 92 "DeviceRetiredException": { 93 "base": "<p>The specified device has been retired.</p>", 94 "refs": { 95 } 96 }, 97 "DeviceStatus": { 98 "base": null, 99 "refs": { 100 "DeviceSummary$deviceStatus": "<p>The status of the device.</p>", 101 "GetDeviceResponse$deviceStatus": "<p>The status of the device.</p>" 102 } 103 }, 104 "DeviceSummary": { 105 "base": "<p>Includes information about the device.</p>", 106 "refs": { 107 "DeviceSummaryList$member": null 108 } 109 }, 110 "DeviceSummaryList": { 111 "base": null, 112 "refs": { 113 "SearchDevicesResponse$devices": "<p>An array of <code>DeviceSummary</code> objects for devices that match the specified filter values.</p>" 114 } 115 }, 116 "DeviceType": { 117 "base": null, 118 "refs": { 119 "DeviceSummary$deviceType": "<p>The type of the device.</p>", 120 "GetDeviceResponse$deviceType": "<p>The type of the device.</p>" 121 } 122 }, 123 "GetDeviceRequest": { 124 "base": null, 125 "refs": { 126 } 127 }, 128 "GetDeviceResponse": { 129 "base": null, 130 "refs": { 131 } 132 }, 133 "GetQuantumTaskRequest": { 134 "base": null, 135 "refs": { 136 } 137 }, 138 "GetQuantumTaskResponse": { 139 "base": null, 140 "refs": { 141 } 142 }, 143 "InternalServiceException": { 144 "base": "<p>The request processing has failed because of an unknown error, exception, or failure.</p>", 145 "refs": { 146 } 147 }, 148 "JsonValue": { 149 "base": null, 150 "refs": { 151 "CreateQuantumTaskRequest$action": "<p>The action associated with the task.</p>", 152 "GetDeviceResponse$deviceCapabilities": "<p>Details about the capabilities of the device.</p>", 153 "GetQuantumTaskResponse$deviceParameters": "<p>The parameters for the device on which the task ran.</p>" 154 } 155 }, 156 "ListTagsForResourceRequest": { 157 "base": null, 158 "refs": { 159 } 160 }, 161 "ListTagsForResourceResponse": { 162 "base": null, 163 "refs": { 164 } 165 }, 166 "Long": { 167 "base": null, 168 "refs": { 169 "GetQuantumTaskResponse$shots": "<p>The number of shots used in the task.</p>", 170 "QuantumTaskSummary$shots": "<p>The shots used for the task.</p>" 171 } 172 }, 173 "QuantumTaskArn": { 174 "base": null, 175 "refs": { 176 "CancelQuantumTaskRequest$quantumTaskArn": "<p>The ARN of the task to cancel.</p>", 177 "CancelQuantumTaskResponse$quantumTaskArn": "<p>The ARN of the task.</p>", 178 "CreateQuantumTaskResponse$quantumTaskArn": "<p>The ARN of the task created by the request.</p>", 179 "GetQuantumTaskRequest$quantumTaskArn": "<p>the ARN of the task to retrieve.</p>", 180 "GetQuantumTaskResponse$quantumTaskArn": "<p>The ARN of the task.</p>", 181 "QuantumTaskSummary$quantumTaskArn": "<p>The ARN of the task.</p>" 182 } 183 }, 184 "QuantumTaskStatus": { 185 "base": null, 186 "refs": { 187 "GetQuantumTaskResponse$status": "<p>The status of the task.</p>", 188 "QuantumTaskSummary$status": "<p>The status of the task.</p>" 189 } 190 }, 191 "QuantumTaskSummary": { 192 "base": "<p>Includes information about a quantum task.</p>", 193 "refs": { 194 "QuantumTaskSummaryList$member": null 195 } 196 }, 197 "QuantumTaskSummaryList": { 198 "base": null, 199 "refs": { 200 "SearchQuantumTasksResponse$quantumTasks": "<p>An array of <code>QuantumTaskSummary</code> objects for tasks that match the specified filters.</p>" 201 } 202 }, 203 "ResourceNotFoundException": { 204 "base": "<p>The specified resource was not found.</p>", 205 "refs": { 206 } 207 }, 208 "SearchDevicesFilter": { 209 "base": "<p>The filter to use for searching devices.</p>", 210 "refs": { 211 "SearchDevicesRequestFiltersList$member": null 212 } 213 }, 214 "SearchDevicesFilterNameString": { 215 "base": null, 216 "refs": { 217 "SearchDevicesFilter$name": "<p>The name to use to filter results.</p>" 218 } 219 }, 220 "SearchDevicesFilterValuesList": { 221 "base": null, 222 "refs": { 223 "SearchDevicesFilter$values": "<p>The values to use to filter results.</p>" 224 } 225 }, 226 "SearchDevicesRequest": { 227 "base": null, 228 "refs": { 229 } 230 }, 231 "SearchDevicesRequestFiltersList": { 232 "base": null, 233 "refs": { 234 "SearchDevicesRequest$filters": "<p>The filter values to use to search for a device.</p>" 235 } 236 }, 237 "SearchDevicesRequestMaxResultsInteger": { 238 "base": null, 239 "refs": { 240 "SearchDevicesRequest$maxResults": "<p>The maximum number of results to return in the response.</p>" 241 } 242 }, 243 "SearchDevicesResponse": { 244 "base": null, 245 "refs": { 246 } 247 }, 248 "SearchQuantumTasksFilter": { 249 "base": "<p>A filter to use to search for tasks.</p>", 250 "refs": { 251 "SearchQuantumTasksRequestFiltersList$member": null 252 } 253 }, 254 "SearchQuantumTasksFilterOperator": { 255 "base": null, 256 "refs": { 257 "SearchQuantumTasksFilter$operator": "<p>An operator to use in the filter.</p>" 258 } 259 }, 260 "SearchQuantumTasksFilterValuesList": { 261 "base": null, 262 "refs": { 263 "SearchQuantumTasksFilter$values": "<p>The values to use for the filter.</p>" 264 } 265 }, 266 "SearchQuantumTasksRequest": { 267 "base": null, 268 "refs": { 269 } 270 }, 271 "SearchQuantumTasksRequestFiltersList": { 272 "base": null, 273 "refs": { 274 "SearchQuantumTasksRequest$filters": "<p>Array of <code>SearchQuantumTasksFilter</code> objects.</p>" 275 } 276 }, 277 "SearchQuantumTasksRequestMaxResultsInteger": { 278 "base": null, 279 "refs": { 280 "SearchQuantumTasksRequest$maxResults": "<p>Maximum number of results to return in the response.</p>" 281 } 282 }, 283 "SearchQuantumTasksResponse": { 284 "base": null, 285 "refs": { 286 } 287 }, 288 "ServiceQuotaExceededException": { 289 "base": "<p>The request failed because a service quota is exceeded.</p>", 290 "refs": { 291 } 292 }, 293 "String": { 294 "base": null, 295 "refs": { 296 "AccessDeniedException$message": null, 297 "ConflictException$message": null, 298 "DeviceOfflineException$message": null, 299 "DeviceRetiredException$message": null, 300 "DeviceSummary$deviceName": "<p>The name of the device.</p>", 301 "DeviceSummary$providerName": "<p>The provider of the device.</p>", 302 "GetDeviceResponse$deviceName": "<p>The name of the device.</p>", 303 "GetDeviceResponse$providerName": "<p>The name of the partner company for the device.</p>", 304 "GetQuantumTaskResponse$failureReason": "<p>The reason that a task failed.</p>", 305 "GetQuantumTaskResponse$outputS3Bucket": "<p>The S3 bucket where task results are stored.</p>", 306 "GetQuantumTaskResponse$outputS3Directory": "<p>The folder in the S3 bucket where task results are stored.</p>", 307 "InternalServiceException$message": null, 308 "ListTagsForResourceRequest$resourceArn": "<p>Specify the <code>resourceArn</code> for the resource whose tags to display.</p>", 309 "QuantumTaskSummary$outputS3Bucket": "<p>The S3 bucket where the task result file is stored..</p>", 310 "QuantumTaskSummary$outputS3Directory": "<p>The folder in the S3 bucket where the task result file is stored.</p>", 311 "ResourceNotFoundException$message": null, 312 "SearchDevicesRequest$nextToken": "<p>A token used for pagination of results returned in the response. Use the token returned from the previous request continue results where the previous request ended.</p>", 313 "SearchDevicesResponse$nextToken": "<p>A token used for pagination of results, or null if there are no additional results. Use the token value in a subsequent request to continue results where the previous request ended.</p>", 314 "SearchQuantumTasksRequest$nextToken": "<p>A token used for pagination of results returned in the response. Use the token returned from the previous request continue results where the previous request ended.</p>", 315 "SearchQuantumTasksResponse$nextToken": "<p>A token used for pagination of results, or null if there are no additional results. Use the token value in a subsequent request to continue results where the previous request ended.</p>", 316 "ServiceQuotaExceededException$message": null, 317 "TagKeys$member": null, 318 "TagResourceRequest$resourceArn": "<p>Specify the <code>resourceArn</code> of the resource to which a tag will be added.</p>", 319 "TagsMap$key": null, 320 "TagsMap$value": null, 321 "ThrottlingException$message": null, 322 "UntagResourceRequest$resourceArn": "<p>Specify the <code>resourceArn</code> for the resource from which to remove the tags.</p>", 323 "ValidationException$message": null 324 } 325 }, 326 "String256": { 327 "base": null, 328 "refs": { 329 "SearchDevicesFilterValuesList$member": null, 330 "SearchQuantumTasksFilterValuesList$member": null 331 } 332 }, 333 "String64": { 334 "base": null, 335 "refs": { 336 "CancelQuantumTaskRequest$clientToken": "<p>The client token associated with the request.</p>", 337 "CreateQuantumTaskRequest$clientToken": "<p>The client token associated with the request.</p>", 338 "SearchQuantumTasksFilter$name": "<p>The name of the device used for the task.</p>" 339 } 340 }, 341 "SyntheticTimestamp_date_time": { 342 "base": null, 343 "refs": { 344 "GetQuantumTaskResponse$createdAt": "<p>The time at which the task was created.</p>", 345 "GetQuantumTaskResponse$endedAt": "<p>The time at which the task ended.</p>", 346 "QuantumTaskSummary$createdAt": "<p>The time at which the task was created.</p>", 347 "QuantumTaskSummary$endedAt": "<p>The time at which the task finished.</p>" 348 } 349 }, 350 "TagKeys": { 351 "base": null, 352 "refs": { 353 "UntagResourceRequest$tagKeys": "<p>Specify the keys for the tags to remove from the resource.</p>" 354 } 355 }, 356 "TagResourceRequest": { 357 "base": null, 358 "refs": { 359 } 360 }, 361 "TagResourceResponse": { 362 "base": null, 363 "refs": { 364 } 365 }, 366 "TagsMap": { 367 "base": null, 368 "refs": { 369 "CreateQuantumTaskRequest$tags": "<p>Tags to be added to the quantum task you're creating.</p>", 370 "GetQuantumTaskResponse$tags": "<p>The tags that belong to this task.</p>", 371 "ListTagsForResourceResponse$tags": "<p>Displays the key, value pairs of tags associated with this resource.</p>", 372 "QuantumTaskSummary$tags": "<p>Displays the key, value pairs of tags associated with this quantum task.</p>", 373 "TagResourceRequest$tags": "<p>Specify the tags to add to the resource.</p>" 374 } 375 }, 376 "ThrottlingException": { 377 "base": "<p>The throttling rate limit is met.</p>", 378 "refs": { 379 } 380 }, 381 "UntagResourceRequest": { 382 "base": null, 383 "refs": { 384 } 385 }, 386 "UntagResourceResponse": { 387 "base": null, 388 "refs": { 389 } 390 }, 391 "ValidationException": { 392 "base": "<p>The input fails to satisfy the constraints specified by an AWS service.</p>", 393 "refs": { 394 } 395 } 396 } 397 }