@aws-sdk/client-ssm-contacts 3.379.1 → 3.385.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -29,26 +29,32 @@ export type AcceptType = (typeof AcceptType)[keyof typeof AcceptType];
29
29
  */
30
30
  export interface AcceptPageRequest {
31
31
  /**
32
+ * @public
32
33
  * <p>The Amazon Resource Name (ARN) of the engagement to a contact channel.</p>
33
34
  */
34
35
  PageId: string | undefined;
35
36
  /**
37
+ * @public
36
38
  * <p>The ARN of the contact channel.</p>
37
39
  */
38
40
  ContactChannelId?: string;
39
41
  /**
42
+ * @public
40
43
  * <p>The type indicates if the page was <code>DELIVERED</code> or <code>READ</code>.</p>
41
44
  */
42
45
  AcceptType: AcceptType | string | undefined;
43
46
  /**
47
+ * @public
44
48
  * <p>Information provided by the user when the user acknowledges the page.</p>
45
49
  */
46
50
  Note?: string;
47
51
  /**
52
+ * @public
48
53
  * <p>A 6-digit code used to acknowledge the page.</p>
49
54
  */
50
55
  AcceptCode: string | undefined;
51
56
  /**
57
+ * @public
52
58
  * <p>An optional field that Incident Manager uses to <code>ENFORCE</code>
53
59
  * <code>AcceptCode</code> validation when acknowledging an page. Acknowledgement can occur by
54
60
  * replying to a page, or when entering the AcceptCode in the console. Enforcing AcceptCode
@@ -87,6 +93,7 @@ export declare class InternalServerException extends __BaseException {
87
93
  readonly $fault: "server";
88
94
  Message: string | undefined;
89
95
  /**
96
+ * @public
90
97
  * Advice to clients on when the call can be safely retried
91
98
  */
92
99
  RetryAfterSeconds?: number;
@@ -104,10 +111,12 @@ export declare class ResourceNotFoundException extends __BaseException {
104
111
  readonly $fault: "client";
105
112
  Message: string | undefined;
106
113
  /**
114
+ * @public
107
115
  * Hypothetical resource identifier that was not found
108
116
  */
109
117
  ResourceId: string | undefined;
110
118
  /**
119
+ * @public
111
120
  * Hypothetical resource type that was not found
112
121
  */
113
122
  ResourceType: string | undefined;
@@ -125,14 +134,17 @@ export declare class ThrottlingException extends __BaseException {
125
134
  readonly $fault: "client";
126
135
  Message: string | undefined;
127
136
  /**
137
+ * @public
128
138
  * Service Quotas requirement to identify originating service
129
139
  */
130
140
  QuotaCode?: string;
131
141
  /**
142
+ * @public
132
143
  * Service Quotas requirement to identify originating quota
133
144
  */
134
145
  ServiceCode?: string;
135
146
  /**
147
+ * @public
136
148
  * Advice to clients on when the call can be safely retried
137
149
  */
138
150
  RetryAfterSeconds?: number;
@@ -147,10 +159,12 @@ export declare class ThrottlingException extends __BaseException {
147
159
  */
148
160
  export interface ValidationExceptionField {
149
161
  /**
162
+ * @public
150
163
  * <p>The name of the field that caused the exception.</p>
151
164
  */
152
165
  Name: string | undefined;
153
166
  /**
167
+ * @public
154
168
  * <p>Information about what caused the field to cause an exception.</p>
155
169
  */
156
170
  Message: string | undefined;
@@ -179,10 +193,12 @@ export declare class ValidationException extends __BaseException {
179
193
  readonly $fault: "client";
180
194
  Message: string | undefined;
181
195
  /**
196
+ * @public
182
197
  * Reason the request failed validation
183
198
  */
184
199
  Reason?: ValidationExceptionReason | string;
185
200
  /**
201
+ * @public
186
202
  * The fields that caused the error
187
203
  */
188
204
  Fields?: ValidationExceptionField[];
@@ -196,10 +212,12 @@ export declare class ValidationException extends __BaseException {
196
212
  */
197
213
  export interface ActivateContactChannelRequest {
198
214
  /**
215
+ * @public
199
216
  * <p>The Amazon Resource Name (ARN) of the contact channel.</p>
200
217
  */
201
218
  ContactChannelId: string | undefined;
202
219
  /**
220
+ * @public
203
221
  * <p>The code sent to the contact channel when it was created in the contact.</p>
204
222
  */
205
223
  ActivationCode: string | undefined;
@@ -228,10 +246,12 @@ export type ActivationStatus = (typeof ActivationStatus)[keyof typeof Activation
228
246
  */
229
247
  export interface ChannelTargetInfo {
230
248
  /**
249
+ * @public
231
250
  * <p>The Amazon Resource Name (ARN) of the contact channel.</p>
232
251
  */
233
252
  ContactChannelId: string | undefined;
234
253
  /**
254
+ * @public
235
255
  * <p>The number of minutes to wait to retry sending engagement in the case the engagement
236
256
  * initially fails.</p>
237
257
  */
@@ -258,11 +278,13 @@ export type ChannelType = (typeof ChannelType)[keyof typeof ChannelType];
258
278
  */
259
279
  export interface DependentEntity {
260
280
  /**
281
+ * @public
261
282
  * <p>The type of relationship between one resource and the other resource that it is related
262
283
  * to or depends on.</p>
263
284
  */
264
285
  RelationType: string | undefined;
265
286
  /**
287
+ * @public
266
288
  * <p>The Amazon Resource Names (ARNs) of the dependent resources.</p>
267
289
  */
268
290
  DependentResourceIds: string[] | undefined;
@@ -276,14 +298,17 @@ export declare class ConflictException extends __BaseException {
276
298
  readonly $fault: "client";
277
299
  Message: string | undefined;
278
300
  /**
301
+ * @public
279
302
  * Identifier of the resource in use
280
303
  */
281
304
  ResourceId: string | undefined;
282
305
  /**
306
+ * @public
283
307
  * Type of the resource in use
284
308
  */
285
309
  ResourceType: string | undefined;
286
310
  /**
311
+ * @public
287
312
  * List of dependent entities containing information on relation type and resourceArns linked to the resource in use
288
313
  */
289
314
  DependentEntities?: DependentEntity[];
@@ -312,18 +337,22 @@ export type ContactType = (typeof ContactType)[keyof typeof ContactType];
312
337
  */
313
338
  export interface Contact {
314
339
  /**
340
+ * @public
315
341
  * <p>The Amazon Resource Name (ARN) of the contact or escalation plan.</p>
316
342
  */
317
343
  ContactArn: string | undefined;
318
344
  /**
345
+ * @public
319
346
  * <p>The unique and identifiable alias of the contact or escalation plan.</p>
320
347
  */
321
348
  Alias: string | undefined;
322
349
  /**
350
+ * @public
323
351
  * <p>The full name of the contact or escalation plan.</p>
324
352
  */
325
353
  DisplayName?: string;
326
354
  /**
355
+ * @public
327
356
  * <p>Refers to the type of contact. A single contact is type <code>PERSONAL</code> and an
328
357
  * escalation plan is type <code>ESCALATION</code>.</p>
329
358
  */
@@ -335,6 +364,7 @@ export interface Contact {
335
364
  */
336
365
  export interface ContactChannelAddress {
337
366
  /**
367
+ * @public
338
368
  * <p>The format is dependent on the type of the contact channel. The following are the
339
369
  * expected formats:</p>
340
370
  * <ul>
@@ -357,18 +387,22 @@ export interface ContactChannelAddress {
357
387
  */
358
388
  export interface ContactChannel {
359
389
  /**
390
+ * @public
360
391
  * <p>The Amazon Resource Name (ARN) of the contact channel.</p>
361
392
  */
362
393
  ContactChannelArn: string | undefined;
363
394
  /**
395
+ * @public
364
396
  * <p>The ARN of the contact that contains the contact channel.</p>
365
397
  */
366
398
  ContactArn: string | undefined;
367
399
  /**
400
+ * @public
368
401
  * <p>The name of the contact channel.</p>
369
402
  */
370
403
  Name: string | undefined;
371
404
  /**
405
+ * @public
372
406
  * <p>The type of the contact channel. Incident Manager supports three contact methods:</p>
373
407
  * <ul>
374
408
  * <li>
@@ -384,10 +418,12 @@ export interface ContactChannel {
384
418
  */
385
419
  Type?: ChannelType | string;
386
420
  /**
421
+ * @public
387
422
  * <p>The details that Incident Manager uses when trying to engage the contact channel.</p>
388
423
  */
389
424
  DeliveryAddress: ContactChannelAddress | undefined;
390
425
  /**
426
+ * @public
391
427
  * <p>A Boolean value describing if the contact channel has been activated or not. If the
392
428
  * contact channel isn't activated, Incident Manager can't engage the contact through it.</p>
393
429
  */
@@ -399,10 +435,12 @@ export interface ContactChannel {
399
435
  */
400
436
  export interface ContactTargetInfo {
401
437
  /**
438
+ * @public
402
439
  * <p>The Amazon Resource Name (ARN) of the contact.</p>
403
440
  */
404
441
  ContactId?: string;
405
442
  /**
443
+ * @public
406
444
  * <p>A Boolean value determining if the contact's acknowledgement stops the progress of
407
445
  * stages in the plan.</p>
408
446
  */
@@ -414,10 +452,12 @@ export interface ContactTargetInfo {
414
452
  */
415
453
  export interface HandOffTime {
416
454
  /**
455
+ * @public
417
456
  * <p>The hour when an on-call rotation shift begins or ends.</p>
418
457
  */
419
458
  HourOfDay: number | undefined;
420
459
  /**
460
+ * @public
421
461
  * <p>The minute when an on-call rotation shift begins or ends.</p>
422
462
  */
423
463
  MinuteOfHour: number | undefined;
@@ -428,10 +468,12 @@ export interface HandOffTime {
428
468
  */
429
469
  export interface CoverageTime {
430
470
  /**
471
+ * @public
431
472
  * <p>Information about when the on-call rotation shift begins.</p>
432
473
  */
433
474
  Start?: HandOffTime;
434
475
  /**
476
+ * @public
435
477
  * <p>Information about when the on-call rotation shift ends.</p>
436
478
  */
437
479
  End?: HandOffTime;
@@ -442,10 +484,12 @@ export interface CoverageTime {
442
484
  */
443
485
  export interface Target {
444
486
  /**
487
+ * @public
445
488
  * <p>Information about the contact channel Incident Manager is engaging.</p>
446
489
  */
447
490
  ChannelTargetInfo?: ChannelTargetInfo;
448
491
  /**
492
+ * @public
449
493
  * <p>Information about the contact that Incident Manager is engaging.</p>
450
494
  */
451
495
  ContactTargetInfo?: ContactTargetInfo;
@@ -457,11 +501,13 @@ export interface Target {
457
501
  */
458
502
  export interface Stage {
459
503
  /**
504
+ * @public
460
505
  * <p>The time to wait until beginning the next stage. The duration can only be set to 0 if a
461
506
  * target is specified.</p>
462
507
  */
463
508
  DurationInMinutes: number | undefined;
464
509
  /**
510
+ * @public
465
511
  * <p>The contacts or contact methods that the escalation plan or engagement plan is
466
512
  * engaging.</p>
467
513
  */
@@ -475,11 +521,13 @@ export interface Stage {
475
521
  */
476
522
  export interface Plan {
477
523
  /**
524
+ * @public
478
525
  * <p>A list of stages that the escalation plan or engagement plan uses to engage contacts and
479
526
  * contact methods.</p>
480
527
  */
481
528
  Stages?: Stage[];
482
529
  /**
530
+ * @public
483
531
  * <p>The Amazon Resource Names (ARNs) of the on-call rotations associated with the plan.
484
532
  * </p>
485
533
  */
@@ -491,10 +539,12 @@ export interface Plan {
491
539
  */
492
540
  export interface Tag {
493
541
  /**
542
+ * @public
494
543
  * <p>Name of the object key.</p>
495
544
  */
496
545
  Key?: string;
497
546
  /**
547
+ * @public
498
548
  * <p>Value of the tag.</p>
499
549
  */
500
550
  Value?: string;
@@ -504,30 +554,36 @@ export interface Tag {
504
554
  */
505
555
  export interface CreateContactRequest {
506
556
  /**
557
+ * @public
507
558
  * <p>The short name to quickly identify a contact or escalation plan. The contact alias must
508
559
  * be unique and identifiable.</p>
509
560
  */
510
561
  Alias: string | undefined;
511
562
  /**
563
+ * @public
512
564
  * <p>The full name of the contact or escalation plan.</p>
513
565
  */
514
566
  DisplayName?: string;
515
567
  /**
568
+ * @public
516
569
  * <p>To create an escalation plan use <code>ESCALATION</code>. To create a contact use
517
570
  * <code>PERSONAL</code>.</p>
518
571
  */
519
572
  Type: ContactType | string | undefined;
520
573
  /**
574
+ * @public
521
575
  * <p>A list of stages. A contact has an engagement plan with stages that contact specified
522
576
  * contact channels. An escalation plan uses stages that contact specified contacts.</p>
523
577
  */
524
578
  Plan: Plan | undefined;
525
579
  /**
580
+ * @public
526
581
  * <p>Adds a tag to the target. You can only tag resources created in the first Region of your
527
582
  * replication set.</p>
528
583
  */
529
584
  Tags?: Tag[];
530
585
  /**
586
+ * @public
531
587
  * <p>A token ensuring that the operation is called only once with the specified
532
588
  * details.</p>
533
589
  */
@@ -538,6 +594,7 @@ export interface CreateContactRequest {
538
594
  */
539
595
  export interface CreateContactResult {
540
596
  /**
597
+ * @public
541
598
  * <p>The Amazon Resource Name (ARN) of the created contact or escalation plan.</p>
542
599
  */
543
600
  ContactArn: string | undefined;
@@ -564,18 +621,22 @@ export declare class ServiceQuotaExceededException extends __BaseException {
564
621
  readonly $fault: "client";
565
622
  Message: string | undefined;
566
623
  /**
624
+ * @public
567
625
  * Identifier of the resource affected
568
626
  */
569
627
  ResourceId?: string;
570
628
  /**
629
+ * @public
571
630
  * Type of the resource affected
572
631
  */
573
632
  ResourceType?: string;
574
633
  /**
634
+ * @public
575
635
  * Service Quotas requirement to identify originating service
576
636
  */
577
637
  QuotaCode: string | undefined;
578
638
  /**
639
+ * @public
579
640
  * Service Quotas requirement to identify originating quota
580
641
  */
581
642
  ServiceCode: string | undefined;
@@ -589,15 +650,18 @@ export declare class ServiceQuotaExceededException extends __BaseException {
589
650
  */
590
651
  export interface CreateContactChannelRequest {
591
652
  /**
653
+ * @public
592
654
  * <p>The Amazon Resource Name (ARN) of the contact you are adding the contact channel
593
655
  * to.</p>
594
656
  */
595
657
  ContactId: string | undefined;
596
658
  /**
659
+ * @public
597
660
  * <p>The name of the contact channel.</p>
598
661
  */
599
662
  Name: string | undefined;
600
663
  /**
664
+ * @public
601
665
  * <p>Incident Manager supports three types of contact channels:</p>
602
666
  * <ul>
603
667
  * <li>
@@ -619,6 +683,7 @@ export interface CreateContactChannelRequest {
619
683
  */
620
684
  Type: ChannelType | string | undefined;
621
685
  /**
686
+ * @public
622
687
  * <p>The details that Incident Manager uses when trying to engage the contact channel. The format
623
688
  * is dependent on the type of the contact channel. The following are the expected
624
689
  * formats:</p>
@@ -636,11 +701,13 @@ export interface CreateContactChannelRequest {
636
701
  */
637
702
  DeliveryAddress: ContactChannelAddress | undefined;
638
703
  /**
704
+ * @public
639
705
  * <p>If you want to activate the channel at a later time, you can choose to defer activation.
640
706
  * Incident Manager can't engage your contact channel until it has been activated.</p>
641
707
  */
642
708
  DeferActivation?: boolean;
643
709
  /**
710
+ * @public
644
711
  * <p>A token ensuring that the operation is called only once with the specified
645
712
  * details.</p>
646
713
  */
@@ -651,6 +718,7 @@ export interface CreateContactChannelRequest {
651
718
  */
652
719
  export interface CreateContactChannelResult {
653
720
  /**
721
+ * @public
654
722
  * <p>The Amazon Resource Name (ARN) of the contact channel.</p>
655
723
  */
656
724
  ContactChannelArn: string | undefined;
@@ -661,10 +729,12 @@ export interface CreateContactChannelResult {
661
729
  */
662
730
  export interface MonthlySetting {
663
731
  /**
732
+ * @public
664
733
  * <p>The day of the month when monthly recurring on-call rotations begin.</p>
665
734
  */
666
735
  DayOfMonth: number | undefined;
667
736
  /**
737
+ * @public
668
738
  * <p>The time of day when a monthly recurring on-call shift rotation begins.</p>
669
739
  */
670
740
  HandOffTime: HandOffTime | undefined;
@@ -692,10 +762,12 @@ export type DayOfWeek = (typeof DayOfWeek)[keyof typeof DayOfWeek];
692
762
  */
693
763
  export interface WeeklySetting {
694
764
  /**
765
+ * @public
695
766
  * <p>The day of the week when weekly recurring on-call shift rotations begins.</p>
696
767
  */
697
768
  DayOfWeek: DayOfWeek | string | undefined;
698
769
  /**
770
+ * @public
699
771
  * <p>The time of day when a weekly recurring on-call shift rotation begins.</p>
700
772
  */
701
773
  HandOffTime: HandOffTime | undefined;
@@ -707,28 +779,34 @@ export interface WeeklySetting {
707
779
  */
708
780
  export interface RecurrenceSettings {
709
781
  /**
782
+ * @public
710
783
  * <p>Information about on-call rotations that recur monthly.</p>
711
784
  */
712
785
  MonthlySettings?: MonthlySetting[];
713
786
  /**
787
+ * @public
714
788
  * <p>Information about on-call rotations that recur weekly.</p>
715
789
  */
716
790
  WeeklySettings?: WeeklySetting[];
717
791
  /**
792
+ * @public
718
793
  * <p>Information about on-call rotations that recur daily.</p>
719
794
  */
720
795
  DailySettings?: HandOffTime[];
721
796
  /**
797
+ * @public
722
798
  * <p>The number of contacts, or shift team members designated to be on call concurrently
723
799
  * during a shift. For example, in an on-call schedule containing ten contacts, a value of
724
800
  * <code>2</code> designates that two of them are on call at any given time.</p>
725
801
  */
726
802
  NumberOfOnCalls: number | undefined;
727
803
  /**
804
+ * @public
728
805
  * <p>Information about the days of the week included in on-call rotation coverage.</p>
729
806
  */
730
807
  ShiftCoverages?: Record<string, CoverageTime[]>;
731
808
  /**
809
+ * @public
732
810
  * <p>The number of days, weeks, or months a single rotation lasts.</p>
733
811
  */
734
812
  RecurrenceMultiplier: number | undefined;
@@ -738,10 +816,12 @@ export interface RecurrenceSettings {
738
816
  */
739
817
  export interface CreateRotationRequest {
740
818
  /**
819
+ * @public
741
820
  * <p>The name of the rotation.</p>
742
821
  */
743
822
  Name: string | undefined;
744
823
  /**
824
+ * @public
745
825
  * <p>The Amazon Resource Names (ARNs) of the contacts to add to the rotation.</p>
746
826
  * <p>The order that you list the contacts in is their shift order in the rotation schedule.
747
827
  * To change the order of the contact's shifts, use the <a>UpdateRotation</a>
@@ -749,10 +829,12 @@ export interface CreateRotationRequest {
749
829
  */
750
830
  ContactIds: string[] | undefined;
751
831
  /**
832
+ * @public
752
833
  * <p>The date and time that the rotation goes into effect.</p>
753
834
  */
754
835
  StartTime?: Date;
755
836
  /**
837
+ * @public
756
838
  * <p>The time zone to base the rotation’s activity on in Internet Assigned Numbers Authority
757
839
  * (IANA) format. For example: "America/Los_Angeles", "UTC", or "Asia/Seoul". For more
758
840
  * information, see the <a href="https://www.iana.org/time-zones">Time Zone
@@ -764,10 +846,12 @@ export interface CreateRotationRequest {
764
846
  */
765
847
  TimeZoneId: string | undefined;
766
848
  /**
849
+ * @public
767
850
  * <p>Information about the rule that specifies when a shift's team members rotate.</p>
768
851
  */
769
852
  Recurrence: RecurrenceSettings | undefined;
770
853
  /**
854
+ * @public
771
855
  * <p>Optional metadata to assign to the rotation. Tags enable you to categorize a resource in
772
856
  * 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
773
857
  * Incident Manager resources</a> in the <i>Incident Manager User
@@ -775,6 +859,7 @@ export interface CreateRotationRequest {
775
859
  */
776
860
  Tags?: Tag[];
777
861
  /**
862
+ * @public
778
863
  * <p>A token that ensures that the operation is called only once with the specified
779
864
  * details.</p>
780
865
  */
@@ -785,6 +870,7 @@ export interface CreateRotationRequest {
785
870
  */
786
871
  export interface CreateRotationResult {
787
872
  /**
873
+ * @public
788
874
  * <p>The Amazon Resource Name (ARN) of the created rotation.</p>
789
875
  */
790
876
  RotationArn: string | undefined;
@@ -794,10 +880,12 @@ export interface CreateRotationResult {
794
880
  */
795
881
  export interface CreateRotationOverrideRequest {
796
882
  /**
883
+ * @public
797
884
  * <p>The Amazon Resource Name (ARN) of the rotation to create an override for.</p>
798
885
  */
799
886
  RotationId: string | undefined;
800
887
  /**
888
+ * @public
801
889
  * <p>The Amazon Resource Names (ARNs) of the contacts to replace those in the current on-call
802
890
  * rotation with.</p>
803
891
  * <p>If you want to include any current team members in the override shift, you must include
@@ -805,14 +893,17 @@ export interface CreateRotationOverrideRequest {
805
893
  */
806
894
  NewContactIds: string[] | undefined;
807
895
  /**
896
+ * @public
808
897
  * <p>The date and time when the override goes into effect.</p>
809
898
  */
810
899
  StartTime: Date | undefined;
811
900
  /**
901
+ * @public
812
902
  * <p>The date and time when the override ends.</p>
813
903
  */
814
904
  EndTime: Date | undefined;
815
905
  /**
906
+ * @public
816
907
  * <p>A token that ensures that the operation is called only once with the specified
817
908
  * details.</p>
818
909
  */
@@ -823,6 +914,7 @@ export interface CreateRotationOverrideRequest {
823
914
  */
824
915
  export interface CreateRotationOverrideResult {
825
916
  /**
917
+ * @public
826
918
  * <p>The Amazon Resource Name (ARN) of the created rotation override.</p>
827
919
  */
828
920
  RotationOverrideId: string | undefined;
@@ -832,6 +924,7 @@ export interface CreateRotationOverrideResult {
832
924
  */
833
925
  export interface DeactivateContactChannelRequest {
834
926
  /**
927
+ * @public
835
928
  * <p>The Amazon Resource Name (ARN) of the contact channel you're deactivating.</p>
836
929
  */
837
930
  ContactChannelId: string | undefined;
@@ -846,6 +939,7 @@ export interface DeactivateContactChannelResult {
846
939
  */
847
940
  export interface DeleteContactRequest {
848
941
  /**
942
+ * @public
849
943
  * <p>The Amazon Resource Name (ARN) of the contact that you're deleting.</p>
850
944
  */
851
945
  ContactId: string | undefined;
@@ -860,6 +954,7 @@ export interface DeleteContactResult {
860
954
  */
861
955
  export interface DeleteContactChannelRequest {
862
956
  /**
957
+ * @public
863
958
  * <p>The Amazon Resource Name (ARN) of the contact channel.</p>
864
959
  */
865
960
  ContactChannelId: string | undefined;
@@ -874,6 +969,7 @@ export interface DeleteContactChannelResult {
874
969
  */
875
970
  export interface DeleteRotationRequest {
876
971
  /**
972
+ * @public
877
973
  * <p>The Amazon Resource Name (ARN) of the on-call rotation to delete.</p>
878
974
  */
879
975
  RotationId: string | undefined;
@@ -888,10 +984,12 @@ export interface DeleteRotationResult {
888
984
  */
889
985
  export interface DeleteRotationOverrideRequest {
890
986
  /**
987
+ * @public
891
988
  * <p>The Amazon Resource Name (ARN) of the rotation that was overridden.</p>
892
989
  */
893
990
  RotationId: string | undefined;
894
991
  /**
992
+ * @public
895
993
  * <p>The Amazon Resource Name (ARN) of the on-call rotation override to delete.</p>
896
994
  */
897
995
  RotationOverrideId: string | undefined;
@@ -906,6 +1004,7 @@ export interface DeleteRotationOverrideResult {
906
1004
  */
907
1005
  export interface DescribeEngagementRequest {
908
1006
  /**
1007
+ * @public
909
1008
  * <p>The Amazon Resource Name (ARN) of the engagement you want the details of.</p>
910
1009
  */
911
1010
  EngagementId: string | undefined;
@@ -915,46 +1014,56 @@ export interface DescribeEngagementRequest {
915
1014
  */
916
1015
  export interface DescribeEngagementResult {
917
1016
  /**
1017
+ * @public
918
1018
  * <p>The ARN of the escalation plan or contacts involved in the engagement.</p>
919
1019
  */
920
1020
  ContactArn: string | undefined;
921
1021
  /**
1022
+ * @public
922
1023
  * <p>The ARN of the engagement.</p>
923
1024
  */
924
1025
  EngagementArn: string | undefined;
925
1026
  /**
1027
+ * @public
926
1028
  * <p>The user that started the engagement.</p>
927
1029
  */
928
1030
  Sender: string | undefined;
929
1031
  /**
1032
+ * @public
930
1033
  * <p>The secure subject of the message that was sent to the contact. Use this field for
931
1034
  * engagements to <code>VOICE</code> and <code>EMAIL</code>.</p>
932
1035
  */
933
1036
  Subject: string | undefined;
934
1037
  /**
1038
+ * @public
935
1039
  * <p>The secure content of the message that was sent to the contact. Use this field for
936
1040
  * engagements to <code>VOICE</code> and <code>EMAIL</code>.</p>
937
1041
  */
938
1042
  Content: string | undefined;
939
1043
  /**
1044
+ * @public
940
1045
  * <p>The insecure subject of the message that was sent to the contact. Use this field for
941
1046
  * engagements to <code>SMS</code>.</p>
942
1047
  */
943
1048
  PublicSubject?: string;
944
1049
  /**
1050
+ * @public
945
1051
  * <p>The insecure content of the message that was sent to the contact. Use this field for
946
1052
  * engagements to <code>SMS</code>.</p>
947
1053
  */
948
1054
  PublicContent?: string;
949
1055
  /**
1056
+ * @public
950
1057
  * <p>The ARN of the incident in which the engagement occurred.</p>
951
1058
  */
952
1059
  IncidentId?: string;
953
1060
  /**
1061
+ * @public
954
1062
  * <p>The time that the engagement started.</p>
955
1063
  */
956
1064
  StartTime?: Date;
957
1065
  /**
1066
+ * @public
958
1067
  * <p>The time that the engagement ended.</p>
959
1068
  */
960
1069
  StopTime?: Date;
@@ -964,6 +1073,7 @@ export interface DescribeEngagementResult {
964
1073
  */
965
1074
  export interface DescribePageRequest {
966
1075
  /**
1076
+ * @public
967
1077
  * <p>The ID of the engagement to a contact channel.</p>
968
1078
  */
969
1079
  PageId: string | undefined;
@@ -973,54 +1083,66 @@ export interface DescribePageRequest {
973
1083
  */
974
1084
  export interface DescribePageResult {
975
1085
  /**
1086
+ * @public
976
1087
  * <p>The Amazon Resource Name (ARN) of the engagement to a contact channel.</p>
977
1088
  */
978
1089
  PageArn: string | undefined;
979
1090
  /**
1091
+ * @public
980
1092
  * <p>The ARN of the engagement that engaged the contact channel.</p>
981
1093
  */
982
1094
  EngagementArn: string | undefined;
983
1095
  /**
1096
+ * @public
984
1097
  * <p>The ARN of the contact that was engaged.</p>
985
1098
  */
986
1099
  ContactArn: string | undefined;
987
1100
  /**
1101
+ * @public
988
1102
  * <p>The user that started the engagement.</p>
989
1103
  */
990
1104
  Sender: string | undefined;
991
1105
  /**
1106
+ * @public
992
1107
  * <p>The secure subject of the message that was sent to the contact. Use this field for
993
1108
  * engagements to <code>VOICE</code> and <code>EMAIL</code>.</p>
994
1109
  */
995
1110
  Subject: string | undefined;
996
1111
  /**
1112
+ * @public
997
1113
  * <p>The secure content of the message that was sent to the contact. Use this field for
998
1114
  * engagements to <code>VOICE</code> and <code>EMAIL</code>.</p>
999
1115
  */
1000
1116
  Content: string | undefined;
1001
1117
  /**
1118
+ * @public
1002
1119
  * <p>The insecure subject of the message that was sent to the contact. Use this field for
1003
1120
  * engagements to <code>SMS</code>.</p>
1004
1121
  */
1005
1122
  PublicSubject?: string;
1006
1123
  /**
1124
+ * @public
1007
1125
  * <p>The insecure content of the message that was sent to the contact. Use this field for
1008
1126
  * engagements to <code>SMS</code>.</p>
1009
1127
  */
1010
1128
  PublicContent?: string;
1011
1129
  /**
1130
+ * @public
1012
1131
  * <p>The ARN of the incident that engaged the contact channel.</p>
1013
1132
  */
1014
1133
  IncidentId?: string;
1015
1134
  /**
1135
+ * @public
1016
1136
  * <p>The time the engagement was sent to the contact channel.</p>
1017
1137
  */
1018
1138
  SentTime?: Date;
1019
1139
  /**
1140
+ * @public
1020
1141
  * <p>The time that the contact channel acknowledged the engagement.</p>
1021
1142
  */
1022
1143
  ReadTime?: Date;
1023
1144
  /**
1145
+ * @public
1024
1146
  * <p>The time that the contact channel received the engagement.</p>
1025
1147
  */
1026
1148
  DeliveryTime?: Date;
@@ -1032,26 +1154,32 @@ export interface DescribePageResult {
1032
1154
  */
1033
1155
  export interface Engagement {
1034
1156
  /**
1157
+ * @public
1035
1158
  * <p>The Amazon Resource Name (ARN) of the engagement.</p>
1036
1159
  */
1037
1160
  EngagementArn: string | undefined;
1038
1161
  /**
1162
+ * @public
1039
1163
  * <p>The ARN of the escalation plan or contact that Incident Manager is engaging.</p>
1040
1164
  */
1041
1165
  ContactArn: string | undefined;
1042
1166
  /**
1167
+ * @public
1043
1168
  * <p>The user that started the engagement.</p>
1044
1169
  */
1045
1170
  Sender: string | undefined;
1046
1171
  /**
1172
+ * @public
1047
1173
  * <p>The ARN of the incident that's engaging the contact.</p>
1048
1174
  */
1049
1175
  IncidentId?: string;
1050
1176
  /**
1177
+ * @public
1051
1178
  * <p>The time that the engagement began.</p>
1052
1179
  */
1053
1180
  StartTime?: Date;
1054
1181
  /**
1182
+ * @public
1055
1183
  * <p>The time that the engagement ended.</p>
1056
1184
  */
1057
1185
  StopTime?: Date;
@@ -1061,6 +1189,7 @@ export interface Engagement {
1061
1189
  */
1062
1190
  export interface GetContactRequest {
1063
1191
  /**
1192
+ * @public
1064
1193
  * <p>The Amazon Resource Name (ARN) of the contact or escalation plan.</p>
1065
1194
  */
1066
1195
  ContactId: string | undefined;
@@ -1070,23 +1199,28 @@ export interface GetContactRequest {
1070
1199
  */
1071
1200
  export interface GetContactResult {
1072
1201
  /**
1202
+ * @public
1073
1203
  * <p>The ARN of the contact or escalation plan.</p>
1074
1204
  */
1075
1205
  ContactArn: string | undefined;
1076
1206
  /**
1207
+ * @public
1077
1208
  * <p>The alias of the contact or escalation plan. The alias is unique and
1078
1209
  * identifiable.</p>
1079
1210
  */
1080
1211
  Alias: string | undefined;
1081
1212
  /**
1213
+ * @public
1082
1214
  * <p>The full name of the contact or escalation plan.</p>
1083
1215
  */
1084
1216
  DisplayName?: string;
1085
1217
  /**
1218
+ * @public
1086
1219
  * <p>The type of contact, either <code>PERSONAL</code> or <code>ESCALATION</code>.</p>
1087
1220
  */
1088
1221
  Type: ContactType | string | undefined;
1089
1222
  /**
1223
+ * @public
1090
1224
  * <p>Details about the specific timing or stages and targets of the escalation plan or
1091
1225
  * engagement plan.</p>
1092
1226
  */
@@ -1097,6 +1231,7 @@ export interface GetContactResult {
1097
1231
  */
1098
1232
  export interface GetContactChannelRequest {
1099
1233
  /**
1234
+ * @public
1100
1235
  * <p>The Amazon Resource Name (ARN) of the contact channel you want information about.</p>
1101
1236
  */
1102
1237
  ContactChannelId: string | undefined;
@@ -1106,27 +1241,33 @@ export interface GetContactChannelRequest {
1106
1241
  */
1107
1242
  export interface GetContactChannelResult {
1108
1243
  /**
1244
+ * @public
1109
1245
  * <p>The ARN of the contact that the channel belongs to.</p>
1110
1246
  */
1111
1247
  ContactArn: string | undefined;
1112
1248
  /**
1249
+ * @public
1113
1250
  * <p>The ARN of the contact channel.</p>
1114
1251
  */
1115
1252
  ContactChannelArn: string | undefined;
1116
1253
  /**
1254
+ * @public
1117
1255
  * <p>The name of the contact channel</p>
1118
1256
  */
1119
1257
  Name: string | undefined;
1120
1258
  /**
1259
+ * @public
1121
1260
  * <p>The type of contact channel. The type is <code>SMS</code>, <code>VOICE</code>, or
1122
1261
  * <code>EMAIL</code>.</p>
1123
1262
  */
1124
1263
  Type: ChannelType | string | undefined;
1125
1264
  /**
1265
+ * @public
1126
1266
  * <p>The details that Incident Manager uses when trying to engage the contact channel.</p>
1127
1267
  */
1128
1268
  DeliveryAddress: ContactChannelAddress | undefined;
1129
1269
  /**
1270
+ * @public
1130
1271
  * <p>A Boolean value indicating if the contact channel has been activated or not.</p>
1131
1272
  */
1132
1273
  ActivationStatus?: ActivationStatus | string;
@@ -1136,6 +1277,7 @@ export interface GetContactChannelResult {
1136
1277
  */
1137
1278
  export interface GetContactPolicyRequest {
1138
1279
  /**
1280
+ * @public
1139
1281
  * <p>The Amazon Resource Name (ARN) of the contact or escalation plan.</p>
1140
1282
  */
1141
1283
  ContactArn: string | undefined;
@@ -1145,10 +1287,12 @@ export interface GetContactPolicyRequest {
1145
1287
  */
1146
1288
  export interface GetContactPolicyResult {
1147
1289
  /**
1290
+ * @public
1148
1291
  * <p>The ARN of the contact or escalation plan.</p>
1149
1292
  */
1150
1293
  ContactArn?: string;
1151
1294
  /**
1295
+ * @public
1152
1296
  * <p>Details about the resource policy attached to the contact or escalation plan.</p>
1153
1297
  */
1154
1298
  Policy?: string;
@@ -1158,6 +1302,7 @@ export interface GetContactPolicyResult {
1158
1302
  */
1159
1303
  export interface GetRotationRequest {
1160
1304
  /**
1305
+ * @public
1161
1306
  * <p>The Amazon Resource Name (ARN) of the on-call rotation to retrieve information
1162
1307
  * about.</p>
1163
1308
  */
@@ -1168,28 +1313,34 @@ export interface GetRotationRequest {
1168
1313
  */
1169
1314
  export interface GetRotationResult {
1170
1315
  /**
1316
+ * @public
1171
1317
  * <p>The Amazon Resource Name (ARN) of the on-call rotation.</p>
1172
1318
  */
1173
1319
  RotationArn: string | undefined;
1174
1320
  /**
1321
+ * @public
1175
1322
  * <p>The name of the on-call rotation.</p>
1176
1323
  */
1177
1324
  Name: string | undefined;
1178
1325
  /**
1326
+ * @public
1179
1327
  * <p>The Amazon Resource Names (ARNs) of the contacts assigned to the on-call rotation
1180
1328
  * team.</p>
1181
1329
  */
1182
1330
  ContactIds: string[] | undefined;
1183
1331
  /**
1332
+ * @public
1184
1333
  * <p>The specified start time for the on-call rotation.</p>
1185
1334
  */
1186
1335
  StartTime: Date | undefined;
1187
1336
  /**
1337
+ * @public
1188
1338
  * <p>The time zone that the rotation’s activity is based on, in Internet Assigned Numbers
1189
1339
  * Authority (IANA) format.</p>
1190
1340
  */
1191
1341
  TimeZoneId: string | undefined;
1192
1342
  /**
1343
+ * @public
1193
1344
  * <p>Specifies how long a rotation lasts before restarting at the beginning of the shift
1194
1345
  * order.</p>
1195
1346
  */
@@ -1200,11 +1351,13 @@ export interface GetRotationResult {
1200
1351
  */
1201
1352
  export interface GetRotationOverrideRequest {
1202
1353
  /**
1354
+ * @public
1203
1355
  * <p>The Amazon Resource Name (ARN) of the overridden rotation to retrieve information
1204
1356
  * about.</p>
1205
1357
  */
1206
1358
  RotationId: string | undefined;
1207
1359
  /**
1360
+ * @public
1208
1361
  * <p>The Amazon Resource Name (ARN) of the on-call rotation override to retrieve information
1209
1362
  * about.</p>
1210
1363
  */
@@ -1215,27 +1368,33 @@ export interface GetRotationOverrideRequest {
1215
1368
  */
1216
1369
  export interface GetRotationOverrideResult {
1217
1370
  /**
1371
+ * @public
1218
1372
  * <p>The Amazon Resource Name (ARN) of the override to an on-call rotation.</p>
1219
1373
  */
1220
1374
  RotationOverrideId?: string;
1221
1375
  /**
1376
+ * @public
1222
1377
  * <p>The Amazon Resource Name (ARN) of the on-call rotation that was overridden.</p>
1223
1378
  */
1224
1379
  RotationArn?: string;
1225
1380
  /**
1381
+ * @public
1226
1382
  * <p>The Amazon Resource Names (ARNs) of the contacts assigned to the override of the on-call
1227
1383
  * rotation.</p>
1228
1384
  */
1229
1385
  NewContactIds?: string[];
1230
1386
  /**
1387
+ * @public
1231
1388
  * <p>The date and time when the override goes into effect.</p>
1232
1389
  */
1233
1390
  StartTime?: Date;
1234
1391
  /**
1392
+ * @public
1235
1393
  * <p>The date and time when the override ends.</p>
1236
1394
  */
1237
1395
  EndTime?: Date;
1238
1396
  /**
1397
+ * @public
1239
1398
  * <p>The date and time when the override was created.</p>
1240
1399
  */
1241
1400
  CreateTime?: Date;
@@ -1245,14 +1404,17 @@ export interface GetRotationOverrideResult {
1245
1404
  */
1246
1405
  export interface ListContactChannelsRequest {
1247
1406
  /**
1407
+ * @public
1248
1408
  * <p>The Amazon Resource Name (ARN) of the contact.</p>
1249
1409
  */
1250
1410
  ContactId: string | undefined;
1251
1411
  /**
1412
+ * @public
1252
1413
  * <p>The pagination token to continue to the next page of results.</p>
1253
1414
  */
1254
1415
  NextToken?: string;
1255
1416
  /**
1417
+ * @public
1256
1418
  * <p>The maximum number of contact channels per page.</p>
1257
1419
  */
1258
1420
  MaxResults?: number;
@@ -1262,10 +1424,12 @@ export interface ListContactChannelsRequest {
1262
1424
  */
1263
1425
  export interface ListContactChannelsResult {
1264
1426
  /**
1427
+ * @public
1265
1428
  * <p>The pagination token to continue to the next page of results.</p>
1266
1429
  */
1267
1430
  NextToken?: string;
1268
1431
  /**
1432
+ * @public
1269
1433
  * <p>A list of contact channels related to the specified contact.</p>
1270
1434
  */
1271
1435
  ContactChannels: ContactChannel[] | undefined;
@@ -1275,18 +1439,22 @@ export interface ListContactChannelsResult {
1275
1439
  */
1276
1440
  export interface ListContactsRequest {
1277
1441
  /**
1442
+ * @public
1278
1443
  * <p>The pagination token to continue to the next page of results.</p>
1279
1444
  */
1280
1445
  NextToken?: string;
1281
1446
  /**
1447
+ * @public
1282
1448
  * <p>The maximum number of contacts and escalation plans per page of results.</p>
1283
1449
  */
1284
1450
  MaxResults?: number;
1285
1451
  /**
1452
+ * @public
1286
1453
  * <p>Used to list only contacts who's aliases start with the specified prefix.</p>
1287
1454
  */
1288
1455
  AliasPrefix?: string;
1289
1456
  /**
1457
+ * @public
1290
1458
  * <p>The type of contact. A contact is type <code>PERSONAL</code> and an escalation plan is
1291
1459
  * type <code>ESCALATION</code>.</p>
1292
1460
  */
@@ -1297,10 +1465,12 @@ export interface ListContactsRequest {
1297
1465
  */
1298
1466
  export interface ListContactsResult {
1299
1467
  /**
1468
+ * @public
1300
1469
  * <p>The pagination token to continue to the next page of results.</p>
1301
1470
  */
1302
1471
  NextToken?: string;
1303
1472
  /**
1473
+ * @public
1304
1474
  * <p>A list of the contacts and escalation plans in your Incident Manager account.</p>
1305
1475
  */
1306
1476
  Contacts?: Contact[];
@@ -1311,10 +1481,12 @@ export interface ListContactsResult {
1311
1481
  */
1312
1482
  export interface TimeRange {
1313
1483
  /**
1484
+ * @public
1314
1485
  * <p>The start of the time range.</p>
1315
1486
  */
1316
1487
  StartTime?: Date;
1317
1488
  /**
1489
+ * @public
1318
1490
  * <p>The end of the time range.</p>
1319
1491
  */
1320
1492
  EndTime?: Date;
@@ -1324,18 +1496,22 @@ export interface TimeRange {
1324
1496
  */
1325
1497
  export interface ListEngagementsRequest {
1326
1498
  /**
1499
+ * @public
1327
1500
  * <p>The pagination token to continue to the next page of results.</p>
1328
1501
  */
1329
1502
  NextToken?: string;
1330
1503
  /**
1504
+ * @public
1331
1505
  * <p>The maximum number of engagements per page of results.</p>
1332
1506
  */
1333
1507
  MaxResults?: number;
1334
1508
  /**
1509
+ * @public
1335
1510
  * <p>The Amazon Resource Name (ARN) of the incident you're listing engagements for.</p>
1336
1511
  */
1337
1512
  IncidentId?: string;
1338
1513
  /**
1514
+ * @public
1339
1515
  * <p>The time range to lists engagements for an incident.</p>
1340
1516
  */
1341
1517
  TimeRangeValue?: TimeRange;
@@ -1345,10 +1521,12 @@ export interface ListEngagementsRequest {
1345
1521
  */
1346
1522
  export interface ListEngagementsResult {
1347
1523
  /**
1524
+ * @public
1348
1525
  * <p>The pagination token to continue to the next page of results.</p>
1349
1526
  */
1350
1527
  NextToken?: string;
1351
1528
  /**
1529
+ * @public
1352
1530
  * <p>A list of each engagement that occurred during the specified time range of an
1353
1531
  * incident.</p>
1354
1532
  */
@@ -1359,14 +1537,17 @@ export interface ListEngagementsResult {
1359
1537
  */
1360
1538
  export interface ListPageReceiptsRequest {
1361
1539
  /**
1540
+ * @public
1362
1541
  * <p>The Amazon Resource Name (ARN) of the engagement to a specific contact channel.</p>
1363
1542
  */
1364
1543
  PageId: string | undefined;
1365
1544
  /**
1545
+ * @public
1366
1546
  * <p>The pagination token to continue to the next page of results.</p>
1367
1547
  */
1368
1548
  NextToken?: string;
1369
1549
  /**
1550
+ * @public
1370
1551
  * <p>The maximum number of acknowledgements per page of results.</p>
1371
1552
  */
1372
1553
  MaxResults?: number;
@@ -1392,19 +1573,23 @@ export type ReceiptType = (typeof ReceiptType)[keyof typeof ReceiptType];
1392
1573
  */
1393
1574
  export interface Receipt {
1394
1575
  /**
1576
+ * @public
1395
1577
  * <p>The Amazon Resource Name (ARN) of the contact channel Incident Manager engaged.</p>
1396
1578
  */
1397
1579
  ContactChannelArn?: string;
1398
1580
  /**
1581
+ * @public
1399
1582
  * <p>The type follows the engagement cycle, <code>SENT</code>, <code>DELIVERED</code>, and
1400
1583
  * <code>READ</code>.</p>
1401
1584
  */
1402
1585
  ReceiptType: ReceiptType | string | undefined;
1403
1586
  /**
1587
+ * @public
1404
1588
  * <p>Information provided during the page acknowledgement.</p>
1405
1589
  */
1406
1590
  ReceiptInfo?: string;
1407
1591
  /**
1592
+ * @public
1408
1593
  * <p>The time receipt was <code>SENT</code>, <code>DELIVERED</code>, or
1409
1594
  * <code>READ</code>.</p>
1410
1595
  */
@@ -1415,10 +1600,12 @@ export interface Receipt {
1415
1600
  */
1416
1601
  export interface ListPageReceiptsResult {
1417
1602
  /**
1603
+ * @public
1418
1604
  * <p>The pagination token to continue to the next page of results.</p>
1419
1605
  */
1420
1606
  NextToken?: string;
1421
1607
  /**
1608
+ * @public
1422
1609
  * <p>A list of each acknowledgement.</p>
1423
1610
  */
1424
1611
  Receipts?: Receipt[];
@@ -1428,10 +1615,12 @@ export interface ListPageReceiptsResult {
1428
1615
  */
1429
1616
  export interface ListPageResolutionsRequest {
1430
1617
  /**
1618
+ * @public
1431
1619
  * <p>A token to start the list. Use this token to get the next set of results.</p>
1432
1620
  */
1433
1621
  NextToken?: string;
1434
1622
  /**
1623
+ * @public
1435
1624
  * <p>The Amazon Resource Name (ARN) of the contact engaged for the incident.</p>
1436
1625
  */
1437
1626
  PageId: string | undefined;
@@ -1447,15 +1636,18 @@ export interface ListPageResolutionsRequest {
1447
1636
  */
1448
1637
  export interface ResolutionContact {
1449
1638
  /**
1639
+ * @public
1450
1640
  * <p>The Amazon Resource Name (ARN) of a contact in the engagement resolution process.
1451
1641
  * </p>
1452
1642
  */
1453
1643
  ContactArn: string | undefined;
1454
1644
  /**
1645
+ * @public
1455
1646
  * <p>The type of contact for a resolution step.</p>
1456
1647
  */
1457
1648
  Type: ContactType | string | undefined;
1458
1649
  /**
1650
+ * @public
1459
1651
  * <p>The stage in the escalation plan that resolves to this contact.</p>
1460
1652
  */
1461
1653
  StageIndex?: number;
@@ -1465,11 +1657,13 @@ export interface ResolutionContact {
1465
1657
  */
1466
1658
  export interface ListPageResolutionsResult {
1467
1659
  /**
1660
+ * @public
1468
1661
  * <p>The token for the next set of items to return. Use this token to get the next set of
1469
1662
  * results.</p>
1470
1663
  */
1471
1664
  NextToken?: string;
1472
1665
  /**
1666
+ * @public
1473
1667
  * <p>Information about the resolution for an engagement.</p>
1474
1668
  */
1475
1669
  PageResolutions: ResolutionContact[] | undefined;
@@ -1479,14 +1673,17 @@ export interface ListPageResolutionsResult {
1479
1673
  */
1480
1674
  export interface ListPagesByContactRequest {
1481
1675
  /**
1676
+ * @public
1482
1677
  * <p>The Amazon Resource Name (ARN) of the contact you are retrieving engagements for.</p>
1483
1678
  */
1484
1679
  ContactId: string | undefined;
1485
1680
  /**
1681
+ * @public
1486
1682
  * <p>The pagination token to continue to the next page of results.</p>
1487
1683
  */
1488
1684
  NextToken?: string;
1489
1685
  /**
1686
+ * @public
1490
1687
  * <p>The maximum number of engagements to contact channels to list per page of results.
1491
1688
  * </p>
1492
1689
  */
@@ -1498,34 +1695,42 @@ export interface ListPagesByContactRequest {
1498
1695
  */
1499
1696
  export interface Page {
1500
1697
  /**
1698
+ * @public
1501
1699
  * <p>The Amazon Resource Name (ARN) of the page to the contact channel.</p>
1502
1700
  */
1503
1701
  PageArn: string | undefined;
1504
1702
  /**
1703
+ * @public
1505
1704
  * <p>The ARN of the engagement that this page is part of.</p>
1506
1705
  */
1507
1706
  EngagementArn: string | undefined;
1508
1707
  /**
1708
+ * @public
1509
1709
  * <p>The ARN of the contact that Incident Manager is engaging.</p>
1510
1710
  */
1511
1711
  ContactArn: string | undefined;
1512
1712
  /**
1713
+ * @public
1513
1714
  * <p>The user that started the engagement.</p>
1514
1715
  */
1515
1716
  Sender: string | undefined;
1516
1717
  /**
1718
+ * @public
1517
1719
  * <p>The ARN of the incident that's engaging the contact channel.</p>
1518
1720
  */
1519
1721
  IncidentId?: string;
1520
1722
  /**
1723
+ * @public
1521
1724
  * <p>The time that Incident Manager engaged the contact channel.</p>
1522
1725
  */
1523
1726
  SentTime?: Date;
1524
1727
  /**
1728
+ * @public
1525
1729
  * <p>The time the message was delivered to the contact channel.</p>
1526
1730
  */
1527
1731
  DeliveryTime?: Date;
1528
1732
  /**
1733
+ * @public
1529
1734
  * <p>The time that the contact channel acknowledged engagement.</p>
1530
1735
  */
1531
1736
  ReadTime?: Date;
@@ -1535,10 +1740,12 @@ export interface Page {
1535
1740
  */
1536
1741
  export interface ListPagesByContactResult {
1537
1742
  /**
1743
+ * @public
1538
1744
  * <p>The pagination token to continue to the next page of results.</p>
1539
1745
  */
1540
1746
  NextToken?: string;
1541
1747
  /**
1748
+ * @public
1542
1749
  * <p>The list of engagements to a contact's contact channel.</p>
1543
1750
  */
1544
1751
  Pages: Page[] | undefined;
@@ -1548,14 +1755,17 @@ export interface ListPagesByContactResult {
1548
1755
  */
1549
1756
  export interface ListPagesByEngagementRequest {
1550
1757
  /**
1758
+ * @public
1551
1759
  * <p>The Amazon Resource Name (ARN) of the engagement.</p>
1552
1760
  */
1553
1761
  EngagementId: string | undefined;
1554
1762
  /**
1763
+ * @public
1555
1764
  * <p>The pagination token to continue to the next page of results.</p>
1556
1765
  */
1557
1766
  NextToken?: string;
1558
1767
  /**
1768
+ * @public
1559
1769
  * <p>The maximum number of engagements to contact channels to list per page of
1560
1770
  * results.</p>
1561
1771
  */
@@ -1566,10 +1776,12 @@ export interface ListPagesByEngagementRequest {
1566
1776
  */
1567
1777
  export interface ListPagesByEngagementResult {
1568
1778
  /**
1779
+ * @public
1569
1780
  * <p>The pagination token to continue to the next page of results.</p>
1570
1781
  */
1571
1782
  NextToken?: string;
1572
1783
  /**
1784
+ * @public
1573
1785
  * <p>The list of engagements to contact channels.</p>
1574
1786
  */
1575
1787
  Pages: Page[] | undefined;
@@ -1580,14 +1792,17 @@ export interface ListPagesByEngagementResult {
1580
1792
  */
1581
1793
  export interface PreviewOverride {
1582
1794
  /**
1795
+ * @public
1583
1796
  * <p>Information about contacts to add to an on-call rotation override.</p>
1584
1797
  */
1585
1798
  NewMembers?: string[];
1586
1799
  /**
1800
+ * @public
1587
1801
  * <p>Information about the time a rotation override would begin.</p>
1588
1802
  */
1589
1803
  StartTime?: Date;
1590
1804
  /**
1805
+ * @public
1591
1806
  * <p>Information about the time a rotation override would end.</p>
1592
1807
  */
1593
1808
  EndTime?: Date;
@@ -1597,43 +1812,52 @@ export interface PreviewOverride {
1597
1812
  */
1598
1813
  export interface ListPreviewRotationShiftsRequest {
1599
1814
  /**
1815
+ * @public
1600
1816
  * <p>The date and time a rotation would begin. The first shift is calculated from this date
1601
1817
  * and time.</p>
1602
1818
  */
1603
1819
  RotationStartTime?: Date;
1604
1820
  /**
1821
+ * @public
1605
1822
  * <p>Used to filter the range of calculated shifts before sending the response back to the
1606
1823
  * user. </p>
1607
1824
  */
1608
1825
  StartTime?: Date;
1609
1826
  /**
1827
+ * @public
1610
1828
  * <p>The date and time a rotation shift would end.</p>
1611
1829
  */
1612
1830
  EndTime: Date | undefined;
1613
1831
  /**
1832
+ * @public
1614
1833
  * <p>The contacts that would be assigned to a rotation.</p>
1615
1834
  */
1616
1835
  Members: string[] | undefined;
1617
1836
  /**
1837
+ * @public
1618
1838
  * <p>The time zone the rotation’s activity would be based on, in Internet Assigned Numbers
1619
1839
  * Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or "Asia/Seoul".
1620
1840
  * </p>
1621
1841
  */
1622
1842
  TimeZoneId: string | undefined;
1623
1843
  /**
1844
+ * @public
1624
1845
  * <p>Information about how long a rotation would last before restarting at the beginning of
1625
1846
  * the shift order.</p>
1626
1847
  */
1627
1848
  Recurrence: RecurrenceSettings | undefined;
1628
1849
  /**
1850
+ * @public
1629
1851
  * <p>Information about changes that would be made in a rotation override.</p>
1630
1852
  */
1631
1853
  Overrides?: PreviewOverride[];
1632
1854
  /**
1855
+ * @public
1633
1856
  * <p>A token to start the list. This token is used to get the next set of results.</p>
1634
1857
  */
1635
1858
  NextToken?: string;
1636
1859
  /**
1860
+ * @public
1637
1861
  * <p>The maximum number of items to return for this call. The call also returns a token that
1638
1862
  * can be specified in a subsequent call to get the next set of results.</p>
1639
1863
  */
@@ -1645,6 +1869,7 @@ export interface ListPreviewRotationShiftsRequest {
1645
1869
  */
1646
1870
  export interface ShiftDetails {
1647
1871
  /**
1872
+ * @public
1648
1873
  * <p>The Amazon Resources Names (ARNs) of the contacts who were replaced in a shift when an
1649
1874
  * override was created. If the override is deleted, these contacts are restored to the
1650
1875
  * shift.</p>
@@ -1669,23 +1894,28 @@ export type ShiftType = (typeof ShiftType)[keyof typeof ShiftType];
1669
1894
  */
1670
1895
  export interface RotationShift {
1671
1896
  /**
1897
+ * @public
1672
1898
  * <p>The Amazon Resource Names (ARNs) of the contacts who are part of the shift rotation.
1673
1899
  * </p>
1674
1900
  */
1675
1901
  ContactIds?: string[];
1676
1902
  /**
1903
+ * @public
1677
1904
  * <p>The time a shift rotation begins.</p>
1678
1905
  */
1679
1906
  StartTime: Date | undefined;
1680
1907
  /**
1908
+ * @public
1681
1909
  * <p>The time a shift rotation ends.</p>
1682
1910
  */
1683
1911
  EndTime: Date | undefined;
1684
1912
  /**
1913
+ * @public
1685
1914
  * <p>The type of shift rotation.</p>
1686
1915
  */
1687
1916
  Type?: ShiftType | string;
1688
1917
  /**
1918
+ * @public
1689
1919
  * <p>Additional information about an on-call rotation shift.</p>
1690
1920
  */
1691
1921
  ShiftDetails?: ShiftDetails;
@@ -1695,10 +1925,12 @@ export interface RotationShift {
1695
1925
  */
1696
1926
  export interface ListPreviewRotationShiftsResult {
1697
1927
  /**
1928
+ * @public
1698
1929
  * <p>Details about a rotation shift, including times, types, and contacts.</p>
1699
1930
  */
1700
1931
  RotationShifts?: RotationShift[];
1701
1932
  /**
1933
+ * @public
1702
1934
  * <p>The token for the next set of items to return. This token is used to get the next set of
1703
1935
  * results.</p>
1704
1936
  */
@@ -1709,22 +1941,27 @@ export interface ListPreviewRotationShiftsResult {
1709
1941
  */
1710
1942
  export interface ListRotationOverridesRequest {
1711
1943
  /**
1944
+ * @public
1712
1945
  * <p>The Amazon Resource Name (ARN) of the rotation to retrieve information about.</p>
1713
1946
  */
1714
1947
  RotationId: string | undefined;
1715
1948
  /**
1949
+ * @public
1716
1950
  * <p>The date and time for the beginning of a time range for listing overrides.</p>
1717
1951
  */
1718
1952
  StartTime: Date | undefined;
1719
1953
  /**
1954
+ * @public
1720
1955
  * <p>The date and time for the end of a time range for listing overrides.</p>
1721
1956
  */
1722
1957
  EndTime: Date | undefined;
1723
1958
  /**
1959
+ * @public
1724
1960
  * <p>A token to start the list. Use this token to get the next set of results.</p>
1725
1961
  */
1726
1962
  NextToken?: string;
1727
1963
  /**
1964
+ * @public
1728
1965
  * <p>The maximum number of items to return for this call. The call also returns a token that
1729
1966
  * you can specify in a subsequent call to get the next set of results.</p>
1730
1967
  */
@@ -1736,23 +1973,28 @@ export interface ListRotationOverridesRequest {
1736
1973
  */
1737
1974
  export interface RotationOverride {
1738
1975
  /**
1976
+ * @public
1739
1977
  * <p>The Amazon Resource Name (ARN) of the override to an on-call rotation.</p>
1740
1978
  */
1741
1979
  RotationOverrideId: string | undefined;
1742
1980
  /**
1981
+ * @public
1743
1982
  * <p>The Amazon Resource Names (ARNs) of the contacts assigned to the override of the on-call
1744
1983
  * rotation.</p>
1745
1984
  */
1746
1985
  NewContactIds: string[] | undefined;
1747
1986
  /**
1987
+ * @public
1748
1988
  * <p>The time a rotation override begins.</p>
1749
1989
  */
1750
1990
  StartTime: Date | undefined;
1751
1991
  /**
1992
+ * @public
1752
1993
  * <p>The time a rotation override ends.</p>
1753
1994
  */
1754
1995
  EndTime: Date | undefined;
1755
1996
  /**
1997
+ * @public
1756
1998
  * <p>The time a rotation override was created.</p>
1757
1999
  */
1758
2000
  CreateTime: Date | undefined;
@@ -1762,10 +2004,12 @@ export interface RotationOverride {
1762
2004
  */
1763
2005
  export interface ListRotationOverridesResult {
1764
2006
  /**
2007
+ * @public
1765
2008
  * <p>A list of rotation overrides in the specified time range.</p>
1766
2009
  */
1767
2010
  RotationOverrides?: RotationOverride[];
1768
2011
  /**
2012
+ * @public
1769
2013
  * <p>The token for the next set of items to return. Use this token to get the next set of
1770
2014
  * results.</p>
1771
2015
  */
@@ -1776,16 +2020,19 @@ export interface ListRotationOverridesResult {
1776
2020
  */
1777
2021
  export interface ListRotationsRequest {
1778
2022
  /**
2023
+ * @public
1779
2024
  * <p>A filter to include rotations in list results based on their common prefix. For example,
1780
2025
  * entering prod returns a list of all rotation names that begin with <code>prod</code>, such
1781
2026
  * as <code>production</code> and <code>prod-1</code>.</p>
1782
2027
  */
1783
2028
  RotationNamePrefix?: string;
1784
2029
  /**
2030
+ * @public
1785
2031
  * <p>A token to start the list. Use this token to get the next set of results.</p>
1786
2032
  */
1787
2033
  NextToken?: string;
1788
2034
  /**
2035
+ * @public
1789
2036
  * <p>The maximum number of items to return for this call. The call also returns a token that
1790
2037
  * you can specify in a subsequent call to get the next set of results.</p>
1791
2038
  */
@@ -1797,28 +2044,34 @@ export interface ListRotationsRequest {
1797
2044
  */
1798
2045
  export interface Rotation {
1799
2046
  /**
2047
+ * @public
1800
2048
  * <p>The Amazon Resource Name (ARN) of the rotation.</p>
1801
2049
  */
1802
2050
  RotationArn: string | undefined;
1803
2051
  /**
2052
+ * @public
1804
2053
  * <p>The name of the rotation.</p>
1805
2054
  */
1806
2055
  Name: string | undefined;
1807
2056
  /**
2057
+ * @public
1808
2058
  * <p>The Amazon Resource Names (ARNs) of the contacts assigned to the rotation team.</p>
1809
2059
  */
1810
2060
  ContactIds?: string[];
1811
2061
  /**
2062
+ * @public
1812
2063
  * <p>The date and time the rotation becomes active.</p>
1813
2064
  */
1814
2065
  StartTime?: Date;
1815
2066
  /**
2067
+ * @public
1816
2068
  * <p>The time zone the rotation’s activity is based on, in Internet Assigned Numbers
1817
2069
  * Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or "Asia/Seoul".
1818
2070
  * </p>
1819
2071
  */
1820
2072
  TimeZoneId?: string;
1821
2073
  /**
2074
+ * @public
1822
2075
  * <p>Information about when an on-call rotation is in effect and how long the rotation period
1823
2076
  * lasts.</p>
1824
2077
  */
@@ -1829,11 +2082,13 @@ export interface Rotation {
1829
2082
  */
1830
2083
  export interface ListRotationsResult {
1831
2084
  /**
2085
+ * @public
1832
2086
  * <p>The token for the next set of items to return. Use this token to get the next set of
1833
2087
  * results.</p>
1834
2088
  */
1835
2089
  NextToken?: string;
1836
2090
  /**
2091
+ * @public
1837
2092
  * <p>Information about rotations that meet the filter criteria.</p>
1838
2093
  */
1839
2094
  Rotations: Rotation[] | undefined;
@@ -1843,23 +2098,28 @@ export interface ListRotationsResult {
1843
2098
  */
1844
2099
  export interface ListRotationShiftsRequest {
1845
2100
  /**
2101
+ * @public
1846
2102
  * <p>The Amazon Resource Name (ARN) of the rotation to retrieve shift information about.
1847
2103
  * </p>
1848
2104
  */
1849
2105
  RotationId: string | undefined;
1850
2106
  /**
2107
+ * @public
1851
2108
  * <p>The date and time for the beginning of the time range to list shifts for.</p>
1852
2109
  */
1853
2110
  StartTime?: Date;
1854
2111
  /**
2112
+ * @public
1855
2113
  * <p>The date and time for the end of the time range to list shifts for.</p>
1856
2114
  */
1857
2115
  EndTime: Date | undefined;
1858
2116
  /**
2117
+ * @public
1859
2118
  * <p>A token to start the list. Use this token to get the next set of results.</p>
1860
2119
  */
1861
2120
  NextToken?: string;
1862
2121
  /**
2122
+ * @public
1863
2123
  * <p>The maximum number of items to return for this call. The call also returns a token that
1864
2124
  * you can specify in a subsequent call to get the next set of results.</p>
1865
2125
  */
@@ -1870,10 +2130,12 @@ export interface ListRotationShiftsRequest {
1870
2130
  */
1871
2131
  export interface ListRotationShiftsResult {
1872
2132
  /**
2133
+ * @public
1873
2134
  * <p>Information about shifts that meet the filter criteria.</p>
1874
2135
  */
1875
2136
  RotationShifts?: RotationShift[];
1876
2137
  /**
2138
+ * @public
1877
2139
  * <p>The token for the next set of items to return. Use this token to get the next set of
1878
2140
  * results.</p>
1879
2141
  */
@@ -1884,6 +2146,7 @@ export interface ListRotationShiftsResult {
1884
2146
  */
1885
2147
  export interface ListTagsForResourceRequest {
1886
2148
  /**
2149
+ * @public
1887
2150
  * <p>The Amazon Resource Name (ARN) of the contact or escalation plan.</p>
1888
2151
  */
1889
2152
  ResourceARN: string | undefined;
@@ -1893,6 +2156,7 @@ export interface ListTagsForResourceRequest {
1893
2156
  */
1894
2157
  export interface ListTagsForResourceResult {
1895
2158
  /**
2159
+ * @public
1896
2160
  * <p>The tags related to the contact or escalation plan.</p>
1897
2161
  */
1898
2162
  Tags?: Tag[];
@@ -1902,10 +2166,12 @@ export interface ListTagsForResourceResult {
1902
2166
  */
1903
2167
  export interface PutContactPolicyRequest {
1904
2168
  /**
2169
+ * @public
1905
2170
  * <p>The Amazon Resource Name (ARN) of the contact or escalation plan.</p>
1906
2171
  */
1907
2172
  ContactArn: string | undefined;
1908
2173
  /**
2174
+ * @public
1909
2175
  * <p>Details of the resource policy.</p>
1910
2176
  */
1911
2177
  Policy: string | undefined;
@@ -1920,6 +2186,7 @@ export interface PutContactPolicyResult {
1920
2186
  */
1921
2187
  export interface SendActivationCodeRequest {
1922
2188
  /**
2189
+ * @public
1923
2190
  * <p>The Amazon Resource Name (ARN) of the contact channel.</p>
1924
2191
  */
1925
2192
  ContactChannelId: string | undefined;
@@ -1934,38 +2201,46 @@ export interface SendActivationCodeResult {
1934
2201
  */
1935
2202
  export interface StartEngagementRequest {
1936
2203
  /**
2204
+ * @public
1937
2205
  * <p>The Amazon Resource Name (ARN) of the contact being engaged.</p>
1938
2206
  */
1939
2207
  ContactId: string | undefined;
1940
2208
  /**
2209
+ * @public
1941
2210
  * <p>The user that started the engagement.</p>
1942
2211
  */
1943
2212
  Sender: string | undefined;
1944
2213
  /**
2214
+ * @public
1945
2215
  * <p>The secure subject of the message that was sent to the contact. Use this field for
1946
2216
  * engagements to <code>VOICE</code> or <code>EMAIL</code>.</p>
1947
2217
  */
1948
2218
  Subject: string | undefined;
1949
2219
  /**
2220
+ * @public
1950
2221
  * <p>The secure content of the message that was sent to the contact. Use this field for
1951
2222
  * engagements to <code>VOICE</code> or <code>EMAIL</code>.</p>
1952
2223
  */
1953
2224
  Content: string | undefined;
1954
2225
  /**
2226
+ * @public
1955
2227
  * <p>The insecure subject of the message that was sent to the contact. Use this field for
1956
2228
  * engagements to <code>SMS</code>.</p>
1957
2229
  */
1958
2230
  PublicSubject?: string;
1959
2231
  /**
2232
+ * @public
1960
2233
  * <p>The insecure content of the message that was sent to the contact. Use this field for
1961
2234
  * engagements to <code>SMS</code>.</p>
1962
2235
  */
1963
2236
  PublicContent?: string;
1964
2237
  /**
2238
+ * @public
1965
2239
  * <p>The ARN of the incident that the engagement is part of.</p>
1966
2240
  */
1967
2241
  IncidentId?: string;
1968
2242
  /**
2243
+ * @public
1969
2244
  * <p>A token ensuring that the operation is called only once with the specified
1970
2245
  * details.</p>
1971
2246
  */
@@ -1976,6 +2251,7 @@ export interface StartEngagementRequest {
1976
2251
  */
1977
2252
  export interface StartEngagementResult {
1978
2253
  /**
2254
+ * @public
1979
2255
  * <p>The ARN of the engagement.</p>
1980
2256
  */
1981
2257
  EngagementArn: string | undefined;
@@ -1985,10 +2261,12 @@ export interface StartEngagementResult {
1985
2261
  */
1986
2262
  export interface StopEngagementRequest {
1987
2263
  /**
2264
+ * @public
1988
2265
  * <p>The Amazon Resource Name (ARN) of the engagement.</p>
1989
2266
  */
1990
2267
  EngagementId: string | undefined;
1991
2268
  /**
2269
+ * @public
1992
2270
  * <p>The reason that you're stopping the engagement.</p>
1993
2271
  */
1994
2272
  Reason?: string;
@@ -2003,10 +2281,12 @@ export interface StopEngagementResult {
2003
2281
  */
2004
2282
  export interface TagResourceRequest {
2005
2283
  /**
2284
+ * @public
2006
2285
  * <p>The Amazon Resource Name (ARN) of the contact or escalation plan.</p>
2007
2286
  */
2008
2287
  ResourceARN: string | undefined;
2009
2288
  /**
2289
+ * @public
2010
2290
  * <p>A list of tags that you are adding to the contact or escalation plan.</p>
2011
2291
  */
2012
2292
  Tags: Tag[] | undefined;
@@ -2021,10 +2301,12 @@ export interface TagResourceResult {
2021
2301
  */
2022
2302
  export interface UntagResourceRequest {
2023
2303
  /**
2304
+ * @public
2024
2305
  * <p>The Amazon Resource Name (ARN) of the contact or escalation plan.</p>
2025
2306
  */
2026
2307
  ResourceARN: string | undefined;
2027
2308
  /**
2309
+ * @public
2028
2310
  * <p>The key of the tag that you want to remove.</p>
2029
2311
  */
2030
2312
  TagKeys: string[] | undefined;
@@ -2039,14 +2321,17 @@ export interface UntagResourceResult {
2039
2321
  */
2040
2322
  export interface UpdateContactRequest {
2041
2323
  /**
2324
+ * @public
2042
2325
  * <p>The Amazon Resource Name (ARN) of the contact or escalation plan you're updating.</p>
2043
2326
  */
2044
2327
  ContactId: string | undefined;
2045
2328
  /**
2329
+ * @public
2046
2330
  * <p>The full name of the contact or escalation plan.</p>
2047
2331
  */
2048
2332
  DisplayName?: string;
2049
2333
  /**
2334
+ * @public
2050
2335
  * <p>A list of stages. A contact has an engagement plan with stages for specified contact
2051
2336
  * channels. An escalation plan uses these stages to contact specified contacts.</p>
2052
2337
  */
@@ -2062,14 +2347,17 @@ export interface UpdateContactResult {
2062
2347
  */
2063
2348
  export interface UpdateContactChannelRequest {
2064
2349
  /**
2350
+ * @public
2065
2351
  * <p>The Amazon Resource Name (ARN) of the contact channel you want to update.</p>
2066
2352
  */
2067
2353
  ContactChannelId: string | undefined;
2068
2354
  /**
2355
+ * @public
2069
2356
  * <p>The name of the contact channel.</p>
2070
2357
  */
2071
2358
  Name?: string;
2072
2359
  /**
2360
+ * @public
2073
2361
  * <p>The details that Incident Manager uses when trying to engage the contact channel.</p>
2074
2362
  */
2075
2363
  DeliveryAddress?: ContactChannelAddress;
@@ -2084,20 +2372,24 @@ export interface UpdateContactChannelResult {
2084
2372
  */
2085
2373
  export interface UpdateRotationRequest {
2086
2374
  /**
2375
+ * @public
2087
2376
  * <p>The Amazon Resource Name (ARN) of the rotation to update.</p>
2088
2377
  */
2089
2378
  RotationId: string | undefined;
2090
2379
  /**
2380
+ * @public
2091
2381
  * <p>The Amazon Resource Names (ARNs) of the contacts to include in the updated rotation. </p>
2092
2382
  * <p>The order in which you list the contacts is their shift order in the rotation
2093
2383
  * schedule.</p>
2094
2384
  */
2095
2385
  ContactIds?: string[];
2096
2386
  /**
2387
+ * @public
2097
2388
  * <p>The date and time the rotation goes into effect.</p>
2098
2389
  */
2099
2390
  StartTime?: Date;
2100
2391
  /**
2392
+ * @public
2101
2393
  * <p>The time zone to base the updated rotation’s activity on, in Internet Assigned Numbers
2102
2394
  * Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or "Asia/Seoul". For
2103
2395
  * more information, see the <a href="https://www.iana.org/time-zones">Time Zone
@@ -2109,6 +2401,7 @@ export interface UpdateRotationRequest {
2109
2401
  */
2110
2402
  TimeZoneId?: string;
2111
2403
  /**
2404
+ * @public
2112
2405
  * <p>Information about how long the updated rotation lasts before restarting at the beginning
2113
2406
  * of the shift order.</p>
2114
2407
  */