github.com/aavshr/aws-sdk-go@v1.41.3/models/apis/braket/2019-09-01/api-2.json (about) 1 { 2 "version":"2.0", 3 "metadata":{ 4 "apiVersion":"2019-09-01", 5 "endpointPrefix":"braket", 6 "jsonVersion":"1.1", 7 "protocol":"rest-json", 8 "serviceFullName":"Braket", 9 "serviceId":"Braket", 10 "signatureVersion":"v4", 11 "signingName":"braket", 12 "uid":"braket-2019-09-01" 13 }, 14 "operations":{ 15 "CancelQuantumTask":{ 16 "name":"CancelQuantumTask", 17 "http":{ 18 "method":"PUT", 19 "requestUri":"/quantum-task/{quantumTaskArn}/cancel", 20 "responseCode":200 21 }, 22 "input":{"shape":"CancelQuantumTaskRequest"}, 23 "output":{"shape":"CancelQuantumTaskResponse"}, 24 "errors":[ 25 {"shape":"ResourceNotFoundException"}, 26 {"shape":"AccessDeniedException"}, 27 {"shape":"ConflictException"}, 28 {"shape":"ThrottlingException"}, 29 {"shape":"InternalServiceException"}, 30 {"shape":"ValidationException"} 31 ], 32 "idempotent":true 33 }, 34 "CreateQuantumTask":{ 35 "name":"CreateQuantumTask", 36 "http":{ 37 "method":"POST", 38 "requestUri":"/quantum-task", 39 "responseCode":201 40 }, 41 "input":{"shape":"CreateQuantumTaskRequest"}, 42 "output":{"shape":"CreateQuantumTaskResponse"}, 43 "errors":[ 44 {"shape":"AccessDeniedException"}, 45 {"shape":"ThrottlingException"}, 46 {"shape":"DeviceOfflineException"}, 47 {"shape":"InternalServiceException"}, 48 {"shape":"ServiceQuotaExceededException"}, 49 {"shape":"ValidationException"} 50 ] 51 }, 52 "GetDevice":{ 53 "name":"GetDevice", 54 "http":{ 55 "method":"GET", 56 "requestUri":"/device/{deviceArn}", 57 "responseCode":200 58 }, 59 "input":{"shape":"GetDeviceRequest"}, 60 "output":{"shape":"GetDeviceResponse"}, 61 "errors":[ 62 {"shape":"ResourceNotFoundException"}, 63 {"shape":"AccessDeniedException"}, 64 {"shape":"ThrottlingException"}, 65 {"shape":"DeviceOfflineException"}, 66 {"shape":"DeviceRetiredException"}, 67 {"shape":"InternalServiceException"}, 68 {"shape":"ValidationException"} 69 ] 70 }, 71 "GetQuantumTask":{ 72 "name":"GetQuantumTask", 73 "http":{ 74 "method":"GET", 75 "requestUri":"/quantum-task/{quantumTaskArn}", 76 "responseCode":200 77 }, 78 "input":{"shape":"GetQuantumTaskRequest"}, 79 "output":{"shape":"GetQuantumTaskResponse"}, 80 "errors":[ 81 {"shape":"ResourceNotFoundException"}, 82 {"shape":"AccessDeniedException"}, 83 {"shape":"ThrottlingException"}, 84 {"shape":"InternalServiceException"}, 85 {"shape":"ValidationException"} 86 ] 87 }, 88 "ListTagsForResource":{ 89 "name":"ListTagsForResource", 90 "http":{ 91 "method":"GET", 92 "requestUri":"/tags/{resourceArn}", 93 "responseCode":200 94 }, 95 "input":{"shape":"ListTagsForResourceRequest"}, 96 "output":{"shape":"ListTagsForResourceResponse"}, 97 "errors":[ 98 {"shape":"ResourceNotFoundException"}, 99 {"shape":"InternalServiceException"}, 100 {"shape":"ValidationException"} 101 ] 102 }, 103 "SearchDevices":{ 104 "name":"SearchDevices", 105 "http":{ 106 "method":"POST", 107 "requestUri":"/devices", 108 "responseCode":200 109 }, 110 "input":{"shape":"SearchDevicesRequest"}, 111 "output":{"shape":"SearchDevicesResponse"}, 112 "errors":[ 113 {"shape":"AccessDeniedException"}, 114 {"shape":"ThrottlingException"}, 115 {"shape":"InternalServiceException"}, 116 {"shape":"ValidationException"} 117 ] 118 }, 119 "SearchQuantumTasks":{ 120 "name":"SearchQuantumTasks", 121 "http":{ 122 "method":"POST", 123 "requestUri":"/quantum-tasks", 124 "responseCode":200 125 }, 126 "input":{"shape":"SearchQuantumTasksRequest"}, 127 "output":{"shape":"SearchQuantumTasksResponse"}, 128 "errors":[ 129 {"shape":"AccessDeniedException"}, 130 {"shape":"ThrottlingException"}, 131 {"shape":"InternalServiceException"}, 132 {"shape":"ValidationException"} 133 ] 134 }, 135 "TagResource":{ 136 "name":"TagResource", 137 "http":{ 138 "method":"POST", 139 "requestUri":"/tags/{resourceArn}", 140 "responseCode":200 141 }, 142 "input":{"shape":"TagResourceRequest"}, 143 "output":{"shape":"TagResourceResponse"}, 144 "errors":[ 145 {"shape":"ResourceNotFoundException"}, 146 {"shape":"InternalServiceException"}, 147 {"shape":"ValidationException"} 148 ] 149 }, 150 "UntagResource":{ 151 "name":"UntagResource", 152 "http":{ 153 "method":"DELETE", 154 "requestUri":"/tags/{resourceArn}", 155 "responseCode":200 156 }, 157 "input":{"shape":"UntagResourceRequest"}, 158 "output":{"shape":"UntagResourceResponse"}, 159 "errors":[ 160 {"shape":"ResourceNotFoundException"}, 161 {"shape":"InternalServiceException"}, 162 {"shape":"ValidationException"} 163 ], 164 "idempotent":true 165 } 166 }, 167 "shapes":{ 168 "AccessDeniedException":{ 169 "type":"structure", 170 "members":{ 171 "message":{"shape":"String"} 172 }, 173 "error":{ 174 "httpStatusCode":403, 175 "senderFault":true 176 }, 177 "exception":true 178 }, 179 "CancelQuantumTaskRequest":{ 180 "type":"structure", 181 "required":[ 182 "clientToken", 183 "quantumTaskArn" 184 ], 185 "members":{ 186 "clientToken":{ 187 "shape":"String64", 188 "idempotencyToken":true 189 }, 190 "quantumTaskArn":{ 191 "shape":"QuantumTaskArn", 192 "location":"uri", 193 "locationName":"quantumTaskArn" 194 } 195 } 196 }, 197 "CancelQuantumTaskResponse":{ 198 "type":"structure", 199 "required":[ 200 "cancellationStatus", 201 "quantumTaskArn" 202 ], 203 "members":{ 204 "cancellationStatus":{"shape":"CancellationStatus"}, 205 "quantumTaskArn":{"shape":"QuantumTaskArn"} 206 } 207 }, 208 "CancellationStatus":{ 209 "type":"string", 210 "enum":[ 211 "CANCELLING", 212 "CANCELLED" 213 ] 214 }, 215 "ConflictException":{ 216 "type":"structure", 217 "members":{ 218 "message":{"shape":"String"} 219 }, 220 "error":{ 221 "httpStatusCode":409, 222 "senderFault":true 223 }, 224 "exception":true 225 }, 226 "CreateQuantumTaskRequest":{ 227 "type":"structure", 228 "required":[ 229 "action", 230 "clientToken", 231 "deviceArn", 232 "outputS3Bucket", 233 "outputS3KeyPrefix", 234 "shots" 235 ], 236 "members":{ 237 "action":{ 238 "shape":"JsonValue", 239 "jsonvalue":true 240 }, 241 "clientToken":{ 242 "shape":"String64", 243 "idempotencyToken":true 244 }, 245 "deviceArn":{"shape":"DeviceArn"}, 246 "deviceParameters":{ 247 "shape":"CreateQuantumTaskRequestDeviceParametersString", 248 "jsonvalue":true 249 }, 250 "outputS3Bucket":{"shape":"CreateQuantumTaskRequestOutputS3BucketString"}, 251 "outputS3KeyPrefix":{"shape":"CreateQuantumTaskRequestOutputS3KeyPrefixString"}, 252 "shots":{"shape":"CreateQuantumTaskRequestShotsLong"}, 253 "tags":{"shape":"TagsMap"} 254 } 255 }, 256 "CreateQuantumTaskRequestDeviceParametersString":{ 257 "type":"string", 258 "max":48000, 259 "min":1 260 }, 261 "CreateQuantumTaskRequestOutputS3BucketString":{ 262 "type":"string", 263 "max":63, 264 "min":3 265 }, 266 "CreateQuantumTaskRequestOutputS3KeyPrefixString":{ 267 "type":"string", 268 "max":1024, 269 "min":1 270 }, 271 "CreateQuantumTaskRequestShotsLong":{ 272 "type":"long", 273 "box":true, 274 "min":0 275 }, 276 "CreateQuantumTaskResponse":{ 277 "type":"structure", 278 "required":["quantumTaskArn"], 279 "members":{ 280 "quantumTaskArn":{"shape":"QuantumTaskArn"} 281 } 282 }, 283 "DeviceArn":{ 284 "type":"string", 285 "max":256, 286 "min":1 287 }, 288 "DeviceOfflineException":{ 289 "type":"structure", 290 "members":{ 291 "message":{"shape":"String"} 292 }, 293 "error":{ 294 "httpStatusCode":424, 295 "senderFault":true 296 }, 297 "exception":true 298 }, 299 "DeviceRetiredException":{ 300 "type":"structure", 301 "members":{ 302 "message":{"shape":"String"} 303 }, 304 "error":{ 305 "httpStatusCode":410, 306 "senderFault":true 307 }, 308 "exception":true 309 }, 310 "DeviceStatus":{ 311 "type":"string", 312 "enum":[ 313 "ONLINE", 314 "OFFLINE", 315 "RETIRED" 316 ] 317 }, 318 "DeviceSummary":{ 319 "type":"structure", 320 "required":[ 321 "deviceArn", 322 "deviceName", 323 "deviceStatus", 324 "deviceType", 325 "providerName" 326 ], 327 "members":{ 328 "deviceArn":{"shape":"DeviceArn"}, 329 "deviceName":{"shape":"String"}, 330 "deviceStatus":{"shape":"DeviceStatus"}, 331 "deviceType":{"shape":"DeviceType"}, 332 "providerName":{"shape":"String"} 333 } 334 }, 335 "DeviceSummaryList":{ 336 "type":"list", 337 "member":{"shape":"DeviceSummary"} 338 }, 339 "DeviceType":{ 340 "type":"string", 341 "enum":[ 342 "QPU", 343 "SIMULATOR" 344 ] 345 }, 346 "GetDeviceRequest":{ 347 "type":"structure", 348 "required":["deviceArn"], 349 "members":{ 350 "deviceArn":{ 351 "shape":"DeviceArn", 352 "location":"uri", 353 "locationName":"deviceArn" 354 } 355 } 356 }, 357 "GetDeviceResponse":{ 358 "type":"structure", 359 "required":[ 360 "deviceArn", 361 "deviceCapabilities", 362 "deviceName", 363 "deviceStatus", 364 "deviceType", 365 "providerName" 366 ], 367 "members":{ 368 "deviceArn":{"shape":"DeviceArn"}, 369 "deviceCapabilities":{ 370 "shape":"JsonValue", 371 "jsonvalue":true 372 }, 373 "deviceName":{"shape":"String"}, 374 "deviceStatus":{"shape":"DeviceStatus"}, 375 "deviceType":{"shape":"DeviceType"}, 376 "providerName":{"shape":"String"} 377 } 378 }, 379 "GetQuantumTaskRequest":{ 380 "type":"structure", 381 "required":["quantumTaskArn"], 382 "members":{ 383 "quantumTaskArn":{ 384 "shape":"QuantumTaskArn", 385 "location":"uri", 386 "locationName":"quantumTaskArn" 387 } 388 } 389 }, 390 "GetQuantumTaskResponse":{ 391 "type":"structure", 392 "required":[ 393 "createdAt", 394 "deviceArn", 395 "deviceParameters", 396 "outputS3Bucket", 397 "outputS3Directory", 398 "quantumTaskArn", 399 "shots", 400 "status" 401 ], 402 "members":{ 403 "createdAt":{"shape":"SyntheticTimestamp_date_time"}, 404 "deviceArn":{"shape":"DeviceArn"}, 405 "deviceParameters":{ 406 "shape":"JsonValue", 407 "jsonvalue":true 408 }, 409 "endedAt":{"shape":"SyntheticTimestamp_date_time"}, 410 "failureReason":{"shape":"String"}, 411 "outputS3Bucket":{"shape":"String"}, 412 "outputS3Directory":{"shape":"String"}, 413 "quantumTaskArn":{"shape":"QuantumTaskArn"}, 414 "shots":{"shape":"Long"}, 415 "status":{"shape":"QuantumTaskStatus"}, 416 "tags":{"shape":"TagsMap"} 417 } 418 }, 419 "InternalServiceException":{ 420 "type":"structure", 421 "members":{ 422 "message":{"shape":"String"} 423 }, 424 "error":{"httpStatusCode":500}, 425 "exception":true, 426 "fault":true 427 }, 428 "JsonValue":{"type":"string"}, 429 "ListTagsForResourceRequest":{ 430 "type":"structure", 431 "required":["resourceArn"], 432 "members":{ 433 "resourceArn":{ 434 "shape":"String", 435 "location":"uri", 436 "locationName":"resourceArn" 437 } 438 } 439 }, 440 "ListTagsForResourceResponse":{ 441 "type":"structure", 442 "members":{ 443 "tags":{"shape":"TagsMap"} 444 } 445 }, 446 "Long":{ 447 "type":"long", 448 "box":true 449 }, 450 "QuantumTaskArn":{ 451 "type":"string", 452 "max":256, 453 "min":1 454 }, 455 "QuantumTaskStatus":{ 456 "type":"string", 457 "enum":[ 458 "CREATED", 459 "QUEUED", 460 "RUNNING", 461 "COMPLETED", 462 "FAILED", 463 "CANCELLING", 464 "CANCELLED" 465 ] 466 }, 467 "QuantumTaskSummary":{ 468 "type":"structure", 469 "required":[ 470 "createdAt", 471 "deviceArn", 472 "outputS3Bucket", 473 "outputS3Directory", 474 "quantumTaskArn", 475 "shots", 476 "status" 477 ], 478 "members":{ 479 "createdAt":{"shape":"SyntheticTimestamp_date_time"}, 480 "deviceArn":{"shape":"DeviceArn"}, 481 "endedAt":{"shape":"SyntheticTimestamp_date_time"}, 482 "outputS3Bucket":{"shape":"String"}, 483 "outputS3Directory":{"shape":"String"}, 484 "quantumTaskArn":{"shape":"QuantumTaskArn"}, 485 "shots":{"shape":"Long"}, 486 "status":{"shape":"QuantumTaskStatus"}, 487 "tags":{"shape":"TagsMap"} 488 } 489 }, 490 "QuantumTaskSummaryList":{ 491 "type":"list", 492 "member":{"shape":"QuantumTaskSummary"} 493 }, 494 "ResourceNotFoundException":{ 495 "type":"structure", 496 "members":{ 497 "message":{"shape":"String"} 498 }, 499 "error":{ 500 "httpStatusCode":404, 501 "senderFault":true 502 }, 503 "exception":true 504 }, 505 "SearchDevicesFilter":{ 506 "type":"structure", 507 "required":[ 508 "name", 509 "values" 510 ], 511 "members":{ 512 "name":{"shape":"SearchDevicesFilterNameString"}, 513 "values":{"shape":"SearchDevicesFilterValuesList"} 514 } 515 }, 516 "SearchDevicesFilterNameString":{ 517 "type":"string", 518 "max":64, 519 "min":1 520 }, 521 "SearchDevicesFilterValuesList":{ 522 "type":"list", 523 "member":{"shape":"String256"}, 524 "max":10, 525 "min":1 526 }, 527 "SearchDevicesRequest":{ 528 "type":"structure", 529 "required":["filters"], 530 "members":{ 531 "filters":{"shape":"SearchDevicesRequestFiltersList"}, 532 "maxResults":{"shape":"SearchDevicesRequestMaxResultsInteger"}, 533 "nextToken":{"shape":"String"} 534 } 535 }, 536 "SearchDevicesRequestFiltersList":{ 537 "type":"list", 538 "member":{"shape":"SearchDevicesFilter"}, 539 "max":10, 540 "min":0 541 }, 542 "SearchDevicesRequestMaxResultsInteger":{ 543 "type":"integer", 544 "box":true, 545 "max":100, 546 "min":1 547 }, 548 "SearchDevicesResponse":{ 549 "type":"structure", 550 "required":["devices"], 551 "members":{ 552 "devices":{"shape":"DeviceSummaryList"}, 553 "nextToken":{"shape":"String"} 554 } 555 }, 556 "SearchQuantumTasksFilter":{ 557 "type":"structure", 558 "required":[ 559 "name", 560 "operator", 561 "values" 562 ], 563 "members":{ 564 "name":{"shape":"String64"}, 565 "operator":{"shape":"SearchQuantumTasksFilterOperator"}, 566 "values":{"shape":"SearchQuantumTasksFilterValuesList"} 567 } 568 }, 569 "SearchQuantumTasksFilterOperator":{ 570 "type":"string", 571 "enum":[ 572 "LT", 573 "LTE", 574 "EQUAL", 575 "GT", 576 "GTE", 577 "BETWEEN" 578 ] 579 }, 580 "SearchQuantumTasksFilterValuesList":{ 581 "type":"list", 582 "member":{"shape":"String256"}, 583 "max":10, 584 "min":1 585 }, 586 "SearchQuantumTasksRequest":{ 587 "type":"structure", 588 "required":["filters"], 589 "members":{ 590 "filters":{"shape":"SearchQuantumTasksRequestFiltersList"}, 591 "maxResults":{"shape":"SearchQuantumTasksRequestMaxResultsInteger"}, 592 "nextToken":{"shape":"String"} 593 } 594 }, 595 "SearchQuantumTasksRequestFiltersList":{ 596 "type":"list", 597 "member":{"shape":"SearchQuantumTasksFilter"}, 598 "max":10, 599 "min":0 600 }, 601 "SearchQuantumTasksRequestMaxResultsInteger":{ 602 "type":"integer", 603 "box":true, 604 "max":100, 605 "min":1 606 }, 607 "SearchQuantumTasksResponse":{ 608 "type":"structure", 609 "required":["quantumTasks"], 610 "members":{ 611 "nextToken":{"shape":"String"}, 612 "quantumTasks":{"shape":"QuantumTaskSummaryList"} 613 } 614 }, 615 "ServiceQuotaExceededException":{ 616 "type":"structure", 617 "members":{ 618 "message":{"shape":"String"} 619 }, 620 "error":{ 621 "httpStatusCode":402, 622 "senderFault":true 623 }, 624 "exception":true 625 }, 626 "String":{"type":"string"}, 627 "String256":{ 628 "type":"string", 629 "max":256, 630 "min":1 631 }, 632 "String64":{ 633 "type":"string", 634 "max":64, 635 "min":1 636 }, 637 "SyntheticTimestamp_date_time":{ 638 "type":"timestamp", 639 "timestampFormat":"iso8601" 640 }, 641 "TagKeys":{ 642 "type":"list", 643 "member":{"shape":"String"} 644 }, 645 "TagResourceRequest":{ 646 "type":"structure", 647 "required":[ 648 "resourceArn", 649 "tags" 650 ], 651 "members":{ 652 "resourceArn":{ 653 "shape":"String", 654 "location":"uri", 655 "locationName":"resourceArn" 656 }, 657 "tags":{"shape":"TagsMap"} 658 } 659 }, 660 "TagResourceResponse":{ 661 "type":"structure", 662 "members":{ 663 } 664 }, 665 "TagsMap":{ 666 "type":"map", 667 "key":{"shape":"String"}, 668 "value":{"shape":"String"} 669 }, 670 "ThrottlingException":{ 671 "type":"structure", 672 "members":{ 673 "message":{"shape":"String"} 674 }, 675 "error":{ 676 "httpStatusCode":429, 677 "senderFault":true 678 }, 679 "exception":true 680 }, 681 "UntagResourceRequest":{ 682 "type":"structure", 683 "required":[ 684 "resourceArn", 685 "tagKeys" 686 ], 687 "members":{ 688 "resourceArn":{ 689 "shape":"String", 690 "location":"uri", 691 "locationName":"resourceArn" 692 }, 693 "tagKeys":{ 694 "shape":"TagKeys", 695 "location":"querystring", 696 "locationName":"tagKeys" 697 } 698 } 699 }, 700 "UntagResourceResponse":{ 701 "type":"structure", 702 "members":{ 703 } 704 }, 705 "ValidationException":{ 706 "type":"structure", 707 "members":{ 708 "message":{"shape":"String"} 709 }, 710 "error":{ 711 "httpStatusCode":400, 712 "senderFault":true 713 }, 714 "exception":true 715 } 716 } 717 }