aws-sdk-ssmcontacts 1.15.0 → 1.17.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -10,18 +10,6 @@
10
10
  module Aws::SSMContacts
11
11
  module Types
12
12
 
13
- # @note When making an API call, you may pass AcceptPageRequest
14
- # data as a hash:
15
- #
16
- # {
17
- # page_id: "SsmContactsArn", # required
18
- # contact_channel_id: "SsmContactsArn",
19
- # accept_type: "DELIVERED", # required, accepts DELIVERED, READ
20
- # note: "ReceiptInfo",
21
- # accept_code: "AcceptCode", # required
22
- # accept_code_validation: "IGNORE", # accepts IGNORE, ENFORCE
23
- # }
24
- #
25
13
  # @!attribute [rw] page_id
26
14
  # The Amazon Resource Name (ARN) of the engagement to a contact
27
15
  # channel.
@@ -41,7 +29,7 @@ module Aws::SSMContacts
41
29
  # @return [String]
42
30
  #
43
31
  # @!attribute [rw] accept_code
44
- # The accept code is a 6-digit code used to acknowledge the page.
32
+ # A 6-digit code used to acknowledge the page.
45
33
  # @return [String]
46
34
  #
47
35
  # @!attribute [rw] accept_code_validation
@@ -87,14 +75,6 @@ module Aws::SSMContacts
87
75
  include Aws::Structure
88
76
  end
89
77
 
90
- # @note When making an API call, you may pass ActivateContactChannelRequest
91
- # data as a hash:
92
- #
93
- # {
94
- # contact_channel_id: "SsmContactsArn", # required
95
- # activation_code: "ActivationCode", # required
96
- # }
97
- #
98
78
  # @!attribute [rw] contact_channel_id
99
79
  # The Amazon Resource Name (ARN) of the contact channel.
100
80
  # @return [String]
@@ -120,14 +100,6 @@ module Aws::SSMContacts
120
100
  # Information about the contact channel that Incident Manager uses to
121
101
  # engage the contact.
122
102
  #
123
- # @note When making an API call, you may pass ChannelTargetInfo
124
- # data as a hash:
125
- #
126
- # {
127
- # contact_channel_id: "SsmContactsArn", # required
128
- # retry_interval_in_minutes: 1,
129
- # }
130
- #
131
103
  # @!attribute [rw] contact_channel_id
132
104
  # The Amazon Resource Name (ARN) of the contact channel.
133
105
  # @return [String]
@@ -156,15 +128,21 @@ module Aws::SSMContacts
156
128
  # @return [String]
157
129
  #
158
130
  # @!attribute [rw] resource_type
159
- # ype of the resource in use
131
+ # Type of the resource in use
160
132
  # @return [String]
161
133
  #
134
+ # @!attribute [rw] dependent_entities
135
+ # List of dependent entities containing information on relation type
136
+ # and resourceArns linked to the resource in use
137
+ # @return [Array<Types::DependentEntity>]
138
+ #
162
139
  # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ConflictException AWS API Documentation
163
140
  #
164
141
  class ConflictException < Struct.new(
165
142
  :message,
166
143
  :resource_id,
167
- :resource_type)
144
+ :resource_type,
145
+ :dependent_entities)
168
146
  SENSITIVE = []
169
147
  include Aws::Structure
170
148
  end
@@ -252,13 +230,6 @@ module Aws::SSMContacts
252
230
  # The details that Incident Manager uses when trying to engage the
253
231
  # contact channel.
254
232
  #
255
- # @note When making an API call, you may pass ContactChannelAddress
256
- # data as a hash:
257
- #
258
- # {
259
- # simple_address: "SimpleAddress",
260
- # }
261
- #
262
233
  # @!attribute [rw] simple_address
263
234
  # The format is dependent on the type of the contact channel. The
264
235
  # following are the expected formats:
@@ -280,14 +251,6 @@ module Aws::SSMContacts
280
251
 
281
252
  # The contact that Incident Manager is engaging during an incident.
282
253
  #
283
- # @note When making an API call, you may pass ContactTargetInfo
284
- # data as a hash:
285
- #
286
- # {
287
- # contact_id: "SsmContactsArn",
288
- # is_essential: false, # required
289
- # }
290
- #
291
254
  # @!attribute [rw] contact_id
292
255
  # The Amazon Resource Name (ARN) of the contact.
293
256
  # @return [String]
@@ -306,20 +269,25 @@ module Aws::SSMContacts
306
269
  include Aws::Structure
307
270
  end
308
271
 
309
- # @note When making an API call, you may pass CreateContactChannelRequest
310
- # data as a hash:
272
+ # Information about when an on-call shift begins and ends.
311
273
  #
312
- # {
313
- # contact_id: "SsmContactsArn", # required
314
- # name: "ChannelName", # required
315
- # type: "SMS", # required, accepts SMS, VOICE, EMAIL
316
- # delivery_address: { # required
317
- # simple_address: "SimpleAddress",
318
- # },
319
- # defer_activation: false,
320
- # idempotency_token: "IdempotencyToken",
321
- # }
274
+ # @!attribute [rw] start
275
+ # Information about when the on-call rotation shift begins.
276
+ # @return [Types::HandOffTime]
322
277
  #
278
+ # @!attribute [rw] end
279
+ # Information about when the on-call rotation shift ends.
280
+ # @return [Types::HandOffTime]
281
+ #
282
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/CoverageTime AWS API Documentation
283
+ #
284
+ class CoverageTime < Struct.new(
285
+ :start,
286
+ :end)
287
+ SENSITIVE = []
288
+ include Aws::Structure
289
+ end
290
+
323
291
  # @!attribute [rw] contact_id
324
292
  # The Amazon Resource Name (ARN) of the contact you are adding the
325
293
  # contact channel to.
@@ -390,41 +358,6 @@ module Aws::SSMContacts
390
358
  include Aws::Structure
391
359
  end
392
360
 
393
- # @note When making an API call, you may pass CreateContactRequest
394
- # data as a hash:
395
- #
396
- # {
397
- # alias: "ContactAlias", # required
398
- # display_name: "ContactName",
399
- # type: "PERSONAL", # required, accepts PERSONAL, ESCALATION
400
- # plan: { # required
401
- # stages: [ # required
402
- # {
403
- # duration_in_minutes: 1, # required
404
- # targets: [ # required
405
- # {
406
- # channel_target_info: {
407
- # contact_channel_id: "SsmContactsArn", # required
408
- # retry_interval_in_minutes: 1,
409
- # },
410
- # contact_target_info: {
411
- # contact_id: "SsmContactsArn",
412
- # is_essential: false, # required
413
- # },
414
- # },
415
- # ],
416
- # },
417
- # ],
418
- # },
419
- # tags: [
420
- # {
421
- # key: "TagKey",
422
- # value: "TagValue",
423
- # },
424
- # ],
425
- # idempotency_token: "IdempotencyToken",
426
- # }
427
- #
428
361
  # @!attribute [rw] alias
429
362
  # The short name to quickly identify a contact or escalation plan. The
430
363
  # contact alias must be unique and identifiable.
@@ -484,6 +417,137 @@ module Aws::SSMContacts
484
417
  include Aws::Structure
485
418
  end
486
419
 
420
+ # @!attribute [rw] rotation_id
421
+ # The Amazon Resource Name (ARN) of the rotation to create an override
422
+ # for.
423
+ # @return [String]
424
+ #
425
+ # @!attribute [rw] new_contact_ids
426
+ # The Amazon Resource Names (ARNs) of the contacts to replace those in
427
+ # the current on-call rotation with.
428
+ #
429
+ # If you want to include any current team members in the override
430
+ # shift, you must include their ARNs in the new contact ID list.
431
+ # @return [Array<String>]
432
+ #
433
+ # @!attribute [rw] start_time
434
+ # The date and time when the override goes into effect.
435
+ # @return [Time]
436
+ #
437
+ # @!attribute [rw] end_time
438
+ # The date and time when the override ends.
439
+ # @return [Time]
440
+ #
441
+ # @!attribute [rw] idempotency_token
442
+ # A token that ensures that the operation is called only once with the
443
+ # specified details.
444
+ # @return [String]
445
+ #
446
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/CreateRotationOverrideRequest AWS API Documentation
447
+ #
448
+ class CreateRotationOverrideRequest < Struct.new(
449
+ :rotation_id,
450
+ :new_contact_ids,
451
+ :start_time,
452
+ :end_time,
453
+ :idempotency_token)
454
+ SENSITIVE = []
455
+ include Aws::Structure
456
+ end
457
+
458
+ # @!attribute [rw] rotation_override_id
459
+ # The Amazon Resource Name (ARN) of the created rotation override.
460
+ # @return [String]
461
+ #
462
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/CreateRotationOverrideResult AWS API Documentation
463
+ #
464
+ class CreateRotationOverrideResult < Struct.new(
465
+ :rotation_override_id)
466
+ SENSITIVE = []
467
+ include Aws::Structure
468
+ end
469
+
470
+ # @!attribute [rw] name
471
+ # The name of the rotation.
472
+ # @return [String]
473
+ #
474
+ # @!attribute [rw] contact_ids
475
+ # The Amazon Resource Names (ARNs) of the contacts to add to the
476
+ # rotation.
477
+ #
478
+ # The order that you list the contacts in is their shift order in the
479
+ # rotation schedule. To change the order of the contact's shifts, use
480
+ # the UpdateRotation operation.
481
+ # @return [Array<String>]
482
+ #
483
+ # @!attribute [rw] start_time
484
+ # The date and time that the rotation goes into effect.
485
+ # @return [Time]
486
+ #
487
+ # @!attribute [rw] time_zone_id
488
+ # The time zone to base the rotation’s activity on in Internet
489
+ # Assigned Numbers Authority (IANA) format. For example:
490
+ # "America/Los\_Angeles", "UTC", or "Asia/Seoul". For more
491
+ # information, see the [Time Zone Database][1] on the IANA website.
492
+ #
493
+ # <note markdown="1"> Designators for time zones that don’t support Daylight Savings Time
494
+ # rules, such as Pacific Standard Time (PST) and Pacific Daylight Time
495
+ # (PDT), are not supported.
496
+ #
497
+ # </note>
498
+ #
499
+ #
500
+ #
501
+ # [1]: https://www.iana.org/time-zones
502
+ # @return [String]
503
+ #
504
+ # @!attribute [rw] recurrence
505
+ # Information about the rule that specifies when a shift's team
506
+ # members rotate.
507
+ # @return [Types::RecurrenceSettings]
508
+ #
509
+ # @!attribute [rw] tags
510
+ # Optional metadata to assign to the rotation. Tags enable you to
511
+ # categorize a resource in different ways, such as by purpose, owner,
512
+ # or environment. For more information, see [Tagging Incident Manager
513
+ # resources][1] in the *Incident Manager User Guide*.
514
+ #
515
+ #
516
+ #
517
+ # [1]: https://docs.aws.amazon.com/incident-manager/latest/userguide/tagging.html
518
+ # @return [Array<Types::Tag>]
519
+ #
520
+ # @!attribute [rw] idempotency_token
521
+ # A token that ensures that the operation is called only once with the
522
+ # specified details.
523
+ # @return [String]
524
+ #
525
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/CreateRotationRequest AWS API Documentation
526
+ #
527
+ class CreateRotationRequest < Struct.new(
528
+ :name,
529
+ :contact_ids,
530
+ :start_time,
531
+ :time_zone_id,
532
+ :recurrence,
533
+ :tags,
534
+ :idempotency_token)
535
+ SENSITIVE = []
536
+ include Aws::Structure
537
+ end
538
+
539
+ # @!attribute [rw] rotation_arn
540
+ # The Amazon Resource Name (ARN) of the created rotation.
541
+ # @return [String]
542
+ #
543
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/CreateRotationResult AWS API Documentation
544
+ #
545
+ class CreateRotationResult < Struct.new(
546
+ :rotation_arn)
547
+ SENSITIVE = []
548
+ include Aws::Structure
549
+ end
550
+
487
551
  # The operation failed to due an encryption key error.
488
552
  #
489
553
  # @!attribute [rw] message
@@ -497,13 +561,6 @@ module Aws::SSMContacts
497
561
  include Aws::Structure
498
562
  end
499
563
 
500
- # @note When making an API call, you may pass DeactivateContactChannelRequest
501
- # data as a hash:
502
- #
503
- # {
504
- # contact_channel_id: "SsmContactsArn", # required
505
- # }
506
- #
507
564
  # @!attribute [rw] contact_channel_id
508
565
  # The Amazon Resource Name (ARN) of the contact channel you're
509
566
  # deactivating.
@@ -521,13 +578,6 @@ module Aws::SSMContacts
521
578
  #
522
579
  class DeactivateContactChannelResult < Aws::EmptyStructure; end
523
580
 
524
- # @note When making an API call, you may pass DeleteContactChannelRequest
525
- # data as a hash:
526
- #
527
- # {
528
- # contact_channel_id: "SsmContactsArn", # required
529
- # }
530
- #
531
581
  # @!attribute [rw] contact_channel_id
532
582
  # The Amazon Resource Name (ARN) of the contact channel.
533
583
  # @return [String]
@@ -544,13 +594,6 @@ module Aws::SSMContacts
544
594
  #
545
595
  class DeleteContactChannelResult < Aws::EmptyStructure; end
546
596
 
547
- # @note When making an API call, you may pass DeleteContactRequest
548
- # data as a hash:
549
- #
550
- # {
551
- # contact_id: "SsmContactsArn", # required
552
- # }
553
- #
554
597
  # @!attribute [rw] contact_id
555
598
  # The Amazon Resource Name (ARN) of the contact that you're deleting.
556
599
  # @return [String]
@@ -567,13 +610,68 @@ module Aws::SSMContacts
567
610
  #
568
611
  class DeleteContactResult < Aws::EmptyStructure; end
569
612
 
570
- # @note When making an API call, you may pass DescribeEngagementRequest
571
- # data as a hash:
613
+ # @!attribute [rw] rotation_id
614
+ # The Amazon Resource Name (ARN) of the rotation that was overridden.
615
+ # @return [String]
616
+ #
617
+ # @!attribute [rw] rotation_override_id
618
+ # The Amazon Resource Name (ARN) of the on-call rotation override to
619
+ # delete.
620
+ # @return [String]
621
+ #
622
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/DeleteRotationOverrideRequest AWS API Documentation
623
+ #
624
+ class DeleteRotationOverrideRequest < Struct.new(
625
+ :rotation_id,
626
+ :rotation_override_id)
627
+ SENSITIVE = []
628
+ include Aws::Structure
629
+ end
630
+
631
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/DeleteRotationOverrideResult AWS API Documentation
632
+ #
633
+ class DeleteRotationOverrideResult < Aws::EmptyStructure; end
634
+
635
+ # @!attribute [rw] rotation_id
636
+ # The Amazon Resource Name (ARN) of the on-call rotation to delete.
637
+ # @return [String]
638
+ #
639
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/DeleteRotationRequest AWS API Documentation
640
+ #
641
+ class DeleteRotationRequest < Struct.new(
642
+ :rotation_id)
643
+ SENSITIVE = []
644
+ include Aws::Structure
645
+ end
646
+
647
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/DeleteRotationResult AWS API Documentation
648
+ #
649
+ class DeleteRotationResult < Aws::EmptyStructure; end
650
+
651
+ # Information about a resource that another resource is related to or
652
+ # depends on.
653
+ #
654
+ # For example, if a contact is a member of a rotation, the rotation is a
655
+ # dependent entity of the contact.
656
+ #
657
+ # @!attribute [rw] relation_type
658
+ # The type of relationship between one resource and the other resource
659
+ # that it is related to or depends on.
660
+ # @return [String]
572
661
  #
573
- # {
574
- # engagement_id: "SsmContactsArn", # required
575
- # }
662
+ # @!attribute [rw] dependent_resource_ids
663
+ # The Amazon Resource Names (ARNs) of the dependent resources.
664
+ # @return [Array<String>]
665
+ #
666
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/DependentEntity AWS API Documentation
576
667
  #
668
+ class DependentEntity < Struct.new(
669
+ :relation_type,
670
+ :dependent_resource_ids)
671
+ SENSITIVE = []
672
+ include Aws::Structure
673
+ end
674
+
577
675
  # @!attribute [rw] engagement_id
578
676
  # The Amazon Resource Name (ARN) of the engagement you want the
579
677
  # details of.
@@ -649,13 +747,6 @@ module Aws::SSMContacts
649
747
  include Aws::Structure
650
748
  end
651
749
 
652
- # @note When making an API call, you may pass DescribePageRequest
653
- # data as a hash:
654
- #
655
- # {
656
- # page_id: "SsmContactsArn", # required
657
- # }
658
- #
659
750
  # @!attribute [rw] page_id
660
751
  # The ID of the engagement to a contact channel.
661
752
  # @return [String]
@@ -781,13 +872,6 @@ module Aws::SSMContacts
781
872
  include Aws::Structure
782
873
  end
783
874
 
784
- # @note When making an API call, you may pass GetContactChannelRequest
785
- # data as a hash:
786
- #
787
- # {
788
- # contact_channel_id: "SsmContactsArn", # required
789
- # }
790
- #
791
875
  # @!attribute [rw] contact_channel_id
792
876
  # The Amazon Resource Name (ARN) of the contact channel you want
793
877
  # information about.
@@ -840,13 +924,6 @@ module Aws::SSMContacts
840
924
  include Aws::Structure
841
925
  end
842
926
 
843
- # @note When making an API call, you may pass GetContactPolicyRequest
844
- # data as a hash:
845
- #
846
- # {
847
- # contact_arn: "SsmContactsArn", # required
848
- # }
849
- #
850
927
  # @!attribute [rw] contact_arn
851
928
  # The Amazon Resource Name (ARN) of the contact or escalation plan.
852
929
  # @return [String]
@@ -877,13 +954,6 @@ module Aws::SSMContacts
877
954
  include Aws::Structure
878
955
  end
879
956
 
880
- # @note When making an API call, you may pass GetContactRequest
881
- # data as a hash:
882
- #
883
- # {
884
- # contact_id: "SsmContactsArn", # required
885
- # }
886
- #
887
957
  # @!attribute [rw] contact_id
888
958
  # The Amazon Resource Name (ARN) of the contact or escalation plan.
889
959
  # @return [String]
@@ -930,6 +1000,137 @@ module Aws::SSMContacts
930
1000
  include Aws::Structure
931
1001
  end
932
1002
 
1003
+ # @!attribute [rw] rotation_id
1004
+ # The Amazon Resource Name (ARN) of the overridden rotation to
1005
+ # retrieve information about.
1006
+ # @return [String]
1007
+ #
1008
+ # @!attribute [rw] rotation_override_id
1009
+ # The Amazon Resource Name (ARN) of the on-call rotation override to
1010
+ # retrieve information about.
1011
+ # @return [String]
1012
+ #
1013
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/GetRotationOverrideRequest AWS API Documentation
1014
+ #
1015
+ class GetRotationOverrideRequest < Struct.new(
1016
+ :rotation_id,
1017
+ :rotation_override_id)
1018
+ SENSITIVE = []
1019
+ include Aws::Structure
1020
+ end
1021
+
1022
+ # @!attribute [rw] rotation_override_id
1023
+ # The Amazon Resource Name (ARN) of the override to an on-call
1024
+ # rotation.
1025
+ # @return [String]
1026
+ #
1027
+ # @!attribute [rw] rotation_arn
1028
+ # The Amazon Resource Name (ARN) of the on-call rotation that was
1029
+ # overridden.
1030
+ # @return [String]
1031
+ #
1032
+ # @!attribute [rw] new_contact_ids
1033
+ # The Amazon Resource Names (ARNs) of the contacts assigned to the
1034
+ # override of the on-call rotation.
1035
+ # @return [Array<String>]
1036
+ #
1037
+ # @!attribute [rw] start_time
1038
+ # The date and time when the override goes into effect.
1039
+ # @return [Time]
1040
+ #
1041
+ # @!attribute [rw] end_time
1042
+ # The date and time when the override ends.
1043
+ # @return [Time]
1044
+ #
1045
+ # @!attribute [rw] create_time
1046
+ # The date and time when the override was created.
1047
+ # @return [Time]
1048
+ #
1049
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/GetRotationOverrideResult AWS API Documentation
1050
+ #
1051
+ class GetRotationOverrideResult < Struct.new(
1052
+ :rotation_override_id,
1053
+ :rotation_arn,
1054
+ :new_contact_ids,
1055
+ :start_time,
1056
+ :end_time,
1057
+ :create_time)
1058
+ SENSITIVE = []
1059
+ include Aws::Structure
1060
+ end
1061
+
1062
+ # @!attribute [rw] rotation_id
1063
+ # The Amazon Resource Name (ARN) of the on-call rotation to retrieve
1064
+ # information about.
1065
+ # @return [String]
1066
+ #
1067
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/GetRotationRequest AWS API Documentation
1068
+ #
1069
+ class GetRotationRequest < Struct.new(
1070
+ :rotation_id)
1071
+ SENSITIVE = []
1072
+ include Aws::Structure
1073
+ end
1074
+
1075
+ # @!attribute [rw] rotation_arn
1076
+ # The Amazon Resource Name (ARN) of the on-call rotation.
1077
+ # @return [String]
1078
+ #
1079
+ # @!attribute [rw] name
1080
+ # The name of the on-call rotation.
1081
+ # @return [String]
1082
+ #
1083
+ # @!attribute [rw] contact_ids
1084
+ # The Amazon Resource Names (ARNs) of the contacts assigned to the
1085
+ # on-call rotation team.
1086
+ # @return [Array<String>]
1087
+ #
1088
+ # @!attribute [rw] start_time
1089
+ # The specified start time for the on-call rotation.
1090
+ # @return [Time]
1091
+ #
1092
+ # @!attribute [rw] time_zone_id
1093
+ # The time zone that the rotation’s activity is based on, in Internet
1094
+ # Assigned Numbers Authority (IANA) format.
1095
+ # @return [String]
1096
+ #
1097
+ # @!attribute [rw] recurrence
1098
+ # Specifies how long a rotation lasts before restarting at the
1099
+ # beginning of the shift order.
1100
+ # @return [Types::RecurrenceSettings]
1101
+ #
1102
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/GetRotationResult AWS API Documentation
1103
+ #
1104
+ class GetRotationResult < Struct.new(
1105
+ :rotation_arn,
1106
+ :name,
1107
+ :contact_ids,
1108
+ :start_time,
1109
+ :time_zone_id,
1110
+ :recurrence)
1111
+ SENSITIVE = []
1112
+ include Aws::Structure
1113
+ end
1114
+
1115
+ # Details about when an on-call rotation shift begins or ends.
1116
+ #
1117
+ # @!attribute [rw] hour_of_day
1118
+ # The hour when an on-call rotation shift begins or ends.
1119
+ # @return [Integer]
1120
+ #
1121
+ # @!attribute [rw] minute_of_hour
1122
+ # The minute when an on-call rotation shift begins or ends.
1123
+ # @return [Integer]
1124
+ #
1125
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/HandOffTime AWS API Documentation
1126
+ #
1127
+ class HandOffTime < Struct.new(
1128
+ :hour_of_day,
1129
+ :minute_of_hour)
1130
+ SENSITIVE = []
1131
+ include Aws::Structure
1132
+ end
1133
+
933
1134
  # Unexpected error occurred while processing the request.
934
1135
  #
935
1136
  # @!attribute [rw] message
@@ -948,15 +1149,6 @@ module Aws::SSMContacts
948
1149
  include Aws::Structure
949
1150
  end
950
1151
 
951
- # @note When making an API call, you may pass ListContactChannelsRequest
952
- # data as a hash:
953
- #
954
- # {
955
- # contact_id: "SsmContactsArn", # required
956
- # next_token: "PaginationToken",
957
- # max_results: 1,
958
- # }
959
- #
960
1152
  # @!attribute [rw] contact_id
961
1153
  # The Amazon Resource Name (ARN) of the contact.
962
1154
  # @return [String]
@@ -996,16 +1188,6 @@ module Aws::SSMContacts
996
1188
  include Aws::Structure
997
1189
  end
998
1190
 
999
- # @note When making an API call, you may pass ListContactsRequest
1000
- # data as a hash:
1001
- #
1002
- # {
1003
- # next_token: "PaginationToken",
1004
- # max_results: 1,
1005
- # alias_prefix: "ContactAlias",
1006
- # type: "PERSONAL", # accepts PERSONAL, ESCALATION
1007
- # }
1008
- #
1009
1191
  # @!attribute [rw] next_token
1010
1192
  # The pagination token to continue to the next page of results.
1011
1193
  # @return [String]
@@ -1054,19 +1236,6 @@ module Aws::SSMContacts
1054
1236
  include Aws::Structure
1055
1237
  end
1056
1238
 
1057
- # @note When making an API call, you may pass ListEngagementsRequest
1058
- # data as a hash:
1059
- #
1060
- # {
1061
- # next_token: "PaginationToken",
1062
- # max_results: 1,
1063
- # incident_id: "IncidentId",
1064
- # time_range_value: {
1065
- # start_time: Time.now,
1066
- # end_time: Time.now,
1067
- # },
1068
- # }
1069
- #
1070
1239
  # @!attribute [rw] next_token
1071
1240
  # The pagination token to continue to the next page of results.
1072
1241
  # @return [String]
@@ -1113,15 +1282,6 @@ module Aws::SSMContacts
1113
1282
  include Aws::Structure
1114
1283
  end
1115
1284
 
1116
- # @note When making an API call, you may pass ListPageReceiptsRequest
1117
- # data as a hash:
1118
- #
1119
- # {
1120
- # page_id: "SsmContactsArn", # required
1121
- # next_token: "PaginationToken",
1122
- # max_results: 1,
1123
- # }
1124
- #
1125
1285
  # @!attribute [rw] page_id
1126
1286
  # The Amazon Resource Name (ARN) of the engagement to a specific
1127
1287
  # contact channel.
@@ -1162,15 +1322,43 @@ module Aws::SSMContacts
1162
1322
  include Aws::Structure
1163
1323
  end
1164
1324
 
1165
- # @note When making an API call, you may pass ListPagesByContactRequest
1166
- # data as a hash:
1325
+ # @!attribute [rw] next_token
1326
+ # A token to start the list. Use this token to get the next set of
1327
+ # results.
1328
+ # @return [String]
1329
+ #
1330
+ # @!attribute [rw] page_id
1331
+ # The Amazon Resource Name (ARN) of the contact engaged for the
1332
+ # incident.
1333
+ # @return [String]
1334
+ #
1335
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ListPageResolutionsRequest AWS API Documentation
1336
+ #
1337
+ class ListPageResolutionsRequest < Struct.new(
1338
+ :next_token,
1339
+ :page_id)
1340
+ SENSITIVE = []
1341
+ include Aws::Structure
1342
+ end
1343
+
1344
+ # @!attribute [rw] next_token
1345
+ # The token for the next set of items to return. Use this token to get
1346
+ # the next set of results.
1347
+ # @return [String]
1348
+ #
1349
+ # @!attribute [rw] page_resolutions
1350
+ # Information about the resolution for an engagement.
1351
+ # @return [Array<Types::ResolutionContact>]
1167
1352
  #
1168
- # {
1169
- # contact_id: "SsmContactsArn", # required
1170
- # next_token: "PaginationToken",
1171
- # max_results: 1,
1172
- # }
1353
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ListPageResolutionsResult AWS API Documentation
1173
1354
  #
1355
+ class ListPageResolutionsResult < Struct.new(
1356
+ :next_token,
1357
+ :page_resolutions)
1358
+ SENSITIVE = []
1359
+ include Aws::Structure
1360
+ end
1361
+
1174
1362
  # @!attribute [rw] contact_id
1175
1363
  # The Amazon Resource Name (ARN) of the contact you are retrieving
1176
1364
  # engagements for.
@@ -1212,15 +1400,6 @@ module Aws::SSMContacts
1212
1400
  include Aws::Structure
1213
1401
  end
1214
1402
 
1215
- # @note When making an API call, you may pass ListPagesByEngagementRequest
1216
- # data as a hash:
1217
- #
1218
- # {
1219
- # engagement_id: "SsmContactsArn", # required
1220
- # next_token: "PaginationToken",
1221
- # max_results: 1,
1222
- # }
1223
- #
1224
1403
  # @!attribute [rw] engagement_id
1225
1404
  # The Amazon Resource Name (ARN) of the engagement.
1226
1405
  # @return [String]
@@ -1261,33 +1440,280 @@ module Aws::SSMContacts
1261
1440
  include Aws::Structure
1262
1441
  end
1263
1442
 
1264
- # @note When making an API call, you may pass ListTagsForResourceRequest
1265
- # data as a hash:
1443
+ # @!attribute [rw] rotation_start_time
1444
+ # The date and time a rotation would begin. The first shift is
1445
+ # calculated from this date and time.
1446
+ # @return [Time]
1266
1447
  #
1267
- # {
1268
- # resource_arn: "AmazonResourceName", # required
1269
- # }
1448
+ # @!attribute [rw] start_time
1449
+ # Used to filter the range of calculated shifts before sending the
1450
+ # response back to the user.
1451
+ # @return [Time]
1270
1452
  #
1271
- # @!attribute [rw] resource_arn
1272
- # The Amazon Resource Name (ARN) of the contact or escalation plan.
1273
- # @return [String]
1453
+ # @!attribute [rw] end_time
1454
+ # The date and time a rotation shift would end.
1455
+ # @return [Time]
1274
1456
  #
1275
- # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ListTagsForResourceRequest AWS API Documentation
1457
+ # @!attribute [rw] members
1458
+ # The contacts that would be assigned to a rotation.
1459
+ # @return [Array<String>]
1276
1460
  #
1277
- class ListTagsForResourceRequest < Struct.new(
1278
- :resource_arn)
1279
- SENSITIVE = []
1280
- include Aws::Structure
1281
- end
1282
-
1283
- # @!attribute [rw] tags
1284
- # The tags related to the contact or escalation plan.
1285
- # @return [Array<Types::Tag>]
1461
+ # @!attribute [rw] time_zone_id
1462
+ # The time zone the rotation’s activity would be based on, in Internet
1463
+ # Assigned Numbers Authority (IANA) format. For example:
1464
+ # "America/Los\_Angeles", "UTC", or "Asia/Seoul".
1465
+ # @return [String]
1286
1466
  #
1287
- # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ListTagsForResourceResult AWS API Documentation
1467
+ # @!attribute [rw] recurrence
1468
+ # Information about how long a rotation would last before restarting
1469
+ # at the beginning of the shift order.
1470
+ # @return [Types::RecurrenceSettings]
1288
1471
  #
1289
- class ListTagsForResourceResult < Struct.new(
1290
- :tags)
1472
+ # @!attribute [rw] overrides
1473
+ # Information about changes that would be made in a rotation override.
1474
+ # @return [Array<Types::PreviewOverride>]
1475
+ #
1476
+ # @!attribute [rw] next_token
1477
+ # A token to start the list. This token is used to get the next set of
1478
+ # results.
1479
+ # @return [String]
1480
+ #
1481
+ # @!attribute [rw] max_results
1482
+ # The maximum number of items to return for this call. The call also
1483
+ # returns a token that can be specified in a subsequent call to get
1484
+ # the next set of results.
1485
+ # @return [Integer]
1486
+ #
1487
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ListPreviewRotationShiftsRequest AWS API Documentation
1488
+ #
1489
+ class ListPreviewRotationShiftsRequest < Struct.new(
1490
+ :rotation_start_time,
1491
+ :start_time,
1492
+ :end_time,
1493
+ :members,
1494
+ :time_zone_id,
1495
+ :recurrence,
1496
+ :overrides,
1497
+ :next_token,
1498
+ :max_results)
1499
+ SENSITIVE = []
1500
+ include Aws::Structure
1501
+ end
1502
+
1503
+ # @!attribute [rw] rotation_shifts
1504
+ # Details about a rotation shift, including times, types, and
1505
+ # contacts.
1506
+ # @return [Array<Types::RotationShift>]
1507
+ #
1508
+ # @!attribute [rw] next_token
1509
+ # The token for the next set of items to return. This token is used to
1510
+ # get the next set of results.
1511
+ # @return [String]
1512
+ #
1513
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ListPreviewRotationShiftsResult AWS API Documentation
1514
+ #
1515
+ class ListPreviewRotationShiftsResult < Struct.new(
1516
+ :rotation_shifts,
1517
+ :next_token)
1518
+ SENSITIVE = []
1519
+ include Aws::Structure
1520
+ end
1521
+
1522
+ # @!attribute [rw] rotation_id
1523
+ # The Amazon Resource Name (ARN) of the rotation to retrieve
1524
+ # information about.
1525
+ # @return [String]
1526
+ #
1527
+ # @!attribute [rw] start_time
1528
+ # The date and time for the beginning of a time range for listing
1529
+ # overrides.
1530
+ # @return [Time]
1531
+ #
1532
+ # @!attribute [rw] end_time
1533
+ # The date and time for the end of a time range for listing overrides.
1534
+ # @return [Time]
1535
+ #
1536
+ # @!attribute [rw] next_token
1537
+ # A token to start the list. Use this token to get the next set of
1538
+ # results.
1539
+ # @return [String]
1540
+ #
1541
+ # @!attribute [rw] max_results
1542
+ # The maximum number of items to return for this call. The call also
1543
+ # returns a token that you can specify in a subsequent call to get the
1544
+ # next set of results.
1545
+ # @return [Integer]
1546
+ #
1547
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ListRotationOverridesRequest AWS API Documentation
1548
+ #
1549
+ class ListRotationOverridesRequest < Struct.new(
1550
+ :rotation_id,
1551
+ :start_time,
1552
+ :end_time,
1553
+ :next_token,
1554
+ :max_results)
1555
+ SENSITIVE = []
1556
+ include Aws::Structure
1557
+ end
1558
+
1559
+ # @!attribute [rw] rotation_overrides
1560
+ # A list of rotation overrides in the specified time range.
1561
+ # @return [Array<Types::RotationOverride>]
1562
+ #
1563
+ # @!attribute [rw] next_token
1564
+ # The token for the next set of items to return. Use this token to get
1565
+ # the next set of results.
1566
+ # @return [String]
1567
+ #
1568
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ListRotationOverridesResult AWS API Documentation
1569
+ #
1570
+ class ListRotationOverridesResult < Struct.new(
1571
+ :rotation_overrides,
1572
+ :next_token)
1573
+ SENSITIVE = []
1574
+ include Aws::Structure
1575
+ end
1576
+
1577
+ # @!attribute [rw] rotation_id
1578
+ # The Amazon Resource Name (ARN) of the rotation to retrieve shift
1579
+ # information about.
1580
+ # @return [String]
1581
+ #
1582
+ # @!attribute [rw] start_time
1583
+ # The date and time for the beginning of the time range to list shifts
1584
+ # for.
1585
+ # @return [Time]
1586
+ #
1587
+ # @!attribute [rw] end_time
1588
+ # The date and time for the end of the time range to list shifts for.
1589
+ # @return [Time]
1590
+ #
1591
+ # @!attribute [rw] next_token
1592
+ # A token to start the list. Use this token to get the next set of
1593
+ # results.
1594
+ # @return [String]
1595
+ #
1596
+ # @!attribute [rw] max_results
1597
+ # The maximum number of items to return for this call. The call also
1598
+ # returns a token that you can specify in a subsequent call to get the
1599
+ # next set of results.
1600
+ # @return [Integer]
1601
+ #
1602
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ListRotationShiftsRequest AWS API Documentation
1603
+ #
1604
+ class ListRotationShiftsRequest < Struct.new(
1605
+ :rotation_id,
1606
+ :start_time,
1607
+ :end_time,
1608
+ :next_token,
1609
+ :max_results)
1610
+ SENSITIVE = []
1611
+ include Aws::Structure
1612
+ end
1613
+
1614
+ # @!attribute [rw] rotation_shifts
1615
+ # Information about shifts that meet the filter criteria.
1616
+ # @return [Array<Types::RotationShift>]
1617
+ #
1618
+ # @!attribute [rw] next_token
1619
+ # The token for the next set of items to return. Use this token to get
1620
+ # the next set of results.
1621
+ # @return [String]
1622
+ #
1623
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ListRotationShiftsResult AWS API Documentation
1624
+ #
1625
+ class ListRotationShiftsResult < Struct.new(
1626
+ :rotation_shifts,
1627
+ :next_token)
1628
+ SENSITIVE = []
1629
+ include Aws::Structure
1630
+ end
1631
+
1632
+ # @!attribute [rw] rotation_name_prefix
1633
+ # A filter to include rotations in list results based on their common
1634
+ # prefix. For example, entering prod returns a list of all rotation
1635
+ # names that begin with `prod`, such as `production` and `prod-1`.
1636
+ # @return [String]
1637
+ #
1638
+ # @!attribute [rw] next_token
1639
+ # A token to start the list. Use this token to get the next set of
1640
+ # results.
1641
+ # @return [String]
1642
+ #
1643
+ # @!attribute [rw] max_results
1644
+ # The maximum number of items to return for this call. The call also
1645
+ # returns a token that you can specify in a subsequent call to get the
1646
+ # next set of results.
1647
+ # @return [Integer]
1648
+ #
1649
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ListRotationsRequest AWS API Documentation
1650
+ #
1651
+ class ListRotationsRequest < Struct.new(
1652
+ :rotation_name_prefix,
1653
+ :next_token,
1654
+ :max_results)
1655
+ SENSITIVE = []
1656
+ include Aws::Structure
1657
+ end
1658
+
1659
+ # @!attribute [rw] next_token
1660
+ # The token for the next set of items to return. Use this token to get
1661
+ # the next set of results.
1662
+ # @return [String]
1663
+ #
1664
+ # @!attribute [rw] rotations
1665
+ # Information about rotations that meet the filter criteria.
1666
+ # @return [Array<Types::Rotation>]
1667
+ #
1668
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ListRotationsResult AWS API Documentation
1669
+ #
1670
+ class ListRotationsResult < Struct.new(
1671
+ :next_token,
1672
+ :rotations)
1673
+ SENSITIVE = []
1674
+ include Aws::Structure
1675
+ end
1676
+
1677
+ # @!attribute [rw] resource_arn
1678
+ # The Amazon Resource Name (ARN) of the contact or escalation plan.
1679
+ # @return [String]
1680
+ #
1681
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ListTagsForResourceRequest AWS API Documentation
1682
+ #
1683
+ class ListTagsForResourceRequest < Struct.new(
1684
+ :resource_arn)
1685
+ SENSITIVE = []
1686
+ include Aws::Structure
1687
+ end
1688
+
1689
+ # @!attribute [rw] tags
1690
+ # The tags related to the contact or escalation plan.
1691
+ # @return [Array<Types::Tag>]
1692
+ #
1693
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ListTagsForResourceResult AWS API Documentation
1694
+ #
1695
+ class ListTagsForResourceResult < Struct.new(
1696
+ :tags)
1697
+ SENSITIVE = []
1698
+ include Aws::Structure
1699
+ end
1700
+
1701
+ # Information about on-call rotations that recur monthly.
1702
+ #
1703
+ # @!attribute [rw] day_of_month
1704
+ # The day of the month when monthly recurring on-call rotations begin.
1705
+ # @return [Integer]
1706
+ #
1707
+ # @!attribute [rw] hand_off_time
1708
+ # The time of day when a monthly recurring on-call shift rotation
1709
+ # begins.
1710
+ # @return [Types::HandOffTime]
1711
+ #
1712
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/MonthlySetting AWS API Documentation
1713
+ #
1714
+ class MonthlySetting < Struct.new(
1715
+ :day_of_month,
1716
+ :hand_off_time)
1291
1717
  SENSITIVE = []
1292
1718
  include Aws::Structure
1293
1719
  end
@@ -1341,53 +1767,53 @@ module Aws::SSMContacts
1341
1767
  include Aws::Structure
1342
1768
  end
1343
1769
 
1344
- # The stages that an escalation plan or engagement plan engages contacts
1345
- # and contact methods in.
1346
- #
1347
- # @note When making an API call, you may pass Plan
1348
- # data as a hash:
1349
- #
1350
- # {
1351
- # stages: [ # required
1352
- # {
1353
- # duration_in_minutes: 1, # required
1354
- # targets: [ # required
1355
- # {
1356
- # channel_target_info: {
1357
- # contact_channel_id: "SsmContactsArn", # required
1358
- # retry_interval_in_minutes: 1,
1359
- # },
1360
- # contact_target_info: {
1361
- # contact_id: "SsmContactsArn",
1362
- # is_essential: false, # required
1363
- # },
1364
- # },
1365
- # ],
1366
- # },
1367
- # ],
1368
- # }
1770
+ # Information about the stages and on-call rotation teams associated
1771
+ # with an escalation plan or engagement plan.
1369
1772
  #
1370
1773
  # @!attribute [rw] stages
1371
1774
  # A list of stages that the escalation plan or engagement plan uses to
1372
1775
  # engage contacts and contact methods.
1373
1776
  # @return [Array<Types::Stage>]
1374
1777
  #
1778
+ # @!attribute [rw] rotation_ids
1779
+ # The Amazon Resource Names (ARNs) of the on-call rotations associated
1780
+ # with the plan.
1781
+ # @return [Array<String>]
1782
+ #
1375
1783
  # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/Plan AWS API Documentation
1376
1784
  #
1377
1785
  class Plan < Struct.new(
1378
- :stages)
1786
+ :stages,
1787
+ :rotation_ids)
1379
1788
  SENSITIVE = []
1380
1789
  include Aws::Structure
1381
1790
  end
1382
1791
 
1383
- # @note When making an API call, you may pass PutContactPolicyRequest
1384
- # data as a hash:
1792
+ # Information about contacts and times that an on-call override
1793
+ # replaces.
1794
+ #
1795
+ # @!attribute [rw] new_members
1796
+ # Information about contacts to add to an on-call rotation override.
1797
+ # @return [Array<String>]
1798
+ #
1799
+ # @!attribute [rw] start_time
1800
+ # Information about the time a rotation override would begin.
1801
+ # @return [Time]
1802
+ #
1803
+ # @!attribute [rw] end_time
1804
+ # Information about the time a rotation override would end.
1805
+ # @return [Time]
1385
1806
  #
1386
- # {
1387
- # contact_arn: "SsmContactsArn", # required
1388
- # policy: "Policy", # required
1389
- # }
1807
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/PreviewOverride AWS API Documentation
1390
1808
  #
1809
+ class PreviewOverride < Struct.new(
1810
+ :new_members,
1811
+ :start_time,
1812
+ :end_time)
1813
+ SENSITIVE = []
1814
+ include Aws::Structure
1815
+ end
1816
+
1391
1817
  # @!attribute [rw] contact_arn
1392
1818
  # The Amazon Resource Name (ARN) of the contact or escalation plan.
1393
1819
  # @return [String]
@@ -1440,6 +1866,82 @@ module Aws::SSMContacts
1440
1866
  include Aws::Structure
1441
1867
  end
1442
1868
 
1869
+ # Information about when an on-call rotation is in effect and how long
1870
+ # the rotation period lasts.
1871
+ #
1872
+ # @!attribute [rw] monthly_settings
1873
+ # Information about on-call rotations that recur monthly.
1874
+ # @return [Array<Types::MonthlySetting>]
1875
+ #
1876
+ # @!attribute [rw] weekly_settings
1877
+ # Information about on-call rotations that recur weekly.
1878
+ # @return [Array<Types::WeeklySetting>]
1879
+ #
1880
+ # @!attribute [rw] daily_settings
1881
+ # Information about on-call rotations that recur daily.
1882
+ # @return [Array<Types::HandOffTime>]
1883
+ #
1884
+ # @!attribute [rw] number_of_on_calls
1885
+ # The number of contacts, or shift team members designated to be on
1886
+ # call concurrently during a shift. For example, in an on-call
1887
+ # schedule containing ten contacts, a value of `2` designates that two
1888
+ # of them are on call at any given time.
1889
+ # @return [Integer]
1890
+ #
1891
+ # @!attribute [rw] shift_coverages
1892
+ # Information about the days of the week included in on-call rotation
1893
+ # coverage.
1894
+ # @return [Hash<String,Array<Types::CoverageTime>>]
1895
+ #
1896
+ # @!attribute [rw] recurrence_multiplier
1897
+ # The number of days, weeks, or months a single rotation lasts.
1898
+ # @return [Integer]
1899
+ #
1900
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/RecurrenceSettings AWS API Documentation
1901
+ #
1902
+ class RecurrenceSettings < Struct.new(
1903
+ :monthly_settings,
1904
+ :weekly_settings,
1905
+ :daily_settings,
1906
+ :number_of_on_calls,
1907
+ :shift_coverages,
1908
+ :recurrence_multiplier)
1909
+ SENSITIVE = []
1910
+ include Aws::Structure
1911
+ end
1912
+
1913
+ # Information about the engagement resolution steps. The resolution
1914
+ # starts from the first contact, which can be an escalation plan, then
1915
+ # resolves to an on-call rotation, and finally to a personal contact.
1916
+ #
1917
+ # The `ResolutionContact` structure describes the information for each
1918
+ # node or step in that process. It contains information about different
1919
+ # contact types, such as the escalation, rotation, and personal
1920
+ # contacts.
1921
+ #
1922
+ # @!attribute [rw] contact_arn
1923
+ # The Amazon Resource Name (ARN) of a contact in the engagement
1924
+ # resolution process.
1925
+ # @return [String]
1926
+ #
1927
+ # @!attribute [rw] type
1928
+ # The type of contact for a resolution step.
1929
+ # @return [String]
1930
+ #
1931
+ # @!attribute [rw] stage_index
1932
+ # The stage in the escalation plan that resolves to this contact.
1933
+ # @return [Integer]
1934
+ #
1935
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ResolutionContact AWS API Documentation
1936
+ #
1937
+ class ResolutionContact < Struct.new(
1938
+ :contact_arn,
1939
+ :type,
1940
+ :stage_index)
1941
+ SENSITIVE = []
1942
+ include Aws::Structure
1943
+ end
1944
+
1443
1945
  # Request references a resource that doesn't exist.
1444
1946
  #
1445
1947
  # @!attribute [rw] message
@@ -1463,13 +1965,120 @@ module Aws::SSMContacts
1463
1965
  include Aws::Structure
1464
1966
  end
1465
1967
 
1466
- # @note When making an API call, you may pass SendActivationCodeRequest
1467
- # data as a hash:
1968
+ # Information about a rotation in an on-call schedule.
1969
+ #
1970
+ # @!attribute [rw] rotation_arn
1971
+ # The Amazon Resource Name (ARN) of the rotation.
1972
+ # @return [String]
1973
+ #
1974
+ # @!attribute [rw] name
1975
+ # The name of the rotation.
1976
+ # @return [String]
1977
+ #
1978
+ # @!attribute [rw] contact_ids
1979
+ # The Amazon Resource Names (ARNs) of the contacts assigned to the
1980
+ # rotation team.
1981
+ # @return [Array<String>]
1982
+ #
1983
+ # @!attribute [rw] start_time
1984
+ # The date and time the rotation becomes active.
1985
+ # @return [Time]
1986
+ #
1987
+ # @!attribute [rw] time_zone_id
1988
+ # The time zone the rotation’s activity is based on, in Internet
1989
+ # Assigned Numbers Authority (IANA) format. For example:
1990
+ # "America/Los\_Angeles", "UTC", or "Asia/Seoul".
1991
+ # @return [String]
1992
+ #
1993
+ # @!attribute [rw] recurrence
1994
+ # Information about when an on-call rotation is in effect and how long
1995
+ # the rotation period lasts.
1996
+ # @return [Types::RecurrenceSettings]
1997
+ #
1998
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/Rotation AWS API Documentation
1999
+ #
2000
+ class Rotation < Struct.new(
2001
+ :rotation_arn,
2002
+ :name,
2003
+ :contact_ids,
2004
+ :start_time,
2005
+ :time_zone_id,
2006
+ :recurrence)
2007
+ SENSITIVE = []
2008
+ include Aws::Structure
2009
+ end
2010
+
2011
+ # Information about an override specified for an on-call rotation.
2012
+ #
2013
+ # @!attribute [rw] rotation_override_id
2014
+ # The Amazon Resource Name (ARN) of the override to an on-call
2015
+ # rotation.
2016
+ # @return [String]
2017
+ #
2018
+ # @!attribute [rw] new_contact_ids
2019
+ # The Amazon Resource Names (ARNs) of the contacts assigned to the
2020
+ # override of the on-call rotation.
2021
+ # @return [Array<String>]
2022
+ #
2023
+ # @!attribute [rw] start_time
2024
+ # The time a rotation override begins.
2025
+ # @return [Time]
2026
+ #
2027
+ # @!attribute [rw] end_time
2028
+ # The time a rotation override ends.
2029
+ # @return [Time]
2030
+ #
2031
+ # @!attribute [rw] create_time
2032
+ # The time a rotation override was created.
2033
+ # @return [Time]
2034
+ #
2035
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/RotationOverride AWS API Documentation
2036
+ #
2037
+ class RotationOverride < Struct.new(
2038
+ :rotation_override_id,
2039
+ :new_contact_ids,
2040
+ :start_time,
2041
+ :end_time,
2042
+ :create_time)
2043
+ SENSITIVE = []
2044
+ include Aws::Structure
2045
+ end
2046
+
2047
+ # Information about a shift that belongs to an on-call rotation.
2048
+ #
2049
+ # @!attribute [rw] contact_ids
2050
+ # The Amazon Resource Names (ARNs) of the contacts who are part of the
2051
+ # shift rotation.
2052
+ # @return [Array<String>]
2053
+ #
2054
+ # @!attribute [rw] start_time
2055
+ # The time a shift rotation begins.
2056
+ # @return [Time]
2057
+ #
2058
+ # @!attribute [rw] end_time
2059
+ # The time a shift rotation ends.
2060
+ # @return [Time]
2061
+ #
2062
+ # @!attribute [rw] type
2063
+ # The type of shift rotation.
2064
+ # @return [String]
2065
+ #
2066
+ # @!attribute [rw] shift_details
2067
+ # Additional information about an on-call rotation shift.
2068
+ # @return [Types::ShiftDetails]
1468
2069
  #
1469
- # {
1470
- # contact_channel_id: "SsmContactsArn", # required
1471
- # }
2070
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/RotationShift AWS API Documentation
1472
2071
  #
2072
+ class RotationShift < Struct.new(
2073
+ :contact_ids,
2074
+ :start_time,
2075
+ :end_time,
2076
+ :type,
2077
+ :shift_details)
2078
+ SENSITIVE = []
2079
+ include Aws::Structure
2080
+ end
2081
+
1473
2082
  # @!attribute [rw] contact_channel_id
1474
2083
  # The Amazon Resource Name (ARN) of the contact channel.
1475
2084
  # @return [String]
@@ -1519,28 +2128,25 @@ module Aws::SSMContacts
1519
2128
  include Aws::Structure
1520
2129
  end
1521
2130
 
2131
+ # Information about overrides to an on-call rotation shift.
2132
+ #
2133
+ # @!attribute [rw] overridden_contact_ids
2134
+ # The Amazon Resources Names (ARNs) of the contacts who were replaced
2135
+ # in a shift when an override was created. If the override is deleted,
2136
+ # these contacts are restored to the shift.
2137
+ # @return [Array<String>]
2138
+ #
2139
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/ShiftDetails AWS API Documentation
2140
+ #
2141
+ class ShiftDetails < Struct.new(
2142
+ :overridden_contact_ids)
2143
+ SENSITIVE = []
2144
+ include Aws::Structure
2145
+ end
2146
+
1522
2147
  # A set amount of time that an escalation plan or engagement plan
1523
2148
  # engages the specified contacts or contact methods.
1524
2149
  #
1525
- # @note When making an API call, you may pass Stage
1526
- # data as a hash:
1527
- #
1528
- # {
1529
- # duration_in_minutes: 1, # required
1530
- # targets: [ # required
1531
- # {
1532
- # channel_target_info: {
1533
- # contact_channel_id: "SsmContactsArn", # required
1534
- # retry_interval_in_minutes: 1,
1535
- # },
1536
- # contact_target_info: {
1537
- # contact_id: "SsmContactsArn",
1538
- # is_essential: false, # required
1539
- # },
1540
- # },
1541
- # ],
1542
- # }
1543
- #
1544
2150
  # @!attribute [rw] duration_in_minutes
1545
2151
  # The time to wait until beginning the next stage. The duration can
1546
2152
  # only be set to 0 if a target is specified.
@@ -1560,20 +2166,6 @@ module Aws::SSMContacts
1560
2166
  include Aws::Structure
1561
2167
  end
1562
2168
 
1563
- # @note When making an API call, you may pass StartEngagementRequest
1564
- # data as a hash:
1565
- #
1566
- # {
1567
- # contact_id: "SsmContactsArn", # required
1568
- # sender: "Sender", # required
1569
- # subject: "Subject", # required
1570
- # content: "Content", # required
1571
- # public_subject: "PublicSubject",
1572
- # public_content: "PublicContent",
1573
- # incident_id: "IncidentId",
1574
- # idempotency_token: "IdempotencyToken",
1575
- # }
1576
- #
1577
2169
  # @!attribute [rw] contact_id
1578
2170
  # The Amazon Resource Name (ARN) of the contact being engaged.
1579
2171
  # @return [String]
@@ -1641,14 +2233,6 @@ module Aws::SSMContacts
1641
2233
  include Aws::Structure
1642
2234
  end
1643
2235
 
1644
- # @note When making an API call, you may pass StopEngagementRequest
1645
- # data as a hash:
1646
- #
1647
- # {
1648
- # engagement_id: "SsmContactsArn", # required
1649
- # reason: "StopReason",
1650
- # }
1651
- #
1652
2236
  # @!attribute [rw] engagement_id
1653
2237
  # The Amazon Resource Name (ARN) of the engagement.
1654
2238
  # @return [String]
@@ -1672,14 +2256,6 @@ module Aws::SSMContacts
1672
2256
 
1673
2257
  # A container of a key-value name pair.
1674
2258
  #
1675
- # @note When making an API call, you may pass Tag
1676
- # data as a hash:
1677
- #
1678
- # {
1679
- # key: "TagKey",
1680
- # value: "TagValue",
1681
- # }
1682
- #
1683
2259
  # @!attribute [rw] key
1684
2260
  # Name of the object key.
1685
2261
  # @return [String]
@@ -1697,19 +2273,6 @@ module Aws::SSMContacts
1697
2273
  include Aws::Structure
1698
2274
  end
1699
2275
 
1700
- # @note When making an API call, you may pass TagResourceRequest
1701
- # data as a hash:
1702
- #
1703
- # {
1704
- # resource_arn: "AmazonResourceName", # required
1705
- # tags: [ # required
1706
- # {
1707
- # key: "TagKey",
1708
- # value: "TagValue",
1709
- # },
1710
- # ],
1711
- # }
1712
- #
1713
2276
  # @!attribute [rw] resource_arn
1714
2277
  # The Amazon Resource Name (ARN) of the contact or escalation plan.
1715
2278
  # @return [String]
@@ -1734,20 +2297,6 @@ module Aws::SSMContacts
1734
2297
 
1735
2298
  # The contact or contact channel that's being engaged.
1736
2299
  #
1737
- # @note When making an API call, you may pass Target
1738
- # data as a hash:
1739
- #
1740
- # {
1741
- # channel_target_info: {
1742
- # contact_channel_id: "SsmContactsArn", # required
1743
- # retry_interval_in_minutes: 1,
1744
- # },
1745
- # contact_target_info: {
1746
- # contact_id: "SsmContactsArn",
1747
- # is_essential: false, # required
1748
- # },
1749
- # }
1750
- #
1751
2300
  # @!attribute [rw] channel_target_info
1752
2301
  # Information about the contact channel Incident Manager is engaging.
1753
2302
  # @return [Types::ChannelTargetInfo]
@@ -1795,14 +2344,6 @@ module Aws::SSMContacts
1795
2344
 
1796
2345
  # A range of between two set times
1797
2346
  #
1798
- # @note When making an API call, you may pass TimeRange
1799
- # data as a hash:
1800
- #
1801
- # {
1802
- # start_time: Time.now,
1803
- # end_time: Time.now,
1804
- # }
1805
- #
1806
2347
  # @!attribute [rw] start_time
1807
2348
  # The start of the time range.
1808
2349
  # @return [Time]
@@ -1820,14 +2361,6 @@ module Aws::SSMContacts
1820
2361
  include Aws::Structure
1821
2362
  end
1822
2363
 
1823
- # @note When making an API call, you may pass UntagResourceRequest
1824
- # data as a hash:
1825
- #
1826
- # {
1827
- # resource_arn: "AmazonResourceName", # required
1828
- # tag_keys: ["TagKey"], # required
1829
- # }
1830
- #
1831
2364
  # @!attribute [rw] resource_arn
1832
2365
  # The Amazon Resource Name (ARN) of the contact or escalation plan.
1833
2366
  # @return [String]
@@ -1849,17 +2382,6 @@ module Aws::SSMContacts
1849
2382
  #
1850
2383
  class UntagResourceResult < Aws::EmptyStructure; end
1851
2384
 
1852
- # @note When making an API call, you may pass UpdateContactChannelRequest
1853
- # data as a hash:
1854
- #
1855
- # {
1856
- # contact_channel_id: "SsmContactsArn", # required
1857
- # name: "ChannelName",
1858
- # delivery_address: {
1859
- # simple_address: "SimpleAddress",
1860
- # },
1861
- # }
1862
- #
1863
2385
  # @!attribute [rw] contact_channel_id
1864
2386
  # The Amazon Resource Name (ARN) of the contact channel you want to
1865
2387
  # update.
@@ -1888,33 +2410,6 @@ module Aws::SSMContacts
1888
2410
  #
1889
2411
  class UpdateContactChannelResult < Aws::EmptyStructure; end
1890
2412
 
1891
- # @note When making an API call, you may pass UpdateContactRequest
1892
- # data as a hash:
1893
- #
1894
- # {
1895
- # contact_id: "SsmContactsArn", # required
1896
- # display_name: "ContactName",
1897
- # plan: {
1898
- # stages: [ # required
1899
- # {
1900
- # duration_in_minutes: 1, # required
1901
- # targets: [ # required
1902
- # {
1903
- # channel_target_info: {
1904
- # contact_channel_id: "SsmContactsArn", # required
1905
- # retry_interval_in_minutes: 1,
1906
- # },
1907
- # contact_target_info: {
1908
- # contact_id: "SsmContactsArn",
1909
- # is_essential: false, # required
1910
- # },
1911
- # },
1912
- # ],
1913
- # },
1914
- # ],
1915
- # },
1916
- # }
1917
- #
1918
2413
  # @!attribute [rw] contact_id
1919
2414
  # The Amazon Resource Name (ARN) of the contact or escalation plan
1920
2415
  # you're updating.
@@ -1944,6 +2439,60 @@ module Aws::SSMContacts
1944
2439
  #
1945
2440
  class UpdateContactResult < Aws::EmptyStructure; end
1946
2441
 
2442
+ # @!attribute [rw] rotation_id
2443
+ # The Amazon Resource Name (ARN) of the rotation to update.
2444
+ # @return [String]
2445
+ #
2446
+ # @!attribute [rw] contact_ids
2447
+ # The Amazon Resource Names (ARNs) of the contacts to include in the
2448
+ # updated rotation.
2449
+ #
2450
+ # The order in which you list the contacts is their shift order in the
2451
+ # rotation schedule.
2452
+ # @return [Array<String>]
2453
+ #
2454
+ # @!attribute [rw] start_time
2455
+ # The date and time the rotation goes into effect.
2456
+ # @return [Time]
2457
+ #
2458
+ # @!attribute [rw] time_zone_id
2459
+ # The time zone to base the updated rotation’s activity on, in
2460
+ # Internet Assigned Numbers Authority (IANA) format. For example:
2461
+ # "America/Los\_Angeles", "UTC", or "Asia/Seoul". For more
2462
+ # information, see the [Time Zone Database][1] on the IANA website.
2463
+ #
2464
+ # <note markdown="1"> Designators for time zones that don’t support Daylight Savings Time
2465
+ # Rules, such as Pacific Standard Time (PST) and Pacific Daylight Time
2466
+ # (PDT), aren't supported.
2467
+ #
2468
+ # </note>
2469
+ #
2470
+ #
2471
+ #
2472
+ # [1]: https://www.iana.org/time-zones
2473
+ # @return [String]
2474
+ #
2475
+ # @!attribute [rw] recurrence
2476
+ # Information about how long the updated rotation lasts before
2477
+ # restarting at the beginning of the shift order.
2478
+ # @return [Types::RecurrenceSettings]
2479
+ #
2480
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/UpdateRotationRequest AWS API Documentation
2481
+ #
2482
+ class UpdateRotationRequest < Struct.new(
2483
+ :rotation_id,
2484
+ :contact_ids,
2485
+ :start_time,
2486
+ :time_zone_id,
2487
+ :recurrence)
2488
+ SENSITIVE = []
2489
+ include Aws::Structure
2490
+ end
2491
+
2492
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/UpdateRotationResult AWS API Documentation
2493
+ #
2494
+ class UpdateRotationResult < Aws::EmptyStructure; end
2495
+
1947
2496
  # The input fails to satisfy the constraints specified by an Amazon Web
1948
2497
  # Services service.
1949
2498
  #
@@ -1987,5 +2536,26 @@ module Aws::SSMContacts
1987
2536
  include Aws::Structure
1988
2537
  end
1989
2538
 
2539
+ # Information about rotations that recur weekly.
2540
+ #
2541
+ # @!attribute [rw] day_of_week
2542
+ # The day of the week when weekly recurring on-call shift rotations
2543
+ # begins.
2544
+ # @return [String]
2545
+ #
2546
+ # @!attribute [rw] hand_off_time
2547
+ # The time of day when a weekly recurring on-call shift rotation
2548
+ # begins.
2549
+ # @return [Types::HandOffTime]
2550
+ #
2551
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ssm-contacts-2021-05-03/WeeklySetting AWS API Documentation
2552
+ #
2553
+ class WeeklySetting < Struct.new(
2554
+ :day_of_week,
2555
+ :hand_off_time)
2556
+ SENSITIVE = []
2557
+ include Aws::Structure
2558
+ end
2559
+
1990
2560
  end
1991
2561
  end