ssm-2014-11-06.min.json (20303B)
1 { 2 "version": "2.0", 3 "metadata": { 4 "apiVersion": "2014-11-06", 5 "endpointPrefix": "ssm", 6 "jsonVersion": "1.1", 7 "protocol": "json", 8 "serviceAbbreviation": "Amazon SSM", 9 "serviceFullName": "Amazon Simple Systems Management Service", 10 "signatureVersion": "v4", 11 "targetPrefix": "AmazonSSM" 12 }, 13 "operations": { 14 "AddTagsToResource": { 15 "input": { 16 "type": "structure", 17 "required": [ 18 "ResourceType", 19 "ResourceId", 20 "Tags" 21 ], 22 "members": { 23 "ResourceType": {}, 24 "ResourceId": {}, 25 "Tags": { 26 "shape": "S4" 27 } 28 } 29 }, 30 "output": { 31 "type": "structure", 32 "members": {} 33 } 34 }, 35 "CancelCommand": { 36 "input": { 37 "type": "structure", 38 "required": [ 39 "CommandId" 40 ], 41 "members": { 42 "CommandId": {}, 43 "InstanceIds": { 44 "shape": "Sb" 45 } 46 } 47 }, 48 "output": { 49 "type": "structure", 50 "members": {} 51 } 52 }, 53 "CreateActivation": { 54 "input": { 55 "type": "structure", 56 "required": [ 57 "IamRole" 58 ], 59 "members": { 60 "Description": {}, 61 "DefaultInstanceName": {}, 62 "IamRole": {}, 63 "RegistrationLimit": { 64 "type": "integer" 65 }, 66 "ExpirationDate": { 67 "type": "timestamp" 68 } 69 } 70 }, 71 "output": { 72 "type": "structure", 73 "members": { 74 "ActivationId": {}, 75 "ActivationCode": {} 76 } 77 } 78 }, 79 "CreateAssociation": { 80 "input": { 81 "type": "structure", 82 "required": [ 83 "Name", 84 "InstanceId" 85 ], 86 "members": { 87 "Name": {}, 88 "InstanceId": {}, 89 "Parameters": { 90 "shape": "Sp" 91 } 92 } 93 }, 94 "output": { 95 "type": "structure", 96 "members": { 97 "AssociationDescription": { 98 "shape": "Su" 99 } 100 } 101 } 102 }, 103 "CreateAssociationBatch": { 104 "input": { 105 "type": "structure", 106 "required": [ 107 "Entries" 108 ], 109 "members": { 110 "Entries": { 111 "type": "list", 112 "member": { 113 "shape": "S12", 114 "locationName": "entries" 115 } 116 } 117 } 118 }, 119 "output": { 120 "type": "structure", 121 "members": { 122 "Successful": { 123 "type": "list", 124 "member": { 125 "shape": "Su", 126 "locationName": "AssociationDescription" 127 } 128 }, 129 "Failed": { 130 "type": "list", 131 "member": { 132 "locationName": "FailedCreateAssociationEntry", 133 "type": "structure", 134 "members": { 135 "Entry": { 136 "shape": "S12" 137 }, 138 "Message": {}, 139 "Fault": {} 140 } 141 } 142 } 143 } 144 } 145 }, 146 "CreateDocument": { 147 "input": { 148 "type": "structure", 149 "required": [ 150 "Content", 151 "Name" 152 ], 153 "members": { 154 "Content": {}, 155 "Name": {} 156 } 157 }, 158 "output": { 159 "type": "structure", 160 "members": { 161 "DocumentDescription": { 162 "shape": "S1c" 163 } 164 } 165 } 166 }, 167 "DeleteActivation": { 168 "input": { 169 "type": "structure", 170 "required": [ 171 "ActivationId" 172 ], 173 "members": { 174 "ActivationId": {} 175 } 176 }, 177 "output": { 178 "type": "structure", 179 "members": {} 180 } 181 }, 182 "DeleteAssociation": { 183 "input": { 184 "type": "structure", 185 "required": [ 186 "Name", 187 "InstanceId" 188 ], 189 "members": { 190 "Name": {}, 191 "InstanceId": {} 192 } 193 }, 194 "output": { 195 "type": "structure", 196 "members": {} 197 } 198 }, 199 "DeleteDocument": { 200 "input": { 201 "type": "structure", 202 "required": [ 203 "Name" 204 ], 205 "members": { 206 "Name": {} 207 } 208 }, 209 "output": { 210 "type": "structure", 211 "members": {} 212 } 213 }, 214 "DeregisterManagedInstance": { 215 "input": { 216 "type": "structure", 217 "required": [ 218 "InstanceId" 219 ], 220 "members": { 221 "InstanceId": {} 222 } 223 }, 224 "output": { 225 "type": "structure", 226 "members": {} 227 } 228 }, 229 "DescribeActivations": { 230 "input": { 231 "type": "structure", 232 "members": { 233 "Filters": { 234 "type": "list", 235 "member": { 236 "type": "structure", 237 "members": { 238 "FilterKey": {}, 239 "FilterValues": { 240 "type": "list", 241 "member": {} 242 } 243 } 244 } 245 }, 246 "MaxResults": { 247 "type": "integer" 248 }, 249 "NextToken": {} 250 } 251 }, 252 "output": { 253 "type": "structure", 254 "members": { 255 "ActivationList": { 256 "type": "list", 257 "member": { 258 "type": "structure", 259 "members": { 260 "ActivationId": {}, 261 "Description": {}, 262 "DefaultInstanceName": {}, 263 "IamRole": {}, 264 "RegistrationLimit": { 265 "type": "integer" 266 }, 267 "RegistrationsCount": { 268 "type": "integer" 269 }, 270 "ExpirationDate": { 271 "type": "timestamp" 272 }, 273 "Expired": { 274 "type": "boolean" 275 }, 276 "CreatedDate": { 277 "type": "timestamp" 278 } 279 } 280 } 281 }, 282 "NextToken": {} 283 } 284 } 285 }, 286 "DescribeAssociation": { 287 "input": { 288 "type": "structure", 289 "required": [ 290 "Name", 291 "InstanceId" 292 ], 293 "members": { 294 "Name": {}, 295 "InstanceId": {} 296 } 297 }, 298 "output": { 299 "type": "structure", 300 "members": { 301 "AssociationDescription": { 302 "shape": "Su" 303 } 304 } 305 } 306 }, 307 "DescribeDocument": { 308 "input": { 309 "type": "structure", 310 "required": [ 311 "Name" 312 ], 313 "members": { 314 "Name": {} 315 } 316 }, 317 "output": { 318 "type": "structure", 319 "members": { 320 "Document": { 321 "shape": "S1c" 322 } 323 } 324 } 325 }, 326 "DescribeDocumentPermission": { 327 "input": { 328 "type": "structure", 329 "required": [ 330 "Name", 331 "PermissionType" 332 ], 333 "members": { 334 "Name": {}, 335 "PermissionType": {} 336 } 337 }, 338 "output": { 339 "type": "structure", 340 "members": { 341 "AccountIds": { 342 "shape": "S2m" 343 } 344 } 345 } 346 }, 347 "DescribeInstanceInformation": { 348 "input": { 349 "type": "structure", 350 "members": { 351 "InstanceInformationFilterList": { 352 "type": "list", 353 "member": { 354 "locationName": "InstanceInformationFilter", 355 "type": "structure", 356 "required": [ 357 "key", 358 "valueSet" 359 ], 360 "members": { 361 "key": {}, 362 "valueSet": { 363 "type": "list", 364 "member": { 365 "locationName": "InstanceInformationFilterValue" 366 } 367 } 368 } 369 } 370 }, 371 "MaxResults": { 372 "type": "integer" 373 }, 374 "NextToken": {} 375 } 376 }, 377 "output": { 378 "type": "structure", 379 "members": { 380 "InstanceInformationList": { 381 "type": "list", 382 "member": { 383 "locationName": "InstanceInformation", 384 "type": "structure", 385 "members": { 386 "InstanceId": {}, 387 "PingStatus": {}, 388 "LastPingDateTime": { 389 "type": "timestamp" 390 }, 391 "AgentVersion": {}, 392 "IsLatestVersion": { 393 "type": "boolean" 394 }, 395 "PlatformType": {}, 396 "PlatformName": {}, 397 "PlatformVersion": {}, 398 "ActivationId": {}, 399 "IamRole": {}, 400 "RegistrationDate": { 401 "type": "timestamp" 402 }, 403 "ResourceType": {}, 404 "Name": {}, 405 "IPAddress": {}, 406 "ComputerName": {} 407 } 408 } 409 }, 410 "NextToken": {} 411 } 412 } 413 }, 414 "GetDocument": { 415 "input": { 416 "type": "structure", 417 "required": [ 418 "Name" 419 ], 420 "members": { 421 "Name": {} 422 } 423 }, 424 "output": { 425 "type": "structure", 426 "members": { 427 "Name": {}, 428 "Content": {} 429 } 430 } 431 }, 432 "ListAssociations": { 433 "input": { 434 "type": "structure", 435 "required": [ 436 "AssociationFilterList" 437 ], 438 "members": { 439 "AssociationFilterList": { 440 "type": "list", 441 "member": { 442 "locationName": "AssociationFilter", 443 "type": "structure", 444 "required": [ 445 "key", 446 "value" 447 ], 448 "members": { 449 "key": {}, 450 "value": {} 451 } 452 } 453 }, 454 "MaxResults": { 455 "type": "integer" 456 }, 457 "NextToken": {} 458 } 459 }, 460 "output": { 461 "type": "structure", 462 "members": { 463 "Associations": { 464 "type": "list", 465 "member": { 466 "locationName": "Association", 467 "type": "structure", 468 "members": { 469 "Name": {}, 470 "InstanceId": {} 471 } 472 } 473 }, 474 "NextToken": {} 475 } 476 } 477 }, 478 "ListCommandInvocations": { 479 "input": { 480 "type": "structure", 481 "members": { 482 "CommandId": {}, 483 "InstanceId": {}, 484 "MaxResults": { 485 "type": "integer" 486 }, 487 "NextToken": {}, 488 "Filters": { 489 "shape": "S3f" 490 }, 491 "Details": { 492 "type": "boolean" 493 } 494 } 495 }, 496 "output": { 497 "type": "structure", 498 "members": { 499 "CommandInvocations": { 500 "type": "list", 501 "member": { 502 "type": "structure", 503 "members": { 504 "CommandId": {}, 505 "InstanceId": {}, 506 "Comment": {}, 507 "DocumentName": {}, 508 "RequestedDateTime": { 509 "type": "timestamp" 510 }, 511 "Status": {}, 512 "TraceOutput": {}, 513 "CommandPlugins": { 514 "type": "list", 515 "member": { 516 "type": "structure", 517 "members": { 518 "Name": {}, 519 "Status": {}, 520 "ResponseCode": { 521 "type": "integer" 522 }, 523 "ResponseStartDateTime": { 524 "type": "timestamp" 525 }, 526 "ResponseFinishDateTime": { 527 "type": "timestamp" 528 }, 529 "Output": {}, 530 "OutputS3BucketName": {}, 531 "OutputS3KeyPrefix": {} 532 } 533 } 534 }, 535 "ServiceRole": {}, 536 "NotificationConfig": { 537 "shape": "S3y" 538 } 539 } 540 } 541 }, 542 "NextToken": {} 543 } 544 } 545 }, 546 "ListCommands": { 547 "input": { 548 "type": "structure", 549 "members": { 550 "CommandId": {}, 551 "InstanceId": {}, 552 "MaxResults": { 553 "type": "integer" 554 }, 555 "NextToken": {}, 556 "Filters": { 557 "shape": "S3f" 558 } 559 } 560 }, 561 "output": { 562 "type": "structure", 563 "members": { 564 "Commands": { 565 "type": "list", 566 "member": { 567 "shape": "S46" 568 } 569 }, 570 "NextToken": {} 571 } 572 } 573 }, 574 "ListDocuments": { 575 "input": { 576 "type": "structure", 577 "members": { 578 "DocumentFilterList": { 579 "type": "list", 580 "member": { 581 "locationName": "DocumentFilter", 582 "type": "structure", 583 "required": [ 584 "key", 585 "value" 586 ], 587 "members": { 588 "key": {}, 589 "value": {} 590 } 591 } 592 }, 593 "MaxResults": { 594 "type": "integer" 595 }, 596 "NextToken": {} 597 } 598 }, 599 "output": { 600 "type": "structure", 601 "members": { 602 "DocumentIdentifiers": { 603 "type": "list", 604 "member": { 605 "locationName": "DocumentIdentifier", 606 "type": "structure", 607 "members": { 608 "Name": {}, 609 "Owner": {}, 610 "PlatformTypes": { 611 "shape": "S1q" 612 } 613 } 614 } 615 }, 616 "NextToken": {} 617 } 618 } 619 }, 620 "ListTagsForResource": { 621 "input": { 622 "type": "structure", 623 "required": [ 624 "ResourceType", 625 "ResourceId" 626 ], 627 "members": { 628 "ResourceType": {}, 629 "ResourceId": {} 630 } 631 }, 632 "output": { 633 "type": "structure", 634 "members": { 635 "TagList": { 636 "shape": "S4" 637 } 638 } 639 } 640 }, 641 "ModifyDocumentPermission": { 642 "input": { 643 "type": "structure", 644 "required": [ 645 "Name", 646 "PermissionType" 647 ], 648 "members": { 649 "Name": {}, 650 "PermissionType": {}, 651 "AccountIdsToAdd": { 652 "shape": "S2m" 653 }, 654 "AccountIdsToRemove": { 655 "shape": "S2m" 656 } 657 } 658 }, 659 "output": { 660 "type": "structure", 661 "members": {} 662 } 663 }, 664 "RemoveTagsFromResource": { 665 "input": { 666 "type": "structure", 667 "required": [ 668 "ResourceType", 669 "ResourceId", 670 "TagKeys" 671 ], 672 "members": { 673 "ResourceType": {}, 674 "ResourceId": {}, 675 "TagKeys": { 676 "type": "list", 677 "member": {} 678 } 679 } 680 }, 681 "output": { 682 "type": "structure", 683 "members": {} 684 } 685 }, 686 "SendCommand": { 687 "input": { 688 "type": "structure", 689 "required": [ 690 "InstanceIds", 691 "DocumentName" 692 ], 693 "members": { 694 "InstanceIds": { 695 "shape": "Sb" 696 }, 697 "DocumentName": {}, 698 "DocumentHash": {}, 699 "DocumentHashType": {}, 700 "TimeoutSeconds": { 701 "type": "integer" 702 }, 703 "Comment": {}, 704 "Parameters": { 705 "shape": "Sp" 706 }, 707 "OutputS3BucketName": {}, 708 "OutputS3KeyPrefix": {}, 709 "ServiceRoleArn": {}, 710 "NotificationConfig": { 711 "shape": "S3y" 712 } 713 } 714 }, 715 "output": { 716 "type": "structure", 717 "members": { 718 "Command": { 719 "shape": "S46" 720 } 721 } 722 } 723 }, 724 "UpdateAssociationStatus": { 725 "input": { 726 "type": "structure", 727 "required": [ 728 "Name", 729 "InstanceId", 730 "AssociationStatus" 731 ], 732 "members": { 733 "Name": {}, 734 "InstanceId": {}, 735 "AssociationStatus": { 736 "shape": "Sw" 737 } 738 } 739 }, 740 "output": { 741 "type": "structure", 742 "members": { 743 "AssociationDescription": { 744 "shape": "Su" 745 } 746 } 747 } 748 }, 749 "UpdateManagedInstanceRole": { 750 "input": { 751 "type": "structure", 752 "required": [ 753 "InstanceId", 754 "IamRole" 755 ], 756 "members": { 757 "InstanceId": {}, 758 "IamRole": {} 759 } 760 }, 761 "output": { 762 "type": "structure", 763 "members": {} 764 } 765 } 766 }, 767 "shapes": { 768 "S4": { 769 "type": "list", 770 "member": { 771 "type": "structure", 772 "required": [ 773 "Key", 774 "Value" 775 ], 776 "members": { 777 "Key": {}, 778 "Value": {} 779 } 780 } 781 }, 782 "Sb": { 783 "type": "list", 784 "member": {} 785 }, 786 "Sp": { 787 "type": "map", 788 "key": {}, 789 "value": { 790 "type": "list", 791 "member": {} 792 } 793 }, 794 "Su": { 795 "type": "structure", 796 "members": { 797 "Name": {}, 798 "InstanceId": {}, 799 "Date": { 800 "type": "timestamp" 801 }, 802 "Status": { 803 "shape": "Sw" 804 }, 805 "Parameters": { 806 "shape": "Sp" 807 } 808 } 809 }, 810 "Sw": { 811 "type": "structure", 812 "required": [ 813 "Date", 814 "Name", 815 "Message" 816 ], 817 "members": { 818 "Date": { 819 "type": "timestamp" 820 }, 821 "Name": {}, 822 "Message": {}, 823 "AdditionalInfo": {} 824 } 825 }, 826 "S12": { 827 "type": "structure", 828 "members": { 829 "Name": {}, 830 "InstanceId": {}, 831 "Parameters": { 832 "shape": "Sp" 833 } 834 } 835 }, 836 "S1c": { 837 "type": "structure", 838 "members": { 839 "Sha1": {}, 840 "Hash": {}, 841 "HashType": {}, 842 "Name": {}, 843 "Owner": {}, 844 "CreatedDate": { 845 "type": "timestamp" 846 }, 847 "Status": {}, 848 "Description": {}, 849 "Parameters": { 850 "type": "list", 851 "member": { 852 "locationName": "DocumentParameter", 853 "type": "structure", 854 "members": { 855 "Name": {}, 856 "Type": {}, 857 "Description": {}, 858 "DefaultValue": {} 859 } 860 } 861 }, 862 "PlatformTypes": { 863 "shape": "S1q" 864 } 865 } 866 }, 867 "S1q": { 868 "type": "list", 869 "member": { 870 "locationName": "PlatformType" 871 } 872 }, 873 "S2m": { 874 "type": "list", 875 "member": { 876 "locationName": "AccountId" 877 } 878 }, 879 "S3f": { 880 "type": "list", 881 "member": { 882 "type": "structure", 883 "required": [ 884 "key", 885 "value" 886 ], 887 "members": { 888 "key": {}, 889 "value": {} 890 } 891 } 892 }, 893 "S3y": { 894 "type": "structure", 895 "members": { 896 "NotificationArn": {}, 897 "NotificationEvents": { 898 "type": "list", 899 "member": {} 900 }, 901 "NotificationType": {} 902 } 903 }, 904 "S46": { 905 "type": "structure", 906 "members": { 907 "CommandId": {}, 908 "DocumentName": {}, 909 "Comment": {}, 910 "ExpiresAfter": { 911 "type": "timestamp" 912 }, 913 "Parameters": { 914 "shape": "Sp" 915 }, 916 "InstanceIds": { 917 "shape": "Sb" 918 }, 919 "RequestedDateTime": { 920 "type": "timestamp" 921 }, 922 "Status": {}, 923 "OutputS3BucketName": {}, 924 "OutputS3KeyPrefix": {}, 925 "ServiceRole": {}, 926 "NotificationConfig": { 927 "shape": "S3y" 928 } 929 } 930 } 931 } 932 }