ecs-2014-11-13.min.json (23840B)
1 { 2 "version": "2.0", 3 "metadata": { 4 "apiVersion": "2014-11-13", 5 "endpointPrefix": "ecs", 6 "jsonVersion": "1.1", 7 "protocol": "json", 8 "serviceAbbreviation": "Amazon ECS", 9 "serviceFullName": "Amazon EC2 Container Service", 10 "signatureVersion": "v4", 11 "targetPrefix": "AmazonEC2ContainerServiceV20141113" 12 }, 13 "operations": { 14 "CreateCluster": { 15 "input": { 16 "type": "structure", 17 "members": { 18 "clusterName": {} 19 } 20 }, 21 "output": { 22 "type": "structure", 23 "members": { 24 "cluster": { 25 "shape": "S4" 26 } 27 } 28 } 29 }, 30 "CreateService": { 31 "input": { 32 "type": "structure", 33 "required": [ 34 "serviceName", 35 "taskDefinition", 36 "desiredCount" 37 ], 38 "members": { 39 "cluster": {}, 40 "serviceName": {}, 41 "taskDefinition": {}, 42 "loadBalancers": { 43 "shape": "S7" 44 }, 45 "desiredCount": { 46 "type": "integer" 47 }, 48 "clientToken": {}, 49 "role": {}, 50 "deploymentConfiguration": { 51 "shape": "Sa" 52 } 53 } 54 }, 55 "output": { 56 "type": "structure", 57 "members": { 58 "service": { 59 "shape": "Sc" 60 } 61 } 62 } 63 }, 64 "DeleteCluster": { 65 "input": { 66 "type": "structure", 67 "required": [ 68 "cluster" 69 ], 70 "members": { 71 "cluster": {} 72 } 73 }, 74 "output": { 75 "type": "structure", 76 "members": { 77 "cluster": { 78 "shape": "S4" 79 } 80 } 81 } 82 }, 83 "DeleteService": { 84 "input": { 85 "type": "structure", 86 "required": [ 87 "service" 88 ], 89 "members": { 90 "cluster": {}, 91 "service": {} 92 } 93 }, 94 "output": { 95 "type": "structure", 96 "members": { 97 "service": { 98 "shape": "Sc" 99 } 100 } 101 } 102 }, 103 "DeregisterContainerInstance": { 104 "input": { 105 "type": "structure", 106 "required": [ 107 "containerInstance" 108 ], 109 "members": { 110 "cluster": {}, 111 "containerInstance": {}, 112 "force": { 113 "type": "boolean" 114 } 115 } 116 }, 117 "output": { 118 "type": "structure", 119 "members": { 120 "containerInstance": { 121 "shape": "Sp" 122 } 123 } 124 } 125 }, 126 "DeregisterTaskDefinition": { 127 "input": { 128 "type": "structure", 129 "required": [ 130 "taskDefinition" 131 ], 132 "members": { 133 "taskDefinition": {} 134 } 135 }, 136 "output": { 137 "type": "structure", 138 "members": { 139 "taskDefinition": { 140 "shape": "S12" 141 } 142 } 143 } 144 }, 145 "DescribeClusters": { 146 "input": { 147 "type": "structure", 148 "members": { 149 "clusters": { 150 "shape": "Sv" 151 } 152 } 153 }, 154 "output": { 155 "type": "structure", 156 "members": { 157 "clusters": { 158 "type": "list", 159 "member": { 160 "shape": "S4" 161 } 162 }, 163 "failures": { 164 "shape": "S1w" 165 } 166 } 167 } 168 }, 169 "DescribeContainerInstances": { 170 "input": { 171 "type": "structure", 172 "required": [ 173 "containerInstances" 174 ], 175 "members": { 176 "cluster": {}, 177 "containerInstances": { 178 "shape": "Sv" 179 } 180 } 181 }, 182 "output": { 183 "type": "structure", 184 "members": { 185 "containerInstances": { 186 "type": "list", 187 "member": { 188 "shape": "Sp" 189 } 190 }, 191 "failures": { 192 "shape": "S1w" 193 } 194 } 195 } 196 }, 197 "DescribeServices": { 198 "input": { 199 "type": "structure", 200 "required": [ 201 "services" 202 ], 203 "members": { 204 "cluster": {}, 205 "services": { 206 "shape": "Sv" 207 } 208 } 209 }, 210 "output": { 211 "type": "structure", 212 "members": { 213 "services": { 214 "type": "list", 215 "member": { 216 "shape": "Sc" 217 } 218 }, 219 "failures": { 220 "shape": "S1w" 221 } 222 } 223 } 224 }, 225 "DescribeTaskDefinition": { 226 "input": { 227 "type": "structure", 228 "required": [ 229 "taskDefinition" 230 ], 231 "members": { 232 "taskDefinition": {} 233 } 234 }, 235 "output": { 236 "type": "structure", 237 "members": { 238 "taskDefinition": { 239 "shape": "S12" 240 } 241 } 242 } 243 }, 244 "DescribeTasks": { 245 "input": { 246 "type": "structure", 247 "required": [ 248 "tasks" 249 ], 250 "members": { 251 "cluster": {}, 252 "tasks": { 253 "shape": "Sv" 254 } 255 } 256 }, 257 "output": { 258 "type": "structure", 259 "members": { 260 "tasks": { 261 "shape": "S28" 262 }, 263 "failures": { 264 "shape": "S1w" 265 } 266 } 267 } 268 }, 269 "DiscoverPollEndpoint": { 270 "input": { 271 "type": "structure", 272 "members": { 273 "containerInstance": {}, 274 "cluster": {} 275 } 276 }, 277 "output": { 278 "type": "structure", 279 "members": { 280 "endpoint": {}, 281 "telemetryEndpoint": {} 282 } 283 } 284 }, 285 "ListClusters": { 286 "input": { 287 "type": "structure", 288 "members": { 289 "nextToken": {}, 290 "maxResults": { 291 "type": "integer" 292 } 293 } 294 }, 295 "output": { 296 "type": "structure", 297 "members": { 298 "clusterArns": { 299 "shape": "Sv" 300 }, 301 "nextToken": {} 302 } 303 } 304 }, 305 "ListContainerInstances": { 306 "input": { 307 "type": "structure", 308 "members": { 309 "cluster": {}, 310 "nextToken": {}, 311 "maxResults": { 312 "type": "integer" 313 } 314 } 315 }, 316 "output": { 317 "type": "structure", 318 "members": { 319 "containerInstanceArns": { 320 "shape": "Sv" 321 }, 322 "nextToken": {} 323 } 324 } 325 }, 326 "ListServices": { 327 "input": { 328 "type": "structure", 329 "members": { 330 "cluster": {}, 331 "nextToken": {}, 332 "maxResults": { 333 "type": "integer" 334 } 335 } 336 }, 337 "output": { 338 "type": "structure", 339 "members": { 340 "serviceArns": { 341 "shape": "Sv" 342 }, 343 "nextToken": {} 344 } 345 } 346 }, 347 "ListTaskDefinitionFamilies": { 348 "input": { 349 "type": "structure", 350 "members": { 351 "familyPrefix": {}, 352 "status": {}, 353 "nextToken": {}, 354 "maxResults": { 355 "type": "integer" 356 } 357 } 358 }, 359 "output": { 360 "type": "structure", 361 "members": { 362 "families": { 363 "shape": "Sv" 364 }, 365 "nextToken": {} 366 } 367 } 368 }, 369 "ListTaskDefinitions": { 370 "input": { 371 "type": "structure", 372 "members": { 373 "familyPrefix": {}, 374 "status": {}, 375 "sort": {}, 376 "nextToken": {}, 377 "maxResults": { 378 "type": "integer" 379 } 380 } 381 }, 382 "output": { 383 "type": "structure", 384 "members": { 385 "taskDefinitionArns": { 386 "shape": "Sv" 387 }, 388 "nextToken": {} 389 } 390 } 391 }, 392 "ListTasks": { 393 "input": { 394 "type": "structure", 395 "members": { 396 "cluster": {}, 397 "containerInstance": {}, 398 "family": {}, 399 "nextToken": {}, 400 "maxResults": { 401 "type": "integer" 402 }, 403 "startedBy": {}, 404 "serviceName": {}, 405 "desiredStatus": {} 406 } 407 }, 408 "output": { 409 "type": "structure", 410 "members": { 411 "taskArns": { 412 "shape": "Sv" 413 }, 414 "nextToken": {} 415 } 416 } 417 }, 418 "RegisterContainerInstance": { 419 "input": { 420 "type": "structure", 421 "members": { 422 "cluster": {}, 423 "instanceIdentityDocument": {}, 424 "instanceIdentityDocumentSignature": {}, 425 "totalResources": { 426 "shape": "Ss" 427 }, 428 "versionInfo": { 429 "shape": "Sr" 430 }, 431 "containerInstanceArn": {}, 432 "attributes": { 433 "shape": "Sy" 434 } 435 } 436 }, 437 "output": { 438 "type": "structure", 439 "members": { 440 "containerInstance": { 441 "shape": "Sp" 442 } 443 } 444 } 445 }, 446 "RegisterTaskDefinition": { 447 "input": { 448 "type": "structure", 449 "required": [ 450 "family", 451 "containerDefinitions" 452 ], 453 "members": { 454 "family": {}, 455 "taskRoleArn": {}, 456 "networkMode": {}, 457 "containerDefinitions": { 458 "shape": "S13" 459 }, 460 "volumes": { 461 "shape": "S1o" 462 } 463 } 464 }, 465 "output": { 466 "type": "structure", 467 "members": { 468 "taskDefinition": { 469 "shape": "S12" 470 } 471 } 472 } 473 }, 474 "RunTask": { 475 "input": { 476 "type": "structure", 477 "required": [ 478 "taskDefinition" 479 ], 480 "members": { 481 "cluster": {}, 482 "taskDefinition": {}, 483 "overrides": { 484 "shape": "S2a" 485 }, 486 "count": { 487 "type": "integer" 488 }, 489 "startedBy": {} 490 } 491 }, 492 "output": { 493 "type": "structure", 494 "members": { 495 "tasks": { 496 "shape": "S28" 497 }, 498 "failures": { 499 "shape": "S1w" 500 } 501 } 502 } 503 }, 504 "StartTask": { 505 "input": { 506 "type": "structure", 507 "required": [ 508 "taskDefinition", 509 "containerInstances" 510 ], 511 "members": { 512 "cluster": {}, 513 "taskDefinition": {}, 514 "overrides": { 515 "shape": "S2a" 516 }, 517 "containerInstances": { 518 "shape": "Sv" 519 }, 520 "startedBy": {} 521 } 522 }, 523 "output": { 524 "type": "structure", 525 "members": { 526 "tasks": { 527 "shape": "S28" 528 }, 529 "failures": { 530 "shape": "S1w" 531 } 532 } 533 } 534 }, 535 "StopTask": { 536 "input": { 537 "type": "structure", 538 "required": [ 539 "task" 540 ], 541 "members": { 542 "cluster": {}, 543 "task": {}, 544 "reason": {} 545 } 546 }, 547 "output": { 548 "type": "structure", 549 "members": { 550 "task": { 551 "shape": "S29" 552 } 553 } 554 } 555 }, 556 "SubmitContainerStateChange": { 557 "input": { 558 "type": "structure", 559 "members": { 560 "cluster": {}, 561 "task": {}, 562 "containerName": {}, 563 "status": {}, 564 "exitCode": { 565 "type": "integer" 566 }, 567 "reason": {}, 568 "networkBindings": { 569 "shape": "S2f" 570 } 571 } 572 }, 573 "output": { 574 "type": "structure", 575 "members": { 576 "acknowledgment": {} 577 } 578 } 579 }, 580 "SubmitTaskStateChange": { 581 "input": { 582 "type": "structure", 583 "members": { 584 "cluster": {}, 585 "task": {}, 586 "status": {}, 587 "reason": {} 588 } 589 }, 590 "output": { 591 "type": "structure", 592 "members": { 593 "acknowledgment": {} 594 } 595 } 596 }, 597 "UpdateContainerAgent": { 598 "input": { 599 "type": "structure", 600 "required": [ 601 "containerInstance" 602 ], 603 "members": { 604 "cluster": {}, 605 "containerInstance": {} 606 } 607 }, 608 "output": { 609 "type": "structure", 610 "members": { 611 "containerInstance": { 612 "shape": "Sp" 613 } 614 } 615 } 616 }, 617 "UpdateService": { 618 "input": { 619 "type": "structure", 620 "required": [ 621 "service" 622 ], 623 "members": { 624 "cluster": {}, 625 "service": {}, 626 "desiredCount": { 627 "type": "integer" 628 }, 629 "taskDefinition": {}, 630 "deploymentConfiguration": { 631 "shape": "Sa" 632 } 633 } 634 }, 635 "output": { 636 "type": "structure", 637 "members": { 638 "service": { 639 "shape": "Sc" 640 } 641 } 642 } 643 } 644 }, 645 "shapes": { 646 "S4": { 647 "type": "structure", 648 "members": { 649 "clusterArn": {}, 650 "clusterName": {}, 651 "status": {}, 652 "registeredContainerInstancesCount": { 653 "type": "integer" 654 }, 655 "runningTasksCount": { 656 "type": "integer" 657 }, 658 "pendingTasksCount": { 659 "type": "integer" 660 }, 661 "activeServicesCount": { 662 "type": "integer" 663 } 664 } 665 }, 666 "S7": { 667 "type": "list", 668 "member": { 669 "type": "structure", 670 "members": { 671 "targetGroupArn": {}, 672 "loadBalancerName": {}, 673 "containerName": {}, 674 "containerPort": { 675 "type": "integer" 676 } 677 } 678 } 679 }, 680 "Sa": { 681 "type": "structure", 682 "members": { 683 "maximumPercent": { 684 "type": "integer" 685 }, 686 "minimumHealthyPercent": { 687 "type": "integer" 688 } 689 } 690 }, 691 "Sc": { 692 "type": "structure", 693 "members": { 694 "serviceArn": {}, 695 "serviceName": {}, 696 "clusterArn": {}, 697 "loadBalancers": { 698 "shape": "S7" 699 }, 700 "status": {}, 701 "desiredCount": { 702 "type": "integer" 703 }, 704 "runningCount": { 705 "type": "integer" 706 }, 707 "pendingCount": { 708 "type": "integer" 709 }, 710 "taskDefinition": {}, 711 "deploymentConfiguration": { 712 "shape": "Sa" 713 }, 714 "deployments": { 715 "type": "list", 716 "member": { 717 "type": "structure", 718 "members": { 719 "id": {}, 720 "status": {}, 721 "taskDefinition": {}, 722 "desiredCount": { 723 "type": "integer" 724 }, 725 "pendingCount": { 726 "type": "integer" 727 }, 728 "runningCount": { 729 "type": "integer" 730 }, 731 "createdAt": { 732 "type": "timestamp" 733 }, 734 "updatedAt": { 735 "type": "timestamp" 736 } 737 } 738 } 739 }, 740 "roleArn": {}, 741 "events": { 742 "type": "list", 743 "member": { 744 "type": "structure", 745 "members": { 746 "id": {}, 747 "createdAt": { 748 "type": "timestamp" 749 }, 750 "message": {} 751 } 752 } 753 }, 754 "createdAt": { 755 "type": "timestamp" 756 } 757 } 758 }, 759 "Sp": { 760 "type": "structure", 761 "members": { 762 "containerInstanceArn": {}, 763 "ec2InstanceId": {}, 764 "version": { 765 "type": "long" 766 }, 767 "versionInfo": { 768 "shape": "Sr" 769 }, 770 "remainingResources": { 771 "shape": "Ss" 772 }, 773 "registeredResources": { 774 "shape": "Ss" 775 }, 776 "status": {}, 777 "agentConnected": { 778 "type": "boolean" 779 }, 780 "runningTasksCount": { 781 "type": "integer" 782 }, 783 "pendingTasksCount": { 784 "type": "integer" 785 }, 786 "agentUpdateStatus": {}, 787 "attributes": { 788 "shape": "Sy" 789 } 790 } 791 }, 792 "Sr": { 793 "type": "structure", 794 "members": { 795 "agentVersion": {}, 796 "agentHash": {}, 797 "dockerVersion": {} 798 } 799 }, 800 "Ss": { 801 "type": "list", 802 "member": { 803 "type": "structure", 804 "members": { 805 "name": {}, 806 "type": {}, 807 "doubleValue": { 808 "type": "double" 809 }, 810 "longValue": { 811 "type": "long" 812 }, 813 "integerValue": { 814 "type": "integer" 815 }, 816 "stringSetValue": { 817 "shape": "Sv" 818 } 819 } 820 } 821 }, 822 "Sv": { 823 "type": "list", 824 "member": {} 825 }, 826 "Sy": { 827 "type": "list", 828 "member": { 829 "shape": "Sz" 830 } 831 }, 832 "Sz": { 833 "type": "structure", 834 "required": [ 835 "name" 836 ], 837 "members": { 838 "name": {}, 839 "value": {} 840 } 841 }, 842 "S12": { 843 "type": "structure", 844 "members": { 845 "taskDefinitionArn": {}, 846 "containerDefinitions": { 847 "shape": "S13" 848 }, 849 "family": {}, 850 "taskRoleArn": {}, 851 "networkMode": {}, 852 "revision": { 853 "type": "integer" 854 }, 855 "volumes": { 856 "shape": "S1o" 857 }, 858 "status": {}, 859 "requiresAttributes": { 860 "type": "list", 861 "member": { 862 "shape": "Sz" 863 } 864 } 865 } 866 }, 867 "S13": { 868 "type": "list", 869 "member": { 870 "type": "structure", 871 "members": { 872 "name": {}, 873 "image": {}, 874 "cpu": { 875 "type": "integer" 876 }, 877 "memory": { 878 "type": "integer" 879 }, 880 "memoryReservation": { 881 "type": "integer" 882 }, 883 "links": { 884 "shape": "Sv" 885 }, 886 "portMappings": { 887 "type": "list", 888 "member": { 889 "type": "structure", 890 "members": { 891 "containerPort": { 892 "type": "integer" 893 }, 894 "hostPort": { 895 "type": "integer" 896 }, 897 "protocol": {} 898 } 899 } 900 }, 901 "essential": { 902 "type": "boolean" 903 }, 904 "entryPoint": { 905 "shape": "Sv" 906 }, 907 "command": { 908 "shape": "Sv" 909 }, 910 "environment": { 911 "shape": "S18" 912 }, 913 "mountPoints": { 914 "type": "list", 915 "member": { 916 "type": "structure", 917 "members": { 918 "sourceVolume": {}, 919 "containerPath": {}, 920 "readOnly": { 921 "type": "boolean" 922 } 923 } 924 } 925 }, 926 "volumesFrom": { 927 "type": "list", 928 "member": { 929 "type": "structure", 930 "members": { 931 "sourceContainer": {}, 932 "readOnly": { 933 "type": "boolean" 934 } 935 } 936 } 937 }, 938 "hostname": {}, 939 "user": {}, 940 "workingDirectory": {}, 941 "disableNetworking": { 942 "type": "boolean" 943 }, 944 "privileged": { 945 "type": "boolean" 946 }, 947 "readonlyRootFilesystem": { 948 "type": "boolean" 949 }, 950 "dnsServers": { 951 "shape": "Sv" 952 }, 953 "dnsSearchDomains": { 954 "shape": "Sv" 955 }, 956 "extraHosts": { 957 "type": "list", 958 "member": { 959 "type": "structure", 960 "required": [ 961 "hostname", 962 "ipAddress" 963 ], 964 "members": { 965 "hostname": {}, 966 "ipAddress": {} 967 } 968 } 969 }, 970 "dockerSecurityOptions": { 971 "shape": "Sv" 972 }, 973 "dockerLabels": { 974 "type": "map", 975 "key": {}, 976 "value": {} 977 }, 978 "ulimits": { 979 "type": "list", 980 "member": { 981 "type": "structure", 982 "required": [ 983 "name", 984 "softLimit", 985 "hardLimit" 986 ], 987 "members": { 988 "name": {}, 989 "softLimit": { 990 "type": "integer" 991 }, 992 "hardLimit": { 993 "type": "integer" 994 } 995 } 996 } 997 }, 998 "logConfiguration": { 999 "type": "structure", 1000 "required": [ 1001 "logDriver" 1002 ], 1003 "members": { 1004 "logDriver": {}, 1005 "options": { 1006 "type": "map", 1007 "key": {}, 1008 "value": {} 1009 } 1010 } 1011 } 1012 } 1013 } 1014 }, 1015 "S18": { 1016 "type": "list", 1017 "member": { 1018 "type": "structure", 1019 "members": { 1020 "name": {}, 1021 "value": {} 1022 } 1023 } 1024 }, 1025 "S1o": { 1026 "type": "list", 1027 "member": { 1028 "type": "structure", 1029 "members": { 1030 "name": {}, 1031 "host": { 1032 "type": "structure", 1033 "members": { 1034 "sourcePath": {} 1035 } 1036 } 1037 } 1038 } 1039 }, 1040 "S1w": { 1041 "type": "list", 1042 "member": { 1043 "type": "structure", 1044 "members": { 1045 "arn": {}, 1046 "reason": {} 1047 } 1048 } 1049 }, 1050 "S28": { 1051 "type": "list", 1052 "member": { 1053 "shape": "S29" 1054 } 1055 }, 1056 "S29": { 1057 "type": "structure", 1058 "members": { 1059 "taskArn": {}, 1060 "clusterArn": {}, 1061 "taskDefinitionArn": {}, 1062 "containerInstanceArn": {}, 1063 "overrides": { 1064 "shape": "S2a" 1065 }, 1066 "lastStatus": {}, 1067 "desiredStatus": {}, 1068 "containers": { 1069 "type": "list", 1070 "member": { 1071 "type": "structure", 1072 "members": { 1073 "containerArn": {}, 1074 "taskArn": {}, 1075 "name": {}, 1076 "lastStatus": {}, 1077 "exitCode": { 1078 "type": "integer" 1079 }, 1080 "reason": {}, 1081 "networkBindings": { 1082 "shape": "S2f" 1083 } 1084 } 1085 } 1086 }, 1087 "startedBy": {}, 1088 "version": { 1089 "type": "long" 1090 }, 1091 "stoppedReason": {}, 1092 "createdAt": { 1093 "type": "timestamp" 1094 }, 1095 "startedAt": { 1096 "type": "timestamp" 1097 }, 1098 "stoppedAt": { 1099 "type": "timestamp" 1100 } 1101 } 1102 }, 1103 "S2a": { 1104 "type": "structure", 1105 "members": { 1106 "containerOverrides": { 1107 "type": "list", 1108 "member": { 1109 "type": "structure", 1110 "members": { 1111 "name": {}, 1112 "command": { 1113 "shape": "Sv" 1114 }, 1115 "environment": { 1116 "shape": "S18" 1117 } 1118 } 1119 } 1120 }, 1121 "taskRoleArn": {} 1122 } 1123 }, 1124 "S2f": { 1125 "type": "list", 1126 "member": { 1127 "type": "structure", 1128 "members": { 1129 "bindIP": {}, 1130 "containerPort": { 1131 "type": "integer" 1132 }, 1133 "hostPort": { 1134 "type": "integer" 1135 }, 1136 "protocol": {} 1137 } 1138 } 1139 } 1140 } 1141 }