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 "documentation":"<p>Used to acknowledge an engagement to a contact channel during an incident.</p>" 33 }, 34 "ActivateContactChannel":{ 35 "name":"ActivateContactChannel", 36 "http":{ 37 "method":"POST", 38 "requestUri":"/" 39 }, 40 "input":{"shape":"ActivateContactChannelRequest"}, 41 "output":{"shape":"ActivateContactChannelResult"}, 42 "errors":[ 43 {"shape":"AccessDeniedException"}, 44 {"shape":"InternalServerException"}, 45 {"shape":"ResourceNotFoundException"}, 46 {"shape":"ThrottlingException"}, 47 {"shape":"ValidationException"} 48 ], 49 "documentation":"<p>Activates a contact's contact channel. Incident Manager can't engage a contact until the contact channel has been activated.</p>" 50 }, 51 "CreateContact":{ 52 "name":"CreateContact", 53 "http":{ 54 "method":"POST", 55 "requestUri":"/" 56 }, 57 "input":{"shape":"CreateContactRequest"}, 58 "output":{"shape":"CreateContactResult"}, 59 "errors":[ 60 {"shape":"AccessDeniedException"}, 61 {"shape":"ConflictException"}, 62 {"shape":"InternalServerException"}, 63 {"shape":"ServiceQuotaExceededException"}, 64 {"shape":"ThrottlingException"}, 65 {"shape":"ValidationException"}, 66 {"shape":"DataEncryptionException"} 67 ], 68 "documentation":"<p>Contacts are either the contacts that Incident Manager engages during an incident or the escalation plans that Incident Manager uses to engage contacts in phases during an incident.</p>" 69 }, 70 "CreateContactChannel":{ 71 "name":"CreateContactChannel", 72 "http":{ 73 "method":"POST", 74 "requestUri":"/" 75 }, 76 "input":{"shape":"CreateContactChannelRequest"}, 77 "output":{"shape":"CreateContactChannelResult"}, 78 "errors":[ 79 {"shape":"AccessDeniedException"}, 80 {"shape":"ConflictException"}, 81 {"shape":"DataEncryptionException"}, 82 {"shape":"InternalServerException"}, 83 {"shape":"ThrottlingException"}, 84 {"shape":"ValidationException"} 85 ], 86 "documentation":"<p>A contact channel is the method that Incident Manager uses to engage your contact.</p>" 87 }, 88 "CreateRotation":{ 89 "name":"CreateRotation", 90 "http":{ 91 "method":"POST", 92 "requestUri":"/" 93 }, 94 "input":{"shape":"CreateRotationRequest"}, 95 "output":{"shape":"CreateRotationResult"}, 96 "errors":[ 97 {"shape":"AccessDeniedException"}, 98 {"shape":"InternalServerException"}, 99 {"shape":"ResourceNotFoundException"}, 100 {"shape":"ServiceQuotaExceededException"}, 101 {"shape":"ThrottlingException"}, 102 {"shape":"ValidationException"} 103 ], 104 "documentation":"<p>Creates a rotation in an on-call schedule.</p>" 105 }, 106 "CreateRotationOverride":{ 107 "name":"CreateRotationOverride", 108 "http":{ 109 "method":"POST", 110 "requestUri":"/" 111 }, 112 "input":{"shape":"CreateRotationOverrideRequest"}, 113 "output":{"shape":"CreateRotationOverrideResult"}, 114 "errors":[ 115 {"shape":"AccessDeniedException"}, 116 {"shape":"InternalServerException"}, 117 {"shape":"ResourceNotFoundException"}, 118 {"shape":"ServiceQuotaExceededException"}, 119 {"shape":"ThrottlingException"}, 120 {"shape":"ValidationException"} 121 ], 122 "documentation":"<p>Creates an override for a rotation in an on-call schedule.</p>" 123 }, 124 "DeactivateContactChannel":{ 125 "name":"DeactivateContactChannel", 126 "http":{ 127 "method":"POST", 128 "requestUri":"/" 129 }, 130 "input":{"shape":"DeactivateContactChannelRequest"}, 131 "output":{"shape":"DeactivateContactChannelResult"}, 132 "errors":[ 133 {"shape":"AccessDeniedException"}, 134 {"shape":"InternalServerException"}, 135 {"shape":"ResourceNotFoundException"}, 136 {"shape":"ThrottlingException"}, 137 {"shape":"ValidationException"} 138 ], 139 "documentation":"<p>To no longer receive Incident Manager engagements to a contact channel, you can deactivate the channel.</p>" 140 }, 141 "DeleteContact":{ 142 "name":"DeleteContact", 143 "http":{ 144 "method":"POST", 145 "requestUri":"/" 146 }, 147 "input":{"shape":"DeleteContactRequest"}, 148 "output":{"shape":"DeleteContactResult"}, 149 "errors":[ 150 {"shape":"AccessDeniedException"}, 151 {"shape":"InternalServerException"}, 152 {"shape":"ResourceNotFoundException"}, 153 {"shape":"ThrottlingException"}, 154 {"shape":"ConflictException"}, 155 {"shape":"ValidationException"} 156 ], 157 "documentation":"<p>To remove a contact from Incident Manager, you can delete the contact. Deleting a contact removes them from all escalation plans and related response plans. Deleting an escalation plan removes it from all related response plans. You will have to recreate the contact and its contact channels before you can use it again.</p>" 158 }, 159 "DeleteContactChannel":{ 160 "name":"DeleteContactChannel", 161 "http":{ 162 "method":"POST", 163 "requestUri":"/" 164 }, 165 "input":{"shape":"DeleteContactChannelRequest"}, 166 "output":{"shape":"DeleteContactChannelResult"}, 167 "errors":[ 168 {"shape":"AccessDeniedException"}, 169 {"shape":"InternalServerException"}, 170 {"shape":"ResourceNotFoundException"}, 171 {"shape":"ThrottlingException"}, 172 {"shape":"ValidationException"} 173 ], 174 "documentation":"<p>To no longer receive engagements on a contact channel, you can delete the channel from a contact. Deleting the contact channel removes it from the contact's engagement plan. If you delete the only contact channel for a contact, you won't be able to engage that contact during an incident.</p>" 175 }, 176 "DeleteRotation":{ 177 "name":"DeleteRotation", 178 "http":{ 179 "method":"POST", 180 "requestUri":"/" 181 }, 182 "input":{"shape":"DeleteRotationRequest"}, 183 "output":{"shape":"DeleteRotationResult"}, 184 "errors":[ 185 {"shape":"AccessDeniedException"}, 186 {"shape":"ConflictException"}, 187 {"shape":"InternalServerException"}, 188 {"shape":"ResourceNotFoundException"}, 189 {"shape":"ThrottlingException"}, 190 {"shape":"ValidationException"} 191 ], 192 "documentation":"<p>Deletes a rotation from the system. If a rotation belongs to more than one on-call schedule, this operation deletes it from all of them.</p>" 193 }, 194 "DeleteRotationOverride":{ 195 "name":"DeleteRotationOverride", 196 "http":{ 197 "method":"POST", 198 "requestUri":"/" 199 }, 200 "input":{"shape":"DeleteRotationOverrideRequest"}, 201 "output":{"shape":"DeleteRotationOverrideResult"}, 202 "errors":[ 203 {"shape":"AccessDeniedException"}, 204 {"shape":"InternalServerException"}, 205 {"shape":"ResourceNotFoundException"}, 206 {"shape":"ThrottlingException"}, 207 {"shape":"ValidationException"} 208 ], 209 "documentation":"<p>Deletes an existing override for an on-call rotation.</p>" 210 }, 211 "DescribeEngagement":{ 212 "name":"DescribeEngagement", 213 "http":{ 214 "method":"POST", 215 "requestUri":"/" 216 }, 217 "input":{"shape":"DescribeEngagementRequest"}, 218 "output":{"shape":"DescribeEngagementResult"}, 219 "errors":[ 220 {"shape":"AccessDeniedException"}, 221 {"shape":"DataEncryptionException"}, 222 {"shape":"InternalServerException"}, 223 {"shape":"ResourceNotFoundException"}, 224 {"shape":"ThrottlingException"}, 225 {"shape":"ValidationException"} 226 ], 227 "documentation":"<p>Incident Manager uses engagements to engage contacts and escalation plans during an incident. Use this command to describe the engagement that occurred during an incident.</p>" 228 }, 229 "DescribePage":{ 230 "name":"DescribePage", 231 "http":{ 232 "method":"POST", 233 "requestUri":"/" 234 }, 235 "input":{"shape":"DescribePageRequest"}, 236 "output":{"shape":"DescribePageResult"}, 237 "errors":[ 238 {"shape":"AccessDeniedException"}, 239 {"shape":"DataEncryptionException"}, 240 {"shape":"InternalServerException"}, 241 {"shape":"ResourceNotFoundException"}, 242 {"shape":"ThrottlingException"}, 243 {"shape":"ValidationException"} 244 ], 245 "documentation":"<p>Lists details of the engagement to a contact channel.</p>" 246 }, 247 "GetContact":{ 248 "name":"GetContact", 249 "http":{ 250 "method":"POST", 251 "requestUri":"/" 252 }, 253 "input":{"shape":"GetContactRequest"}, 254 "output":{"shape":"GetContactResult"}, 255 "errors":[ 256 {"shape":"AccessDeniedException"}, 257 {"shape":"InternalServerException"}, 258 {"shape":"ResourceNotFoundException"}, 259 {"shape":"ThrottlingException"}, 260 {"shape":"ValidationException"}, 261 {"shape":"DataEncryptionException"} 262 ], 263 "documentation":"<p>Retrieves information about the specified contact or escalation plan.</p>" 264 }, 265 "GetContactChannel":{ 266 "name":"GetContactChannel", 267 "http":{ 268 "method":"POST", 269 "requestUri":"/" 270 }, 271 "input":{"shape":"GetContactChannelRequest"}, 272 "output":{"shape":"GetContactChannelResult"}, 273 "errors":[ 274 {"shape":"AccessDeniedException"}, 275 {"shape":"DataEncryptionException"}, 276 {"shape":"InternalServerException"}, 277 {"shape":"ResourceNotFoundException"}, 278 {"shape":"ThrottlingException"}, 279 {"shape":"ValidationException"} 280 ], 281 "documentation":"<p>List details about a specific contact channel.</p>" 282 }, 283 "GetContactPolicy":{ 284 "name":"GetContactPolicy", 285 "http":{ 286 "method":"POST", 287 "requestUri":"/" 288 }, 289 "input":{"shape":"GetContactPolicyRequest"}, 290 "output":{"shape":"GetContactPolicyResult"}, 291 "errors":[ 292 {"shape":"AccessDeniedException"}, 293 {"shape":"InternalServerException"}, 294 {"shape":"ResourceNotFoundException"}, 295 {"shape":"ThrottlingException"}, 296 {"shape":"ValidationException"} 297 ], 298 "documentation":"<p>Retrieves the resource policies attached to the specified contact or escalation plan.</p>" 299 }, 300 "GetRotation":{ 301 "name":"GetRotation", 302 "http":{ 303 "method":"POST", 304 "requestUri":"/" 305 }, 306 "input":{"shape":"GetRotationRequest"}, 307 "output":{"shape":"GetRotationResult"}, 308 "errors":[ 309 {"shape":"AccessDeniedException"}, 310 {"shape":"InternalServerException"}, 311 {"shape":"ResourceNotFoundException"}, 312 {"shape":"ThrottlingException"}, 313 {"shape":"ValidationException"} 314 ], 315 "documentation":"<p>Retrieves information about an on-call rotation.</p>" 316 }, 317 "GetRotationOverride":{ 318 "name":"GetRotationOverride", 319 "http":{ 320 "method":"POST", 321 "requestUri":"/" 322 }, 323 "input":{"shape":"GetRotationOverrideRequest"}, 324 "output":{"shape":"GetRotationOverrideResult"}, 325 "errors":[ 326 {"shape":"AccessDeniedException"}, 327 {"shape":"InternalServerException"}, 328 {"shape":"ResourceNotFoundException"}, 329 {"shape":"ThrottlingException"}, 330 {"shape":"ValidationException"} 331 ], 332 "documentation":"<p>Retrieves information about an override to an on-call rotation.</p>" 333 }, 334 "ListContactChannels":{ 335 "name":"ListContactChannels", 336 "http":{ 337 "method":"POST", 338 "requestUri":"/" 339 }, 340 "input":{"shape":"ListContactChannelsRequest"}, 341 "output":{"shape":"ListContactChannelsResult"}, 342 "errors":[ 343 {"shape":"AccessDeniedException"}, 344 {"shape":"DataEncryptionException"}, 345 {"shape":"InternalServerException"}, 346 {"shape":"ResourceNotFoundException"}, 347 {"shape":"ThrottlingException"}, 348 {"shape":"ValidationException"} 349 ], 350 "documentation":"<p>Lists all contact channels for the specified contact.</p>" 351 }, 352 "ListContacts":{ 353 "name":"ListContacts", 354 "http":{ 355 "method":"POST", 356 "requestUri":"/" 357 }, 358 "input":{"shape":"ListContactsRequest"}, 359 "output":{"shape":"ListContactsResult"}, 360 "errors":[ 361 {"shape":"AccessDeniedException"}, 362 {"shape":"InternalServerException"}, 363 {"shape":"ThrottlingException"}, 364 {"shape":"ValidationException"} 365 ], 366 "documentation":"<p>Lists all contacts and escalation plans in Incident Manager.</p>" 367 }, 368 "ListEngagements":{ 369 "name":"ListEngagements", 370 "http":{ 371 "method":"POST", 372 "requestUri":"/" 373 }, 374 "input":{"shape":"ListEngagementsRequest"}, 375 "output":{"shape":"ListEngagementsResult"}, 376 "errors":[ 377 {"shape":"AccessDeniedException"}, 378 {"shape":"InternalServerException"}, 379 {"shape":"ThrottlingException"}, 380 {"shape":"ValidationException"} 381 ], 382 "documentation":"<p>Lists all engagements that have happened in an incident.</p>" 383 }, 384 "ListPageReceipts":{ 385 "name":"ListPageReceipts", 386 "http":{ 387 "method":"POST", 388 "requestUri":"/" 389 }, 390 "input":{"shape":"ListPageReceiptsRequest"}, 391 "output":{"shape":"ListPageReceiptsResult"}, 392 "errors":[ 393 {"shape":"AccessDeniedException"}, 394 {"shape":"InternalServerException"}, 395 {"shape":"ResourceNotFoundException"}, 396 {"shape":"ThrottlingException"}, 397 {"shape":"ValidationException"} 398 ], 399 "documentation":"<p>Lists all of the engagements to contact channels that have been acknowledged.</p>" 400 }, 401 "ListPageResolutions":{ 402 "name":"ListPageResolutions", 403 "http":{ 404 "method":"POST", 405 "requestUri":"/" 406 }, 407 "input":{"shape":"ListPageResolutionsRequest"}, 408 "output":{"shape":"ListPageResolutionsResult"}, 409 "errors":[ 410 {"shape":"AccessDeniedException"}, 411 {"shape":"InternalServerException"}, 412 {"shape":"ResourceNotFoundException"}, 413 {"shape":"ThrottlingException"}, 414 {"shape":"ValidationException"} 415 ], 416 "documentation":"<p>Returns the resolution path of an engagement. For example, the escalation plan engaged in an incident might target an on-call schedule that includes several contacts in a rotation, but just one contact on-call when the incident starts. The resolution path indicates the hierarchy of <i>escalation plan > on-call schedule > contact</i>.</p>" 417 }, 418 "ListPagesByContact":{ 419 "name":"ListPagesByContact", 420 "http":{ 421 "method":"POST", 422 "requestUri":"/" 423 }, 424 "input":{"shape":"ListPagesByContactRequest"}, 425 "output":{"shape":"ListPagesByContactResult"}, 426 "errors":[ 427 {"shape":"AccessDeniedException"}, 428 {"shape":"InternalServerException"}, 429 {"shape":"ResourceNotFoundException"}, 430 {"shape":"ThrottlingException"}, 431 {"shape":"ValidationException"} 432 ], 433 "documentation":"<p>Lists the engagements to a contact's contact channels.</p>" 434 }, 435 "ListPagesByEngagement":{ 436 "name":"ListPagesByEngagement", 437 "http":{ 438 "method":"POST", 439 "requestUri":"/" 440 }, 441 "input":{"shape":"ListPagesByEngagementRequest"}, 442 "output":{"shape":"ListPagesByEngagementResult"}, 443 "errors":[ 444 {"shape":"AccessDeniedException"}, 445 {"shape":"InternalServerException"}, 446 {"shape":"ResourceNotFoundException"}, 447 {"shape":"ThrottlingException"}, 448 {"shape":"ValidationException"} 449 ], 450 "documentation":"<p>Lists the engagements to contact channels that occurred by engaging a contact.</p>" 451 }, 452 "ListPreviewRotationShifts":{ 453 "name":"ListPreviewRotationShifts", 454 "http":{ 455 "method":"POST", 456 "requestUri":"/" 457 }, 458 "input":{"shape":"ListPreviewRotationShiftsRequest"}, 459 "output":{"shape":"ListPreviewRotationShiftsResult"}, 460 "errors":[ 461 {"shape":"AccessDeniedException"}, 462 {"shape":"InternalServerException"}, 463 {"shape":"ThrottlingException"}, 464 {"shape":"ValidationException"} 465 ], 466 "documentation":"<p>Returns a list of shifts based on rotation configuration parameters.</p> <note> <p>The Incident Manager primarily uses this operation to populate the <b>Preview</b> calendar. It is not typically run by end users.</p> </note>" 467 }, 468 "ListRotationOverrides":{ 469 "name":"ListRotationOverrides", 470 "http":{ 471 "method":"POST", 472 "requestUri":"/" 473 }, 474 "input":{"shape":"ListRotationOverridesRequest"}, 475 "output":{"shape":"ListRotationOverridesResult"}, 476 "errors":[ 477 {"shape":"AccessDeniedException"}, 478 {"shape":"InternalServerException"}, 479 {"shape":"ResourceNotFoundException"}, 480 {"shape":"ThrottlingException"}, 481 {"shape":"ValidationException"} 482 ], 483 "documentation":"<p>Retrieves a list of overrides currently specified for an on-call rotation.</p>" 484 }, 485 "ListRotationShifts":{ 486 "name":"ListRotationShifts", 487 "http":{ 488 "method":"POST", 489 "requestUri":"/" 490 }, 491 "input":{"shape":"ListRotationShiftsRequest"}, 492 "output":{"shape":"ListRotationShiftsResult"}, 493 "errors":[ 494 {"shape":"AccessDeniedException"}, 495 {"shape":"ConflictException"}, 496 {"shape":"InternalServerException"}, 497 {"shape":"ResourceNotFoundException"}, 498 {"shape":"ThrottlingException"}, 499 {"shape":"ValidationException"} 500 ], 501 "documentation":"<p>Returns a list of shifts generated by an existing rotation in the system.</p>" 502 }, 503 "ListRotations":{ 504 "name":"ListRotations", 505 "http":{ 506 "method":"POST", 507 "requestUri":"/" 508 }, 509 "input":{"shape":"ListRotationsRequest"}, 510 "output":{"shape":"ListRotationsResult"}, 511 "errors":[ 512 {"shape":"AccessDeniedException"}, 513 {"shape":"InternalServerException"}, 514 {"shape":"ResourceNotFoundException"}, 515 {"shape":"ThrottlingException"}, 516 {"shape":"ValidationException"} 517 ], 518 "documentation":"<p>Retrieves a list of on-call rotations.</p>" 519 }, 520 "ListTagsForResource":{ 521 "name":"ListTagsForResource", 522 "http":{ 523 "method":"POST", 524 "requestUri":"/" 525 }, 526 "input":{"shape":"ListTagsForResourceRequest"}, 527 "output":{"shape":"ListTagsForResourceResult"}, 528 "errors":[ 529 {"shape":"AccessDeniedException"}, 530 {"shape":"ThrottlingException"}, 531 {"shape":"ResourceNotFoundException"}, 532 {"shape":"ValidationException"}, 533 {"shape":"InternalServerException"} 534 ], 535 "documentation":"<p>Lists the tags of an escalation plan or contact.</p>" 536 }, 537 "PutContactPolicy":{ 538 "name":"PutContactPolicy", 539 "http":{ 540 "method":"POST", 541 "requestUri":"/" 542 }, 543 "input":{"shape":"PutContactPolicyRequest"}, 544 "output":{"shape":"PutContactPolicyResult"}, 545 "errors":[ 546 {"shape":"AccessDeniedException"}, 547 {"shape":"ConflictException"}, 548 {"shape":"ValidationException"}, 549 {"shape":"ResourceNotFoundException"}, 550 {"shape":"ThrottlingException"}, 551 {"shape":"InternalServerException"} 552 ], 553 "documentation":"<p>Adds a resource policy to the specified contact or escalation plan. The resource policy is used to share the contact or escalation plan using Resource Access Manager (RAM). For more information about cross-account sharing, see <a href=\"https://docs.aws.amazon.com/incident-manager/latest/userguide/xa.html\">Setting up cross-account functionality</a>.</p>" 554 }, 555 "SendActivationCode":{ 556 "name":"SendActivationCode", 557 "http":{ 558 "method":"POST", 559 "requestUri":"/" 560 }, 561 "input":{"shape":"SendActivationCodeRequest"}, 562 "output":{"shape":"SendActivationCodeResult"}, 563 "errors":[ 564 {"shape":"AccessDeniedException"}, 565 {"shape":"DataEncryptionException"}, 566 {"shape":"InternalServerException"}, 567 {"shape":"ResourceNotFoundException"}, 568 {"shape":"ServiceQuotaExceededException"}, 569 {"shape":"ThrottlingException"}, 570 {"shape":"ValidationException"} 571 ], 572 "documentation":"<p>Sends an activation code to a contact channel. The contact can use this code to activate the contact channel in the console or with the <code>ActivateChannel</code> operation. Incident Manager can't engage a contact channel until it has been activated.</p>" 573 }, 574 "StartEngagement":{ 575 "name":"StartEngagement", 576 "http":{ 577 "method":"POST", 578 "requestUri":"/" 579 }, 580 "input":{"shape":"StartEngagementRequest"}, 581 "output":{"shape":"StartEngagementResult"}, 582 "errors":[ 583 {"shape":"AccessDeniedException"}, 584 {"shape":"DataEncryptionException"}, 585 {"shape":"InternalServerException"}, 586 {"shape":"ResourceNotFoundException"}, 587 {"shape":"ThrottlingException"}, 588 {"shape":"ValidationException"} 589 ], 590 "documentation":"<p>Starts an engagement to a contact or escalation plan. The engagement engages each contact specified in the incident.</p>" 591 }, 592 "StopEngagement":{ 593 "name":"StopEngagement", 594 "http":{ 595 "method":"POST", 596 "requestUri":"/" 597 }, 598 "input":{"shape":"StopEngagementRequest"}, 599 "output":{"shape":"StopEngagementResult"}, 600 "errors":[ 601 {"shape":"AccessDeniedException"}, 602 {"shape":"ValidationException"}, 603 {"shape":"ResourceNotFoundException"}, 604 {"shape":"ThrottlingException"}, 605 {"shape":"InternalServerException"} 606 ], 607 "documentation":"<p>Stops an engagement before it finishes the final stage of the escalation plan or engagement plan. Further contacts aren't engaged.</p>" 608 }, 609 "TagResource":{ 610 "name":"TagResource", 611 "http":{ 612 "method":"POST", 613 "requestUri":"/" 614 }, 615 "input":{"shape":"TagResourceRequest"}, 616 "output":{"shape":"TagResourceResult"}, 617 "errors":[ 618 {"shape":"AccessDeniedException"}, 619 {"shape":"ThrottlingException"}, 620 {"shape":"ResourceNotFoundException"}, 621 {"shape":"InternalServerException"}, 622 {"shape":"ServiceQuotaExceededException"}, 623 {"shape":"ValidationException"} 624 ], 625 "documentation":"<p>Tags a contact or escalation plan. You can tag only contacts and escalation plans in the first region of your replication set.</p>" 626 }, 627 "UntagResource":{ 628 "name":"UntagResource", 629 "http":{ 630 "method":"POST", 631 "requestUri":"/" 632 }, 633 "input":{"shape":"UntagResourceRequest"}, 634 "output":{"shape":"UntagResourceResult"}, 635 "errors":[ 636 {"shape":"AccessDeniedException"}, 637 {"shape":"ThrottlingException"}, 638 {"shape":"ResourceNotFoundException"}, 639 {"shape":"ValidationException"}, 640 {"shape":"InternalServerException"} 641 ], 642 "documentation":"<p>Removes tags from the specified resource.</p>" 643 }, 644 "UpdateContact":{ 645 "name":"UpdateContact", 646 "http":{ 647 "method":"POST", 648 "requestUri":"/" 649 }, 650 "input":{"shape":"UpdateContactRequest"}, 651 "output":{"shape":"UpdateContactResult"}, 652 "errors":[ 653 {"shape":"AccessDeniedException"}, 654 {"shape":"InternalServerException"}, 655 {"shape":"ResourceNotFoundException"}, 656 {"shape":"ServiceQuotaExceededException"}, 657 {"shape":"ThrottlingException"}, 658 {"shape":"ValidationException"}, 659 {"shape":"DataEncryptionException"} 660 ], 661 "documentation":"<p>Updates the contact or escalation plan specified.</p>" 662 }, 663 "UpdateContactChannel":{ 664 "name":"UpdateContactChannel", 665 "http":{ 666 "method":"POST", 667 "requestUri":"/" 668 }, 669 "input":{"shape":"UpdateContactChannelRequest"}, 670 "output":{"shape":"UpdateContactChannelResult"}, 671 "errors":[ 672 {"shape":"AccessDeniedException"}, 673 {"shape":"ConflictException"}, 674 {"shape":"DataEncryptionException"}, 675 {"shape":"InternalServerException"}, 676 {"shape":"ResourceNotFoundException"}, 677 {"shape":"ThrottlingException"}, 678 {"shape":"ValidationException"} 679 ], 680 "documentation":"<p>Updates a contact's contact channel.</p>" 681 }, 682 "UpdateRotation":{ 683 "name":"UpdateRotation", 684 "http":{ 685 "method":"POST", 686 "requestUri":"/" 687 }, 688 "input":{"shape":"UpdateRotationRequest"}, 689 "output":{"shape":"UpdateRotationResult"}, 690 "errors":[ 691 {"shape":"AccessDeniedException"}, 692 {"shape":"ConflictException"}, 693 {"shape":"InternalServerException"}, 694 {"shape":"ResourceNotFoundException"}, 695 {"shape":"ThrottlingException"}, 696 {"shape":"ValidationException"} 697 ], 698 "documentation":"<p>Updates the information specified for an on-call rotation.</p>" 699 } 700 }, 701 "shapes":{ 702 "AcceptCode":{ 703 "type":"string", 704 "max":10, 705 "min":6, 706 "pattern":"^[0-9]*$" 707 }, 708 "AcceptCodeValidation":{ 709 "type":"string", 710 "enum":[ 711 "IGNORE", 712 "ENFORCE" 713 ] 714 }, 715 "AcceptPageRequest":{ 716 "type":"structure", 717 "required":[ 718 "PageId", 719 "AcceptType", 720 "AcceptCode" 721 ], 722 "members":{ 723 "PageId":{ 724 "shape":"SsmContactsArn", 725 "documentation":"<p>The Amazon Resource Name (ARN) of the engagement to a contact channel.</p>" 726 }, 727 "ContactChannelId":{ 728 "shape":"SsmContactsArn", 729 "documentation":"<p>The ARN of the contact channel.</p>" 730 }, 731 "AcceptType":{ 732 "shape":"AcceptType", 733 "documentation":"<p>The type indicates if the page was <code>DELIVERED</code> or <code>READ</code>.</p>" 734 }, 735 "Note":{ 736 "shape":"ReceiptInfo", 737 "documentation":"<p>Information provided by the user when the user acknowledges the page.</p>" 738 }, 739 "AcceptCode":{ 740 "shape":"AcceptCode", 741 "documentation":"<p>A 6-digit code used to acknowledge the page.</p>" 742 }, 743 "AcceptCodeValidation":{ 744 "shape":"AcceptCodeValidation", 745 "documentation":"<p>An optional field that Incident Manager uses to <code>ENFORCE</code> <code>AcceptCode</code> validation when acknowledging an page. Acknowledgement can occur by replying to a page, or when entering the AcceptCode in the console. Enforcing AcceptCode validation causes Incident Manager to verify that the code entered by the user matches the code sent by Incident Manager with the page.</p> <p>Incident Manager can also <code>IGNORE</code> <code>AcceptCode</code> validation. Ignoring <code>AcceptCode</code> validation causes Incident Manager to accept any value entered for the <code>AcceptCode</code>.</p>" 746 } 747 } 748 }, 749 "AcceptPageResult":{ 750 "type":"structure", 751 "members":{ 752 } 753 }, 754 "AcceptType":{ 755 "type":"string", 756 "enum":[ 757 "DELIVERED", 758 "READ" 759 ] 760 }, 761 "AccessDeniedException":{ 762 "type":"structure", 763 "required":["Message"], 764 "members":{ 765 "Message":{"shape":"String"} 766 }, 767 "documentation":"<p>You don't have sufficient access to perform this operation.</p>", 768 "exception":true 769 }, 770 "ActivateContactChannelRequest":{ 771 "type":"structure", 772 "required":[ 773 "ContactChannelId", 774 "ActivationCode" 775 ], 776 "members":{ 777 "ContactChannelId":{ 778 "shape":"SsmContactsArn", 779 "documentation":"<p>The Amazon Resource Name (ARN) of the contact channel.</p>" 780 }, 781 "ActivationCode":{ 782 "shape":"ActivationCode", 783 "documentation":"<p>The code sent to the contact channel when it was created in the contact.</p>" 784 } 785 } 786 }, 787 "ActivateContactChannelResult":{ 788 "type":"structure", 789 "members":{ 790 } 791 }, 792 "ActivationCode":{ 793 "type":"string", 794 "max":10, 795 "min":6, 796 "pattern":"^[0-9]*$" 797 }, 798 "ActivationStatus":{ 799 "type":"string", 800 "enum":[ 801 "ACTIVATED", 802 "NOT_ACTIVATED" 803 ] 804 }, 805 "AmazonResourceName":{ 806 "type":"string", 807 "max":1011, 808 "min":1 809 }, 810 "ChannelName":{ 811 "type":"string", 812 "max":255, 813 "min":1, 814 "pattern":"^[\\p{L}\\p{Z}\\p{N}_.\\-]*$" 815 }, 816 "ChannelTargetInfo":{ 817 "type":"structure", 818 "required":["ContactChannelId"], 819 "members":{ 820 "ContactChannelId":{ 821 "shape":"SsmContactsArn", 822 "documentation":"<p>The Amazon Resource Name (ARN) of the contact channel.</p>" 823 }, 824 "RetryIntervalInMinutes":{ 825 "shape":"RetryIntervalInMinutes", 826 "documentation":"<p>The number of minutes to wait to retry sending engagement in the case the engagement initially fails.</p>" 827 } 828 }, 829 "documentation":"<p>Information about the contact channel that Incident Manager uses to engage the contact.</p>" 830 }, 831 "ChannelType":{ 832 "type":"string", 833 "enum":[ 834 "SMS", 835 "VOICE", 836 "EMAIL" 837 ] 838 }, 839 "ConflictException":{ 840 "type":"structure", 841 "required":[ 842 "Message", 843 "ResourceId", 844 "ResourceType" 845 ], 846 "members":{ 847 "Message":{"shape":"String"}, 848 "ResourceId":{ 849 "shape":"String", 850 "documentation":"Identifier of the resource in use" 851 }, 852 "ResourceType":{ 853 "shape":"String", 854 "documentation":"Type of the resource in use" 855 }, 856 "DependentEntities":{ 857 "shape":"DependentEntityList", 858 "documentation":"List of dependent entities containing information on relation type and resourceArns linked to the resource in use" 859 } 860 }, 861 "documentation":"<p>Updating or deleting a resource causes an inconsistent state.</p>", 862 "exception":true 863 }, 864 "Contact":{ 865 "type":"structure", 866 "required":[ 867 "ContactArn", 868 "Alias", 869 "Type" 870 ], 871 "members":{ 872 "ContactArn":{ 873 "shape":"SsmContactsArn", 874 "documentation":"<p>The Amazon Resource Name (ARN) of the contact or escalation plan.</p>" 875 }, 876 "Alias":{ 877 "shape":"ContactAlias", 878 "documentation":"<p>The unique and identifiable alias of the contact or escalation plan.</p>" 879 }, 880 "DisplayName":{ 881 "shape":"ContactName", 882 "documentation":"<p>The full name of the contact or escalation plan.</p>" 883 }, 884 "Type":{ 885 "shape":"ContactType", 886 "documentation":"<p>Refers to the type of contact. A single contact is type <code>PERSONAL</code> and an escalation plan is type <code>ESCALATION</code>.</p>" 887 } 888 }, 889 "documentation":"<p>A personal contact or escalation plan that Incident Manager engages during an incident.</p>" 890 }, 891 "ContactAlias":{ 892 "type":"string", 893 "max":255, 894 "min":1, 895 "pattern":"^[a-z0-9_\\-]*$" 896 }, 897 "ContactChannel":{ 898 "type":"structure", 899 "required":[ 900 "ContactChannelArn", 901 "ContactArn", 902 "Name", 903 "DeliveryAddress", 904 "ActivationStatus" 905 ], 906 "members":{ 907 "ContactChannelArn":{ 908 "shape":"SsmContactsArn", 909 "documentation":"<p>The Amazon Resource Name (ARN) of the contact channel.</p>" 910 }, 911 "ContactArn":{ 912 "shape":"SsmContactsArn", 913 "documentation":"<p>The ARN of the contact that contains the contact channel.</p>" 914 }, 915 "Name":{ 916 "shape":"ChannelName", 917 "documentation":"<p>The name of the contact channel.</p>" 918 }, 919 "Type":{ 920 "shape":"ChannelType", 921 "documentation":"<p>The type of the contact channel. Incident Manager supports three contact methods:</p> <ul> <li> <p>SMS</p> </li> <li> <p>VOICE</p> </li> <li> <p>EMAIL</p> </li> </ul>" 922 }, 923 "DeliveryAddress":{ 924 "shape":"ContactChannelAddress", 925 "documentation":"<p>The details that Incident Manager uses when trying to engage the contact channel.</p>" 926 }, 927 "ActivationStatus":{ 928 "shape":"ActivationStatus", 929 "documentation":"<p>A Boolean value describing if the contact channel has been activated or not. If the contact channel isn't activated, Incident Manager can't engage the contact through it.</p>" 930 } 931 }, 932 "documentation":"<p>The method that Incident Manager uses to engage a contact.</p>" 933 }, 934 "ContactChannelAddress":{ 935 "type":"structure", 936 "members":{ 937 "SimpleAddress":{ 938 "shape":"SimpleAddress", 939 "documentation":"<p>The format is dependent on the type of the contact channel. The following are the expected formats:</p> <ul> <li> <p>SMS - '+' followed by the country code and phone number</p> </li> <li> <p>VOICE - '+' followed by the country code and phone number</p> </li> <li> <p>EMAIL - any standard email format</p> </li> </ul>" 940 } 941 }, 942 "documentation":"<p>The details that Incident Manager uses when trying to engage the contact channel.</p>" 943 }, 944 "ContactChannelList":{ 945 "type":"list", 946 "member":{"shape":"ContactChannel"} 947 }, 948 "ContactName":{ 949 "type":"string", 950 "max":255, 951 "min":0, 952 "pattern":"^[\\p{L}\\p{Z}\\p{N}_.\\-]*$" 953 }, 954 "ContactTargetInfo":{ 955 "type":"structure", 956 "required":["IsEssential"], 957 "members":{ 958 "ContactId":{ 959 "shape":"SsmContactsArn", 960 "documentation":"<p>The Amazon Resource Name (ARN) of the contact.</p>" 961 }, 962 "IsEssential":{ 963 "shape":"IsEssential", 964 "documentation":"<p>A Boolean value determining if the contact's acknowledgement stops the progress of stages in the plan.</p>" 965 } 966 }, 967 "documentation":"<p>The contact that Incident Manager is engaging during an incident.</p>" 968 }, 969 "ContactType":{ 970 "type":"string", 971 "enum":[ 972 "PERSONAL", 973 "ESCALATION", 974 "ONCALL_SCHEDULE" 975 ] 976 }, 977 "ContactsList":{ 978 "type":"list", 979 "member":{"shape":"Contact"} 980 }, 981 "Content":{ 982 "type":"string", 983 "max":8192, 984 "min":1, 985 "pattern":"^[.\\s\\S]*$" 986 }, 987 "CoverageTime":{ 988 "type":"structure", 989 "members":{ 990 "Start":{ 991 "shape":"HandOffTime", 992 "documentation":"<p>Information about when the on-call rotation shift begins.</p>" 993 }, 994 "End":{ 995 "shape":"HandOffTime", 996 "documentation":"<p>Information about when the on-call rotation shift ends.</p>" 997 } 998 }, 999 "documentation":"<p>Information about when an on-call shift begins and ends.</p>" 1000 }, 1001 "CoverageTimes":{ 1002 "type":"list", 1003 "member":{"shape":"CoverageTime"} 1004 }, 1005 "CreateContactChannelRequest":{ 1006 "type":"structure", 1007 "required":[ 1008 "ContactId", 1009 "Name", 1010 "Type", 1011 "DeliveryAddress" 1012 ], 1013 "members":{ 1014 "ContactId":{ 1015 "shape":"SsmContactsArn", 1016 "documentation":"<p>The Amazon Resource Name (ARN) of the contact you are adding the contact channel to.</p>" 1017 }, 1018 "Name":{ 1019 "shape":"ChannelName", 1020 "documentation":"<p>The name of the contact channel.</p>" 1021 }, 1022 "Type":{ 1023 "shape":"ChannelType", 1024 "documentation":"<p>Incident Manager supports three types of contact channels:</p> <ul> <li> <p> <code>SMS</code> </p> </li> <li> <p> <code>VOICE</code> </p> </li> <li> <p> <code>EMAIL</code> </p> </li> </ul>" 1025 }, 1026 "DeliveryAddress":{ 1027 "shape":"ContactChannelAddress", 1028 "documentation":"<p>The details that Incident Manager uses when trying to engage the contact channel. The format is dependent on the type of the contact channel. The following are the expected formats:</p> <ul> <li> <p>SMS - '+' followed by the country code and phone number</p> </li> <li> <p>VOICE - '+' followed by the country code and phone number</p> </li> <li> <p>EMAIL - any standard email format</p> </li> </ul>" 1029 }, 1030 "DeferActivation":{ 1031 "shape":"DeferActivation", 1032 "documentation":"<p>If you want to activate the channel at a later time, you can choose to defer activation. Incident Manager can't engage your contact channel until it has been activated.</p>" 1033 }, 1034 "IdempotencyToken":{ 1035 "shape":"IdempotencyToken", 1036 "documentation":"<p>A token ensuring that the operation is called only once with the specified details.</p>", 1037 "idempotencyToken":true 1038 } 1039 } 1040 }, 1041 "CreateContactChannelResult":{ 1042 "type":"structure", 1043 "required":["ContactChannelArn"], 1044 "members":{ 1045 "ContactChannelArn":{ 1046 "shape":"SsmContactsArn", 1047 "documentation":"<p>The Amazon Resource Name (ARN) of the contact channel.</p>" 1048 } 1049 } 1050 }, 1051 "CreateContactRequest":{ 1052 "type":"structure", 1053 "required":[ 1054 "Alias", 1055 "Type", 1056 "Plan" 1057 ], 1058 "members":{ 1059 "Alias":{ 1060 "shape":"ContactAlias", 1061 "documentation":"<p>The short name to quickly identify a contact or escalation plan. The contact alias must be unique and identifiable.</p>" 1062 }, 1063 "DisplayName":{ 1064 "shape":"ContactName", 1065 "documentation":"<p>The full name of the contact or escalation plan.</p>" 1066 }, 1067 "Type":{ 1068 "shape":"ContactType", 1069 "documentation":"<p>To create an escalation plan use <code>ESCALATION</code>. To create a contact use <code>PERSONAL</code>.</p>" 1070 }, 1071 "Plan":{ 1072 "shape":"Plan", 1073 "documentation":"<p>A list of stages. A contact has an engagement plan with stages that contact specified contact channels. An escalation plan uses stages that contact specified contacts.</p>" 1074 }, 1075 "Tags":{ 1076 "shape":"TagsList", 1077 "documentation":"<p>Adds a tag to the target. You can only tag resources created in the first Region of your replication set.</p>" 1078 }, 1079 "IdempotencyToken":{ 1080 "shape":"IdempotencyToken", 1081 "documentation":"<p>A token ensuring that the operation is called only once with the specified details.</p>", 1082 "idempotencyToken":true 1083 } 1084 } 1085 }, 1086 "CreateContactResult":{ 1087 "type":"structure", 1088 "required":["ContactArn"], 1089 "members":{ 1090 "ContactArn":{ 1091 "shape":"SsmContactsArn", 1092 "documentation":"<p>The Amazon Resource Name (ARN) of the created contact or escalation plan.</p>" 1093 } 1094 } 1095 }, 1096 "CreateRotationOverrideRequest":{ 1097 "type":"structure", 1098 "required":[ 1099 "RotationId", 1100 "NewContactIds", 1101 "StartTime", 1102 "EndTime" 1103 ], 1104 "members":{ 1105 "RotationId":{ 1106 "shape":"SsmContactsArn", 1107 "documentation":"<p>The Amazon Resource Name (ARN) of the rotation to create an override for.</p>" 1108 }, 1109 "NewContactIds":{ 1110 "shape":"RotationOverrideContactsArnList", 1111 "documentation":"<p>The Amazon Resource Names (ARNs) of the contacts to replace those in the current on-call rotation with.</p> <p>If you want to include any current team members in the override shift, you must include their ARNs in the new contact ID list.</p>" 1112 }, 1113 "StartTime":{ 1114 "shape":"DateTime", 1115 "documentation":"<p>The date and time when the override goes into effect.</p>" 1116 }, 1117 "EndTime":{ 1118 "shape":"DateTime", 1119 "documentation":"<p>The date and time when the override ends.</p>" 1120 }, 1121 "IdempotencyToken":{ 1122 "shape":"IdempotencyToken", 1123 "documentation":"<p>A token that ensures that the operation is called only once with the specified details.</p>" 1124 } 1125 } 1126 }, 1127 "CreateRotationOverrideResult":{ 1128 "type":"structure", 1129 "required":["RotationOverrideId"], 1130 "members":{ 1131 "RotationOverrideId":{ 1132 "shape":"Uuid", 1133 "documentation":"<p>The Amazon Resource Name (ARN) of the created rotation override.</p>" 1134 } 1135 } 1136 }, 1137 "CreateRotationRequest":{ 1138 "type":"structure", 1139 "required":[ 1140 "Name", 1141 "ContactIds", 1142 "TimeZoneId", 1143 "Recurrence" 1144 ], 1145 "members":{ 1146 "Name":{ 1147 "shape":"RotationName", 1148 "documentation":"<p>The name of the rotation.</p>" 1149 }, 1150 "ContactIds":{ 1151 "shape":"RotationContactsArnList", 1152 "documentation":"<p>The Amazon Resource Names (ARNs) of the contacts to add to the rotation.</p> <p>The order that you list the contacts in is their shift order in the rotation schedule. To change the order of the contact's shifts, use the <a>UpdateRotation</a> operation.</p>" 1153 }, 1154 "StartTime":{ 1155 "shape":"DateTime", 1156 "documentation":"<p>The date and time that the rotation goes into effect.</p>" 1157 }, 1158 "TimeZoneId":{ 1159 "shape":"TimeZoneId", 1160 "documentation":"<p>The time zone to base the rotation’s activity on in Internet Assigned Numbers Authority (IANA) format. For example: \"America/Los_Angeles\", \"UTC\", or \"Asia/Seoul\". For more information, see the <a href=\"https://www.iana.org/time-zones\">Time Zone Database</a> on the IANA website.</p> <note> <p>Designators for time zones that don’t support Daylight Savings Time rules, such as Pacific Standard Time (PST) and Pacific Daylight Time (PDT), are not supported.</p> </note>" 1161 }, 1162 "Recurrence":{ 1163 "shape":"RecurrenceSettings", 1164 "documentation":"<p>Information about the rule that specifies when a shift's team members rotate.</p>" 1165 }, 1166 "Tags":{ 1167 "shape":"TagsList", 1168 "documentation":"<p>Optional metadata to assign to the rotation. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For more information, see <a href=\"https://docs.aws.amazon.com/incident-manager/latest/userguide/tagging.html\">Tagging Incident Manager resources</a> in the <i>Incident Manager User Guide</i>.</p>" 1169 }, 1170 "IdempotencyToken":{ 1171 "shape":"IdempotencyToken", 1172 "documentation":"<p>A token that ensures that the operation is called only once with the specified details.</p>" 1173 } 1174 } 1175 }, 1176 "CreateRotationResult":{ 1177 "type":"structure", 1178 "required":["RotationArn"], 1179 "members":{ 1180 "RotationArn":{ 1181 "shape":"SsmContactsArn", 1182 "documentation":"<p>The Amazon Resource Name (ARN) of the created rotation.</p>" 1183 } 1184 } 1185 }, 1186 "DailySettings":{ 1187 "type":"list", 1188 "member":{"shape":"HandOffTime"} 1189 }, 1190 "DataEncryptionException":{ 1191 "type":"structure", 1192 "required":["Message"], 1193 "members":{ 1194 "Message":{"shape":"String"} 1195 }, 1196 "documentation":"<p>The operation failed to due an encryption key error.</p>", 1197 "exception":true 1198 }, 1199 "DateTime":{"type":"timestamp"}, 1200 "DayOfMonth":{ 1201 "type":"integer", 1202 "max":31, 1203 "min":1 1204 }, 1205 "DayOfWeek":{ 1206 "type":"string", 1207 "enum":[ 1208 "MON", 1209 "TUE", 1210 "WED", 1211 "THU", 1212 "FRI", 1213 "SAT", 1214 "SUN" 1215 ] 1216 }, 1217 "DeactivateContactChannelRequest":{ 1218 "type":"structure", 1219 "required":["ContactChannelId"], 1220 "members":{ 1221 "ContactChannelId":{ 1222 "shape":"SsmContactsArn", 1223 "documentation":"<p>The Amazon Resource Name (ARN) of the contact channel you're deactivating.</p>" 1224 } 1225 } 1226 }, 1227 "DeactivateContactChannelResult":{ 1228 "type":"structure", 1229 "members":{ 1230 } 1231 }, 1232 "DeferActivation":{ 1233 "type":"boolean", 1234 "box":true 1235 }, 1236 "DeleteContactChannelRequest":{ 1237 "type":"structure", 1238 "required":["ContactChannelId"], 1239 "members":{ 1240 "ContactChannelId":{ 1241 "shape":"SsmContactsArn", 1242 "documentation":"<p>The Amazon Resource Name (ARN) of the contact channel.</p>" 1243 } 1244 } 1245 }, 1246 "DeleteContactChannelResult":{ 1247 "type":"structure", 1248 "members":{ 1249 } 1250 }, 1251 "DeleteContactRequest":{ 1252 "type":"structure", 1253 "required":["ContactId"], 1254 "members":{ 1255 "ContactId":{ 1256 "shape":"SsmContactsArn", 1257 "documentation":"<p>The Amazon Resource Name (ARN) of the contact that you're deleting.</p>" 1258 } 1259 } 1260 }, 1261 "DeleteContactResult":{ 1262 "type":"structure", 1263 "members":{ 1264 } 1265 }, 1266 "DeleteRotationOverrideRequest":{ 1267 "type":"structure", 1268 "required":[ 1269 "RotationId", 1270 "RotationOverrideId" 1271 ], 1272 "members":{ 1273 "RotationId":{ 1274 "shape":"SsmContactsArn", 1275 "documentation":"<p>The Amazon Resource Name (ARN) of the rotation that was overridden.</p>" 1276 }, 1277 "RotationOverrideId":{ 1278 "shape":"Uuid", 1279 "documentation":"<p>The Amazon Resource Name (ARN) of the on-call rotation override to delete.</p>" 1280 } 1281 } 1282 }, 1283 "DeleteRotationOverrideResult":{ 1284 "type":"structure", 1285 "members":{ 1286 } 1287 }, 1288 "DeleteRotationRequest":{ 1289 "type":"structure", 1290 "required":["RotationId"], 1291 "members":{ 1292 "RotationId":{ 1293 "shape":"SsmContactsArn", 1294 "documentation":"<p>The Amazon Resource Name (ARN) of the on-call rotation to delete.</p>" 1295 } 1296 } 1297 }, 1298 "DeleteRotationResult":{ 1299 "type":"structure", 1300 "members":{ 1301 } 1302 }, 1303 "DependentEntity":{ 1304 "type":"structure", 1305 "required":[ 1306 "RelationType", 1307 "DependentResourceIds" 1308 ], 1309 "members":{ 1310 "RelationType":{ 1311 "shape":"String", 1312 "documentation":"<p>The type of relationship between one resource and the other resource that it is related to or depends on.</p>" 1313 }, 1314 "DependentResourceIds":{ 1315 "shape":"SsmContactsArnList", 1316 "documentation":"<p>The Amazon Resource Names (ARNs) of the dependent resources.</p>" 1317 } 1318 }, 1319 "documentation":"<p>Information about a resource that another resource is related to or depends on.</p> <p>For example, if a contact is a member of a rotation, the rotation is a dependent entity of the contact.</p>" 1320 }, 1321 "DependentEntityList":{ 1322 "type":"list", 1323 "member":{"shape":"DependentEntity"} 1324 }, 1325 "DescribeEngagementRequest":{ 1326 "type":"structure", 1327 "required":["EngagementId"], 1328 "members":{ 1329 "EngagementId":{ 1330 "shape":"SsmContactsArn", 1331 "documentation":"<p>The Amazon Resource Name (ARN) of the engagement you want the details of.</p>" 1332 } 1333 } 1334 }, 1335 "DescribeEngagementResult":{ 1336 "type":"structure", 1337 "required":[ 1338 "ContactArn", 1339 "EngagementArn", 1340 "Sender", 1341 "Subject", 1342 "Content" 1343 ], 1344 "members":{ 1345 "ContactArn":{ 1346 "shape":"SsmContactsArn", 1347 "documentation":"<p>The ARN of the escalation plan or contacts involved in the engagement.</p>" 1348 }, 1349 "EngagementArn":{ 1350 "shape":"SsmContactsArn", 1351 "documentation":"<p>The ARN of the engagement.</p>" 1352 }, 1353 "Sender":{ 1354 "shape":"Sender", 1355 "documentation":"<p>The user that started the engagement.</p>" 1356 }, 1357 "Subject":{ 1358 "shape":"Subject", 1359 "documentation":"<p>The secure subject of the message that was sent to the contact. Use this field for engagements to <code>VOICE</code> and <code>EMAIL</code>.</p>" 1360 }, 1361 "Content":{ 1362 "shape":"Content", 1363 "documentation":"<p>The secure content of the message that was sent to the contact. Use this field for engagements to <code>VOICE</code> and <code>EMAIL</code>.</p>" 1364 }, 1365 "PublicSubject":{ 1366 "shape":"PublicSubject", 1367 "documentation":"<p>The insecure subject of the message that was sent to the contact. Use this field for engagements to <code>SMS</code>.</p>" 1368 }, 1369 "PublicContent":{ 1370 "shape":"PublicContent", 1371 "documentation":"<p>The insecure content of the message that was sent to the contact. Use this field for engagements to <code>SMS</code>.</p>" 1372 }, 1373 "IncidentId":{ 1374 "shape":"IncidentId", 1375 "documentation":"<p>The ARN of the incident in which the engagement occurred.</p>" 1376 }, 1377 "StartTime":{ 1378 "shape":"DateTime", 1379 "documentation":"<p>The time that the engagement started.</p>" 1380 }, 1381 "StopTime":{ 1382 "shape":"DateTime", 1383 "documentation":"<p>The time that the engagement ended.</p>" 1384 } 1385 } 1386 }, 1387 "DescribePageRequest":{ 1388 "type":"structure", 1389 "required":["PageId"], 1390 "members":{ 1391 "PageId":{ 1392 "shape":"SsmContactsArn", 1393 "documentation":"<p>The ID of the engagement to a contact channel.</p>" 1394 } 1395 } 1396 }, 1397 "DescribePageResult":{ 1398 "type":"structure", 1399 "required":[ 1400 "PageArn", 1401 "EngagementArn", 1402 "ContactArn", 1403 "Sender", 1404 "Subject", 1405 "Content" 1406 ], 1407 "members":{ 1408 "PageArn":{ 1409 "shape":"SsmContactsArn", 1410 "documentation":"<p>The Amazon Resource Name (ARN) of the engagement to a contact channel.</p>" 1411 }, 1412 "EngagementArn":{ 1413 "shape":"SsmContactsArn", 1414 "documentation":"<p>The ARN of the engagement that engaged the contact channel.</p>" 1415 }, 1416 "ContactArn":{ 1417 "shape":"SsmContactsArn", 1418 "documentation":"<p>The ARN of the contact that was engaged.</p>" 1419 }, 1420 "Sender":{ 1421 "shape":"Sender", 1422 "documentation":"<p>The user that started the engagement.</p>" 1423 }, 1424 "Subject":{ 1425 "shape":"Subject", 1426 "documentation":"<p>The secure subject of the message that was sent to the contact. Use this field for engagements to <code>VOICE</code> and <code>EMAIL</code>.</p>" 1427 }, 1428 "Content":{ 1429 "shape":"Content", 1430 "documentation":"<p>The secure content of the message that was sent to the contact. Use this field for engagements to <code>VOICE</code> and <code>EMAIL</code>.</p>" 1431 }, 1432 "PublicSubject":{ 1433 "shape":"PublicSubject", 1434 "documentation":"<p>The insecure subject of the message that was sent to the contact. Use this field for engagements to <code>SMS</code>.</p>" 1435 }, 1436 "PublicContent":{ 1437 "shape":"PublicContent", 1438 "documentation":"<p>The insecure content of the message that was sent to the contact. Use this field for engagements to <code>SMS</code>.</p>" 1439 }, 1440 "IncidentId":{ 1441 "shape":"IncidentId", 1442 "documentation":"<p>The ARN of the incident that engaged the contact channel.</p>" 1443 }, 1444 "SentTime":{ 1445 "shape":"DateTime", 1446 "documentation":"<p>The time the engagement was sent to the contact channel.</p>" 1447 }, 1448 "ReadTime":{ 1449 "shape":"DateTime", 1450 "documentation":"<p>The time that the contact channel acknowledged the engagement.</p>" 1451 }, 1452 "DeliveryTime":{ 1453 "shape":"DateTime", 1454 "documentation":"<p>The time that the contact channel received the engagement.</p>" 1455 } 1456 } 1457 }, 1458 "Engagement":{ 1459 "type":"structure", 1460 "required":[ 1461 "EngagementArn", 1462 "ContactArn", 1463 "Sender" 1464 ], 1465 "members":{ 1466 "EngagementArn":{ 1467 "shape":"SsmContactsArn", 1468 "documentation":"<p>The Amazon Resource Name (ARN) of the engagement.</p>" 1469 }, 1470 "ContactArn":{ 1471 "shape":"SsmContactsArn", 1472 "documentation":"<p>The ARN of the escalation plan or contact that Incident Manager is engaging.</p>" 1473 }, 1474 "Sender":{ 1475 "shape":"Sender", 1476 "documentation":"<p>The user that started the engagement.</p>" 1477 }, 1478 "IncidentId":{ 1479 "shape":"IncidentId", 1480 "documentation":"<p>The ARN of the incident that's engaging the contact.</p>" 1481 }, 1482 "StartTime":{ 1483 "shape":"DateTime", 1484 "documentation":"<p>The time that the engagement began.</p>" 1485 }, 1486 "StopTime":{ 1487 "shape":"DateTime", 1488 "documentation":"<p>The time that the engagement ended.</p>" 1489 } 1490 }, 1491 "documentation":"<p>Incident Manager reaching out to a contact or escalation plan to engage contact during an incident.</p>" 1492 }, 1493 "EngagementsList":{ 1494 "type":"list", 1495 "member":{"shape":"Engagement"} 1496 }, 1497 "GetContactChannelRequest":{ 1498 "type":"structure", 1499 "required":["ContactChannelId"], 1500 "members":{ 1501 "ContactChannelId":{ 1502 "shape":"SsmContactsArn", 1503 "documentation":"<p>The Amazon Resource Name (ARN) of the contact channel you want information about.</p>" 1504 } 1505 } 1506 }, 1507 "GetContactChannelResult":{ 1508 "type":"structure", 1509 "required":[ 1510 "ContactArn", 1511 "ContactChannelArn", 1512 "Name", 1513 "Type", 1514 "DeliveryAddress" 1515 ], 1516 "members":{ 1517 "ContactArn":{ 1518 "shape":"SsmContactsArn", 1519 "documentation":"<p>The ARN of the contact that the channel belongs to.</p>" 1520 }, 1521 "ContactChannelArn":{ 1522 "shape":"SsmContactsArn", 1523 "documentation":"<p>The ARN of the contact channel.</p>" 1524 }, 1525 "Name":{ 1526 "shape":"ChannelName", 1527 "documentation":"<p>The name of the contact channel</p>" 1528 }, 1529 "Type":{ 1530 "shape":"ChannelType", 1531 "documentation":"<p>The type of contact channel. The type is <code>SMS</code>, <code>VOICE</code>, or <code>EMAIL</code>.</p>" 1532 }, 1533 "DeliveryAddress":{ 1534 "shape":"ContactChannelAddress", 1535 "documentation":"<p>The details that Incident Manager uses when trying to engage the contact channel.</p>" 1536 }, 1537 "ActivationStatus":{ 1538 "shape":"ActivationStatus", 1539 "documentation":"<p>A Boolean value indicating if the contact channel has been activated or not.</p>" 1540 } 1541 } 1542 }, 1543 "GetContactPolicyRequest":{ 1544 "type":"structure", 1545 "required":["ContactArn"], 1546 "members":{ 1547 "ContactArn":{ 1548 "shape":"SsmContactsArn", 1549 "documentation":"<p>The Amazon Resource Name (ARN) of the contact or escalation plan.</p>" 1550 } 1551 } 1552 }, 1553 "GetContactPolicyResult":{ 1554 "type":"structure", 1555 "members":{ 1556 "ContactArn":{ 1557 "shape":"SsmContactsArn", 1558 "documentation":"<p>The ARN of the contact or escalation plan.</p>" 1559 }, 1560 "Policy":{ 1561 "shape":"Policy", 1562 "documentation":"<p>Details about the resource policy attached to the contact or escalation plan.</p>" 1563 } 1564 } 1565 }, 1566 "GetContactRequest":{ 1567 "type":"structure", 1568 "required":["ContactId"], 1569 "members":{ 1570 "ContactId":{ 1571 "shape":"SsmContactsArn", 1572 "documentation":"<p>The Amazon Resource Name (ARN) of the contact or escalation plan.</p>" 1573 } 1574 } 1575 }, 1576 "GetContactResult":{ 1577 "type":"structure", 1578 "required":[ 1579 "ContactArn", 1580 "Alias", 1581 "Type", 1582 "Plan" 1583 ], 1584 "members":{ 1585 "ContactArn":{ 1586 "shape":"SsmContactsArn", 1587 "documentation":"<p>The ARN of the contact or escalation plan.</p>" 1588 }, 1589 "Alias":{ 1590 "shape":"ContactAlias", 1591 "documentation":"<p>The alias of the contact or escalation plan. The alias is unique and identifiable.</p>" 1592 }, 1593 "DisplayName":{ 1594 "shape":"ContactName", 1595 "documentation":"<p>The full name of the contact or escalation plan.</p>" 1596 }, 1597 "Type":{ 1598 "shape":"ContactType", 1599 "documentation":"<p>The type of contact, either <code>PERSONAL</code> or <code>ESCALATION</code>.</p>" 1600 }, 1601 "Plan":{ 1602 "shape":"Plan", 1603 "documentation":"<p>Details about the specific timing or stages and targets of the escalation plan or engagement plan.</p>" 1604 } 1605 } 1606 }, 1607 "GetRotationOverrideRequest":{ 1608 "type":"structure", 1609 "required":[ 1610 "RotationId", 1611 "RotationOverrideId" 1612 ], 1613 "members":{ 1614 "RotationId":{ 1615 "shape":"SsmContactsArn", 1616 "documentation":"<p>The Amazon Resource Name (ARN) of the overridden rotation to retrieve information about.</p>" 1617 }, 1618 "RotationOverrideId":{ 1619 "shape":"Uuid", 1620 "documentation":"<p>The Amazon Resource Name (ARN) of the on-call rotation override to retrieve information about.</p>" 1621 } 1622 } 1623 }, 1624 "GetRotationOverrideResult":{ 1625 "type":"structure", 1626 "members":{ 1627 "RotationOverrideId":{ 1628 "shape":"Uuid", 1629 "documentation":"<p>The Amazon Resource Name (ARN) of the override to an on-call rotation.</p>" 1630 }, 1631 "RotationArn":{ 1632 "shape":"SsmContactsArn", 1633 "documentation":"<p>The Amazon Resource Name (ARN) of the on-call rotation that was overridden.</p>" 1634 }, 1635 "NewContactIds":{ 1636 "shape":"SsmContactsArnList", 1637 "documentation":"<p>The Amazon Resource Names (ARNs) of the contacts assigned to the override of the on-call rotation.</p>" 1638 }, 1639 "StartTime":{ 1640 "shape":"DateTime", 1641 "documentation":"<p>The date and time when the override goes into effect.</p>" 1642 }, 1643 "EndTime":{ 1644 "shape":"DateTime", 1645 "documentation":"<p>The date and time when the override ends.</p>" 1646 }, 1647 "CreateTime":{ 1648 "shape":"DateTime", 1649 "documentation":"<p>The date and time when the override was created.</p>" 1650 } 1651 } 1652 }, 1653 "GetRotationRequest":{ 1654 "type":"structure", 1655 "required":["RotationId"], 1656 "members":{ 1657 "RotationId":{ 1658 "shape":"SsmContactsArn", 1659 "documentation":"<p>The Amazon Resource Name (ARN) of the on-call rotation to retrieve information about.</p>" 1660 } 1661 } 1662 }, 1663 "GetRotationResult":{ 1664 "type":"structure", 1665 "required":[ 1666 "RotationArn", 1667 "Name", 1668 "ContactIds", 1669 "StartTime", 1670 "TimeZoneId", 1671 "Recurrence" 1672 ], 1673 "members":{ 1674 "RotationArn":{ 1675 "shape":"SsmContactsArn", 1676 "documentation":"<p>The Amazon Resource Name (ARN) of the on-call rotation.</p>" 1677 }, 1678 "Name":{ 1679 "shape":"RotationName", 1680 "documentation":"<p>The name of the on-call rotation.</p>" 1681 }, 1682 "ContactIds":{ 1683 "shape":"RotationContactsArnList", 1684 "documentation":"<p>The Amazon Resource Names (ARNs) of the contacts assigned to the on-call rotation team.</p>" 1685 }, 1686 "StartTime":{ 1687 "shape":"DateTime", 1688 "documentation":"<p>The specified start time for the on-call rotation.</p>" 1689 }, 1690 "TimeZoneId":{ 1691 "shape":"TimeZoneId", 1692 "documentation":"<p>The time zone that the rotation’s activity is based on, in Internet Assigned Numbers Authority (IANA) format.</p>" 1693 }, 1694 "Recurrence":{ 1695 "shape":"RecurrenceSettings", 1696 "documentation":"<p>Specifies how long a rotation lasts before restarting at the beginning of the shift order.</p>" 1697 } 1698 } 1699 }, 1700 "HandOffTime":{ 1701 "type":"structure", 1702 "required":[ 1703 "HourOfDay", 1704 "MinuteOfHour" 1705 ], 1706 "members":{ 1707 "HourOfDay":{ 1708 "shape":"HourOfDay", 1709 "documentation":"<p>The hour when an on-call rotation shift begins or ends.</p>" 1710 }, 1711 "MinuteOfHour":{ 1712 "shape":"MinuteOfHour", 1713 "documentation":"<p>The minute when an on-call rotation shift begins or ends.</p>" 1714 } 1715 }, 1716 "documentation":"<p>Details about when an on-call rotation shift begins or ends.</p>" 1717 }, 1718 "HourOfDay":{ 1719 "type":"integer", 1720 "max":23, 1721 "min":0 1722 }, 1723 "IdempotencyToken":{ 1724 "type":"string", 1725 "max":2048, 1726 "pattern":"^[\\\\\\/a-zA-Z0-9_+=\\-]*$" 1727 }, 1728 "IncidentId":{ 1729 "type":"string", 1730 "max":1024, 1731 "pattern":"^[\\\\a-zA-Z0-9_@#%*+=:?.\\/!\\s-]*$" 1732 }, 1733 "InternalServerException":{ 1734 "type":"structure", 1735 "required":["Message"], 1736 "members":{ 1737 "Message":{"shape":"String"}, 1738 "RetryAfterSeconds":{ 1739 "shape":"RetryAfterSeconds", 1740 "documentation":"Advice to clients on when the call can be safely retried" 1741 } 1742 }, 1743 "documentation":"<p>Unexpected error occurred while processing the request.</p>", 1744 "exception":true, 1745 "fault":true 1746 }, 1747 "IsEssential":{ 1748 "type":"boolean", 1749 "box":true 1750 }, 1751 "ListContactChannelsRequest":{ 1752 "type":"structure", 1753 "required":["ContactId"], 1754 "members":{ 1755 "ContactId":{ 1756 "shape":"SsmContactsArn", 1757 "documentation":"<p>The Amazon Resource Name (ARN) of the contact.</p>" 1758 }, 1759 "NextToken":{ 1760 "shape":"PaginationToken", 1761 "documentation":"<p>The pagination token to continue to the next page of results.</p>" 1762 }, 1763 "MaxResults":{ 1764 "shape":"MaxResults", 1765 "documentation":"<p>The maximum number of contact channels per page.</p>", 1766 "box":true 1767 } 1768 } 1769 }, 1770 "ListContactChannelsResult":{ 1771 "type":"structure", 1772 "required":["ContactChannels"], 1773 "members":{ 1774 "NextToken":{ 1775 "shape":"PaginationToken", 1776 "documentation":"<p>The pagination token to continue to the next page of results.</p>" 1777 }, 1778 "ContactChannels":{ 1779 "shape":"ContactChannelList", 1780 "documentation":"<p>A list of contact channels related to the specified contact.</p>" 1781 } 1782 } 1783 }, 1784 "ListContactsRequest":{ 1785 "type":"structure", 1786 "members":{ 1787 "NextToken":{ 1788 "shape":"PaginationToken", 1789 "documentation":"<p>The pagination token to continue to the next page of results.</p>" 1790 }, 1791 "MaxResults":{ 1792 "shape":"MaxResults", 1793 "documentation":"<p>The maximum number of contacts and escalation plans per page of results.</p>", 1794 "box":true 1795 }, 1796 "AliasPrefix":{ 1797 "shape":"ContactAlias", 1798 "documentation":"<p>Used to list only contacts who's aliases start with the specified prefix.</p>" 1799 }, 1800 "Type":{ 1801 "shape":"ContactType", 1802 "documentation":"<p>The type of contact. A contact is type <code>PERSONAL</code> and an escalation plan is type <code>ESCALATION</code>.</p>" 1803 } 1804 } 1805 }, 1806 "ListContactsResult":{ 1807 "type":"structure", 1808 "members":{ 1809 "NextToken":{ 1810 "shape":"PaginationToken", 1811 "documentation":"<p>The pagination token to continue to the next page of results.</p>" 1812 }, 1813 "Contacts":{ 1814 "shape":"ContactsList", 1815 "documentation":"<p>A list of the contacts and escalation plans in your Incident Manager account.</p>" 1816 } 1817 } 1818 }, 1819 "ListEngagementsRequest":{ 1820 "type":"structure", 1821 "members":{ 1822 "NextToken":{ 1823 "shape":"PaginationToken", 1824 "documentation":"<p>The pagination token to continue to the next page of results.</p>" 1825 }, 1826 "MaxResults":{ 1827 "shape":"MaxResults", 1828 "documentation":"<p>The maximum number of engagements per page of results.</p>", 1829 "box":true 1830 }, 1831 "IncidentId":{ 1832 "shape":"IncidentId", 1833 "documentation":"<p>The Amazon Resource Name (ARN) of the incident you're listing engagements for.</p>" 1834 }, 1835 "TimeRangeValue":{ 1836 "shape":"TimeRange", 1837 "documentation":"<p>The time range to lists engagements for an incident.</p>" 1838 } 1839 } 1840 }, 1841 "ListEngagementsResult":{ 1842 "type":"structure", 1843 "required":["Engagements"], 1844 "members":{ 1845 "NextToken":{ 1846 "shape":"PaginationToken", 1847 "documentation":"<p>The pagination token to continue to the next page of results.</p>" 1848 }, 1849 "Engagements":{ 1850 "shape":"EngagementsList", 1851 "documentation":"<p>A list of each engagement that occurred during the specified time range of an incident.</p>" 1852 } 1853 } 1854 }, 1855 "ListPageReceiptsRequest":{ 1856 "type":"structure", 1857 "required":["PageId"], 1858 "members":{ 1859 "PageId":{ 1860 "shape":"SsmContactsArn", 1861 "documentation":"<p>The Amazon Resource Name (ARN) of the engagement to a specific contact channel.</p>" 1862 }, 1863 "NextToken":{ 1864 "shape":"PaginationToken", 1865 "documentation":"<p>The pagination token to continue to the next page of results.</p>" 1866 }, 1867 "MaxResults":{ 1868 "shape":"MaxResults", 1869 "documentation":"<p>The maximum number of acknowledgements per page of results.</p>", 1870 "box":true 1871 } 1872 } 1873 }, 1874 "ListPageReceiptsResult":{ 1875 "type":"structure", 1876 "members":{ 1877 "NextToken":{ 1878 "shape":"PaginationToken", 1879 "documentation":"<p>The pagination token to continue to the next page of results.</p>" 1880 }, 1881 "Receipts":{ 1882 "shape":"ReceiptsList", 1883 "documentation":"<p>A list of each acknowledgement.</p>" 1884 } 1885 } 1886 }, 1887 "ListPageResolutionsRequest":{ 1888 "type":"structure", 1889 "required":["PageId"], 1890 "members":{ 1891 "NextToken":{ 1892 "shape":"PaginationToken", 1893 "documentation":"<p>A token to start the list. Use this token to get the next set of results.</p>" 1894 }, 1895 "PageId":{ 1896 "shape":"SsmContactsArn", 1897 "documentation":"<p>The Amazon Resource Name (ARN) of the contact engaged for the incident.</p>" 1898 } 1899 } 1900 }, 1901 "ListPageResolutionsResult":{ 1902 "type":"structure", 1903 "required":["PageResolutions"], 1904 "members":{ 1905 "NextToken":{ 1906 "shape":"PaginationToken", 1907 "documentation":"<p>The token for the next set of items to return. Use this token to get the next set of results.</p>" 1908 }, 1909 "PageResolutions":{ 1910 "shape":"ResolutionList", 1911 "documentation":"<p>Information about the resolution for an engagement.</p>" 1912 } 1913 } 1914 }, 1915 "ListPagesByContactRequest":{ 1916 "type":"structure", 1917 "required":["ContactId"], 1918 "members":{ 1919 "ContactId":{ 1920 "shape":"SsmContactsArn", 1921 "documentation":"<p>The Amazon Resource Name (ARN) of the contact you are retrieving engagements for.</p>" 1922 }, 1923 "NextToken":{ 1924 "shape":"PaginationToken", 1925 "documentation":"<p>The pagination token to continue to the next page of results.</p>" 1926 }, 1927 "MaxResults":{ 1928 "shape":"MaxResults", 1929 "documentation":"<p>The maximum number of engagements to contact channels to list per page of results. </p>", 1930 "box":true 1931 } 1932 } 1933 }, 1934 "ListPagesByContactResult":{ 1935 "type":"structure", 1936 "required":["Pages"], 1937 "members":{ 1938 "NextToken":{ 1939 "shape":"PaginationToken", 1940 "documentation":"<p>The pagination token to continue to the next page of results.</p>" 1941 }, 1942 "Pages":{ 1943 "shape":"PagesList", 1944 "documentation":"<p>The list of engagements to a contact's contact channel.</p>" 1945 } 1946 } 1947 }, 1948 "ListPagesByEngagementRequest":{ 1949 "type":"structure", 1950 "required":["EngagementId"], 1951 "members":{ 1952 "EngagementId":{ 1953 "shape":"SsmContactsArn", 1954 "documentation":"<p>The Amazon Resource Name (ARN) of the engagement.</p>" 1955 }, 1956 "NextToken":{ 1957 "shape":"PaginationToken", 1958 "documentation":"<p>The pagination token to continue to the next page of results.</p>" 1959 }, 1960 "MaxResults":{ 1961 "shape":"MaxResults", 1962 "documentation":"<p>The maximum number of engagements to contact channels to list per page of results.</p>", 1963 "box":true 1964 } 1965 } 1966 }, 1967 "ListPagesByEngagementResult":{ 1968 "type":"structure", 1969 "required":["Pages"], 1970 "members":{ 1971 "NextToken":{ 1972 "shape":"PaginationToken", 1973 "documentation":"<p>The pagination token to continue to the next page of results.</p>" 1974 }, 1975 "Pages":{ 1976 "shape":"PagesList", 1977 "documentation":"<p>The list of engagements to contact channels.</p>" 1978 } 1979 } 1980 }, 1981 "ListPreviewRotationShiftsRequest":{ 1982 "type":"structure", 1983 "required":[ 1984 "EndTime", 1985 "Members", 1986 "TimeZoneId", 1987 "Recurrence" 1988 ], 1989 "members":{ 1990 "RotationStartTime":{ 1991 "shape":"DateTime", 1992 "documentation":"<p>The date and time a rotation would begin. The first shift is calculated from this date and time.</p>" 1993 }, 1994 "StartTime":{ 1995 "shape":"DateTime", 1996 "documentation":"<p>Used to filter the range of calculated shifts before sending the response back to the user. </p>" 1997 }, 1998 "EndTime":{ 1999 "shape":"DateTime", 2000 "documentation":"<p>The date and time a rotation shift would end.</p>" 2001 }, 2002 "Members":{ 2003 "shape":"RotationPreviewMemberList", 2004 "documentation":"<p>The contacts that would be assigned to a rotation.</p>" 2005 }, 2006 "TimeZoneId":{ 2007 "shape":"TimeZoneId", 2008 "documentation":"<p>The time zone the rotation’s activity would be based on, in Internet Assigned Numbers Authority (IANA) format. For example: \"America/Los_Angeles\", \"UTC\", or \"Asia/Seoul\". </p>" 2009 }, 2010 "Recurrence":{ 2011 "shape":"RecurrenceSettings", 2012 "documentation":"<p>Information about how long a rotation would last before restarting at the beginning of the shift order.</p>" 2013 }, 2014 "Overrides":{ 2015 "shape":"OverrideList", 2016 "documentation":"<p>Information about changes that would be made in a rotation override.</p>" 2017 }, 2018 "NextToken":{ 2019 "shape":"PaginationToken", 2020 "documentation":"<p>A token to start the list. This token is used to get the next set of results.</p>" 2021 }, 2022 "MaxResults":{ 2023 "shape":"MaxResults", 2024 "documentation":"<p>The maximum number of items to return for this call. The call also returns a token that can be specified in a subsequent call to get the next set of results.</p>", 2025 "box":true 2026 } 2027 } 2028 }, 2029 "ListPreviewRotationShiftsResult":{ 2030 "type":"structure", 2031 "members":{ 2032 "RotationShifts":{ 2033 "shape":"RotationShifts", 2034 "documentation":"<p>Details about a rotation shift, including times, types, and contacts.</p>" 2035 }, 2036 "NextToken":{ 2037 "shape":"PaginationToken", 2038 "documentation":"<p>The token for the next set of items to return. This token is used to get the next set of results.</p>" 2039 } 2040 } 2041 }, 2042 "ListRotationOverridesRequest":{ 2043 "type":"structure", 2044 "required":[ 2045 "RotationId", 2046 "StartTime", 2047 "EndTime" 2048 ], 2049 "members":{ 2050 "RotationId":{ 2051 "shape":"SsmContactsArn", 2052 "documentation":"<p>The Amazon Resource Name (ARN) of the rotation to retrieve information about.</p>" 2053 }, 2054 "StartTime":{ 2055 "shape":"DateTime", 2056 "documentation":"<p>The date and time for the beginning of a time range for listing overrides.</p>" 2057 }, 2058 "EndTime":{ 2059 "shape":"DateTime", 2060 "documentation":"<p>The date and time for the end of a time range for listing overrides.</p>" 2061 }, 2062 "NextToken":{ 2063 "shape":"PaginationToken", 2064 "documentation":"<p>A token to start the list. Use this token to get the next set of results.</p>" 2065 }, 2066 "MaxResults":{ 2067 "shape":"MaxResults", 2068 "documentation":"<p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>", 2069 "box":true 2070 } 2071 } 2072 }, 2073 "ListRotationOverridesResult":{ 2074 "type":"structure", 2075 "members":{ 2076 "RotationOverrides":{ 2077 "shape":"RotationOverrides", 2078 "documentation":"<p>A list of rotation overrides in the specified time range.</p>" 2079 }, 2080 "NextToken":{ 2081 "shape":"PaginationToken", 2082 "documentation":"<p>The token for the next set of items to return. Use this token to get the next set of results.</p>" 2083 } 2084 } 2085 }, 2086 "ListRotationShiftsRequest":{ 2087 "type":"structure", 2088 "required":[ 2089 "RotationId", 2090 "EndTime" 2091 ], 2092 "members":{ 2093 "RotationId":{ 2094 "shape":"SsmContactsArn", 2095 "documentation":"<p>The Amazon Resource Name (ARN) of the rotation to retrieve shift information about. </p>" 2096 }, 2097 "StartTime":{ 2098 "shape":"DateTime", 2099 "documentation":"<p>The date and time for the beginning of the time range to list shifts for.</p>" 2100 }, 2101 "EndTime":{ 2102 "shape":"DateTime", 2103 "documentation":"<p>The date and time for the end of the time range to list shifts for.</p>" 2104 }, 2105 "NextToken":{ 2106 "shape":"PaginationToken", 2107 "documentation":"<p>A token to start the list. Use this token to get the next set of results.</p>" 2108 }, 2109 "MaxResults":{ 2110 "shape":"MaxResults", 2111 "documentation":"<p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>", 2112 "box":true 2113 } 2114 } 2115 }, 2116 "ListRotationShiftsResult":{ 2117 "type":"structure", 2118 "members":{ 2119 "RotationShifts":{ 2120 "shape":"RotationShifts", 2121 "documentation":"<p>Information about shifts that meet the filter criteria.</p>" 2122 }, 2123 "NextToken":{ 2124 "shape":"PaginationToken", 2125 "documentation":"<p>The token for the next set of items to return. Use this token to get the next set of results.</p>" 2126 } 2127 } 2128 }, 2129 "ListRotationsRequest":{ 2130 "type":"structure", 2131 "members":{ 2132 "RotationNamePrefix":{ 2133 "shape":"RotationName", 2134 "documentation":"<p>A filter to include rotations in list results based on their common prefix. For example, entering prod returns a list of all rotation names that begin with <code>prod</code>, such as <code>production</code> and <code>prod-1</code>.</p>" 2135 }, 2136 "NextToken":{ 2137 "shape":"PaginationToken", 2138 "documentation":"<p>A token to start the list. Use this token to get the next set of results.</p>" 2139 }, 2140 "MaxResults":{ 2141 "shape":"MaxResults", 2142 "documentation":"<p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>", 2143 "box":true 2144 } 2145 } 2146 }, 2147 "ListRotationsResult":{ 2148 "type":"structure", 2149 "required":["Rotations"], 2150 "members":{ 2151 "NextToken":{ 2152 "shape":"PaginationToken", 2153 "documentation":"<p>The token for the next set of items to return. Use this token to get the next set of results.</p>" 2154 }, 2155 "Rotations":{ 2156 "shape":"Rotations", 2157 "documentation":"<p>Information about rotations that meet the filter criteria.</p>" 2158 } 2159 } 2160 }, 2161 "ListTagsForResourceRequest":{ 2162 "type":"structure", 2163 "required":["ResourceARN"], 2164 "members":{ 2165 "ResourceARN":{ 2166 "shape":"AmazonResourceName", 2167 "documentation":"<p>The Amazon Resource Name (ARN) of the contact or escalation plan.</p>" 2168 } 2169 } 2170 }, 2171 "ListTagsForResourceResult":{ 2172 "type":"structure", 2173 "members":{ 2174 "Tags":{ 2175 "shape":"TagsList", 2176 "documentation":"<p>The tags related to the contact or escalation plan.</p>" 2177 } 2178 } 2179 }, 2180 "MaxResults":{ 2181 "type":"integer", 2182 "box":true, 2183 "max":1024, 2184 "min":0 2185 }, 2186 "Member":{ 2187 "type":"string", 2188 "max":512, 2189 "min":1, 2190 "pattern":".*\\S.*" 2191 }, 2192 "MinuteOfHour":{ 2193 "type":"integer", 2194 "max":59, 2195 "min":0 2196 }, 2197 "MonthlySetting":{ 2198 "type":"structure", 2199 "required":[ 2200 "DayOfMonth", 2201 "HandOffTime" 2202 ], 2203 "members":{ 2204 "DayOfMonth":{ 2205 "shape":"DayOfMonth", 2206 "documentation":"<p>The day of the month when monthly recurring on-call rotations begin.</p>" 2207 }, 2208 "HandOffTime":{ 2209 "shape":"HandOffTime", 2210 "documentation":"<p>The time of day when a monthly recurring on-call shift rotation begins.</p>" 2211 } 2212 }, 2213 "documentation":"<p>Information about on-call rotations that recur monthly.</p>" 2214 }, 2215 "MonthlySettings":{ 2216 "type":"list", 2217 "member":{"shape":"MonthlySetting"} 2218 }, 2219 "NumberOfOnCalls":{ 2220 "type":"integer", 2221 "min":1 2222 }, 2223 "OverrideList":{ 2224 "type":"list", 2225 "member":{"shape":"PreviewOverride"} 2226 }, 2227 "Page":{ 2228 "type":"structure", 2229 "required":[ 2230 "PageArn", 2231 "EngagementArn", 2232 "ContactArn", 2233 "Sender" 2234 ], 2235 "members":{ 2236 "PageArn":{ 2237 "shape":"SsmContactsArn", 2238 "documentation":"<p>The Amazon Resource Name (ARN) of the page to the contact channel.</p>" 2239 }, 2240 "EngagementArn":{ 2241 "shape":"SsmContactsArn", 2242 "documentation":"<p>The ARN of the engagement that this page is part of.</p>" 2243 }, 2244 "ContactArn":{ 2245 "shape":"SsmContactsArn", 2246 "documentation":"<p>The ARN of the contact that Incident Manager is engaging.</p>" 2247 }, 2248 "Sender":{ 2249 "shape":"Sender", 2250 "documentation":"<p>The user that started the engagement.</p>" 2251 }, 2252 "IncidentId":{ 2253 "shape":"IncidentId", 2254 "documentation":"<p>The ARN of the incident that's engaging the contact channel.</p>" 2255 }, 2256 "SentTime":{ 2257 "shape":"DateTime", 2258 "documentation":"<p>The time that Incident Manager engaged the contact channel.</p>" 2259 }, 2260 "DeliveryTime":{ 2261 "shape":"DateTime", 2262 "documentation":"<p>The time the message was delivered to the contact channel.</p>" 2263 }, 2264 "ReadTime":{ 2265 "shape":"DateTime", 2266 "documentation":"<p>The time that the contact channel acknowledged engagement.</p>" 2267 } 2268 }, 2269 "documentation":"<p>Incident Manager engaging a contact's contact channel.</p>" 2270 }, 2271 "PagesList":{ 2272 "type":"list", 2273 "member":{"shape":"Page"} 2274 }, 2275 "PaginationToken":{ 2276 "type":"string", 2277 "max":2048, 2278 "pattern":"^[\\\\\\/a-zA-Z0-9_+=\\-]*$" 2279 }, 2280 "Plan":{ 2281 "type":"structure", 2282 "members":{ 2283 "Stages":{ 2284 "shape":"StagesList", 2285 "documentation":"<p>A list of stages that the escalation plan or engagement plan uses to engage contacts and contact methods.</p>" 2286 }, 2287 "RotationIds":{ 2288 "shape":"SsmContactsArnList", 2289 "documentation":"<p>The Amazon Resource Names (ARNs) of the on-call rotations associated with the plan. </p>" 2290 } 2291 }, 2292 "documentation":"<p>Information about the stages and on-call rotation teams associated with an escalation plan or engagement plan. </p>" 2293 }, 2294 "Policy":{ 2295 "type":"string", 2296 "max":395000, 2297 "min":1, 2298 "pattern":".*\\S.*" 2299 }, 2300 "PreviewOverride":{ 2301 "type":"structure", 2302 "members":{ 2303 "NewMembers":{ 2304 "shape":"RotationOverridePreviewMemberList", 2305 "documentation":"<p>Information about contacts to add to an on-call rotation override.</p>" 2306 }, 2307 "StartTime":{ 2308 "shape":"DateTime", 2309 "documentation":"<p>Information about the time a rotation override would begin.</p>" 2310 }, 2311 "EndTime":{ 2312 "shape":"DateTime", 2313 "documentation":"<p>Information about the time a rotation override would end.</p>" 2314 } 2315 }, 2316 "documentation":"<p>Information about contacts and times that an on-call override replaces.</p>" 2317 }, 2318 "PublicContent":{ 2319 "type":"string", 2320 "max":8192, 2321 "min":1, 2322 "pattern":"^[.\\s\\S]*$" 2323 }, 2324 "PublicSubject":{ 2325 "type":"string", 2326 "max":2048, 2327 "min":1, 2328 "pattern":"^[.\\s\\S]*$" 2329 }, 2330 "PutContactPolicyRequest":{ 2331 "type":"structure", 2332 "required":[ 2333 "ContactArn", 2334 "Policy" 2335 ], 2336 "members":{ 2337 "ContactArn":{ 2338 "shape":"SsmContactsArn", 2339 "documentation":"<p>The Amazon Resource Name (ARN) of the contact or escalation plan.</p>" 2340 }, 2341 "Policy":{ 2342 "shape":"Policy", 2343 "documentation":"<p>Details of the resource policy.</p>" 2344 } 2345 } 2346 }, 2347 "PutContactPolicyResult":{ 2348 "type":"structure", 2349 "members":{ 2350 } 2351 }, 2352 "Receipt":{ 2353 "type":"structure", 2354 "required":[ 2355 "ReceiptType", 2356 "ReceiptTime" 2357 ], 2358 "members":{ 2359 "ContactChannelArn":{ 2360 "shape":"SsmContactsArn", 2361 "documentation":"<p>The Amazon Resource Name (ARN) of the contact channel Incident Manager engaged.</p>" 2362 }, 2363 "ReceiptType":{ 2364 "shape":"ReceiptType", 2365 "documentation":"<p>The type follows the engagement cycle, <code>SENT</code>, <code>DELIVERED</code>, and <code>READ</code>.</p>" 2366 }, 2367 "ReceiptInfo":{ 2368 "shape":"ReceiptInfo", 2369 "documentation":"<p>Information provided during the page acknowledgement.</p>" 2370 }, 2371 "ReceiptTime":{ 2372 "shape":"DateTime", 2373 "documentation":"<p>The time receipt was <code>SENT</code>, <code>DELIVERED</code>, or <code>READ</code>.</p>" 2374 } 2375 }, 2376 "documentation":"<p>Records events during an engagement.</p>" 2377 }, 2378 "ReceiptInfo":{ 2379 "type":"string", 2380 "max":2048, 2381 "min":1, 2382 "pattern":"^[.\\s\\S]*$" 2383 }, 2384 "ReceiptType":{ 2385 "type":"string", 2386 "enum":[ 2387 "DELIVERED", 2388 "ERROR", 2389 "READ", 2390 "SENT", 2391 "STOP" 2392 ] 2393 }, 2394 "ReceiptsList":{ 2395 "type":"list", 2396 "member":{"shape":"Receipt"} 2397 }, 2398 "RecurrenceMultiplier":{ 2399 "type":"integer", 2400 "max":100, 2401 "min":1 2402 }, 2403 "RecurrenceSettings":{ 2404 "type":"structure", 2405 "required":[ 2406 "NumberOfOnCalls", 2407 "RecurrenceMultiplier" 2408 ], 2409 "members":{ 2410 "MonthlySettings":{ 2411 "shape":"MonthlySettings", 2412 "documentation":"<p>Information about on-call rotations that recur monthly.</p>" 2413 }, 2414 "WeeklySettings":{ 2415 "shape":"WeeklySettings", 2416 "documentation":"<p>Information about on-call rotations that recur weekly.</p>" 2417 }, 2418 "DailySettings":{ 2419 "shape":"DailySettings", 2420 "documentation":"<p>Information about on-call rotations that recur daily.</p>" 2421 }, 2422 "NumberOfOnCalls":{ 2423 "shape":"NumberOfOnCalls", 2424 "documentation":"<p>The number of contacts, or shift team members designated to be on call concurrently during a shift. For example, in an on-call schedule containing ten contacts, a value of <code>2</code> designates that two of them are on call at any given time.</p>", 2425 "box":true 2426 }, 2427 "ShiftCoverages":{ 2428 "shape":"ShiftCoveragesMap", 2429 "documentation":"<p>Information about the days of the week included in on-call rotation coverage.</p>" 2430 }, 2431 "RecurrenceMultiplier":{ 2432 "shape":"RecurrenceMultiplier", 2433 "documentation":"<p>The number of days, weeks, or months a single rotation lasts.</p>", 2434 "box":true 2435 } 2436 }, 2437 "documentation":"<p>Information about when an on-call rotation is in effect and how long the rotation period lasts.</p>" 2438 }, 2439 "ResolutionContact":{ 2440 "type":"structure", 2441 "required":[ 2442 "ContactArn", 2443 "Type" 2444 ], 2445 "members":{ 2446 "ContactArn":{ 2447 "shape":"SsmContactsArn", 2448 "documentation":"<p>The Amazon Resource Name (ARN) of a contact in the engagement resolution process. </p>" 2449 }, 2450 "Type":{ 2451 "shape":"ContactType", 2452 "documentation":"<p>The type of contact for a resolution step.</p>" 2453 }, 2454 "StageIndex":{ 2455 "shape":"StageIndex", 2456 "documentation":"<p>The stage in the escalation plan that resolves to this contact.</p>", 2457 "box":true 2458 } 2459 }, 2460 "documentation":"<p>Information about the engagement resolution steps. The resolution starts from the first contact, which can be an escalation plan, then resolves to an on-call rotation, and finally to a personal contact.</p> <p>The <code>ResolutionContact</code> structure describes the information for each node or step in that process. It contains information about different contact types, such as the escalation, rotation, and personal contacts.</p>" 2461 }, 2462 "ResolutionList":{ 2463 "type":"list", 2464 "member":{"shape":"ResolutionContact"} 2465 }, 2466 "ResourceNotFoundException":{ 2467 "type":"structure", 2468 "required":[ 2469 "Message", 2470 "ResourceId", 2471 "ResourceType" 2472 ], 2473 "members":{ 2474 "Message":{"shape":"String"}, 2475 "ResourceId":{ 2476 "shape":"String", 2477 "documentation":"Hypothetical resource identifier that was not found" 2478 }, 2479 "ResourceType":{ 2480 "shape":"String", 2481 "documentation":"Hypothetical resource type that was not found" 2482 } 2483 }, 2484 "documentation":"<p>Request references a resource that doesn't exist.</p>", 2485 "exception":true 2486 }, 2487 "RetryAfterSeconds":{"type":"integer"}, 2488 "RetryIntervalInMinutes":{ 2489 "type":"integer", 2490 "box":true, 2491 "max":60, 2492 "min":0 2493 }, 2494 "Rotation":{ 2495 "type":"structure", 2496 "required":[ 2497 "RotationArn", 2498 "Name" 2499 ], 2500 "members":{ 2501 "RotationArn":{ 2502 "shape":"SsmContactsArn", 2503 "documentation":"<p>The Amazon Resource Name (ARN) of the rotation.</p>" 2504 }, 2505 "Name":{ 2506 "shape":"RotationName", 2507 "documentation":"<p>The name of the rotation.</p>" 2508 }, 2509 "ContactIds":{ 2510 "shape":"SsmContactsArnList", 2511 "documentation":"<p>The Amazon Resource Names (ARNs) of the contacts assigned to the rotation team.</p>" 2512 }, 2513 "StartTime":{ 2514 "shape":"DateTime", 2515 "documentation":"<p>The date and time the rotation becomes active.</p>" 2516 }, 2517 "TimeZoneId":{ 2518 "shape":"TimeZoneId", 2519 "documentation":"<p>The time zone the rotation’s activity is based on, in Internet Assigned Numbers Authority (IANA) format. For example: \"America/Los_Angeles\", \"UTC\", or \"Asia/Seoul\". </p>" 2520 }, 2521 "Recurrence":{ 2522 "shape":"RecurrenceSettings", 2523 "documentation":"<p>Information about when an on-call rotation is in effect and how long the rotation period lasts.</p>" 2524 } 2525 }, 2526 "documentation":"<p>Information about a rotation in an on-call schedule.</p>" 2527 }, 2528 "RotationContactsArnList":{ 2529 "type":"list", 2530 "member":{"shape":"SsmContactsArn"}, 2531 "max":30, 2532 "min":1 2533 }, 2534 "RotationName":{ 2535 "type":"string", 2536 "max":255, 2537 "min":1, 2538 "pattern":"^[a-zA-Z0-9_\\-\\s\\.]*$" 2539 }, 2540 "RotationOverride":{ 2541 "type":"structure", 2542 "required":[ 2543 "RotationOverrideId", 2544 "NewContactIds", 2545 "StartTime", 2546 "EndTime", 2547 "CreateTime" 2548 ], 2549 "members":{ 2550 "RotationOverrideId":{ 2551 "shape":"Uuid", 2552 "documentation":"<p>The Amazon Resource Name (ARN) of the override to an on-call rotation.</p>" 2553 }, 2554 "NewContactIds":{ 2555 "shape":"SsmContactsArnList", 2556 "documentation":"<p>The Amazon Resource Names (ARNs) of the contacts assigned to the override of the on-call rotation.</p>" 2557 }, 2558 "StartTime":{ 2559 "shape":"DateTime", 2560 "documentation":"<p>The time a rotation override begins.</p>" 2561 }, 2562 "EndTime":{ 2563 "shape":"DateTime", 2564 "documentation":"<p>The time a rotation override ends.</p>" 2565 }, 2566 "CreateTime":{ 2567 "shape":"DateTime", 2568 "documentation":"<p>The time a rotation override was created.</p>" 2569 } 2570 }, 2571 "documentation":"<p>Information about an override specified for an on-call rotation.</p>" 2572 }, 2573 "RotationOverrideContactsArnList":{ 2574 "type":"list", 2575 "member":{"shape":"SsmContactsArn"}, 2576 "max":30, 2577 "min":0 2578 }, 2579 "RotationOverridePreviewMemberList":{ 2580 "type":"list", 2581 "member":{"shape":"Member"}, 2582 "max":30, 2583 "min":0 2584 }, 2585 "RotationOverrides":{ 2586 "type":"list", 2587 "member":{"shape":"RotationOverride"} 2588 }, 2589 "RotationPreviewMemberList":{ 2590 "type":"list", 2591 "member":{"shape":"Member"}, 2592 "max":30, 2593 "min":1 2594 }, 2595 "RotationShift":{ 2596 "type":"structure", 2597 "required":[ 2598 "StartTime", 2599 "EndTime" 2600 ], 2601 "members":{ 2602 "ContactIds":{ 2603 "shape":"SsmContactsArnList", 2604 "documentation":"<p>The Amazon Resource Names (ARNs) of the contacts who are part of the shift rotation. </p>" 2605 }, 2606 "StartTime":{ 2607 "shape":"DateTime", 2608 "documentation":"<p>The time a shift rotation begins.</p>" 2609 }, 2610 "EndTime":{ 2611 "shape":"DateTime", 2612 "documentation":"<p>The time a shift rotation ends.</p>" 2613 }, 2614 "Type":{ 2615 "shape":"ShiftType", 2616 "documentation":"<p>The type of shift rotation.</p>" 2617 }, 2618 "ShiftDetails":{ 2619 "shape":"ShiftDetails", 2620 "documentation":"<p>Additional information about an on-call rotation shift.</p>" 2621 } 2622 }, 2623 "documentation":"<p>Information about a shift that belongs to an on-call rotation.</p>" 2624 }, 2625 "RotationShifts":{ 2626 "type":"list", 2627 "member":{"shape":"RotationShift"} 2628 }, 2629 "Rotations":{ 2630 "type":"list", 2631 "member":{"shape":"Rotation"} 2632 }, 2633 "SendActivationCodeRequest":{ 2634 "type":"structure", 2635 "required":["ContactChannelId"], 2636 "members":{ 2637 "ContactChannelId":{ 2638 "shape":"SsmContactsArn", 2639 "documentation":"<p>The Amazon Resource Name (ARN) of the contact channel.</p>" 2640 } 2641 } 2642 }, 2643 "SendActivationCodeResult":{ 2644 "type":"structure", 2645 "members":{ 2646 } 2647 }, 2648 "Sender":{ 2649 "type":"string", 2650 "max":255, 2651 "pattern":"^[\\\\a-zA-Z0-9_@#%*+=:?.\\/!\\s-]*$" 2652 }, 2653 "ServiceQuotaExceededException":{ 2654 "type":"structure", 2655 "required":[ 2656 "Message", 2657 "QuotaCode", 2658 "ServiceCode" 2659 ], 2660 "members":{ 2661 "Message":{"shape":"String"}, 2662 "ResourceId":{ 2663 "shape":"String", 2664 "documentation":"Identifier of the resource affected" 2665 }, 2666 "ResourceType":{ 2667 "shape":"String", 2668 "documentation":"Type of the resource affected" 2669 }, 2670 "QuotaCode":{ 2671 "shape":"String", 2672 "documentation":"Service Quotas requirement to identify originating service" 2673 }, 2674 "ServiceCode":{ 2675 "shape":"String", 2676 "documentation":"Service Quotas requirement to identify originating quota" 2677 } 2678 }, 2679 "documentation":"<p>Request would cause a service quota to be exceeded.</p>", 2680 "exception":true 2681 }, 2682 "ShiftCoveragesMap":{ 2683 "type":"map", 2684 "key":{"shape":"DayOfWeek"}, 2685 "value":{"shape":"CoverageTimes"} 2686 }, 2687 "ShiftDetails":{ 2688 "type":"structure", 2689 "required":["OverriddenContactIds"], 2690 "members":{ 2691 "OverriddenContactIds":{ 2692 "shape":"SsmContactsArnList", 2693 "documentation":"<p>The Amazon Resources Names (ARNs) of the contacts who were replaced in a shift when an override was created. If the override is deleted, these contacts are restored to the shift.</p>" 2694 } 2695 }, 2696 "documentation":"<p>Information about overrides to an on-call rotation shift.</p>" 2697 }, 2698 "ShiftType":{ 2699 "type":"string", 2700 "enum":[ 2701 "REGULAR", 2702 "OVERRIDDEN" 2703 ] 2704 }, 2705 "SimpleAddress":{ 2706 "type":"string", 2707 "max":320, 2708 "min":1 2709 }, 2710 "SsmContactsArn":{ 2711 "type":"string", 2712 "max":2048, 2713 "min":1, 2714 "pattern":"arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\\w+=\\/,.@]*:[0-9]+:([\\w+=\\/,.@:-]+)*" 2715 }, 2716 "SsmContactsArnList":{ 2717 "type":"list", 2718 "member":{"shape":"SsmContactsArn"}, 2719 "max":25, 2720 "min":0 2721 }, 2722 "Stage":{ 2723 "type":"structure", 2724 "required":[ 2725 "DurationInMinutes", 2726 "Targets" 2727 ], 2728 "members":{ 2729 "DurationInMinutes":{ 2730 "shape":"StageDurationInMins", 2731 "documentation":"<p>The time to wait until beginning the next stage. The duration can only be set to 0 if a target is specified.</p>" 2732 }, 2733 "Targets":{ 2734 "shape":"TargetsList", 2735 "documentation":"<p>The contacts or contact methods that the escalation plan or engagement plan is engaging.</p>" 2736 } 2737 }, 2738 "documentation":"<p>A set amount of time that an escalation plan or engagement plan engages the specified contacts or contact methods.</p>" 2739 }, 2740 "StageDurationInMins":{ 2741 "type":"integer", 2742 "box":true, 2743 "max":30, 2744 "min":0 2745 }, 2746 "StageIndex":{ 2747 "type":"integer", 2748 "max":100, 2749 "min":0 2750 }, 2751 "StagesList":{ 2752 "type":"list", 2753 "member":{"shape":"Stage"} 2754 }, 2755 "StartEngagementRequest":{ 2756 "type":"structure", 2757 "required":[ 2758 "ContactId", 2759 "Sender", 2760 "Subject", 2761 "Content" 2762 ], 2763 "members":{ 2764 "ContactId":{ 2765 "shape":"SsmContactsArn", 2766 "documentation":"<p>The Amazon Resource Name (ARN) of the contact being engaged.</p>" 2767 }, 2768 "Sender":{ 2769 "shape":"Sender", 2770 "documentation":"<p>The user that started the engagement.</p>" 2771 }, 2772 "Subject":{ 2773 "shape":"Subject", 2774 "documentation":"<p>The secure subject of the message that was sent to the contact. Use this field for engagements to <code>VOICE</code> or <code>EMAIL</code>.</p>" 2775 }, 2776 "Content":{ 2777 "shape":"Content", 2778 "documentation":"<p>The secure content of the message that was sent to the contact. Use this field for engagements to <code>VOICE</code> or <code>EMAIL</code>.</p>" 2779 }, 2780 "PublicSubject":{ 2781 "shape":"PublicSubject", 2782 "documentation":"<p>The insecure subject of the message that was sent to the contact. Use this field for engagements to <code>SMS</code>.</p>" 2783 }, 2784 "PublicContent":{ 2785 "shape":"PublicContent", 2786 "documentation":"<p>The insecure content of the message that was sent to the contact. Use this field for engagements to <code>SMS</code>.</p>" 2787 }, 2788 "IncidentId":{ 2789 "shape":"IncidentId", 2790 "documentation":"<p>The ARN of the incident that the engagement is part of.</p>" 2791 }, 2792 "IdempotencyToken":{ 2793 "shape":"IdempotencyToken", 2794 "documentation":"<p>A token ensuring that the operation is called only once with the specified details.</p>", 2795 "idempotencyToken":true 2796 } 2797 } 2798 }, 2799 "StartEngagementResult":{ 2800 "type":"structure", 2801 "required":["EngagementArn"], 2802 "members":{ 2803 "EngagementArn":{ 2804 "shape":"SsmContactsArn", 2805 "documentation":"<p>The ARN of the engagement.</p>" 2806 } 2807 } 2808 }, 2809 "StopEngagementRequest":{ 2810 "type":"structure", 2811 "required":["EngagementId"], 2812 "members":{ 2813 "EngagementId":{ 2814 "shape":"SsmContactsArn", 2815 "documentation":"<p>The Amazon Resource Name (ARN) of the engagement.</p>" 2816 }, 2817 "Reason":{ 2818 "shape":"StopReason", 2819 "documentation":"<p>The reason that you're stopping the engagement.</p>" 2820 } 2821 } 2822 }, 2823 "StopEngagementResult":{ 2824 "type":"structure", 2825 "members":{ 2826 } 2827 }, 2828 "StopReason":{ 2829 "type":"string", 2830 "max":255, 2831 "pattern":"^[.\\s\\S]*$" 2832 }, 2833 "String":{"type":"string"}, 2834 "Subject":{ 2835 "type":"string", 2836 "max":2048, 2837 "min":1, 2838 "pattern":"^[.\\s\\S]*$" 2839 }, 2840 "Tag":{ 2841 "type":"structure", 2842 "members":{ 2843 "Key":{ 2844 "shape":"TagKey", 2845 "documentation":"<p>Name of the object key.</p>" 2846 }, 2847 "Value":{ 2848 "shape":"TagValue", 2849 "documentation":"<p>Value of the tag.</p>" 2850 } 2851 }, 2852 "documentation":"<p>A container of a key-value name pair.</p>" 2853 }, 2854 "TagKey":{ 2855 "type":"string", 2856 "max":128, 2857 "min":1, 2858 "pattern":"^[\\\\\\/a-zA-Z0-9_+=\\-]*$" 2859 }, 2860 "TagKeyList":{ 2861 "type":"list", 2862 "member":{"shape":"TagKey"}, 2863 "max":50, 2864 "min":0 2865 }, 2866 "TagResourceRequest":{ 2867 "type":"structure", 2868 "required":[ 2869 "ResourceARN", 2870 "Tags" 2871 ], 2872 "members":{ 2873 "ResourceARN":{ 2874 "shape":"AmazonResourceName", 2875 "documentation":"<p>The Amazon Resource Name (ARN) of the contact or escalation plan.</p>" 2876 }, 2877 "Tags":{ 2878 "shape":"TagsList", 2879 "documentation":"<p>A list of tags that you are adding to the contact or escalation plan.</p>" 2880 } 2881 } 2882 }, 2883 "TagResourceResult":{ 2884 "type":"structure", 2885 "members":{ 2886 } 2887 }, 2888 "TagValue":{ 2889 "type":"string", 2890 "max":256, 2891 "min":1, 2892 "pattern":"^[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*$" 2893 }, 2894 "TagsList":{ 2895 "type":"list", 2896 "member":{"shape":"Tag"}, 2897 "max":50, 2898 "min":0 2899 }, 2900 "Target":{ 2901 "type":"structure", 2902 "members":{ 2903 "ChannelTargetInfo":{ 2904 "shape":"ChannelTargetInfo", 2905 "documentation":"<p>Information about the contact channel Incident Manager is engaging.</p>" 2906 }, 2907 "ContactTargetInfo":{ 2908 "shape":"ContactTargetInfo", 2909 "documentation":"<p>Information about the contact that Incident Manager is engaging.</p>" 2910 } 2911 }, 2912 "documentation":"<p>The contact or contact channel that's being engaged.</p>" 2913 }, 2914 "TargetsList":{ 2915 "type":"list", 2916 "member":{"shape":"Target"} 2917 }, 2918 "ThrottlingException":{ 2919 "type":"structure", 2920 "required":["Message"], 2921 "members":{ 2922 "Message":{"shape":"String"}, 2923 "QuotaCode":{ 2924 "shape":"String", 2925 "documentation":"Service Quotas requirement to identify originating service" 2926 }, 2927 "ServiceCode":{ 2928 "shape":"String", 2929 "documentation":"Service Quotas requirement to identify originating quota" 2930 }, 2931 "RetryAfterSeconds":{ 2932 "shape":"RetryAfterSeconds", 2933 "documentation":"Advice to clients on when the call can be safely retried" 2934 } 2935 }, 2936 "documentation":"<p>The request was denied due to request throttling.</p>", 2937 "exception":true 2938 }, 2939 "TimeRange":{ 2940 "type":"structure", 2941 "members":{ 2942 "StartTime":{ 2943 "shape":"DateTime", 2944 "documentation":"<p>The start of the time range.</p>" 2945 }, 2946 "EndTime":{ 2947 "shape":"DateTime", 2948 "documentation":"<p>The end of the time range.</p>" 2949 } 2950 }, 2951 "documentation":"<p>A range of between two set times</p>" 2952 }, 2953 "TimeZoneId":{ 2954 "type":"string", 2955 "max":255, 2956 "min":1, 2957 "pattern":"^[:a-zA-Z0-9_\\-\\s\\.\\\\/]*$" 2958 }, 2959 "UntagResourceRequest":{ 2960 "type":"structure", 2961 "required":[ 2962 "ResourceARN", 2963 "TagKeys" 2964 ], 2965 "members":{ 2966 "ResourceARN":{ 2967 "shape":"AmazonResourceName", 2968 "documentation":"<p>The Amazon Resource Name (ARN) of the contact or escalation plan.</p>" 2969 }, 2970 "TagKeys":{ 2971 "shape":"TagKeyList", 2972 "documentation":"<p>The key of the tag that you want to remove.</p>" 2973 } 2974 } 2975 }, 2976 "UntagResourceResult":{ 2977 "type":"structure", 2978 "members":{ 2979 } 2980 }, 2981 "UpdateContactChannelRequest":{ 2982 "type":"structure", 2983 "required":["ContactChannelId"], 2984 "members":{ 2985 "ContactChannelId":{ 2986 "shape":"SsmContactsArn", 2987 "documentation":"<p>The Amazon Resource Name (ARN) of the contact channel you want to update.</p>" 2988 }, 2989 "Name":{ 2990 "shape":"ChannelName", 2991 "documentation":"<p>The name of the contact channel.</p>" 2992 }, 2993 "DeliveryAddress":{ 2994 "shape":"ContactChannelAddress", 2995 "documentation":"<p>The details that Incident Manager uses when trying to engage the contact channel.</p>" 2996 } 2997 } 2998 }, 2999 "UpdateContactChannelResult":{ 3000 "type":"structure", 3001 "members":{ 3002 } 3003 }, 3004 "UpdateContactRequest":{ 3005 "type":"structure", 3006 "required":["ContactId"], 3007 "members":{ 3008 "ContactId":{ 3009 "shape":"SsmContactsArn", 3010 "documentation":"<p>The Amazon Resource Name (ARN) of the contact or escalation plan you're updating.</p>" 3011 }, 3012 "DisplayName":{ 3013 "shape":"ContactName", 3014 "documentation":"<p>The full name of the contact or escalation plan.</p>" 3015 }, 3016 "Plan":{ 3017 "shape":"Plan", 3018 "documentation":"<p>A list of stages. A contact has an engagement plan with stages for specified contact channels. An escalation plan uses these stages to contact specified contacts.</p>" 3019 } 3020 } 3021 }, 3022 "UpdateContactResult":{ 3023 "type":"structure", 3024 "members":{ 3025 } 3026 }, 3027 "UpdateRotationRequest":{ 3028 "type":"structure", 3029 "required":[ 3030 "RotationId", 3031 "Recurrence" 3032 ], 3033 "members":{ 3034 "RotationId":{ 3035 "shape":"SsmContactsArn", 3036 "documentation":"<p>The Amazon Resource Name (ARN) of the rotation to update.</p>" 3037 }, 3038 "ContactIds":{ 3039 "shape":"RotationContactsArnList", 3040 "documentation":"<p>The Amazon Resource Names (ARNs) of the contacts to include in the updated rotation. </p> <p>The order in which you list the contacts is their shift order in the rotation schedule.</p>" 3041 }, 3042 "StartTime":{ 3043 "shape":"DateTime", 3044 "documentation":"<p>The date and time the rotation goes into effect.</p>" 3045 }, 3046 "TimeZoneId":{ 3047 "shape":"TimeZoneId", 3048 "documentation":"<p>The time zone to base the updated rotation’s activity on, in Internet Assigned Numbers Authority (IANA) format. For example: \"America/Los_Angeles\", \"UTC\", or \"Asia/Seoul\". For more information, see the <a href=\"https://www.iana.org/time-zones\">Time Zone Database</a> on the IANA website.</p> <note> <p>Designators for time zones that don’t support Daylight Savings Time Rules, such as Pacific Standard Time (PST) and Pacific Daylight Time (PDT), aren't supported.</p> </note>" 3049 }, 3050 "Recurrence":{ 3051 "shape":"RecurrenceSettings", 3052 "documentation":"<p>Information about how long the updated rotation lasts before restarting at the beginning of the shift order.</p>" 3053 } 3054 } 3055 }, 3056 "UpdateRotationResult":{ 3057 "type":"structure", 3058 "members":{ 3059 } 3060 }, 3061 "Uuid":{ 3062 "type":"string", 3063 "max":39, 3064 "min":36, 3065 "pattern":"([a-fA-Z0-9]{8,11}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}){1}" 3066 }, 3067 "ValidationException":{ 3068 "type":"structure", 3069 "required":["Message"], 3070 "members":{ 3071 "Message":{"shape":"String"}, 3072 "Reason":{ 3073 "shape":"ValidationExceptionReason", 3074 "documentation":"Reason the request failed validation" 3075 }, 3076 "Fields":{ 3077 "shape":"ValidationExceptionFieldList", 3078 "documentation":"The fields that caused the error" 3079 } 3080 }, 3081 "documentation":"<p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>", 3082 "exception":true 3083 }, 3084 "ValidationExceptionField":{ 3085 "type":"structure", 3086 "required":[ 3087 "Name", 3088 "Message" 3089 ], 3090 "members":{ 3091 "Name":{ 3092 "shape":"String", 3093 "documentation":"<p>The name of the field that caused the exception.</p>" 3094 }, 3095 "Message":{ 3096 "shape":"String", 3097 "documentation":"<p>Information about what caused the field to cause an exception.</p>" 3098 } 3099 }, 3100 "documentation":"<p>Provides information about which field caused the exception.</p>" 3101 }, 3102 "ValidationExceptionFieldList":{ 3103 "type":"list", 3104 "member":{"shape":"ValidationExceptionField"} 3105 }, 3106 "ValidationExceptionReason":{ 3107 "type":"string", 3108 "enum":[ 3109 "UNKNOWN_OPERATION", 3110 "CANNOT_PARSE", 3111 "FIELD_VALIDATION_FAILED", 3112 "OTHER" 3113 ] 3114 }, 3115 "WeeklySetting":{ 3116 "type":"structure", 3117 "required":[ 3118 "DayOfWeek", 3119 "HandOffTime" 3120 ], 3121 "members":{ 3122 "DayOfWeek":{ 3123 "shape":"DayOfWeek", 3124 "documentation":"<p>The day of the week when weekly recurring on-call shift rotations begins.</p>" 3125 }, 3126 "HandOffTime":{ 3127 "shape":"HandOffTime", 3128 "documentation":"<p>The time of day when a weekly recurring on-call shift rotation begins.</p>" 3129 } 3130 }, 3131 "documentation":"<p>Information about rotations that recur weekly.</p>" 3132 }, 3133 "WeeklySettings":{ 3134 "type":"list", 3135 "member":{"shape":"WeeklySetting"} 3136 } 3137 }, 3138 "documentation":"<p>Systems Manager Incident Manager is an incident management console designed to help users mitigate and recover from incidents affecting their Amazon Web Services-hosted applications. An incident is any unplanned interruption or reduction in quality of services.</p> <p>Incident Manager increases incident resolution by notifying responders of impact, highlighting relevant troubleshooting data, and providing collaboration tools to get services back up and running. To achieve the primary goal of reducing the time-to-resolution of critical incidents, Incident Manager automates response plans and enables responder team escalation.</p>" 3139} 3140