github.com/aavshr/aws-sdk-go@v1.41.3/models/apis/ssm-contacts/2021-05-03/examples-1.json (about) 1 { 2 "version": "1.0", 3 "examples": { 4 "AcceptPage": [ 5 { 6 "input": { 7 "AcceptCode": "425440", 8 "AcceptType": "READ", 9 "PageId": "arn:aws:ssm-contacts:us-east-2:682428703967:page/akuam/94ea0c7b-56d9-46c3-b84a-a37c8b067ad3" 10 }, 11 "output": { 12 }, 13 "comments": { 14 }, 15 "description": "The following accept-page operation uses an accept code sent to the contact channel to accept a page.", 16 "id": "to-accept-a-page-during-and-engagement-1630357840187", 17 "title": "To accept a page during and engagement" 18 } 19 ], 20 "ActivateContactChannel": [ 21 { 22 "input": { 23 "ActivationCode": "466136", 24 "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d" 25 }, 26 "output": { 27 }, 28 "comments": { 29 }, 30 "description": "The following activate-contact-channel example activates a contact channel and makes it usable as part of an incident.", 31 "id": "activate-a-contacts-contact-channel-1630359780075", 32 "title": "Activate a contact's contact channel" 33 } 34 ], 35 "CreateContact": [ 36 { 37 "input": { 38 "Alias": "akuam", 39 "DisplayName": "Akua Mansa", 40 "Plan": { 41 "Stages": [ 42 43 ] 44 }, 45 "Type": "PERSONAL" 46 }, 47 "output": { 48 "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam" 49 }, 50 "comments": { 51 }, 52 "description": "The following create-contact example creates a contact in your environment with a blank plan. The plan can be updated after creating contact channels. Use the create-contact-channel operation with the output ARN of this command. After you have created contact channels for this contact use update-contact to update the plan.", 53 "id": "to-create-a-contact-1630360152750", 54 "title": "To create a contact" 55 } 56 ], 57 "CreateContactChannel": [ 58 { 59 "input": { 60 "ContactId": "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam", 61 "DeliveryAddress": { 62 "SimpleAddress": "+15005550199" 63 }, 64 "Name": "akuas sms-test", 65 "Type": "SMS" 66 }, 67 "output": { 68 "ContactChannelArn": "arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/02f506b9-ea5d-4764-af89-2daa793ff024" 69 }, 70 "comments": { 71 "input": { 72 }, 73 "output": { 74 } 75 }, 76 "description": "Creates a contact channel of type SMS for the contact Akua Mansa. Contact channels can be created of type SMS, EMAIL, or VOICE.", 77 "id": "to-create-a-contact-channel-1630360447010", 78 "title": "To create a contact channel" 79 } 80 ], 81 "DeactivateContactChannel": [ 82 { 83 "input": { 84 "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d" 85 }, 86 "output": { 87 }, 88 "comments": { 89 }, 90 "description": "The following ``deactivate-contact-channel`` example deactivates a contact channel. Deactivating a contact channel means the contact channel will no longer be paged during an incident. You can also reactivate a contact channel at any time using the activate-contact-channel operation.", 91 "id": "to-deactivate-a-contact-channel-1630360853894", 92 "title": "To deactivate a contact channel" 93 } 94 ], 95 "DeleteContact": [ 96 { 97 "input": { 98 "ContactId": "arn:aws:ssm-contacts:us-east-1:111122223333:contact/alejr" 99 }, 100 "output": { 101 }, 102 "comments": { 103 }, 104 "description": "The following delete-contact example deletes a contact. The contact will no longer be reachable from any escalation plan that refers to them.", 105 "id": "to-delete-a-contact-1630361093863", 106 "title": "To delete a contact" 107 } 108 ], 109 "DeleteContactChannel": [ 110 { 111 "input": { 112 "ContactChannelId": "arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/13149bad-52ee-45ea-ae1e-45857f78f9b2" 113 }, 114 "output": { 115 }, 116 "comments": { 117 "input": { 118 }, 119 "output": { 120 } 121 }, 122 "description": "The following delete-contact-channel example deletes a contact channel. Deleting a contact channel ensures the contact channel will not be paged during an incident.", 123 "id": "to-delete-a-contact-channel-1630364616682", 124 "title": "To delete a contact channel" 125 } 126 ], 127 "DescribeEngagement": [ 128 { 129 "input": { 130 "EngagementId": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356" 131 }, 132 "output": { 133 "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation", 134 "Content": "Testing engagements", 135 "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356", 136 "PublicContent": "Testing engagements", 137 "PublicSubject": "test", 138 "Sender": "tester", 139 "StartTime": "$2021-05-18T18:25:41.151000+00:00", 140 "Subject": "test" 141 }, 142 "comments": { 143 }, 144 "description": "The following describe-engagement example lists the details of an engagement to a contact or escalation plan. The subject and content are sent to the contact channels.", 145 "id": "to-describe-the-details-of-an-engagement-1630364719475", 146 "title": "To describe the details of an engagement" 147 } 148 ], 149 "DescribePage": [ 150 { 151 "input": { 152 "PageId": "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93" 153 }, 154 "output": { 155 "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 156 "Content": "Testing engagements", 157 "DeliveryTime": "2021-05-18T18:43:55.265000+00:00", 158 "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0", 159 "PageArn": "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93", 160 "PublicContent": "Testing engagements", 161 "PublicSubject": "test", 162 "ReadTime": "2021-05-18T18:43:55.708000+00:00", 163 "Sender": "tester", 164 "SentTime": "2021-05-18T18:43:29.301000+00:00", 165 "Subject": "test" 166 }, 167 "comments": { 168 }, 169 "description": "The following describe-page example lists details of a page to a contact channel. The page will include the subject and content provided.", 170 "id": "to-list-the-details-of-a-page-to-a-contact-channel-1630364907282", 171 "title": "To list the details of a page to a contact channel" 172 } 173 ], 174 "GetContact": [ 175 { 176 "input": { 177 "ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam" 178 }, 179 "output": { 180 "Alias": "akuam", 181 "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 182 "DisplayName": "Akua Mansa", 183 "Plan": { 184 "Stages": [ 185 { 186 "DurationInMinutes": 5, 187 "Targets": [ 188 { 189 "ChannelTargetInfo": { 190 "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/beb25840-5ac8-4644-95cc-7a8de390fa65", 191 "RetryIntervalInMinutes": 1 192 } 193 } 194 ] 195 }, 196 { 197 "DurationInMinutes": 5, 198 "Targets": [ 199 { 200 "ChannelTargetInfo": { 201 "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/49f3c24d-5f9f-4638-ae25-3f49e04229ad", 202 "RetryIntervalInMinutes": 1 203 } 204 } 205 ] 206 }, 207 { 208 "DurationInMinutes": 5, 209 "Targets": [ 210 { 211 "ChannelTargetInfo": { 212 "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/77d4f447-f619-4954-afff-85551e369c2a", 213 "RetryIntervalInMinutes": 1 214 } 215 } 216 ] 217 } 218 ] 219 }, 220 "Type": "PERSONAL" 221 }, 222 "comments": { 223 }, 224 "description": "The following get-contact example describes a contact.", 225 "id": "example-1-to-describe-a-contact-plan-1630365360005", 226 "title": "Example 1: To describe a contact plan" 227 }, 228 { 229 "input": { 230 "ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation" 231 }, 232 "output": { 233 "Alias": "example_escalation", 234 "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation", 235 "DisplayName": "Example Escalation Plan", 236 "Plan": { 237 "Stages": [ 238 { 239 "DurationInMinutes": 5, 240 "Targets": [ 241 { 242 "ContactTargetInfo": { 243 "ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 244 "IsEssential": true 245 } 246 } 247 ] 248 }, 249 { 250 "DurationInMinutes": 5, 251 "Targets": [ 252 { 253 "ContactTargetInfo": { 254 "ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/alejr", 255 "IsEssential": false 256 } 257 } 258 ] 259 }, 260 { 261 "DurationInMinutes": 0, 262 "Targets": [ 263 { 264 "ContactTargetInfo": { 265 "ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/anasi", 266 "IsEssential": false 267 } 268 } 269 ] 270 } 271 ] 272 }, 273 "Type": "ESCALATION" 274 }, 275 "comments": { 276 }, 277 "description": "The following get-contact example describes an escalation plan.", 278 "id": "example-2-to-describe-an-escalation-plan-1630365515731", 279 "title": "Example 2: To describe an escalation plan" 280 } 281 ], 282 "GetContactChannel": [ 283 { 284 "input": { 285 "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d" 286 }, 287 "output": { 288 "ActivationStatus": "ACTIVATED", 289 "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 290 "ContactChannelArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d", 291 "DeliveryAddress": { 292 "SimpleAddress": "+15005550199" 293 }, 294 "Name": "akuas sms", 295 "Type": "SMS" 296 }, 297 "comments": { 298 }, 299 "description": "The following get-contact-channel example lists the details of a contact channel.", 300 "id": "to-list-the-details-of-a-contact-channel-1630365682730", 301 "title": "To list the details of a contact channel" 302 } 303 ], 304 "GetContactPolicy": [ 305 { 306 "input": { 307 "ContactArn": "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam" 308 }, 309 "output": { 310 "ContactArn": "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam", 311 "Policy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"SharePolicyForDocumentationDralia\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"222233334444\"},\"Action\":[\"ssm-contacts:GetContact\",\"ssm-contacts:StartEngagement\",\"ssm-contacts:DescribeEngagement\",\"ssm-contacts:ListPagesByEngagement\",\"ssm-contacts:StopEngagement\"],\"Resource\":[\"arn:aws:ssm-contacts:*:111122223333:contact/akuam\",\"arn:aws:ssm-contacts:*:111122223333:engagement/akuam/*\"]}]}" 312 }, 313 "comments": { 314 }, 315 "description": "The following get-contact-policy example lists the resource policies associated with the specified contact.", 316 "id": "to-list-the-details-of-a-contact-channel-1630365682730", 317 "title": "To list the resource policies of a contact" 318 } 319 ], 320 "ListContactChannels": [ 321 { 322 "input": { 323 "ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam" 324 }, 325 "output": { 326 "ContactChannels": [ 327 { 328 "ActivationStatus": "ACTIVATED", 329 "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 330 "ContactChannelArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d", 331 "DeliveryAddress": { 332 "SimpleAddress": "+15005550100" 333 }, 334 "Name": "akuas sms", 335 "Type": "SMS" 336 } 337 ] 338 }, 339 "comments": { 340 }, 341 "description": "The following list-contact-channels example lists the available contact channels of the specified contact.", 342 "id": "to-list-the-contact-channels-of-a-contact-1630366544252", 343 "title": "To list the contact channels of a contact" 344 } 345 ], 346 "ListContacts": [ 347 { 348 "input": { 349 }, 350 "output": { 351 "Contacts": [ 352 { 353 "Alias": "akuam", 354 "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 355 "DisplayName": "Akua Mansa", 356 "Type": "PERSONAL" 357 }, 358 { 359 "Alias": "alejr", 360 "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/alejr", 361 "DisplayName": "Alejandro Rosalez", 362 "Type": "PERSONAL" 363 }, 364 { 365 "Alias": "anasi", 366 "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/anasi", 367 "DisplayName": "Ana Carolina Silva", 368 "Type": "PERSONAL" 369 }, 370 { 371 "Alias": "example_escalation", 372 "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation", 373 "DisplayName": "Example Escalation", 374 "Type": "ESCALATION" 375 } 376 ] 377 }, 378 "comments": { 379 }, 380 "description": "The following list-contacts example lists the contacts and escalation plans in your account.", 381 "id": "to-list-all-escalation-plans-and-contacts-1630367103082", 382 "title": "To list all escalation plans and contacts" 383 } 384 ], 385 "ListEngagements": [ 386 { 387 "input": { 388 }, 389 "output": { 390 "Engagements": [ 391 { 392 "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 393 "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/91792571-0b53-4821-9f73-d25d13d9e529", 394 "Sender": "cli", 395 "StartTime": "2021-05-18T20:37:50.300000+00:00" 396 }, 397 { 398 "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 399 "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0", 400 "Sender": "cli", 401 "StartTime": "2021-05-18T18:40:26.666000+00:00" 402 }, 403 { 404 "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation", 405 "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356", 406 "Sender": "cli", 407 "StartTime": "2021-05-18T18:25:41.151000+00:00" 408 }, 409 { 410 "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 411 "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/607ced0e-e8fa-4ea7-8958-a237b8803f8f", 412 "Sender": "cli", 413 "StartTime": "2021-05-18T18:20:58.093000+00:00" 414 } 415 ] 416 }, 417 "comments": { 418 }, 419 "description": "The following list-engagements example lists engagements to escalation plans and contacts. You can also list engagements for a single incident.", 420 "id": "to-list-all-engagements-1630367432635", 421 "title": "To list all engagements" 422 } 423 ], 424 "ListPageReceipts": [ 425 { 426 "input": { 427 "PageId": "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/94ea0c7b-56d9-46c3-b84a-a37c8b067ad3" 428 }, 429 "output": { 430 "Receipts": [ 431 { 432 "ContactChannelArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d", 433 "ReceiptInfo": "425440", 434 "ReceiptTime": "2021-05-18T20:42:57.485000+00:00", 435 "ReceiptType": "DELIVERED" 436 }, 437 { 438 "ContactChannelArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d", 439 "ReceiptInfo": "425440", 440 "ReceiptTime": "2021-05-18T20:42:57.907000+00:00", 441 "ReceiptType": "READ" 442 }, 443 { 444 "ContactChannelArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d", 445 "ReceiptInfo": "SM6656c19132f1465f9c9c1123a5dde7c9", 446 "ReceiptTime": "2021-05-18T20:40:52.962000+00:00", 447 "ReceiptType": "SENT" 448 } 449 ] 450 }, 451 "comments": { 452 }, 453 "description": "The following command-name example lists whether a page was received or not by a contact.", 454 "id": "to-list-page-receipts-1630367706869", 455 "title": "To list page receipts" 456 } 457 ], 458 "ListPagesByContact": [ 459 { 460 "input": { 461 "ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam" 462 }, 463 "output": { 464 "Pages": [ 465 { 466 "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 467 "DeliveryTime": "2021-05-18T18:43:55.265000+00:00", 468 "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0", 469 "PageArn": "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93", 470 "ReadTime": "2021-05-18T18:43:55.708000+00:00", 471 "Sender": "cli", 472 "SentTime": "2021-05-18T18:43:29.301000+00:00" 473 } 474 ] 475 }, 476 "comments": { 477 }, 478 "description": "The following list-pages-by-contact example lists all pages to the specified contact.", 479 "id": "to-list-pages-by-contact-1630435789132", 480 "title": "To list pages by contact" 481 } 482 ], 483 "ListPagesByEngagement": [ 484 { 485 "input": { 486 "EngagementId": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0" 487 }, 488 "output": { 489 "Pages": [ 490 { 491 "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 492 "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0", 493 "PageArn": "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93", 494 "Sender": "cli", 495 "SentTime": "2021-05-18T18:40:27.245000+00:00" 496 } 497 ] 498 }, 499 "comments": { 500 }, 501 "description": "The following list-pages-by-engagement example lists the pages that occurred while engaging the defined engagement plan.", 502 "id": "to-list-pages-to-contact-channels-started-from-an-engagement-1630435864674", 503 "title": "To list pages to contact channels started from an engagement." 504 } 505 ], 506 "ListTagsForResource": [ 507 { 508 "input": { 509 "ResourceARN": "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam" 510 }, 511 "output": { 512 "Tags": [ 513 { 514 "Key": "group1", 515 "Value": "1" 516 } 517 ] 518 }, 519 "comments": { 520 }, 521 "description": "The following list-tags-for-resource example lists the tags of the specified contact.", 522 "id": "to-list-tags-for-a-contact-1630436051681", 523 "title": "To list tags for a contact" 524 } 525 ], 526 "PutContactPolicy": [ 527 { 528 "input": { 529 "ContactArn": "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam", 530 "Policy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"ExampleResourcePolicy\",\"Action\":[\"ssm-contacts:GetContact\",\"ssm-contacts:StartEngagement\",\"ssm-contacts:DescribeEngagement\",\"ssm-contacts:ListPagesByEngagement\",\"ssm-contacts:StopEngagement\"],\"Principal\":{\"AWS\":\"222233334444\"},\"Effect\":\"Allow\",\"Resource\":[\"arn:aws:ssm-contacts:*:111122223333:contact/akuam\",\"arn:aws:ssm-contacts:*:111122223333:engagement/akuam/*\"]}]}" 531 }, 532 "output": { 533 }, 534 "comments": { 535 }, 536 "description": "The following put-contact-policy example adds a resource policy to the contact Akua that shares the contact and related engagements with the principal.", 537 "id": "to-share-a-contact-and-engagements-1630436278898", 538 "title": "To share a contact and engagements" 539 } 540 ], 541 "SendActivationCode": [ 542 { 543 "input": { 544 "ContactChannelId": "arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/8ddae2d1-12c8-4e45-b852-c8587266c400" 545 }, 546 "output": { 547 }, 548 "comments": { 549 }, 550 "description": "The following send-activation-code example sends an activation code and message to the specified contact channel.", 551 "id": "to-send-an-activation-code-1630436453574", 552 "title": "To send an activation code" 553 } 554 ], 555 "StartEngagement": [ 556 { 557 "input": { 558 "ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 559 "Content": "Testing engagements", 560 "PublicContent": "Testing engagements", 561 "PublicSubject": "test", 562 "Sender": "tester", 563 "Subject": "test" 564 }, 565 "output": { 566 "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/607ced0e-e8fa-4ea7-8958-a237b8803f8f" 567 }, 568 "comments": { 569 }, 570 "description": "The following start-engagement pages contact's contact channels. Sender, subject, public-subject, and public-content are all free from fields. Incident Manager sends the subject and content to the provided VOICE or EMAIL contact channels. Incident Manager sends the public-subject and public-content to the provided SMS contact channels. Sender is used to track who started the engagement.", 571 "id": "example-1-to-page-a-contacts-contact-channels-1630436634872", 572 "title": "Example 1: To page a contact's contact channels" 573 }, 574 { 575 "input": { 576 "ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation", 577 "Content": "Testing engagements", 578 "PublicContent": "Testing engagements", 579 "PublicSubject": "test", 580 "Sender": "tester", 581 "Subject": "test" 582 }, 583 "output": { 584 "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356" 585 }, 586 "comments": { 587 }, 588 "description": "The following start-engagement engages contact's through an escalation plan. Each contact is paged according to their engagement plan.", 589 "id": "example-2-to-page-a-contact-in-the-provided-escalation-plan-1630436808480", 590 "title": "Example 2: To page a contact in the provided escalation plan." 591 } 592 ], 593 "StopEngagement": [ 594 { 595 "input": { 596 "EngagementId": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356" 597 }, 598 "output": { 599 }, 600 "comments": { 601 }, 602 "description": "The following stop-engagement example stops an engagement from paging further contacts and contact channels.", 603 "id": "to-stop-an-engagement-1630436882864", 604 "title": "To stop an engagement" 605 } 606 ], 607 "TagResource": [ 608 { 609 "input": { 610 "ResourceARN": "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam", 611 "Tags": [ 612 { 613 "Key": "group1", 614 "Value": "1" 615 } 616 ] 617 }, 618 "output": { 619 }, 620 "comments": { 621 }, 622 "description": "The following tag-resource example tags a specified contact with the provided tag key value pair.", 623 "id": "to-tag-a-contact-1630437124572", 624 "title": "To tag a contact" 625 } 626 ], 627 "UntagResource": [ 628 { 629 "input": { 630 "ResourceARN": "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam", 631 "TagKeys": [ 632 "group1" 633 ] 634 }, 635 "output": { 636 }, 637 "comments": { 638 }, 639 "description": "The following untag-resource example removes the group1 tag from the specified contact.", 640 "id": "to-remove-tags-from-a-contact-1630437251110", 641 "title": "To remove tags from a contact" 642 } 643 ], 644 "UpdateContact": [ 645 { 646 "input": { 647 "ContactId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 648 "Plan": { 649 "Stages": [ 650 { 651 "DurationInMinutes": 5, 652 "Targets": [ 653 { 654 "ChannelTargetInfo": { 655 "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/beb25840-5ac8-4644-95cc-7a8de390fa65", 656 "RetryIntervalInMinutes": 1 657 } 658 } 659 ] 660 }, 661 { 662 "DurationInMinutes": 5, 663 "Targets": [ 664 { 665 "ChannelTargetInfo": { 666 "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/49f3c24d-5f9f-4638-ae25-3f49e04229ad", 667 "RetryIntervalInMinutes": 1 668 } 669 } 670 ] 671 }, 672 { 673 "DurationInMinutes": 5, 674 "Targets": [ 675 { 676 "ChannelTargetInfo": { 677 "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/77d4f447-f619-4954-afff-85551e369c2a", 678 "RetryIntervalInMinutes": 1 679 } 680 } 681 ] 682 } 683 ] 684 } 685 }, 686 "output": { 687 }, 688 "comments": { 689 }, 690 "description": "The following update-contact example updates the engagement plan of the contact Akua to include the three types of contacts channels. This is done after creating contact channels for Akua.", 691 "id": "to-update-the-engagement-plan-of-contact-1630437436599", 692 "title": "To update the engagement plan of contact" 693 } 694 ], 695 "UpdateContactChannel": [ 696 { 697 "input": { 698 "ContactChannelId": "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/49f3c24d-5f9f-4638-ae25-3f49e04229ad", 699 "DeliveryAddress": { 700 "SimpleAddress": "+15005550198" 701 }, 702 "Name": "akuas voice channel" 703 }, 704 "output": { 705 }, 706 "comments": { 707 }, 708 "description": "The following update-contact-channel example updates the name and delivery address of a contact channel.", 709 "id": "to-update-a-contact-channel-1630437610256", 710 "title": "To update a contact channel" 711 } 712 ] 713 } 714 }