github.com/aavshr/aws-sdk-go@v1.41.3/models/apis/ssm-contacts/2021-05-03/api-2.json (about) 1 { 2 "version":"2.0", 3 "metadata":{ 4 "apiVersion":"2021-05-03", 5 "endpointPrefix":"ssm-contacts", 6 "jsonVersion":"1.1", 7 "protocol":"json", 8 "serviceAbbreviation":"SSM Contacts", 9 "serviceFullName":"AWS Systems Manager Incident Manager Contacts", 10 "serviceId":"SSM Contacts", 11 "signatureVersion":"v4", 12 "signingName":"ssm-contacts", 13 "targetPrefix":"SSMContacts", 14 "uid":"ssm-contacts-2021-05-03" 15 }, 16 "operations":{ 17 "AcceptPage":{ 18 "name":"AcceptPage", 19 "http":{ 20 "method":"POST", 21 "requestUri":"/" 22 }, 23 "input":{"shape":"AcceptPageRequest"}, 24 "output":{"shape":"AcceptPageResult"}, 25 "errors":[ 26 {"shape":"AccessDeniedException"}, 27 {"shape":"InternalServerException"}, 28 {"shape":"ResourceNotFoundException"}, 29 {"shape":"ThrottlingException"}, 30 {"shape":"ValidationException"} 31 ] 32 }, 33 "ActivateContactChannel":{ 34 "name":"ActivateContactChannel", 35 "http":{ 36 "method":"POST", 37 "requestUri":"/" 38 }, 39 "input":{"shape":"ActivateContactChannelRequest"}, 40 "output":{"shape":"ActivateContactChannelResult"}, 41 "errors":[ 42 {"shape":"AccessDeniedException"}, 43 {"shape":"InternalServerException"}, 44 {"shape":"ResourceNotFoundException"}, 45 {"shape":"ThrottlingException"}, 46 {"shape":"ValidationException"} 47 ] 48 }, 49 "CreateContact":{ 50 "name":"CreateContact", 51 "http":{ 52 "method":"POST", 53 "requestUri":"/" 54 }, 55 "input":{"shape":"CreateContactRequest"}, 56 "output":{"shape":"CreateContactResult"}, 57 "errors":[ 58 {"shape":"AccessDeniedException"}, 59 {"shape":"ConflictException"}, 60 {"shape":"InternalServerException"}, 61 {"shape":"ServiceQuotaExceededException"}, 62 {"shape":"ThrottlingException"}, 63 {"shape":"ValidationException"}, 64 {"shape":"DataEncryptionException"} 65 ] 66 }, 67 "CreateContactChannel":{ 68 "name":"CreateContactChannel", 69 "http":{ 70 "method":"POST", 71 "requestUri":"/" 72 }, 73 "input":{"shape":"CreateContactChannelRequest"}, 74 "output":{"shape":"CreateContactChannelResult"}, 75 "errors":[ 76 {"shape":"AccessDeniedException"}, 77 {"shape":"ConflictException"}, 78 {"shape":"DataEncryptionException"}, 79 {"shape":"InternalServerException"}, 80 {"shape":"ThrottlingException"}, 81 {"shape":"ValidationException"} 82 ] 83 }, 84 "DeactivateContactChannel":{ 85 "name":"DeactivateContactChannel", 86 "http":{ 87 "method":"POST", 88 "requestUri":"/" 89 }, 90 "input":{"shape":"DeactivateContactChannelRequest"}, 91 "output":{"shape":"DeactivateContactChannelResult"}, 92 "errors":[ 93 {"shape":"AccessDeniedException"}, 94 {"shape":"InternalServerException"}, 95 {"shape":"ResourceNotFoundException"}, 96 {"shape":"ThrottlingException"}, 97 {"shape":"ValidationException"} 98 ] 99 }, 100 "DeleteContact":{ 101 "name":"DeleteContact", 102 "http":{ 103 "method":"POST", 104 "requestUri":"/" 105 }, 106 "input":{"shape":"DeleteContactRequest"}, 107 "output":{"shape":"DeleteContactResult"}, 108 "errors":[ 109 {"shape":"AccessDeniedException"}, 110 {"shape":"InternalServerException"}, 111 {"shape":"ResourceNotFoundException"}, 112 {"shape":"ThrottlingException"}, 113 {"shape":"ValidationException"} 114 ] 115 }, 116 "DeleteContactChannel":{ 117 "name":"DeleteContactChannel", 118 "http":{ 119 "method":"POST", 120 "requestUri":"/" 121 }, 122 "input":{"shape":"DeleteContactChannelRequest"}, 123 "output":{"shape":"DeleteContactChannelResult"}, 124 "errors":[ 125 {"shape":"AccessDeniedException"}, 126 {"shape":"InternalServerException"}, 127 {"shape":"ResourceNotFoundException"}, 128 {"shape":"ThrottlingException"}, 129 {"shape":"ValidationException"} 130 ] 131 }, 132 "DescribeEngagement":{ 133 "name":"DescribeEngagement", 134 "http":{ 135 "method":"POST", 136 "requestUri":"/" 137 }, 138 "input":{"shape":"DescribeEngagementRequest"}, 139 "output":{"shape":"DescribeEngagementResult"}, 140 "errors":[ 141 {"shape":"AccessDeniedException"}, 142 {"shape":"DataEncryptionException"}, 143 {"shape":"InternalServerException"}, 144 {"shape":"ResourceNotFoundException"}, 145 {"shape":"ThrottlingException"}, 146 {"shape":"ValidationException"} 147 ] 148 }, 149 "DescribePage":{ 150 "name":"DescribePage", 151 "http":{ 152 "method":"POST", 153 "requestUri":"/" 154 }, 155 "input":{"shape":"DescribePageRequest"}, 156 "output":{"shape":"DescribePageResult"}, 157 "errors":[ 158 {"shape":"AccessDeniedException"}, 159 {"shape":"DataEncryptionException"}, 160 {"shape":"InternalServerException"}, 161 {"shape":"ResourceNotFoundException"}, 162 {"shape":"ThrottlingException"}, 163 {"shape":"ValidationException"} 164 ] 165 }, 166 "GetContact":{ 167 "name":"GetContact", 168 "http":{ 169 "method":"POST", 170 "requestUri":"/" 171 }, 172 "input":{"shape":"GetContactRequest"}, 173 "output":{"shape":"GetContactResult"}, 174 "errors":[ 175 {"shape":"AccessDeniedException"}, 176 {"shape":"InternalServerException"}, 177 {"shape":"ResourceNotFoundException"}, 178 {"shape":"ThrottlingException"}, 179 {"shape":"ValidationException"}, 180 {"shape":"DataEncryptionException"} 181 ] 182 }, 183 "GetContactChannel":{ 184 "name":"GetContactChannel", 185 "http":{ 186 "method":"POST", 187 "requestUri":"/" 188 }, 189 "input":{"shape":"GetContactChannelRequest"}, 190 "output":{"shape":"GetContactChannelResult"}, 191 "errors":[ 192 {"shape":"AccessDeniedException"}, 193 {"shape":"DataEncryptionException"}, 194 {"shape":"InternalServerException"}, 195 {"shape":"ResourceNotFoundException"}, 196 {"shape":"ThrottlingException"}, 197 {"shape":"ValidationException"} 198 ] 199 }, 200 "GetContactPolicy":{ 201 "name":"GetContactPolicy", 202 "http":{ 203 "method":"POST", 204 "requestUri":"/" 205 }, 206 "input":{"shape":"GetContactPolicyRequest"}, 207 "output":{"shape":"GetContactPolicyResult"}, 208 "errors":[ 209 {"shape":"AccessDeniedException"}, 210 {"shape":"InternalServerException"}, 211 {"shape":"ResourceNotFoundException"}, 212 {"shape":"ThrottlingException"}, 213 {"shape":"ValidationException"} 214 ] 215 }, 216 "ListContactChannels":{ 217 "name":"ListContactChannels", 218 "http":{ 219 "method":"POST", 220 "requestUri":"/" 221 }, 222 "input":{"shape":"ListContactChannelsRequest"}, 223 "output":{"shape":"ListContactChannelsResult"}, 224 "errors":[ 225 {"shape":"AccessDeniedException"}, 226 {"shape":"DataEncryptionException"}, 227 {"shape":"InternalServerException"}, 228 {"shape":"ResourceNotFoundException"}, 229 {"shape":"ThrottlingException"}, 230 {"shape":"ValidationException"} 231 ] 232 }, 233 "ListContacts":{ 234 "name":"ListContacts", 235 "http":{ 236 "method":"POST", 237 "requestUri":"/" 238 }, 239 "input":{"shape":"ListContactsRequest"}, 240 "output":{"shape":"ListContactsResult"}, 241 "errors":[ 242 {"shape":"AccessDeniedException"}, 243 {"shape":"InternalServerException"}, 244 {"shape":"ThrottlingException"}, 245 {"shape":"ValidationException"} 246 ] 247 }, 248 "ListEngagements":{ 249 "name":"ListEngagements", 250 "http":{ 251 "method":"POST", 252 "requestUri":"/" 253 }, 254 "input":{"shape":"ListEngagementsRequest"}, 255 "output":{"shape":"ListEngagementsResult"}, 256 "errors":[ 257 {"shape":"AccessDeniedException"}, 258 {"shape":"InternalServerException"}, 259 {"shape":"ThrottlingException"}, 260 {"shape":"ValidationException"} 261 ] 262 }, 263 "ListPageReceipts":{ 264 "name":"ListPageReceipts", 265 "http":{ 266 "method":"POST", 267 "requestUri":"/" 268 }, 269 "input":{"shape":"ListPageReceiptsRequest"}, 270 "output":{"shape":"ListPageReceiptsResult"}, 271 "errors":[ 272 {"shape":"AccessDeniedException"}, 273 {"shape":"InternalServerException"}, 274 {"shape":"ResourceNotFoundException"}, 275 {"shape":"ThrottlingException"}, 276 {"shape":"ValidationException"} 277 ] 278 }, 279 "ListPagesByContact":{ 280 "name":"ListPagesByContact", 281 "http":{ 282 "method":"POST", 283 "requestUri":"/" 284 }, 285 "input":{"shape":"ListPagesByContactRequest"}, 286 "output":{"shape":"ListPagesByContactResult"}, 287 "errors":[ 288 {"shape":"AccessDeniedException"}, 289 {"shape":"InternalServerException"}, 290 {"shape":"ResourceNotFoundException"}, 291 {"shape":"ThrottlingException"}, 292 {"shape":"ValidationException"} 293 ] 294 }, 295 "ListPagesByEngagement":{ 296 "name":"ListPagesByEngagement", 297 "http":{ 298 "method":"POST", 299 "requestUri":"/" 300 }, 301 "input":{"shape":"ListPagesByEngagementRequest"}, 302 "output":{"shape":"ListPagesByEngagementResult"}, 303 "errors":[ 304 {"shape":"AccessDeniedException"}, 305 {"shape":"InternalServerException"}, 306 {"shape":"ResourceNotFoundException"}, 307 {"shape":"ThrottlingException"}, 308 {"shape":"ValidationException"} 309 ] 310 }, 311 "ListTagsForResource":{ 312 "name":"ListTagsForResource", 313 "http":{ 314 "method":"POST", 315 "requestUri":"/" 316 }, 317 "input":{"shape":"ListTagsForResourceRequest"}, 318 "output":{"shape":"ListTagsForResourceResult"}, 319 "errors":[ 320 {"shape":"AccessDeniedException"}, 321 {"shape":"ThrottlingException"}, 322 {"shape":"ResourceNotFoundException"}, 323 {"shape":"ValidationException"}, 324 {"shape":"InternalServerException"} 325 ] 326 }, 327 "PutContactPolicy":{ 328 "name":"PutContactPolicy", 329 "http":{ 330 "method":"POST", 331 "requestUri":"/" 332 }, 333 "input":{"shape":"PutContactPolicyRequest"}, 334 "output":{"shape":"PutContactPolicyResult"}, 335 "errors":[ 336 {"shape":"AccessDeniedException"}, 337 {"shape":"ConflictException"}, 338 {"shape":"ValidationException"}, 339 {"shape":"ResourceNotFoundException"}, 340 {"shape":"ThrottlingException"}, 341 {"shape":"InternalServerException"} 342 ] 343 }, 344 "SendActivationCode":{ 345 "name":"SendActivationCode", 346 "http":{ 347 "method":"POST", 348 "requestUri":"/" 349 }, 350 "input":{"shape":"SendActivationCodeRequest"}, 351 "output":{"shape":"SendActivationCodeResult"}, 352 "errors":[ 353 {"shape":"AccessDeniedException"}, 354 {"shape":"DataEncryptionException"}, 355 {"shape":"InternalServerException"}, 356 {"shape":"ResourceNotFoundException"}, 357 {"shape":"ServiceQuotaExceededException"}, 358 {"shape":"ThrottlingException"}, 359 {"shape":"ValidationException"} 360 ] 361 }, 362 "StartEngagement":{ 363 "name":"StartEngagement", 364 "http":{ 365 "method":"POST", 366 "requestUri":"/" 367 }, 368 "input":{"shape":"StartEngagementRequest"}, 369 "output":{"shape":"StartEngagementResult"}, 370 "errors":[ 371 {"shape":"AccessDeniedException"}, 372 {"shape":"DataEncryptionException"}, 373 {"shape":"InternalServerException"}, 374 {"shape":"ResourceNotFoundException"}, 375 {"shape":"ThrottlingException"}, 376 {"shape":"ValidationException"} 377 ] 378 }, 379 "StopEngagement":{ 380 "name":"StopEngagement", 381 "http":{ 382 "method":"POST", 383 "requestUri":"/" 384 }, 385 "input":{"shape":"StopEngagementRequest"}, 386 "output":{"shape":"StopEngagementResult"}, 387 "errors":[ 388 {"shape":"AccessDeniedException"}, 389 {"shape":"ValidationException"}, 390 {"shape":"ResourceNotFoundException"}, 391 {"shape":"ThrottlingException"}, 392 {"shape":"InternalServerException"} 393 ] 394 }, 395 "TagResource":{ 396 "name":"TagResource", 397 "http":{ 398 "method":"POST", 399 "requestUri":"/" 400 }, 401 "input":{"shape":"TagResourceRequest"}, 402 "output":{"shape":"TagResourceResult"}, 403 "errors":[ 404 {"shape":"AccessDeniedException"}, 405 {"shape":"ThrottlingException"}, 406 {"shape":"ResourceNotFoundException"}, 407 {"shape":"InternalServerException"}, 408 {"shape":"ServiceQuotaExceededException"}, 409 {"shape":"ValidationException"} 410 ] 411 }, 412 "UntagResource":{ 413 "name":"UntagResource", 414 "http":{ 415 "method":"POST", 416 "requestUri":"/" 417 }, 418 "input":{"shape":"UntagResourceRequest"}, 419 "output":{"shape":"UntagResourceResult"}, 420 "errors":[ 421 {"shape":"AccessDeniedException"}, 422 {"shape":"ThrottlingException"}, 423 {"shape":"ResourceNotFoundException"}, 424 {"shape":"ValidationException"}, 425 {"shape":"InternalServerException"} 426 ] 427 }, 428 "UpdateContact":{ 429 "name":"UpdateContact", 430 "http":{ 431 "method":"POST", 432 "requestUri":"/" 433 }, 434 "input":{"shape":"UpdateContactRequest"}, 435 "output":{"shape":"UpdateContactResult"}, 436 "errors":[ 437 {"shape":"AccessDeniedException"}, 438 {"shape":"InternalServerException"}, 439 {"shape":"ResourceNotFoundException"}, 440 {"shape":"ServiceQuotaExceededException"}, 441 {"shape":"ThrottlingException"}, 442 {"shape":"ValidationException"}, 443 {"shape":"DataEncryptionException"} 444 ] 445 }, 446 "UpdateContactChannel":{ 447 "name":"UpdateContactChannel", 448 "http":{ 449 "method":"POST", 450 "requestUri":"/" 451 }, 452 "input":{"shape":"UpdateContactChannelRequest"}, 453 "output":{"shape":"UpdateContactChannelResult"}, 454 "errors":[ 455 {"shape":"AccessDeniedException"}, 456 {"shape":"ConflictException"}, 457 {"shape":"DataEncryptionException"}, 458 {"shape":"InternalServerException"}, 459 {"shape":"ResourceNotFoundException"}, 460 {"shape":"ThrottlingException"}, 461 {"shape":"ValidationException"} 462 ] 463 } 464 }, 465 "shapes":{ 466 "AcceptCode":{ 467 "type":"string", 468 "max":10, 469 "min":6, 470 "pattern":"^[0-9]*$" 471 }, 472 "AcceptCodeValidation":{ 473 "type":"string", 474 "enum":[ 475 "IGNORE", 476 "ENFORCE" 477 ] 478 }, 479 "AcceptPageRequest":{ 480 "type":"structure", 481 "required":[ 482 "PageId", 483 "AcceptType", 484 "AcceptCode" 485 ], 486 "members":{ 487 "PageId":{"shape":"SsmContactsArn"}, 488 "ContactChannelId":{"shape":"SsmContactsArn"}, 489 "AcceptType":{"shape":"AcceptType"}, 490 "Note":{"shape":"ReceiptInfo"}, 491 "AcceptCode":{"shape":"AcceptCode"}, 492 "AcceptCodeValidation":{"shape":"AcceptCodeValidation"} 493 } 494 }, 495 "AcceptPageResult":{ 496 "type":"structure", 497 "members":{ 498 } 499 }, 500 "AcceptType":{ 501 "type":"string", 502 "enum":[ 503 "DELIVERED", 504 "READ" 505 ] 506 }, 507 "AccessDeniedException":{ 508 "type":"structure", 509 "required":["Message"], 510 "members":{ 511 "Message":{"shape":"String"} 512 }, 513 "exception":true 514 }, 515 "ActivateContactChannelRequest":{ 516 "type":"structure", 517 "required":[ 518 "ContactChannelId", 519 "ActivationCode" 520 ], 521 "members":{ 522 "ContactChannelId":{"shape":"SsmContactsArn"}, 523 "ActivationCode":{"shape":"ActivationCode"} 524 } 525 }, 526 "ActivateContactChannelResult":{ 527 "type":"structure", 528 "members":{ 529 } 530 }, 531 "ActivationCode":{ 532 "type":"string", 533 "max":10, 534 "min":6, 535 "pattern":"^[0-9]*$" 536 }, 537 "ActivationStatus":{ 538 "type":"string", 539 "enum":[ 540 "ACTIVATED", 541 "NOT_ACTIVATED" 542 ] 543 }, 544 "AmazonResourceName":{ 545 "type":"string", 546 "max":1011, 547 "min":1 548 }, 549 "ChannelName":{ 550 "type":"string", 551 "max":255, 552 "min":1, 553 "pattern":"^[\\p{L}\\p{Z}\\p{N}_.\\-]*$" 554 }, 555 "ChannelTargetInfo":{ 556 "type":"structure", 557 "required":["ContactChannelId"], 558 "members":{ 559 "ContactChannelId":{"shape":"SsmContactsArn"}, 560 "RetryIntervalInMinutes":{"shape":"RetryIntervalInMinutes"} 561 } 562 }, 563 "ChannelType":{ 564 "type":"string", 565 "enum":[ 566 "SMS", 567 "VOICE", 568 "EMAIL" 569 ] 570 }, 571 "ConflictException":{ 572 "type":"structure", 573 "required":[ 574 "Message", 575 "ResourceId", 576 "ResourceType" 577 ], 578 "members":{ 579 "Message":{"shape":"String"}, 580 "ResourceId":{"shape":"String"}, 581 "ResourceType":{"shape":"String"} 582 }, 583 "exception":true 584 }, 585 "Contact":{ 586 "type":"structure", 587 "required":[ 588 "ContactArn", 589 "Alias", 590 "Type" 591 ], 592 "members":{ 593 "ContactArn":{"shape":"SsmContactsArn"}, 594 "Alias":{"shape":"ContactAlias"}, 595 "DisplayName":{"shape":"ContactName"}, 596 "Type":{"shape":"ContactType"} 597 } 598 }, 599 "ContactAlias":{ 600 "type":"string", 601 "max":255, 602 "min":1, 603 "pattern":"^[a-z0-9_\\-]*$" 604 }, 605 "ContactChannel":{ 606 "type":"structure", 607 "required":[ 608 "ContactChannelArn", 609 "ContactArn", 610 "Name", 611 "DeliveryAddress", 612 "ActivationStatus" 613 ], 614 "members":{ 615 "ContactChannelArn":{"shape":"SsmContactsArn"}, 616 "ContactArn":{"shape":"SsmContactsArn"}, 617 "Name":{"shape":"ChannelName"}, 618 "Type":{"shape":"ChannelType"}, 619 "DeliveryAddress":{"shape":"ContactChannelAddress"}, 620 "ActivationStatus":{"shape":"ActivationStatus"} 621 } 622 }, 623 "ContactChannelAddress":{ 624 "type":"structure", 625 "members":{ 626 "SimpleAddress":{"shape":"SimpleAddress"} 627 } 628 }, 629 "ContactChannelList":{ 630 "type":"list", 631 "member":{"shape":"ContactChannel"} 632 }, 633 "ContactName":{ 634 "type":"string", 635 "max":255, 636 "min":0, 637 "pattern":"^[\\p{L}\\p{Z}\\p{N}_.\\-]*$" 638 }, 639 "ContactTargetInfo":{ 640 "type":"structure", 641 "required":["IsEssential"], 642 "members":{ 643 "ContactId":{"shape":"SsmContactsArn"}, 644 "IsEssential":{"shape":"IsEssential"} 645 } 646 }, 647 "ContactType":{ 648 "type":"string", 649 "enum":[ 650 "PERSONAL", 651 "ESCALATION" 652 ] 653 }, 654 "ContactsList":{ 655 "type":"list", 656 "member":{"shape":"Contact"} 657 }, 658 "Content":{ 659 "type":"string", 660 "max":8192, 661 "min":1, 662 "pattern":"^[.\\s\\S]*$" 663 }, 664 "CreateContactChannelRequest":{ 665 "type":"structure", 666 "required":[ 667 "ContactId", 668 "Name", 669 "Type", 670 "DeliveryAddress" 671 ], 672 "members":{ 673 "ContactId":{"shape":"SsmContactsArn"}, 674 "Name":{"shape":"ChannelName"}, 675 "Type":{"shape":"ChannelType"}, 676 "DeliveryAddress":{"shape":"ContactChannelAddress"}, 677 "DeferActivation":{"shape":"DeferActivation"}, 678 "IdempotencyToken":{ 679 "shape":"IdempotencyToken", 680 "idempotencyToken":true 681 } 682 } 683 }, 684 "CreateContactChannelResult":{ 685 "type":"structure", 686 "required":["ContactChannelArn"], 687 "members":{ 688 "ContactChannelArn":{"shape":"SsmContactsArn"} 689 } 690 }, 691 "CreateContactRequest":{ 692 "type":"structure", 693 "required":[ 694 "Alias", 695 "Type", 696 "Plan" 697 ], 698 "members":{ 699 "Alias":{"shape":"ContactAlias"}, 700 "DisplayName":{"shape":"ContactName"}, 701 "Type":{"shape":"ContactType"}, 702 "Plan":{"shape":"Plan"}, 703 "Tags":{"shape":"TagsList"}, 704 "IdempotencyToken":{ 705 "shape":"IdempotencyToken", 706 "idempotencyToken":true 707 } 708 } 709 }, 710 "CreateContactResult":{ 711 "type":"structure", 712 "required":["ContactArn"], 713 "members":{ 714 "ContactArn":{"shape":"SsmContactsArn"} 715 } 716 }, 717 "DataEncryptionException":{ 718 "type":"structure", 719 "required":["Message"], 720 "members":{ 721 "Message":{"shape":"String"} 722 }, 723 "exception":true 724 }, 725 "DateTime":{"type":"timestamp"}, 726 "DeactivateContactChannelRequest":{ 727 "type":"structure", 728 "required":["ContactChannelId"], 729 "members":{ 730 "ContactChannelId":{"shape":"SsmContactsArn"} 731 } 732 }, 733 "DeactivateContactChannelResult":{ 734 "type":"structure", 735 "members":{ 736 } 737 }, 738 "DeferActivation":{ 739 "type":"boolean", 740 "box":true 741 }, 742 "DeleteContactChannelRequest":{ 743 "type":"structure", 744 "required":["ContactChannelId"], 745 "members":{ 746 "ContactChannelId":{"shape":"SsmContactsArn"} 747 } 748 }, 749 "DeleteContactChannelResult":{ 750 "type":"structure", 751 "members":{ 752 } 753 }, 754 "DeleteContactRequest":{ 755 "type":"structure", 756 "required":["ContactId"], 757 "members":{ 758 "ContactId":{"shape":"SsmContactsArn"} 759 } 760 }, 761 "DeleteContactResult":{ 762 "type":"structure", 763 "members":{ 764 } 765 }, 766 "DescribeEngagementRequest":{ 767 "type":"structure", 768 "required":["EngagementId"], 769 "members":{ 770 "EngagementId":{"shape":"SsmContactsArn"} 771 } 772 }, 773 "DescribeEngagementResult":{ 774 "type":"structure", 775 "required":[ 776 "ContactArn", 777 "EngagementArn", 778 "Sender", 779 "Subject", 780 "Content" 781 ], 782 "members":{ 783 "ContactArn":{"shape":"SsmContactsArn"}, 784 "EngagementArn":{"shape":"SsmContactsArn"}, 785 "Sender":{"shape":"Sender"}, 786 "Subject":{"shape":"Subject"}, 787 "Content":{"shape":"Content"}, 788 "PublicSubject":{"shape":"PublicSubject"}, 789 "PublicContent":{"shape":"PublicContent"}, 790 "IncidentId":{"shape":"IncidentId"}, 791 "StartTime":{"shape":"DateTime"}, 792 "StopTime":{"shape":"DateTime"} 793 } 794 }, 795 "DescribePageRequest":{ 796 "type":"structure", 797 "required":["PageId"], 798 "members":{ 799 "PageId":{"shape":"SsmContactsArn"} 800 } 801 }, 802 "DescribePageResult":{ 803 "type":"structure", 804 "required":[ 805 "PageArn", 806 "EngagementArn", 807 "ContactArn", 808 "Sender", 809 "Subject", 810 "Content" 811 ], 812 "members":{ 813 "PageArn":{"shape":"SsmContactsArn"}, 814 "EngagementArn":{"shape":"SsmContactsArn"}, 815 "ContactArn":{"shape":"SsmContactsArn"}, 816 "Sender":{"shape":"Sender"}, 817 "Subject":{"shape":"Subject"}, 818 "Content":{"shape":"Content"}, 819 "PublicSubject":{"shape":"PublicSubject"}, 820 "PublicContent":{"shape":"PublicContent"}, 821 "IncidentId":{"shape":"IncidentId"}, 822 "SentTime":{"shape":"DateTime"}, 823 "ReadTime":{"shape":"DateTime"}, 824 "DeliveryTime":{"shape":"DateTime"} 825 } 826 }, 827 "Engagement":{ 828 "type":"structure", 829 "required":[ 830 "EngagementArn", 831 "ContactArn", 832 "Sender" 833 ], 834 "members":{ 835 "EngagementArn":{"shape":"SsmContactsArn"}, 836 "ContactArn":{"shape":"SsmContactsArn"}, 837 "Sender":{"shape":"Sender"}, 838 "IncidentId":{"shape":"IncidentId"}, 839 "StartTime":{"shape":"DateTime"}, 840 "StopTime":{"shape":"DateTime"} 841 } 842 }, 843 "EngagementsList":{ 844 "type":"list", 845 "member":{"shape":"Engagement"} 846 }, 847 "GetContactChannelRequest":{ 848 "type":"structure", 849 "required":["ContactChannelId"], 850 "members":{ 851 "ContactChannelId":{"shape":"SsmContactsArn"} 852 } 853 }, 854 "GetContactChannelResult":{ 855 "type":"structure", 856 "required":[ 857 "ContactArn", 858 "ContactChannelArn", 859 "Name", 860 "Type", 861 "DeliveryAddress" 862 ], 863 "members":{ 864 "ContactArn":{"shape":"SsmContactsArn"}, 865 "ContactChannelArn":{"shape":"SsmContactsArn"}, 866 "Name":{"shape":"ChannelName"}, 867 "Type":{"shape":"ChannelType"}, 868 "DeliveryAddress":{"shape":"ContactChannelAddress"}, 869 "ActivationStatus":{"shape":"ActivationStatus"} 870 } 871 }, 872 "GetContactPolicyRequest":{ 873 "type":"structure", 874 "required":["ContactArn"], 875 "members":{ 876 "ContactArn":{"shape":"SsmContactsArn"} 877 } 878 }, 879 "GetContactPolicyResult":{ 880 "type":"structure", 881 "members":{ 882 "ContactArn":{"shape":"SsmContactsArn"}, 883 "Policy":{"shape":"Policy"} 884 } 885 }, 886 "GetContactRequest":{ 887 "type":"structure", 888 "required":["ContactId"], 889 "members":{ 890 "ContactId":{"shape":"SsmContactsArn"} 891 } 892 }, 893 "GetContactResult":{ 894 "type":"structure", 895 "required":[ 896 "ContactArn", 897 "Alias", 898 "Type", 899 "Plan" 900 ], 901 "members":{ 902 "ContactArn":{"shape":"SsmContactsArn"}, 903 "Alias":{"shape":"ContactAlias"}, 904 "DisplayName":{"shape":"ContactName"}, 905 "Type":{"shape":"ContactType"}, 906 "Plan":{"shape":"Plan"} 907 } 908 }, 909 "IdempotencyToken":{ 910 "type":"string", 911 "max":2048, 912 "pattern":"^[\\\\\\/a-zA-Z0-9_+=\\-]*$" 913 }, 914 "IncidentId":{ 915 "type":"string", 916 "max":1024, 917 "pattern":"^[\\\\a-zA-Z0-9_@#%*+=:?.\\/!\\s-]*$" 918 }, 919 "InternalServerException":{ 920 "type":"structure", 921 "required":["Message"], 922 "members":{ 923 "Message":{"shape":"String"}, 924 "RetryAfterSeconds":{"shape":"RetryAfterSeconds"} 925 }, 926 "exception":true, 927 "fault":true 928 }, 929 "IsEssential":{ 930 "type":"boolean", 931 "box":true 932 }, 933 "ListContactChannelsRequest":{ 934 "type":"structure", 935 "required":["ContactId"], 936 "members":{ 937 "ContactId":{"shape":"SsmContactsArn"}, 938 "NextToken":{"shape":"PaginationToken"}, 939 "MaxResults":{"shape":"MaxResults"} 940 } 941 }, 942 "ListContactChannelsResult":{ 943 "type":"structure", 944 "required":["ContactChannels"], 945 "members":{ 946 "NextToken":{"shape":"PaginationToken"}, 947 "ContactChannels":{"shape":"ContactChannelList"} 948 } 949 }, 950 "ListContactsRequest":{ 951 "type":"structure", 952 "members":{ 953 "NextToken":{"shape":"PaginationToken"}, 954 "MaxResults":{"shape":"MaxResults"}, 955 "AliasPrefix":{"shape":"ContactAlias"}, 956 "Type":{"shape":"ContactType"} 957 } 958 }, 959 "ListContactsResult":{ 960 "type":"structure", 961 "members":{ 962 "NextToken":{"shape":"PaginationToken"}, 963 "Contacts":{"shape":"ContactsList"} 964 } 965 }, 966 "ListEngagementsRequest":{ 967 "type":"structure", 968 "members":{ 969 "NextToken":{"shape":"PaginationToken"}, 970 "MaxResults":{"shape":"MaxResults"}, 971 "IncidentId":{"shape":"IncidentId"}, 972 "TimeRangeValue":{"shape":"TimeRange"} 973 } 974 }, 975 "ListEngagementsResult":{ 976 "type":"structure", 977 "required":["Engagements"], 978 "members":{ 979 "NextToken":{"shape":"PaginationToken"}, 980 "Engagements":{"shape":"EngagementsList"} 981 } 982 }, 983 "ListPageReceiptsRequest":{ 984 "type":"structure", 985 "required":["PageId"], 986 "members":{ 987 "PageId":{"shape":"SsmContactsArn"}, 988 "NextToken":{"shape":"PaginationToken"}, 989 "MaxResults":{"shape":"MaxResults"} 990 } 991 }, 992 "ListPageReceiptsResult":{ 993 "type":"structure", 994 "members":{ 995 "NextToken":{"shape":"PaginationToken"}, 996 "Receipts":{"shape":"ReceiptsList"} 997 } 998 }, 999 "ListPagesByContactRequest":{ 1000 "type":"structure", 1001 "required":["ContactId"], 1002 "members":{ 1003 "ContactId":{"shape":"SsmContactsArn"}, 1004 "NextToken":{"shape":"PaginationToken"}, 1005 "MaxResults":{"shape":"MaxResults"} 1006 } 1007 }, 1008 "ListPagesByContactResult":{ 1009 "type":"structure", 1010 "required":["Pages"], 1011 "members":{ 1012 "NextToken":{"shape":"PaginationToken"}, 1013 "Pages":{"shape":"PagesList"} 1014 } 1015 }, 1016 "ListPagesByEngagementRequest":{ 1017 "type":"structure", 1018 "required":["EngagementId"], 1019 "members":{ 1020 "EngagementId":{"shape":"SsmContactsArn"}, 1021 "NextToken":{"shape":"PaginationToken"}, 1022 "MaxResults":{"shape":"MaxResults"} 1023 } 1024 }, 1025 "ListPagesByEngagementResult":{ 1026 "type":"structure", 1027 "required":["Pages"], 1028 "members":{ 1029 "NextToken":{"shape":"PaginationToken"}, 1030 "Pages":{"shape":"PagesList"} 1031 } 1032 }, 1033 "ListTagsForResourceRequest":{ 1034 "type":"structure", 1035 "required":["ResourceARN"], 1036 "members":{ 1037 "ResourceARN":{"shape":"AmazonResourceName"} 1038 } 1039 }, 1040 "ListTagsForResourceResult":{ 1041 "type":"structure", 1042 "members":{ 1043 "Tags":{"shape":"TagsList"} 1044 } 1045 }, 1046 "MaxResults":{ 1047 "type":"integer", 1048 "box":true, 1049 "max":1024, 1050 "min":0 1051 }, 1052 "Page":{ 1053 "type":"structure", 1054 "required":[ 1055 "PageArn", 1056 "EngagementArn", 1057 "ContactArn", 1058 "Sender" 1059 ], 1060 "members":{ 1061 "PageArn":{"shape":"SsmContactsArn"}, 1062 "EngagementArn":{"shape":"SsmContactsArn"}, 1063 "ContactArn":{"shape":"SsmContactsArn"}, 1064 "Sender":{"shape":"Sender"}, 1065 "IncidentId":{"shape":"IncidentId"}, 1066 "SentTime":{"shape":"DateTime"}, 1067 "DeliveryTime":{"shape":"DateTime"}, 1068 "ReadTime":{"shape":"DateTime"} 1069 } 1070 }, 1071 "PagesList":{ 1072 "type":"list", 1073 "member":{"shape":"Page"} 1074 }, 1075 "PaginationToken":{ 1076 "type":"string", 1077 "max":2048, 1078 "pattern":"^[\\\\\\/a-zA-Z0-9_+=\\-]*$" 1079 }, 1080 "Plan":{ 1081 "type":"structure", 1082 "required":["Stages"], 1083 "members":{ 1084 "Stages":{"shape":"StagesList"} 1085 } 1086 }, 1087 "Policy":{ 1088 "type":"string", 1089 "max":395000, 1090 "min":1, 1091 "pattern":".*\\S.*" 1092 }, 1093 "PublicContent":{ 1094 "type":"string", 1095 "max":8192, 1096 "min":1, 1097 "pattern":"^[.\\s\\S]*$" 1098 }, 1099 "PublicSubject":{ 1100 "type":"string", 1101 "max":2048, 1102 "min":1, 1103 "pattern":"^[.\\s\\S]*$" 1104 }, 1105 "PutContactPolicyRequest":{ 1106 "type":"structure", 1107 "required":[ 1108 "ContactArn", 1109 "Policy" 1110 ], 1111 "members":{ 1112 "ContactArn":{"shape":"SsmContactsArn"}, 1113 "Policy":{"shape":"Policy"} 1114 } 1115 }, 1116 "PutContactPolicyResult":{ 1117 "type":"structure", 1118 "members":{ 1119 } 1120 }, 1121 "Receipt":{ 1122 "type":"structure", 1123 "required":[ 1124 "ReceiptType", 1125 "ReceiptTime" 1126 ], 1127 "members":{ 1128 "ContactChannelArn":{"shape":"SsmContactsArn"}, 1129 "ReceiptType":{"shape":"ReceiptType"}, 1130 "ReceiptInfo":{"shape":"ReceiptInfo"}, 1131 "ReceiptTime":{"shape":"DateTime"} 1132 } 1133 }, 1134 "ReceiptInfo":{ 1135 "type":"string", 1136 "max":2048, 1137 "min":1, 1138 "pattern":"^[.\\s\\S]*$" 1139 }, 1140 "ReceiptType":{ 1141 "type":"string", 1142 "enum":[ 1143 "DELIVERED", 1144 "ERROR", 1145 "READ", 1146 "SENT", 1147 "STOP" 1148 ] 1149 }, 1150 "ReceiptsList":{ 1151 "type":"list", 1152 "member":{"shape":"Receipt"} 1153 }, 1154 "ResourceNotFoundException":{ 1155 "type":"structure", 1156 "required":[ 1157 "Message", 1158 "ResourceId", 1159 "ResourceType" 1160 ], 1161 "members":{ 1162 "Message":{"shape":"String"}, 1163 "ResourceId":{"shape":"String"}, 1164 "ResourceType":{"shape":"String"} 1165 }, 1166 "exception":true 1167 }, 1168 "RetryAfterSeconds":{"type":"integer"}, 1169 "RetryIntervalInMinutes":{ 1170 "type":"integer", 1171 "box":true, 1172 "max":60, 1173 "min":0 1174 }, 1175 "SendActivationCodeRequest":{ 1176 "type":"structure", 1177 "required":["ContactChannelId"], 1178 "members":{ 1179 "ContactChannelId":{"shape":"SsmContactsArn"} 1180 } 1181 }, 1182 "SendActivationCodeResult":{ 1183 "type":"structure", 1184 "members":{ 1185 } 1186 }, 1187 "Sender":{ 1188 "type":"string", 1189 "max":255, 1190 "pattern":"^[\\\\a-zA-Z0-9_@#%*+=:?.\\/!\\s-]*$" 1191 }, 1192 "ServiceQuotaExceededException":{ 1193 "type":"structure", 1194 "required":[ 1195 "Message", 1196 "QuotaCode", 1197 "ServiceCode" 1198 ], 1199 "members":{ 1200 "Message":{"shape":"String"}, 1201 "ResourceId":{"shape":"String"}, 1202 "ResourceType":{"shape":"String"}, 1203 "QuotaCode":{"shape":"String"}, 1204 "ServiceCode":{"shape":"String"} 1205 }, 1206 "exception":true 1207 }, 1208 "SimpleAddress":{ 1209 "type":"string", 1210 "max":320, 1211 "min":1 1212 }, 1213 "SsmContactsArn":{ 1214 "type":"string", 1215 "max":2048, 1216 "min":1, 1217 "pattern":"arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\\w+=\\/,.@]*:[0-9]+:([\\w+=\\/,.@:-]+)*" 1218 }, 1219 "Stage":{ 1220 "type":"structure", 1221 "required":[ 1222 "DurationInMinutes", 1223 "Targets" 1224 ], 1225 "members":{ 1226 "DurationInMinutes":{"shape":"StageDurationInMins"}, 1227 "Targets":{"shape":"TargetsList"} 1228 } 1229 }, 1230 "StageDurationInMins":{ 1231 "type":"integer", 1232 "box":true, 1233 "max":30, 1234 "min":0 1235 }, 1236 "StagesList":{ 1237 "type":"list", 1238 "member":{"shape":"Stage"} 1239 }, 1240 "StartEngagementRequest":{ 1241 "type":"structure", 1242 "required":[ 1243 "ContactId", 1244 "Sender", 1245 "Subject", 1246 "Content" 1247 ], 1248 "members":{ 1249 "ContactId":{"shape":"SsmContactsArn"}, 1250 "Sender":{"shape":"Sender"}, 1251 "Subject":{"shape":"Subject"}, 1252 "Content":{"shape":"Content"}, 1253 "PublicSubject":{"shape":"PublicSubject"}, 1254 "PublicContent":{"shape":"PublicContent"}, 1255 "IncidentId":{"shape":"IncidentId"}, 1256 "IdempotencyToken":{ 1257 "shape":"IdempotencyToken", 1258 "idempotencyToken":true 1259 } 1260 } 1261 }, 1262 "StartEngagementResult":{ 1263 "type":"structure", 1264 "required":["EngagementArn"], 1265 "members":{ 1266 "EngagementArn":{"shape":"SsmContactsArn"} 1267 } 1268 }, 1269 "StopEngagementRequest":{ 1270 "type":"structure", 1271 "required":["EngagementId"], 1272 "members":{ 1273 "EngagementId":{"shape":"SsmContactsArn"}, 1274 "Reason":{"shape":"StopReason"} 1275 } 1276 }, 1277 "StopEngagementResult":{ 1278 "type":"structure", 1279 "members":{ 1280 } 1281 }, 1282 "StopReason":{ 1283 "type":"string", 1284 "max":255, 1285 "pattern":"^[.\\s\\S]*$" 1286 }, 1287 "String":{"type":"string"}, 1288 "Subject":{ 1289 "type":"string", 1290 "max":2048, 1291 "min":1, 1292 "pattern":"^[.\\s\\S]*$" 1293 }, 1294 "Tag":{ 1295 "type":"structure", 1296 "members":{ 1297 "Key":{"shape":"TagKey"}, 1298 "Value":{"shape":"TagValue"} 1299 } 1300 }, 1301 "TagKey":{ 1302 "type":"string", 1303 "max":128, 1304 "min":1, 1305 "pattern":"^[\\\\\\/a-zA-Z0-9_+=\\-]*$" 1306 }, 1307 "TagKeyList":{ 1308 "type":"list", 1309 "member":{"shape":"TagKey"}, 1310 "max":50, 1311 "min":0 1312 }, 1313 "TagResourceRequest":{ 1314 "type":"structure", 1315 "required":[ 1316 "ResourceARN", 1317 "Tags" 1318 ], 1319 "members":{ 1320 "ResourceARN":{"shape":"AmazonResourceName"}, 1321 "Tags":{"shape":"TagsList"} 1322 } 1323 }, 1324 "TagResourceResult":{ 1325 "type":"structure", 1326 "members":{ 1327 } 1328 }, 1329 "TagValue":{ 1330 "type":"string", 1331 "max":256, 1332 "min":1, 1333 "pattern":"^[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*$" 1334 }, 1335 "TagsList":{ 1336 "type":"list", 1337 "member":{"shape":"Tag"}, 1338 "max":50, 1339 "min":0 1340 }, 1341 "Target":{ 1342 "type":"structure", 1343 "members":{ 1344 "ChannelTargetInfo":{"shape":"ChannelTargetInfo"}, 1345 "ContactTargetInfo":{"shape":"ContactTargetInfo"} 1346 } 1347 }, 1348 "TargetsList":{ 1349 "type":"list", 1350 "member":{"shape":"Target"} 1351 }, 1352 "ThrottlingException":{ 1353 "type":"structure", 1354 "required":["Message"], 1355 "members":{ 1356 "Message":{"shape":"String"}, 1357 "QuotaCode":{"shape":"String"}, 1358 "ServiceCode":{"shape":"String"}, 1359 "RetryAfterSeconds":{"shape":"RetryAfterSeconds"} 1360 }, 1361 "exception":true 1362 }, 1363 "TimeRange":{ 1364 "type":"structure", 1365 "members":{ 1366 "StartTime":{"shape":"DateTime"}, 1367 "EndTime":{"shape":"DateTime"} 1368 } 1369 }, 1370 "UntagResourceRequest":{ 1371 "type":"structure", 1372 "required":[ 1373 "ResourceARN", 1374 "TagKeys" 1375 ], 1376 "members":{ 1377 "ResourceARN":{"shape":"AmazonResourceName"}, 1378 "TagKeys":{"shape":"TagKeyList"} 1379 } 1380 }, 1381 "UntagResourceResult":{ 1382 "type":"structure", 1383 "members":{ 1384 } 1385 }, 1386 "UpdateContactChannelRequest":{ 1387 "type":"structure", 1388 "required":["ContactChannelId"], 1389 "members":{ 1390 "ContactChannelId":{"shape":"SsmContactsArn"}, 1391 "Name":{"shape":"ChannelName"}, 1392 "DeliveryAddress":{"shape":"ContactChannelAddress"} 1393 } 1394 }, 1395 "UpdateContactChannelResult":{ 1396 "type":"structure", 1397 "members":{ 1398 } 1399 }, 1400 "UpdateContactRequest":{ 1401 "type":"structure", 1402 "required":["ContactId"], 1403 "members":{ 1404 "ContactId":{"shape":"SsmContactsArn"}, 1405 "DisplayName":{"shape":"ContactName"}, 1406 "Plan":{"shape":"Plan"} 1407 } 1408 }, 1409 "UpdateContactResult":{ 1410 "type":"structure", 1411 "members":{ 1412 } 1413 }, 1414 "ValidationException":{ 1415 "type":"structure", 1416 "required":["Message"], 1417 "members":{ 1418 "Message":{"shape":"String"}, 1419 "Reason":{"shape":"ValidationExceptionReason"}, 1420 "Fields":{"shape":"ValidationExceptionFieldList"} 1421 }, 1422 "exception":true 1423 }, 1424 "ValidationExceptionField":{ 1425 "type":"structure", 1426 "required":[ 1427 "Name", 1428 "Message" 1429 ], 1430 "members":{ 1431 "Name":{"shape":"String"}, 1432 "Message":{"shape":"String"} 1433 } 1434 }, 1435 "ValidationExceptionFieldList":{ 1436 "type":"list", 1437 "member":{"shape":"ValidationExceptionField"} 1438 }, 1439 "ValidationExceptionReason":{ 1440 "type":"string", 1441 "enum":[ 1442 "UNKNOWN_OPERATION", 1443 "CANNOT_PARSE", 1444 "FIELD_VALIDATION_FAILED", 1445 "OTHER" 1446 ] 1447 } 1448 } 1449 }