aws-sdk 2.1344.0 → 2.1346.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.
@@ -28,11 +28,11 @@ declare class SSMContacts extends Service {
28
28
  */
29
29
  activateContactChannel(callback?: (err: AWSError, data: SSMContacts.Types.ActivateContactChannelResult) => void): Request<SSMContacts.Types.ActivateContactChannelResult, AWSError>;
30
30
  /**
31
- * 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.
31
+ * 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.
32
32
  */
33
33
  createContact(params: SSMContacts.Types.CreateContactRequest, callback?: (err: AWSError, data: SSMContacts.Types.CreateContactResult) => void): Request<SSMContacts.Types.CreateContactResult, AWSError>;
34
34
  /**
35
- * 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.
35
+ * 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.
36
36
  */
37
37
  createContact(callback?: (err: AWSError, data: SSMContacts.Types.CreateContactResult) => void): Request<SSMContacts.Types.CreateContactResult, AWSError>;
38
38
  /**
@@ -43,6 +43,22 @@ declare class SSMContacts extends Service {
43
43
  * A contact channel is the method that Incident Manager uses to engage your contact.
44
44
  */
45
45
  createContactChannel(callback?: (err: AWSError, data: SSMContacts.Types.CreateContactChannelResult) => void): Request<SSMContacts.Types.CreateContactChannelResult, AWSError>;
46
+ /**
47
+ * Creates a rotation in an on-call schedule.
48
+ */
49
+ createRotation(params: SSMContacts.Types.CreateRotationRequest, callback?: (err: AWSError, data: SSMContacts.Types.CreateRotationResult) => void): Request<SSMContacts.Types.CreateRotationResult, AWSError>;
50
+ /**
51
+ * Creates a rotation in an on-call schedule.
52
+ */
53
+ createRotation(callback?: (err: AWSError, data: SSMContacts.Types.CreateRotationResult) => void): Request<SSMContacts.Types.CreateRotationResult, AWSError>;
54
+ /**
55
+ * Creates an override for a rotation in an on-call schedule.
56
+ */
57
+ createRotationOverride(params: SSMContacts.Types.CreateRotationOverrideRequest, callback?: (err: AWSError, data: SSMContacts.Types.CreateRotationOverrideResult) => void): Request<SSMContacts.Types.CreateRotationOverrideResult, AWSError>;
58
+ /**
59
+ * Creates an override for a rotation in an on-call schedule.
60
+ */
61
+ createRotationOverride(callback?: (err: AWSError, data: SSMContacts.Types.CreateRotationOverrideResult) => void): Request<SSMContacts.Types.CreateRotationOverrideResult, AWSError>;
46
62
  /**
47
63
  * To no longer receive Incident Manager engagements to a contact channel, you can deactivate the channel.
48
64
  */
@@ -67,6 +83,22 @@ declare class SSMContacts extends Service {
67
83
  * 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.
68
84
  */
69
85
  deleteContactChannel(callback?: (err: AWSError, data: SSMContacts.Types.DeleteContactChannelResult) => void): Request<SSMContacts.Types.DeleteContactChannelResult, AWSError>;
86
+ /**
87
+ * 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.
88
+ */
89
+ deleteRotation(params: SSMContacts.Types.DeleteRotationRequest, callback?: (err: AWSError, data: SSMContacts.Types.DeleteRotationResult) => void): Request<SSMContacts.Types.DeleteRotationResult, AWSError>;
90
+ /**
91
+ * 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.
92
+ */
93
+ deleteRotation(callback?: (err: AWSError, data: SSMContacts.Types.DeleteRotationResult) => void): Request<SSMContacts.Types.DeleteRotationResult, AWSError>;
94
+ /**
95
+ * Deletes an existing override for an on-call rotation.
96
+ */
97
+ deleteRotationOverride(params: SSMContacts.Types.DeleteRotationOverrideRequest, callback?: (err: AWSError, data: SSMContacts.Types.DeleteRotationOverrideResult) => void): Request<SSMContacts.Types.DeleteRotationOverrideResult, AWSError>;
98
+ /**
99
+ * Deletes an existing override for an on-call rotation.
100
+ */
101
+ deleteRotationOverride(callback?: (err: AWSError, data: SSMContacts.Types.DeleteRotationOverrideResult) => void): Request<SSMContacts.Types.DeleteRotationOverrideResult, AWSError>;
70
102
  /**
71
103
  * 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.
72
104
  */
@@ -107,6 +139,22 @@ declare class SSMContacts extends Service {
107
139
  * Retrieves the resource policies attached to the specified contact or escalation plan.
108
140
  */
109
141
  getContactPolicy(callback?: (err: AWSError, data: SSMContacts.Types.GetContactPolicyResult) => void): Request<SSMContacts.Types.GetContactPolicyResult, AWSError>;
142
+ /**
143
+ * Retrieves information about an on-call rotation.
144
+ */
145
+ getRotation(params: SSMContacts.Types.GetRotationRequest, callback?: (err: AWSError, data: SSMContacts.Types.GetRotationResult) => void): Request<SSMContacts.Types.GetRotationResult, AWSError>;
146
+ /**
147
+ * Retrieves information about an on-call rotation.
148
+ */
149
+ getRotation(callback?: (err: AWSError, data: SSMContacts.Types.GetRotationResult) => void): Request<SSMContacts.Types.GetRotationResult, AWSError>;
150
+ /**
151
+ * Retrieves information about an override to an on-call rotation.
152
+ */
153
+ getRotationOverride(params: SSMContacts.Types.GetRotationOverrideRequest, callback?: (err: AWSError, data: SSMContacts.Types.GetRotationOverrideResult) => void): Request<SSMContacts.Types.GetRotationOverrideResult, AWSError>;
154
+ /**
155
+ * Retrieves information about an override to an on-call rotation.
156
+ */
157
+ getRotationOverride(callback?: (err: AWSError, data: SSMContacts.Types.GetRotationOverrideResult) => void): Request<SSMContacts.Types.GetRotationOverrideResult, AWSError>;
110
158
  /**
111
159
  * Lists all contact channels for the specified contact.
112
160
  */
@@ -132,13 +180,21 @@ declare class SSMContacts extends Service {
132
180
  */
133
181
  listEngagements(callback?: (err: AWSError, data: SSMContacts.Types.ListEngagementsResult) => void): Request<SSMContacts.Types.ListEngagementsResult, AWSError>;
134
182
  /**
135
- * Lists all of the engagements to contact channels that have been acknowledged.
183
+ * Lists all of the engagements to contact channels that have been acknowledged.
136
184
  */
137
185
  listPageReceipts(params: SSMContacts.Types.ListPageReceiptsRequest, callback?: (err: AWSError, data: SSMContacts.Types.ListPageReceiptsResult) => void): Request<SSMContacts.Types.ListPageReceiptsResult, AWSError>;
138
186
  /**
139
- * Lists all of the engagements to contact channels that have been acknowledged.
187
+ * Lists all of the engagements to contact channels that have been acknowledged.
140
188
  */
141
189
  listPageReceipts(callback?: (err: AWSError, data: SSMContacts.Types.ListPageReceiptsResult) => void): Request<SSMContacts.Types.ListPageReceiptsResult, AWSError>;
190
+ /**
191
+ * 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 escalation plan &gt; on-call schedule &gt; contact.
192
+ */
193
+ listPageResolutions(params: SSMContacts.Types.ListPageResolutionsRequest, callback?: (err: AWSError, data: SSMContacts.Types.ListPageResolutionsResult) => void): Request<SSMContacts.Types.ListPageResolutionsResult, AWSError>;
194
+ /**
195
+ * 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 escalation plan &gt; on-call schedule &gt; contact.
196
+ */
197
+ listPageResolutions(callback?: (err: AWSError, data: SSMContacts.Types.ListPageResolutionsResult) => void): Request<SSMContacts.Types.ListPageResolutionsResult, AWSError>;
142
198
  /**
143
199
  * Lists the engagements to a contact's contact channels.
144
200
  */
@@ -155,6 +211,38 @@ declare class SSMContacts extends Service {
155
211
  * Lists the engagements to contact channels that occurred by engaging a contact.
156
212
  */
157
213
  listPagesByEngagement(callback?: (err: AWSError, data: SSMContacts.Types.ListPagesByEngagementResult) => void): Request<SSMContacts.Types.ListPagesByEngagementResult, AWSError>;
214
+ /**
215
+ * Returns a list of shifts based on rotation configuration parameters. The Incident Manager primarily uses this operation to populate the Preview calendar. It is not typically run by end users.
216
+ */
217
+ listPreviewRotationShifts(params: SSMContacts.Types.ListPreviewRotationShiftsRequest, callback?: (err: AWSError, data: SSMContacts.Types.ListPreviewRotationShiftsResult) => void): Request<SSMContacts.Types.ListPreviewRotationShiftsResult, AWSError>;
218
+ /**
219
+ * Returns a list of shifts based on rotation configuration parameters. The Incident Manager primarily uses this operation to populate the Preview calendar. It is not typically run by end users.
220
+ */
221
+ listPreviewRotationShifts(callback?: (err: AWSError, data: SSMContacts.Types.ListPreviewRotationShiftsResult) => void): Request<SSMContacts.Types.ListPreviewRotationShiftsResult, AWSError>;
222
+ /**
223
+ * Retrieves a list of overrides currently specified for an on-call rotation.
224
+ */
225
+ listRotationOverrides(params: SSMContacts.Types.ListRotationOverridesRequest, callback?: (err: AWSError, data: SSMContacts.Types.ListRotationOverridesResult) => void): Request<SSMContacts.Types.ListRotationOverridesResult, AWSError>;
226
+ /**
227
+ * Retrieves a list of overrides currently specified for an on-call rotation.
228
+ */
229
+ listRotationOverrides(callback?: (err: AWSError, data: SSMContacts.Types.ListRotationOverridesResult) => void): Request<SSMContacts.Types.ListRotationOverridesResult, AWSError>;
230
+ /**
231
+ * Returns a list of shifts generated by an existing rotation in the system.
232
+ */
233
+ listRotationShifts(params: SSMContacts.Types.ListRotationShiftsRequest, callback?: (err: AWSError, data: SSMContacts.Types.ListRotationShiftsResult) => void): Request<SSMContacts.Types.ListRotationShiftsResult, AWSError>;
234
+ /**
235
+ * Returns a list of shifts generated by an existing rotation in the system.
236
+ */
237
+ listRotationShifts(callback?: (err: AWSError, data: SSMContacts.Types.ListRotationShiftsResult) => void): Request<SSMContacts.Types.ListRotationShiftsResult, AWSError>;
238
+ /**
239
+ * Retrieves a list of on-call rotations.
240
+ */
241
+ listRotations(params: SSMContacts.Types.ListRotationsRequest, callback?: (err: AWSError, data: SSMContacts.Types.ListRotationsResult) => void): Request<SSMContacts.Types.ListRotationsResult, AWSError>;
242
+ /**
243
+ * Retrieves a list of on-call rotations.
244
+ */
245
+ listRotations(callback?: (err: AWSError, data: SSMContacts.Types.ListRotationsResult) => void): Request<SSMContacts.Types.ListRotationsResult, AWSError>;
158
246
  /**
159
247
  * Lists the tags of an escalation plan or contact.
160
248
  */
@@ -196,27 +284,27 @@ declare class SSMContacts extends Service {
196
284
  */
197
285
  stopEngagement(callback?: (err: AWSError, data: SSMContacts.Types.StopEngagementResult) => void): Request<SSMContacts.Types.StopEngagementResult, AWSError>;
198
286
  /**
199
- * Tags a contact or escalation plan. You can tag only contacts and escalation plans in the first region of your replication set.
287
+ * Tags a contact or escalation plan. You can tag only contacts and escalation plans in the first region of your replication set.
200
288
  */
201
289
  tagResource(params: SSMContacts.Types.TagResourceRequest, callback?: (err: AWSError, data: SSMContacts.Types.TagResourceResult) => void): Request<SSMContacts.Types.TagResourceResult, AWSError>;
202
290
  /**
203
- * Tags a contact or escalation plan. You can tag only contacts and escalation plans in the first region of your replication set.
291
+ * Tags a contact or escalation plan. You can tag only contacts and escalation plans in the first region of your replication set.
204
292
  */
205
293
  tagResource(callback?: (err: AWSError, data: SSMContacts.Types.TagResourceResult) => void): Request<SSMContacts.Types.TagResourceResult, AWSError>;
206
294
  /**
207
- * Removes tags from the specified resource.
295
+ * Removes tags from the specified resource.
208
296
  */
209
297
  untagResource(params: SSMContacts.Types.UntagResourceRequest, callback?: (err: AWSError, data: SSMContacts.Types.UntagResourceResult) => void): Request<SSMContacts.Types.UntagResourceResult, AWSError>;
210
298
  /**
211
- * Removes tags from the specified resource.
299
+ * Removes tags from the specified resource.
212
300
  */
213
301
  untagResource(callback?: (err: AWSError, data: SSMContacts.Types.UntagResourceResult) => void): Request<SSMContacts.Types.UntagResourceResult, AWSError>;
214
302
  /**
215
- * Updates the contact or escalation plan specified.
303
+ * Updates the contact or escalation plan specified.
216
304
  */
217
305
  updateContact(params: SSMContacts.Types.UpdateContactRequest, callback?: (err: AWSError, data: SSMContacts.Types.UpdateContactResult) => void): Request<SSMContacts.Types.UpdateContactResult, AWSError>;
218
306
  /**
219
- * Updates the contact or escalation plan specified.
307
+ * Updates the contact or escalation plan specified.
220
308
  */
221
309
  updateContact(callback?: (err: AWSError, data: SSMContacts.Types.UpdateContactResult) => void): Request<SSMContacts.Types.UpdateContactResult, AWSError>;
222
310
  /**
@@ -227,6 +315,14 @@ declare class SSMContacts extends Service {
227
315
  * Updates a contact's contact channel.
228
316
  */
229
317
  updateContactChannel(callback?: (err: AWSError, data: SSMContacts.Types.UpdateContactChannelResult) => void): Request<SSMContacts.Types.UpdateContactChannelResult, AWSError>;
318
+ /**
319
+ * Updates the information specified for an on-call rotation.
320
+ */
321
+ updateRotation(params: SSMContacts.Types.UpdateRotationRequest, callback?: (err: AWSError, data: SSMContacts.Types.UpdateRotationResult) => void): Request<SSMContacts.Types.UpdateRotationResult, AWSError>;
322
+ /**
323
+ * Updates the information specified for an on-call rotation.
324
+ */
325
+ updateRotation(callback?: (err: AWSError, data: SSMContacts.Types.UpdateRotationResult) => void): Request<SSMContacts.Types.UpdateRotationResult, AWSError>;
230
326
  }
231
327
  declare namespace SSMContacts {
232
328
  export type AcceptCode = string;
@@ -249,7 +345,7 @@ declare namespace SSMContacts {
249
345
  */
250
346
  Note?: ReceiptInfo;
251
347
  /**
252
- * The accept code is a 6-digit code used to acknowledge the page.
348
+ * A 6-digit code used to acknowledge the page.
253
349
  */
254
350
  AcceptCode: AcceptCode;
255
351
  /**
@@ -266,7 +362,7 @@ declare namespace SSMContacts {
266
362
  */
267
363
  ContactChannelId: SsmContactsArn;
268
364
  /**
269
- * The code sent to the contact channel when it was created in the contact.
365
+ * The code sent to the contact channel when it was created in the contact.
270
366
  */
271
367
  ActivationCode: ActivationCode;
272
368
  }
@@ -328,7 +424,7 @@ declare namespace SSMContacts {
328
424
  */
329
425
  DeliveryAddress: ContactChannelAddress;
330
426
  /**
331
- * 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.
427
+ * 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.
332
428
  */
333
429
  ActivationStatus: ActivationStatus;
334
430
  }
@@ -350,9 +446,20 @@ declare namespace SSMContacts {
350
446
  */
351
447
  IsEssential: IsEssential;
352
448
  }
353
- export type ContactType = "PERSONAL"|"ESCALATION"|string;
449
+ export type ContactType = "PERSONAL"|"ESCALATION"|"ONCALL_SCHEDULE"|string;
354
450
  export type ContactsList = Contact[];
355
451
  export type Content = string;
452
+ export interface CoverageTime {
453
+ /**
454
+ * Information about when the on-call rotation shift begins.
455
+ */
456
+ Start?: HandOffTime;
457
+ /**
458
+ * Information about when the on-call rotation shift ends.
459
+ */
460
+ End?: HandOffTime;
461
+ }
462
+ export type CoverageTimes = CoverageTime[];
356
463
  export interface CreateContactChannelRequest {
357
464
  /**
358
465
  * The Amazon Resource Name (ARN) of the contact you are adding the contact channel to.
@@ -387,11 +494,11 @@ declare namespace SSMContacts {
387
494
  }
388
495
  export interface CreateContactRequest {
389
496
  /**
390
- * The short name to quickly identify a contact or escalation plan. The contact alias must be unique and identifiable.
497
+ * The short name to quickly identify a contact or escalation plan. The contact alias must be unique and identifiable.
391
498
  */
392
499
  Alias: ContactAlias;
393
500
  /**
394
- * The full name of the contact or escalation plan.
501
+ * The full name of the contact or escalation plan.
395
502
  */
396
503
  DisplayName?: ContactName;
397
504
  /**
@@ -399,11 +506,11 @@ declare namespace SSMContacts {
399
506
  */
400
507
  Type: ContactType;
401
508
  /**
402
- * 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.
509
+ * 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.
403
510
  */
404
511
  Plan: Plan;
405
512
  /**
406
- * Adds a tag to the target. You can only tag resources created in the first Region of your replication set.
513
+ * Adds a tag to the target. You can only tag resources created in the first Region of your replication set.
407
514
  */
408
515
  Tags?: TagsList;
409
516
  /**
@@ -417,7 +524,74 @@ declare namespace SSMContacts {
417
524
  */
418
525
  ContactArn: SsmContactsArn;
419
526
  }
527
+ export interface CreateRotationOverrideRequest {
528
+ /**
529
+ * The Amazon Resource Name (ARN) of the rotation to create an override for.
530
+ */
531
+ RotationId: SsmContactsArn;
532
+ /**
533
+ * The Amazon Resource Names (ARNs) of the contacts to replace those in the current on-call rotation with. If you want to include any current team members in the override shift, you must include their ARNs in the new contact ID list.
534
+ */
535
+ NewContactIds: RotationOverrideContactsArnList;
536
+ /**
537
+ * The date and time when the override goes into effect.
538
+ */
539
+ StartTime: DateTime;
540
+ /**
541
+ * The date and time when the override ends.
542
+ */
543
+ EndTime: DateTime;
544
+ /**
545
+ * A token that ensures that the operation is called only once with the specified details.
546
+ */
547
+ IdempotencyToken?: IdempotencyToken;
548
+ }
549
+ export interface CreateRotationOverrideResult {
550
+ /**
551
+ * The Amazon Resource Name (ARN) of the created rotation override.
552
+ */
553
+ RotationOverrideId: Uuid;
554
+ }
555
+ export interface CreateRotationRequest {
556
+ /**
557
+ * The name of the rotation.
558
+ */
559
+ Name: RotationName;
560
+ /**
561
+ * The Amazon Resource Names (ARNs) of the contacts to add to the rotation. 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 UpdateRotation operation.
562
+ */
563
+ ContactIds: RotationContactsArnList;
564
+ /**
565
+ * The date and time that the rotation goes into effect.
566
+ */
567
+ StartTime?: DateTime;
568
+ /**
569
+ * 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 Time Zone Database on the IANA website. 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.
570
+ */
571
+ TimeZoneId: TimeZoneId;
572
+ /**
573
+ * Information about the rule that specifies when a shift's team members rotate.
574
+ */
575
+ Recurrence: RecurrenceSettings;
576
+ /**
577
+ * 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 Tagging Incident Manager resources in the Incident Manager User Guide.
578
+ */
579
+ Tags?: TagsList;
580
+ /**
581
+ * A token that ensures that the operation is called only once with the specified details.
582
+ */
583
+ IdempotencyToken?: IdempotencyToken;
584
+ }
585
+ export interface CreateRotationResult {
586
+ /**
587
+ * The Amazon Resource Name (ARN) of the created rotation.
588
+ */
589
+ RotationArn: SsmContactsArn;
590
+ }
591
+ export type DailySettings = HandOffTime[];
420
592
  export type DateTime = Date;
593
+ export type DayOfMonth = number;
594
+ export type DayOfWeek = "MON"|"TUE"|"WED"|"THU"|"FRI"|"SAT"|"SUN"|string;
421
595
  export interface DeactivateContactChannelRequest {
422
596
  /**
423
597
  * The Amazon Resource Name (ARN) of the contact channel you're deactivating.
@@ -443,6 +617,26 @@ declare namespace SSMContacts {
443
617
  }
444
618
  export interface DeleteContactResult {
445
619
  }
620
+ export interface DeleteRotationOverrideRequest {
621
+ /**
622
+ * The Amazon Resource Name (ARN) of the rotation that was overridden.
623
+ */
624
+ RotationId: SsmContactsArn;
625
+ /**
626
+ * The Amazon Resource Name (ARN) of the on-call rotation override to delete.
627
+ */
628
+ RotationOverrideId: Uuid;
629
+ }
630
+ export interface DeleteRotationOverrideResult {
631
+ }
632
+ export interface DeleteRotationRequest {
633
+ /**
634
+ * The Amazon Resource Name (ARN) of the on-call rotation to delete.
635
+ */
636
+ RotationId: SsmContactsArn;
637
+ }
638
+ export interface DeleteRotationResult {
639
+ }
446
640
  export interface DescribeEngagementRequest {
447
641
  /**
448
642
  * The Amazon Resource Name (ARN) of the engagement you want the details of.
@@ -598,7 +792,7 @@ declare namespace SSMContacts {
598
792
  */
599
793
  Type: ChannelType;
600
794
  /**
601
- * The details that Incident Manager uses when trying to engage the contact channel.
795
+ * The details that Incident Manager uses when trying to engage the contact channel.
602
796
  */
603
797
  DeliveryAddress: ContactChannelAddress;
604
798
  /**
@@ -642,7 +836,7 @@ declare namespace SSMContacts {
642
836
  */
643
837
  DisplayName?: ContactName;
644
838
  /**
645
- * The type of contact, either PERSONAL or ESCALATION.
839
+ * The type of contact, either PERSONAL or ESCALATION.
646
840
  */
647
841
  Type: ContactType;
648
842
  /**
@@ -650,12 +844,91 @@ declare namespace SSMContacts {
650
844
  */
651
845
  Plan: Plan;
652
846
  }
847
+ export interface GetRotationOverrideRequest {
848
+ /**
849
+ * The Amazon Resource Name (ARN) of the overridden rotation to retrieve information about.
850
+ */
851
+ RotationId: SsmContactsArn;
852
+ /**
853
+ * The Amazon Resource Name (ARN) of the on-call rotation override to retrieve information about.
854
+ */
855
+ RotationOverrideId: Uuid;
856
+ }
857
+ export interface GetRotationOverrideResult {
858
+ /**
859
+ * The Amazon Resource Name (ARN) of the override to an on-call rotation.
860
+ */
861
+ RotationOverrideId?: Uuid;
862
+ /**
863
+ * The Amazon Resource Name (ARN) of the on-call rotation that was overridden.
864
+ */
865
+ RotationArn?: SsmContactsArn;
866
+ /**
867
+ * The Amazon Resource Names (ARNs) of the contacts assigned to the override of the on-call rotation.
868
+ */
869
+ NewContactIds?: SsmContactsArnList;
870
+ /**
871
+ * The date and time when the override goes into effect.
872
+ */
873
+ StartTime?: DateTime;
874
+ /**
875
+ * The date and time when the override ends.
876
+ */
877
+ EndTime?: DateTime;
878
+ /**
879
+ * The date and time when the override was created.
880
+ */
881
+ CreateTime?: DateTime;
882
+ }
883
+ export interface GetRotationRequest {
884
+ /**
885
+ * The Amazon Resource Name (ARN) of the on-call rotation to retrieve information about.
886
+ */
887
+ RotationId: SsmContactsArn;
888
+ }
889
+ export interface GetRotationResult {
890
+ /**
891
+ * The Amazon Resource Name (ARN) of the on-call rotation.
892
+ */
893
+ RotationArn: SsmContactsArn;
894
+ /**
895
+ * The name of the on-call rotation.
896
+ */
897
+ Name: RotationName;
898
+ /**
899
+ * The Amazon Resource Names (ARNs) of the contacts assigned to the on-call rotation team.
900
+ */
901
+ ContactIds: RotationContactsArnList;
902
+ /**
903
+ * The specified start time for the on-call rotation.
904
+ */
905
+ StartTime: DateTime;
906
+ /**
907
+ * The time zone that the rotation’s activity is based on, in Internet Assigned Numbers Authority (IANA) format.
908
+ */
909
+ TimeZoneId: TimeZoneId;
910
+ /**
911
+ * Specifies how long a rotation lasts before restarting at the beginning of the shift order.
912
+ */
913
+ Recurrence: RecurrenceSettings;
914
+ }
915
+ export interface HandOffTime {
916
+ /**
917
+ * The hour when an on-call rotation shift begins or ends.
918
+ */
919
+ HourOfDay: HourOfDay;
920
+ /**
921
+ * The minute when an on-call rotation shift begins or ends.
922
+ */
923
+ MinuteOfHour: MinuteOfHour;
924
+ }
925
+ export type HourOfDay = number;
653
926
  export type IdempotencyToken = string;
654
927
  export type IncidentId = string;
655
928
  export type IsEssential = boolean;
656
929
  export interface ListContactChannelsRequest {
657
930
  /**
658
- * The Amazon Resource Name (ARN) of the contact.
931
+ * The Amazon Resource Name (ARN) of the contact.
659
932
  */
660
933
  ContactId: SsmContactsArn;
661
934
  /**
@@ -757,6 +1030,26 @@ declare namespace SSMContacts {
757
1030
  */
758
1031
  Receipts?: ReceiptsList;
759
1032
  }
1033
+ export interface ListPageResolutionsRequest {
1034
+ /**
1035
+ * A token to start the list. Use this token to get the next set of results.
1036
+ */
1037
+ NextToken?: PaginationToken;
1038
+ /**
1039
+ * The Amazon Resource Name (ARN) of the contact engaged for the incident.
1040
+ */
1041
+ PageId: SsmContactsArn;
1042
+ }
1043
+ export interface ListPageResolutionsResult {
1044
+ /**
1045
+ * The token for the next set of items to return. Use this token to get the next set of results.
1046
+ */
1047
+ NextToken?: PaginationToken;
1048
+ /**
1049
+ * Information about the resolution for an engagement.
1050
+ */
1051
+ PageResolutions: ResolutionList;
1052
+ }
760
1053
  export interface ListPagesByContactRequest {
761
1054
  /**
762
1055
  * The Amazon Resource Name (ARN) of the contact you are retrieving engagements for.
@@ -805,6 +1098,142 @@ declare namespace SSMContacts {
805
1098
  */
806
1099
  Pages: PagesList;
807
1100
  }
1101
+ export interface ListPreviewRotationShiftsRequest {
1102
+ /**
1103
+ * The date and time a rotation would begin. The first shift is calculated from this date and time.
1104
+ */
1105
+ RotationStartTime?: DateTime;
1106
+ /**
1107
+ * Used to filter the range of calculated shifts before sending the response back to the user.
1108
+ */
1109
+ StartTime?: DateTime;
1110
+ /**
1111
+ * The date and time a rotation shift would end.
1112
+ */
1113
+ EndTime: DateTime;
1114
+ /**
1115
+ * The contacts that would be assigned to a rotation.
1116
+ */
1117
+ Members: RotationPreviewMemberList;
1118
+ /**
1119
+ * 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".
1120
+ */
1121
+ TimeZoneId: TimeZoneId;
1122
+ /**
1123
+ * Information about how long a rotation would last before restarting at the beginning of the shift order.
1124
+ */
1125
+ Recurrence: RecurrenceSettings;
1126
+ /**
1127
+ * Information about changes that would be made in a rotation override.
1128
+ */
1129
+ Overrides?: OverrideList;
1130
+ /**
1131
+ * A token to start the list. This token is used to get the next set of results.
1132
+ */
1133
+ NextToken?: PaginationToken;
1134
+ /**
1135
+ * 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.
1136
+ */
1137
+ MaxResults?: MaxResults;
1138
+ }
1139
+ export interface ListPreviewRotationShiftsResult {
1140
+ /**
1141
+ * Details about a rotation shift, including times, types, and contacts.
1142
+ */
1143
+ RotationShifts?: RotationShifts;
1144
+ /**
1145
+ * The token for the next set of items to return. This token is used to get the next set of results.
1146
+ */
1147
+ NextToken?: PaginationToken;
1148
+ }
1149
+ export interface ListRotationOverridesRequest {
1150
+ /**
1151
+ * The Amazon Resource Name (ARN) of the rotation to retrieve information about.
1152
+ */
1153
+ RotationId: SsmContactsArn;
1154
+ /**
1155
+ * The date and time for the beginning of a time range for listing overrides.
1156
+ */
1157
+ StartTime: DateTime;
1158
+ /**
1159
+ * The date and time for the end of a time range for listing overrides.
1160
+ */
1161
+ EndTime: DateTime;
1162
+ /**
1163
+ * A token to start the list. Use this token to get the next set of results.
1164
+ */
1165
+ NextToken?: PaginationToken;
1166
+ /**
1167
+ * 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.
1168
+ */
1169
+ MaxResults?: MaxResults;
1170
+ }
1171
+ export interface ListRotationOverridesResult {
1172
+ /**
1173
+ * A list of rotation overrides in the specified time range.
1174
+ */
1175
+ RotationOverrides?: RotationOverrides;
1176
+ /**
1177
+ * The token for the next set of items to return. Use this token to get the next set of results.
1178
+ */
1179
+ NextToken?: PaginationToken;
1180
+ }
1181
+ export interface ListRotationShiftsRequest {
1182
+ /**
1183
+ * The Amazon Resource Name (ARN) of the rotation to retrieve shift information about.
1184
+ */
1185
+ RotationId: SsmContactsArn;
1186
+ /**
1187
+ * The date and time for the beginning of the time range to list shifts for.
1188
+ */
1189
+ StartTime?: DateTime;
1190
+ /**
1191
+ * The date and time for the end of the time range to list shifts for.
1192
+ */
1193
+ EndTime: DateTime;
1194
+ /**
1195
+ * A token to start the list. Use this token to get the next set of results.
1196
+ */
1197
+ NextToken?: PaginationToken;
1198
+ /**
1199
+ * 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.
1200
+ */
1201
+ MaxResults?: MaxResults;
1202
+ }
1203
+ export interface ListRotationShiftsResult {
1204
+ /**
1205
+ * Information about shifts that meet the filter criteria.
1206
+ */
1207
+ RotationShifts?: RotationShifts;
1208
+ /**
1209
+ * The token for the next set of items to return. Use this token to get the next set of results.
1210
+ */
1211
+ NextToken?: PaginationToken;
1212
+ }
1213
+ export interface ListRotationsRequest {
1214
+ /**
1215
+ * 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 prod, such as production and prod-1.
1216
+ */
1217
+ RotationNamePrefix?: RotationName;
1218
+ /**
1219
+ * A token to start the list. Use this token to get the next set of results.
1220
+ */
1221
+ NextToken?: PaginationToken;
1222
+ /**
1223
+ * 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.
1224
+ */
1225
+ MaxResults?: MaxResults;
1226
+ }
1227
+ export interface ListRotationsResult {
1228
+ /**
1229
+ * The token for the next set of items to return. Use this token to get the next set of results.
1230
+ */
1231
+ NextToken?: PaginationToken;
1232
+ /**
1233
+ * Information about rotations that meet the filter criteria.
1234
+ */
1235
+ Rotations: Rotations;
1236
+ }
808
1237
  export interface ListTagsForResourceRequest {
809
1238
  /**
810
1239
  * The Amazon Resource Name (ARN) of the contact or escalation plan.
@@ -818,6 +1247,21 @@ declare namespace SSMContacts {
818
1247
  Tags?: TagsList;
819
1248
  }
820
1249
  export type MaxResults = number;
1250
+ export type Member = string;
1251
+ export type MinuteOfHour = number;
1252
+ export interface MonthlySetting {
1253
+ /**
1254
+ * The day of the month when monthly recurring on-call rotations begin.
1255
+ */
1256
+ DayOfMonth: DayOfMonth;
1257
+ /**
1258
+ * The time of day when a monthly recurring on-call shift rotation begins.
1259
+ */
1260
+ HandOffTime: HandOffTime;
1261
+ }
1262
+ export type MonthlySettings = MonthlySetting[];
1263
+ export type NumberOfOnCalls = number;
1264
+ export type OverrideList = PreviewOverride[];
821
1265
  export interface Page {
822
1266
  /**
823
1267
  * The Amazon Resource Name (ARN) of the page to the contact channel.
@@ -858,9 +1302,27 @@ declare namespace SSMContacts {
858
1302
  /**
859
1303
  * A list of stages that the escalation plan or engagement plan uses to engage contacts and contact methods.
860
1304
  */
861
- Stages: StagesList;
1305
+ Stages?: StagesList;
1306
+ /**
1307
+ * The Amazon Resource Names (ARNs) of the on-call rotations associated with the plan.
1308
+ */
1309
+ RotationIds?: SsmContactsArnList;
862
1310
  }
863
1311
  export type Policy = string;
1312
+ export interface PreviewOverride {
1313
+ /**
1314
+ * Information about contacts to add to an on-call rotation override.
1315
+ */
1316
+ NewMembers?: RotationOverridePreviewMemberList;
1317
+ /**
1318
+ * Information about the time a rotation override would begin.
1319
+ */
1320
+ StartTime?: DateTime;
1321
+ /**
1322
+ * Information about the time a rotation override would end.
1323
+ */
1324
+ EndTime?: DateTime;
1325
+ }
864
1326
  export type PublicContent = string;
865
1327
  export type PublicSubject = string;
866
1328
  export interface PutContactPolicyRequest {
@@ -896,7 +1358,127 @@ declare namespace SSMContacts {
896
1358
  export type ReceiptInfo = string;
897
1359
  export type ReceiptType = "DELIVERED"|"ERROR"|"READ"|"SENT"|"STOP"|string;
898
1360
  export type ReceiptsList = Receipt[];
1361
+ export type RecurrenceMultiplier = number;
1362
+ export interface RecurrenceSettings {
1363
+ /**
1364
+ * Information about on-call rotations that recur monthly.
1365
+ */
1366
+ MonthlySettings?: MonthlySettings;
1367
+ /**
1368
+ * Information about on-call rotations that recur weekly.
1369
+ */
1370
+ WeeklySettings?: WeeklySettings;
1371
+ /**
1372
+ * Information about on-call rotations that recur daily.
1373
+ */
1374
+ DailySettings?: DailySettings;
1375
+ /**
1376
+ * 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 2 designates that two of them are on call at any given time.
1377
+ */
1378
+ NumberOfOnCalls: NumberOfOnCalls;
1379
+ /**
1380
+ * Information about the days of the week included in on-call rotation coverage.
1381
+ */
1382
+ ShiftCoverages?: ShiftCoveragesMap;
1383
+ /**
1384
+ * The number of days, weeks, or months a single rotation lasts.
1385
+ */
1386
+ RecurrenceMultiplier: RecurrenceMultiplier;
1387
+ }
1388
+ export interface ResolutionContact {
1389
+ /**
1390
+ * The Amazon Resource Name (ARN) of a contact in the engagement resolution process.
1391
+ */
1392
+ ContactArn: SsmContactsArn;
1393
+ /**
1394
+ * The type of contact for a resolution step.
1395
+ */
1396
+ Type: ContactType;
1397
+ /**
1398
+ * The stage in the escalation plan that resolves to this contact.
1399
+ */
1400
+ StageIndex?: StageIndex;
1401
+ }
1402
+ export type ResolutionList = ResolutionContact[];
899
1403
  export type RetryIntervalInMinutes = number;
1404
+ export interface Rotation {
1405
+ /**
1406
+ * The Amazon Resource Name (ARN) of the rotation.
1407
+ */
1408
+ RotationArn: SsmContactsArn;
1409
+ /**
1410
+ * The name of the rotation.
1411
+ */
1412
+ Name: RotationName;
1413
+ /**
1414
+ * The Amazon Resource Names (ARNs) of the contacts assigned to the rotation team.
1415
+ */
1416
+ ContactIds?: SsmContactsArnList;
1417
+ /**
1418
+ * The date and time the rotation becomes active.
1419
+ */
1420
+ StartTime?: DateTime;
1421
+ /**
1422
+ * 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".
1423
+ */
1424
+ TimeZoneId?: TimeZoneId;
1425
+ /**
1426
+ * Information about when an on-call rotation is in effect and how long the rotation period lasts.
1427
+ */
1428
+ Recurrence?: RecurrenceSettings;
1429
+ }
1430
+ export type RotationContactsArnList = SsmContactsArn[];
1431
+ export type RotationName = string;
1432
+ export interface RotationOverride {
1433
+ /**
1434
+ * The Amazon Resource Name (ARN) of the override to an on-call rotation.
1435
+ */
1436
+ RotationOverrideId: Uuid;
1437
+ /**
1438
+ * The Amazon Resource Names (ARNs) of the contacts assigned to the override of the on-call rotation.
1439
+ */
1440
+ NewContactIds: SsmContactsArnList;
1441
+ /**
1442
+ * The time a rotation override begins.
1443
+ */
1444
+ StartTime: DateTime;
1445
+ /**
1446
+ * The time a rotation override ends.
1447
+ */
1448
+ EndTime: DateTime;
1449
+ /**
1450
+ * The time a rotation override was created.
1451
+ */
1452
+ CreateTime: DateTime;
1453
+ }
1454
+ export type RotationOverrideContactsArnList = SsmContactsArn[];
1455
+ export type RotationOverridePreviewMemberList = Member[];
1456
+ export type RotationOverrides = RotationOverride[];
1457
+ export type RotationPreviewMemberList = Member[];
1458
+ export interface RotationShift {
1459
+ /**
1460
+ * The Amazon Resource Names (ARNs) of the contacts who are part of the shift rotation.
1461
+ */
1462
+ ContactIds?: SsmContactsArnList;
1463
+ /**
1464
+ * The time a shift rotation begins.
1465
+ */
1466
+ StartTime: DateTime;
1467
+ /**
1468
+ * The time a shift rotation ends.
1469
+ */
1470
+ EndTime: DateTime;
1471
+ /**
1472
+ * The type of shift rotation.
1473
+ */
1474
+ Type?: ShiftType;
1475
+ /**
1476
+ * Additional information about an on-call rotation shift.
1477
+ */
1478
+ ShiftDetails?: ShiftDetails;
1479
+ }
1480
+ export type RotationShifts = RotationShift[];
1481
+ export type Rotations = Rotation[];
900
1482
  export interface SendActivationCodeRequest {
901
1483
  /**
902
1484
  * The Amazon Resource Name (ARN) of the contact channel.
@@ -906,8 +1488,17 @@ declare namespace SSMContacts {
906
1488
  export interface SendActivationCodeResult {
907
1489
  }
908
1490
  export type Sender = string;
1491
+ export type ShiftCoveragesMap = {[key: string]: CoverageTimes};
1492
+ export interface ShiftDetails {
1493
+ /**
1494
+ * 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.
1495
+ */
1496
+ OverriddenContactIds: SsmContactsArnList;
1497
+ }
1498
+ export type ShiftType = "REGULAR"|"OVERRIDDEN"|string;
909
1499
  export type SimpleAddress = string;
910
1500
  export type SsmContactsArn = string;
1501
+ export type SsmContactsArnList = SsmContactsArn[];
911
1502
  export interface Stage {
912
1503
  /**
913
1504
  * The time to wait until beginning the next stage. The duration can only be set to 0 if a target is specified.
@@ -919,6 +1510,7 @@ declare namespace SSMContacts {
919
1510
  Targets: TargetsList;
920
1511
  }
921
1512
  export type StageDurationInMins = number;
1513
+ export type StageIndex = number;
922
1514
  export type StagesList = Stage[];
923
1515
  export interface StartEngagementRequest {
924
1516
  /**
@@ -966,7 +1558,7 @@ declare namespace SSMContacts {
966
1558
  */
967
1559
  EngagementId: SsmContactsArn;
968
1560
  /**
969
- * The reason that you're stopping the engagement.
1561
+ * The reason that you're stopping the engagement.
970
1562
  */
971
1563
  Reason?: StopReason;
972
1564
  }
@@ -1021,6 +1613,7 @@ declare namespace SSMContacts {
1021
1613
  */
1022
1614
  EndTime?: DateTime;
1023
1615
  }
1616
+ export type TimeZoneId = string;
1024
1617
  export interface UntagResourceRequest {
1025
1618
  /**
1026
1619
  * The Amazon Resource Name (ARN) of the contact or escalation plan.
@@ -1043,7 +1636,7 @@ declare namespace SSMContacts {
1043
1636
  */
1044
1637
  Name?: ChannelName;
1045
1638
  /**
1046
- * The details that Incident Manager uses when trying to engage the contact channel.
1639
+ * The details that Incident Manager uses when trying to engage the contact channel.
1047
1640
  */
1048
1641
  DeliveryAddress?: ContactChannelAddress;
1049
1642
  }
@@ -1059,12 +1652,48 @@ declare namespace SSMContacts {
1059
1652
  */
1060
1653
  DisplayName?: ContactName;
1061
1654
  /**
1062
- * 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.
1655
+ * 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.
1063
1656
  */
1064
1657
  Plan?: Plan;
1065
1658
  }
1066
1659
  export interface UpdateContactResult {
1067
1660
  }
1661
+ export interface UpdateRotationRequest {
1662
+ /**
1663
+ * The Amazon Resource Name (ARN) of the rotation to update.
1664
+ */
1665
+ RotationId: SsmContactsArn;
1666
+ /**
1667
+ * The Amazon Resource Names (ARNs) of the contacts to include in the updated rotation. The order in which you list the contacts is their shift order in the rotation schedule.
1668
+ */
1669
+ ContactIds?: RotationContactsArnList;
1670
+ /**
1671
+ * The date and time the rotation goes into effect.
1672
+ */
1673
+ StartTime?: DateTime;
1674
+ /**
1675
+ * 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 Time Zone Database on the IANA website. 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.
1676
+ */
1677
+ TimeZoneId?: TimeZoneId;
1678
+ /**
1679
+ * Information about how long the updated rotation lasts before restarting at the beginning of the shift order.
1680
+ */
1681
+ Recurrence: RecurrenceSettings;
1682
+ }
1683
+ export interface UpdateRotationResult {
1684
+ }
1685
+ export type Uuid = string;
1686
+ export interface WeeklySetting {
1687
+ /**
1688
+ * The day of the week when weekly recurring on-call shift rotations begins.
1689
+ */
1690
+ DayOfWeek: DayOfWeek;
1691
+ /**
1692
+ * The time of day when a weekly recurring on-call shift rotation begins.
1693
+ */
1694
+ HandOffTime: HandOffTime;
1695
+ }
1696
+ export type WeeklySettings = WeeklySetting[];
1068
1697
  /**
1069
1698
  * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
1070
1699
  */