github.com/aavshr/aws-sdk-go@v1.41.3/models/apis/outposts/2019-12-03/api-2.json (about) 1 { 2 "version":"2.0", 3 "metadata":{ 4 "apiVersion":"2019-12-03", 5 "endpointPrefix":"outposts", 6 "jsonVersion":"1.1", 7 "protocol":"rest-json", 8 "serviceAbbreviation":"Outposts", 9 "serviceFullName":"AWS Outposts", 10 "serviceId":"Outposts", 11 "signatureVersion":"v4", 12 "signingName":"outposts", 13 "uid":"outposts-2019-12-03" 14 }, 15 "operations":{ 16 "CreateOrder":{ 17 "name":"CreateOrder", 18 "http":{ 19 "method":"POST", 20 "requestUri":"/orders" 21 }, 22 "input":{"shape":"CreateOrderInput"}, 23 "output":{"shape":"CreateOrderOutput"}, 24 "errors":[ 25 {"shape":"ValidationException"}, 26 {"shape":"ConflictException"}, 27 {"shape":"AccessDeniedException"}, 28 {"shape":"NotFoundException"}, 29 {"shape":"InternalServerException"}, 30 {"shape":"ServiceQuotaExceededException"} 31 ] 32 }, 33 "CreateOutpost":{ 34 "name":"CreateOutpost", 35 "http":{ 36 "method":"POST", 37 "requestUri":"/outposts" 38 }, 39 "input":{"shape":"CreateOutpostInput"}, 40 "output":{"shape":"CreateOutpostOutput"}, 41 "errors":[ 42 {"shape":"ValidationException"}, 43 {"shape":"ConflictException"}, 44 {"shape":"NotFoundException"}, 45 {"shape":"AccessDeniedException"}, 46 {"shape":"InternalServerException"}, 47 {"shape":"ServiceQuotaExceededException"} 48 ] 49 }, 50 "DeleteOutpost":{ 51 "name":"DeleteOutpost", 52 "http":{ 53 "method":"DELETE", 54 "requestUri":"/outposts/{OutpostId}" 55 }, 56 "input":{"shape":"DeleteOutpostInput"}, 57 "output":{"shape":"DeleteOutpostOutput"}, 58 "errors":[ 59 {"shape":"ValidationException"}, 60 {"shape":"ConflictException"}, 61 {"shape":"NotFoundException"}, 62 {"shape":"AccessDeniedException"}, 63 {"shape":"InternalServerException"} 64 ] 65 }, 66 "DeleteSite":{ 67 "name":"DeleteSite", 68 "http":{ 69 "method":"DELETE", 70 "requestUri":"/sites/{SiteId}" 71 }, 72 "input":{"shape":"DeleteSiteInput"}, 73 "output":{"shape":"DeleteSiteOutput"}, 74 "errors":[ 75 {"shape":"ValidationException"}, 76 {"shape":"ConflictException"}, 77 {"shape":"NotFoundException"}, 78 {"shape":"AccessDeniedException"}, 79 {"shape":"InternalServerException"} 80 ] 81 }, 82 "GetOutpost":{ 83 "name":"GetOutpost", 84 "http":{ 85 "method":"GET", 86 "requestUri":"/outposts/{OutpostId}" 87 }, 88 "input":{"shape":"GetOutpostInput"}, 89 "output":{"shape":"GetOutpostOutput"}, 90 "errors":[ 91 {"shape":"ValidationException"}, 92 {"shape":"NotFoundException"}, 93 {"shape":"AccessDeniedException"}, 94 {"shape":"InternalServerException"} 95 ] 96 }, 97 "GetOutpostInstanceTypes":{ 98 "name":"GetOutpostInstanceTypes", 99 "http":{ 100 "method":"GET", 101 "requestUri":"/outposts/{OutpostId}/instanceTypes" 102 }, 103 "input":{"shape":"GetOutpostInstanceTypesInput"}, 104 "output":{"shape":"GetOutpostInstanceTypesOutput"}, 105 "errors":[ 106 {"shape":"ValidationException"}, 107 {"shape":"NotFoundException"}, 108 {"shape":"AccessDeniedException"}, 109 {"shape":"InternalServerException"} 110 ] 111 }, 112 "ListOutposts":{ 113 "name":"ListOutposts", 114 "http":{ 115 "method":"GET", 116 "requestUri":"/outposts" 117 }, 118 "input":{"shape":"ListOutpostsInput"}, 119 "output":{"shape":"ListOutpostsOutput"}, 120 "errors":[ 121 {"shape":"ValidationException"}, 122 {"shape":"AccessDeniedException"}, 123 {"shape":"InternalServerException"} 124 ] 125 }, 126 "ListSites":{ 127 "name":"ListSites", 128 "http":{ 129 "method":"GET", 130 "requestUri":"/sites" 131 }, 132 "input":{"shape":"ListSitesInput"}, 133 "output":{"shape":"ListSitesOutput"}, 134 "errors":[ 135 {"shape":"ValidationException"}, 136 {"shape":"AccessDeniedException"}, 137 {"shape":"InternalServerException"} 138 ] 139 }, 140 "ListTagsForResource":{ 141 "name":"ListTagsForResource", 142 "http":{ 143 "method":"GET", 144 "requestUri":"/tags/{ResourceArn}" 145 }, 146 "input":{"shape":"ListTagsForResourceRequest"}, 147 "output":{"shape":"ListTagsForResourceResponse"}, 148 "errors":[ 149 {"shape":"InternalServerException"}, 150 {"shape":"ValidationException"}, 151 {"shape":"NotFoundException"} 152 ] 153 }, 154 "TagResource":{ 155 "name":"TagResource", 156 "http":{ 157 "method":"POST", 158 "requestUri":"/tags/{ResourceArn}" 159 }, 160 "input":{"shape":"TagResourceRequest"}, 161 "output":{"shape":"TagResourceResponse"}, 162 "errors":[ 163 {"shape":"InternalServerException"}, 164 {"shape":"ValidationException"}, 165 {"shape":"NotFoundException"} 166 ] 167 }, 168 "UntagResource":{ 169 "name":"UntagResource", 170 "http":{ 171 "method":"DELETE", 172 "requestUri":"/tags/{ResourceArn}" 173 }, 174 "input":{"shape":"UntagResourceRequest"}, 175 "output":{"shape":"UntagResourceResponse"}, 176 "errors":[ 177 {"shape":"InternalServerException"}, 178 {"shape":"ValidationException"}, 179 {"shape":"NotFoundException"} 180 ] 181 } 182 }, 183 "shapes":{ 184 "AccessDeniedException":{ 185 "type":"structure", 186 "members":{ 187 "Message":{"shape":"ErrorMessage"} 188 }, 189 "error":{"httpStatusCode":403}, 190 "exception":true 191 }, 192 "AccountId":{ 193 "type":"string", 194 "max":12, 195 "min":12, 196 "pattern":"\\d{12}" 197 }, 198 "Arn":{ 199 "type":"string", 200 "max":1011, 201 "pattern":"^(arn:aws([a-z-]+)?:outposts:[a-z\\d-]+:\\d{12}:([a-z\\d-]+)/)[a-z]{2,8}-[a-f0-9]{17}$" 202 }, 203 "AvailabilityZone":{ 204 "type":"string", 205 "max":1000, 206 "min":1, 207 "pattern":"^([a-zA-Z]+-){1,3}([a-zA-Z]+)?(\\d+[a-zA-Z]?)?$" 208 }, 209 "AvailabilityZoneId":{ 210 "type":"string", 211 "max":255, 212 "min":1, 213 "pattern":"^[a-zA-Z]+\\d-[a-zA-Z]+\\d$" 214 }, 215 "AvailabilityZoneIdList":{ 216 "type":"list", 217 "member":{"shape":"AvailabilityZoneId"}, 218 "max":5, 219 "min":1 220 }, 221 "AvailabilityZoneList":{ 222 "type":"list", 223 "member":{"shape":"AvailabilityZone"}, 224 "max":5, 225 "min":1 226 }, 227 "ConflictException":{ 228 "type":"structure", 229 "members":{ 230 "Message":{"shape":"ErrorMessage"}, 231 "ResourceId":{"shape":"String"}, 232 "ResourceType":{"shape":"ResourceType"} 233 }, 234 "error":{"httpStatusCode":409}, 235 "exception":true 236 }, 237 "CreateOrderInput":{ 238 "type":"structure", 239 "required":[ 240 "OutpostIdentifier", 241 "LineItems", 242 "PaymentOption" 243 ], 244 "members":{ 245 "OutpostIdentifier":{"shape":"OutpostIdentifier"}, 246 "LineItems":{"shape":"LineItemRequestListDefinition"}, 247 "PaymentOption":{"shape":"PaymentOption"}, 248 "PaymentTerm":{"shape":"PaymentTerm"} 249 } 250 }, 251 "CreateOrderOutput":{ 252 "type":"structure", 253 "members":{ 254 "Order":{"shape":"Order"} 255 } 256 }, 257 "CreateOutpostInput":{ 258 "type":"structure", 259 "required":[ 260 "Name", 261 "SiteId" 262 ], 263 "members":{ 264 "Name":{"shape":"OutpostName"}, 265 "Description":{"shape":"OutpostDescription"}, 266 "SiteId":{"shape":"SiteId"}, 267 "AvailabilityZone":{"shape":"AvailabilityZone"}, 268 "AvailabilityZoneId":{"shape":"AvailabilityZoneId"}, 269 "Tags":{"shape":"TagMap"} 270 } 271 }, 272 "CreateOutpostOutput":{ 273 "type":"structure", 274 "members":{ 275 "Outpost":{"shape":"Outpost"} 276 } 277 }, 278 "DeleteOutpostInput":{ 279 "type":"structure", 280 "required":["OutpostId"], 281 "members":{ 282 "OutpostId":{ 283 "shape":"OutpostId", 284 "location":"uri", 285 "locationName":"OutpostId" 286 } 287 } 288 }, 289 "DeleteOutpostOutput":{ 290 "type":"structure", 291 "members":{ 292 } 293 }, 294 "DeleteSiteInput":{ 295 "type":"structure", 296 "required":["SiteId"], 297 "members":{ 298 "SiteId":{ 299 "shape":"SiteId", 300 "location":"uri", 301 "locationName":"SiteId" 302 } 303 } 304 }, 305 "DeleteSiteOutput":{ 306 "type":"structure", 307 "members":{ 308 } 309 }, 310 "ErrorMessage":{ 311 "type":"string", 312 "max":1000, 313 "min":1, 314 "pattern":"^[\\S \\n]+$" 315 }, 316 "GetOutpostInput":{ 317 "type":"structure", 318 "required":["OutpostId"], 319 "members":{ 320 "OutpostId":{ 321 "shape":"OutpostId", 322 "location":"uri", 323 "locationName":"OutpostId" 324 } 325 } 326 }, 327 "GetOutpostInstanceTypesInput":{ 328 "type":"structure", 329 "required":["OutpostId"], 330 "members":{ 331 "OutpostId":{ 332 "shape":"OutpostId", 333 "location":"uri", 334 "locationName":"OutpostId" 335 }, 336 "NextToken":{ 337 "shape":"Token", 338 "location":"querystring", 339 "locationName":"NextToken" 340 }, 341 "MaxResults":{ 342 "shape":"MaxResults1000", 343 "location":"querystring", 344 "locationName":"MaxResults" 345 } 346 } 347 }, 348 "GetOutpostInstanceTypesOutput":{ 349 "type":"structure", 350 "members":{ 351 "InstanceTypes":{"shape":"InstanceTypeListDefinition"}, 352 "NextToken":{"shape":"Token"}, 353 "OutpostId":{"shape":"OutpostId"}, 354 "OutpostArn":{"shape":"OutpostArn"} 355 } 356 }, 357 "GetOutpostOutput":{ 358 "type":"structure", 359 "members":{ 360 "Outpost":{"shape":"Outpost"} 361 } 362 }, 363 "ISO8601Timestamp":{"type":"timestamp"}, 364 "InstanceType":{"type":"string"}, 365 "InstanceTypeItem":{ 366 "type":"structure", 367 "members":{ 368 "InstanceType":{"shape":"InstanceType"} 369 } 370 }, 371 "InstanceTypeListDefinition":{ 372 "type":"list", 373 "member":{"shape":"InstanceTypeItem"} 374 }, 375 "InternalServerException":{ 376 "type":"structure", 377 "members":{ 378 "Message":{"shape":"ErrorMessage"} 379 }, 380 "error":{"httpStatusCode":500}, 381 "exception":true 382 }, 383 "LifeCycleStatus":{ 384 "type":"string", 385 "max":20, 386 "min":1, 387 "pattern":"^[ A-Za-z]+$" 388 }, 389 "LifeCycleStatusList":{ 390 "type":"list", 391 "member":{"shape":"LifeCycleStatus"}, 392 "max":5, 393 "min":1 394 }, 395 "LineItem":{ 396 "type":"structure", 397 "members":{ 398 "CatalogItemId":{"shape":"SkuCode"}, 399 "LineItemId":{"shape":"LineItemId"}, 400 "Quantity":{"shape":"LineItemQuantity"}, 401 "Status":{"shape":"Status"} 402 } 403 }, 404 "LineItemId":{ 405 "type":"string", 406 "pattern":"ooi-[a-f0-9]{17}" 407 }, 408 "LineItemListDefinition":{ 409 "type":"list", 410 "member":{"shape":"LineItem"} 411 }, 412 "LineItemQuantity":{ 413 "type":"integer", 414 "max":20, 415 "min":1 416 }, 417 "LineItemRequest":{ 418 "type":"structure", 419 "members":{ 420 "CatalogItemId":{"shape":"SkuCode"}, 421 "Quantity":{"shape":"LineItemQuantity"} 422 } 423 }, 424 "LineItemRequestListDefinition":{ 425 "type":"list", 426 "member":{"shape":"LineItemRequest"}, 427 "max":20, 428 "min":1 429 }, 430 "ListOutpostsInput":{ 431 "type":"structure", 432 "members":{ 433 "NextToken":{ 434 "shape":"Token", 435 "location":"querystring", 436 "locationName":"NextToken" 437 }, 438 "MaxResults":{ 439 "shape":"MaxResults1000", 440 "location":"querystring", 441 "locationName":"MaxResults" 442 }, 443 "LifeCycleStatusFilter":{ 444 "shape":"LifeCycleStatusList", 445 "location":"querystring", 446 "locationName":"LifeCycleStatusFilter" 447 }, 448 "AvailabilityZoneFilter":{ 449 "shape":"AvailabilityZoneList", 450 "location":"querystring", 451 "locationName":"AvailabilityZoneFilter" 452 }, 453 "AvailabilityZoneIdFilter":{ 454 "shape":"AvailabilityZoneIdList", 455 "location":"querystring", 456 "locationName":"AvailabilityZoneIdFilter" 457 } 458 } 459 }, 460 "ListOutpostsOutput":{ 461 "type":"structure", 462 "members":{ 463 "Outposts":{"shape":"outpostListDefinition"}, 464 "NextToken":{"shape":"Token"} 465 } 466 }, 467 "ListSitesInput":{ 468 "type":"structure", 469 "members":{ 470 "NextToken":{ 471 "shape":"Token", 472 "location":"querystring", 473 "locationName":"NextToken" 474 }, 475 "MaxResults":{ 476 "shape":"MaxResults1000", 477 "location":"querystring", 478 "locationName":"MaxResults" 479 } 480 } 481 }, 482 "ListSitesOutput":{ 483 "type":"structure", 484 "members":{ 485 "Sites":{"shape":"siteListDefinition"}, 486 "NextToken":{"shape":"Token"} 487 } 488 }, 489 "ListTagsForResourceRequest":{ 490 "type":"structure", 491 "required":["ResourceArn"], 492 "members":{ 493 "ResourceArn":{ 494 "shape":"Arn", 495 "location":"uri", 496 "locationName":"ResourceArn" 497 } 498 } 499 }, 500 "ListTagsForResourceResponse":{ 501 "type":"structure", 502 "members":{ 503 "Tags":{"shape":"TagMap"} 504 } 505 }, 506 "MaxResults1000":{ 507 "type":"integer", 508 "box":true, 509 "max":1000, 510 "min":1 511 }, 512 "NotFoundException":{ 513 "type":"structure", 514 "members":{ 515 "Message":{"shape":"ErrorMessage"} 516 }, 517 "error":{"httpStatusCode":404}, 518 "exception":true 519 }, 520 "Order":{ 521 "type":"structure", 522 "members":{ 523 "OutpostId":{"shape":"OutpostIdOnly"}, 524 "OrderId":{"shape":"OrderId"}, 525 "Status":{"shape":"OrderStatus"}, 526 "LineItems":{"shape":"LineItemListDefinition"}, 527 "PaymentOption":{"shape":"PaymentOption"}, 528 "OrderSubmissionDate":{"shape":"ISO8601Timestamp"}, 529 "OrderFulfilledDate":{"shape":"ISO8601Timestamp"} 530 } 531 }, 532 "OrderId":{ 533 "type":"string", 534 "max":20, 535 "min":1, 536 "pattern":"oo-[a-f0-9]{17}$" 537 }, 538 "OrderStatus":{ 539 "type":"string", 540 "enum":[ 541 "RECEIVED", 542 "PENDING", 543 "PROCESSING", 544 "INSTALLING", 545 "FULFILLED", 546 "CANCELLED" 547 ] 548 }, 549 "Outpost":{ 550 "type":"structure", 551 "members":{ 552 "OutpostId":{"shape":"OutpostId"}, 553 "OwnerId":{"shape":"OwnerId"}, 554 "OutpostArn":{"shape":"OutpostArn"}, 555 "SiteId":{"shape":"SiteId"}, 556 "Name":{"shape":"OutpostName"}, 557 "Description":{"shape":"OutpostDescription"}, 558 "LifeCycleStatus":{"shape":"LifeCycleStatus"}, 559 "AvailabilityZone":{"shape":"AvailabilityZone"}, 560 "AvailabilityZoneId":{"shape":"AvailabilityZoneId"}, 561 "Tags":{"shape":"TagMap"}, 562 "SiteArn":{"shape":"SiteArn"} 563 } 564 }, 565 "OutpostArn":{ 566 "type":"string", 567 "max":255, 568 "min":1, 569 "pattern":"^arn:aws([a-z-]+)?:outposts:[a-z\\d-]+:\\d{12}:outpost/op-[a-f0-9]{17}$" 570 }, 571 "OutpostDescription":{ 572 "type":"string", 573 "max":1000, 574 "min":0, 575 "pattern":"^[\\S ]*$" 576 }, 577 "OutpostId":{ 578 "type":"string", 579 "max":180, 580 "min":1, 581 "pattern":"^(arn:aws([a-z-]+)?:outposts:[a-z\\d-]+:\\d{12}:outpost/)?op-[a-f0-9]{17}$" 582 }, 583 "OutpostIdOnly":{ 584 "type":"string", 585 "max":20, 586 "min":1, 587 "pattern":"^op-[a-f0-9]{17}$" 588 }, 589 "OutpostIdentifier":{ 590 "type":"string", 591 "max":180, 592 "min":1, 593 "pattern":"^(arn:aws([a-z-]+)?:outposts:[a-z\\d-]+:\\d{12}:outpost/)?op-[a-f0-9]{17}$" 594 }, 595 "OutpostName":{ 596 "type":"string", 597 "max":255, 598 "min":1, 599 "pattern":"^[\\S ]+$" 600 }, 601 "OwnerId":{ 602 "type":"string", 603 "max":12, 604 "min":12, 605 "pattern":"\\d{12}" 606 }, 607 "PaymentOption":{ 608 "type":"string", 609 "enum":[ 610 "ALL_UPFRONT", 611 "NO_UPFRONT", 612 "PARTIAL_UPFRONT" 613 ] 614 }, 615 "PaymentTerm":{ 616 "type":"string", 617 "enum":["THREE_YEARS"] 618 }, 619 "ResourceType":{ 620 "type":"string", 621 "enum":["OUTPOST"] 622 }, 623 "ServiceQuotaExceededException":{ 624 "type":"structure", 625 "members":{ 626 "Message":{"shape":"ErrorMessage"} 627 }, 628 "error":{"httpStatusCode":402}, 629 "exception":true 630 }, 631 "Site":{ 632 "type":"structure", 633 "members":{ 634 "SiteId":{"shape":"SiteId"}, 635 "AccountId":{"shape":"AccountId"}, 636 "Name":{"shape":"SiteName"}, 637 "Description":{"shape":"SiteDescription"}, 638 "Tags":{"shape":"TagMap"}, 639 "SiteArn":{"shape":"SiteArn"} 640 } 641 }, 642 "SiteArn":{ 643 "type":"string", 644 "max":255, 645 "min":1, 646 "pattern":"^arn:aws([a-z-]+)?:outposts:[a-z\\d-]+:\\d{12}:site/(os-[a-f0-9]{17})$" 647 }, 648 "SiteDescription":{ 649 "type":"string", 650 "max":1001, 651 "min":1, 652 "pattern":"^[\\S ]+$" 653 }, 654 "SiteId":{ 655 "type":"string", 656 "max":255, 657 "min":1, 658 "pattern":"^(arn:aws([a-z-]+)?:outposts:[a-z\\d-]+:\\d{12}:site/)?(os-[a-f0-9]{17})$" 659 }, 660 "SiteName":{ 661 "type":"string", 662 "max":1000, 663 "min":1, 664 "pattern":"^[\\S ]+$" 665 }, 666 "SkuCode":{ 667 "type":"string", 668 "max":10, 669 "min":1, 670 "pattern":"OR-[A-Z0-9]{7}" 671 }, 672 "Status":{ 673 "type":"string", 674 "max":1000, 675 "min":1, 676 "pattern":"^[\\S ]+$" 677 }, 678 "String":{ 679 "type":"string", 680 "max":1000, 681 "min":1, 682 "pattern":"^[\\S \\n]+$" 683 }, 684 "TagKey":{ 685 "type":"string", 686 "max":128, 687 "min":1, 688 "pattern":"^(?!aws:)[a-zA-Z+-=._:/]+$" 689 }, 690 "TagKeyList":{ 691 "type":"list", 692 "member":{"shape":"TagKey"}, 693 "max":50, 694 "min":1 695 }, 696 "TagMap":{ 697 "type":"map", 698 "key":{"shape":"TagKey"}, 699 "value":{"shape":"TagValue"}, 700 "max":50, 701 "min":1 702 }, 703 "TagResourceRequest":{ 704 "type":"structure", 705 "required":[ 706 "ResourceArn", 707 "Tags" 708 ], 709 "members":{ 710 "ResourceArn":{ 711 "shape":"Arn", 712 "location":"uri", 713 "locationName":"ResourceArn" 714 }, 715 "Tags":{"shape":"TagMap"} 716 } 717 }, 718 "TagResourceResponse":{ 719 "type":"structure", 720 "members":{ 721 } 722 }, 723 "TagValue":{ 724 "type":"string", 725 "max":256, 726 "pattern":"^[\\S \\n]+$" 727 }, 728 "Token":{ 729 "type":"string", 730 "max":1005, 731 "min":1, 732 "pattern":"^(\\d+)##(\\S+)$" 733 }, 734 "UntagResourceRequest":{ 735 "type":"structure", 736 "required":[ 737 "ResourceArn", 738 "TagKeys" 739 ], 740 "members":{ 741 "ResourceArn":{ 742 "shape":"Arn", 743 "location":"uri", 744 "locationName":"ResourceArn" 745 }, 746 "TagKeys":{ 747 "shape":"TagKeyList", 748 "location":"querystring", 749 "locationName":"tagKeys" 750 } 751 } 752 }, 753 "UntagResourceResponse":{ 754 "type":"structure", 755 "members":{ 756 } 757 }, 758 "ValidationException":{ 759 "type":"structure", 760 "members":{ 761 "Message":{"shape":"ErrorMessage"} 762 }, 763 "error":{"httpStatusCode":400}, 764 "exception":true 765 }, 766 "outpostListDefinition":{ 767 "type":"list", 768 "member":{"shape":"Outpost"} 769 }, 770 "siteListDefinition":{ 771 "type":"list", 772 "member":{"shape":"Site"} 773 } 774 } 775 }