update_rotation
async
¶
update_rotation(
rotation_id: SsmContactsArn,
recurrence: RecurrenceSettings,
*,
config_overrides: Optional[AsyncSSMContactsClientConfig] = None,
contact_ids: Optional[RotationContactsArnList] = None,
start_time: Optional[DateTime] = None,
time_zone_id: Optional[TimeZoneId] = None,
) -> UpdateRotationResult
Updates the information specified for an on-call rotation.
Parameters:
-
rotation_id(SsmContactsArn) –The Amazon Resource Name (ARN) of the rotation to update.
-
contact_ids(Optional[RotationContactsArnList], default:None) –The Amazon Resource Names (ARNs) of the contacts to include in the updated rotation.
Only the
PERSONALcontact type is supported. The contact typesESCALATIONandONCALL_SCHEDULEare not supported for this operation.The order in which you list the contacts is their shift order in the rotation schedule.
-
start_time(Optional[DateTime], default:None) –The date and time the rotation goes into effect.
-
time_zone_id(Optional[TimeZoneId], default:None) –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), aren't supported.
-
recurrence(RecurrenceSettings) –Information about how long the updated rotation lasts before restarting at the beginning of the shift order.
Raises:
-
AccessDeniedException–You don't have sufficient access to perform this operation.
-
ConflictException–Updating or deleting a resource causes an inconsistent state.
-
InternalServerException–Unexpected error occurred while processing the request.
-
ResourceNotFoundException–Request references a resource that doesn't exist.
-
ThrottlingException–The request was denied due to request throttling.
-
ValidationException–The input fails to satisfy the constraints specified by an Amazon Web Services service.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_ssm_contacts/_services/async_ssm_contacts.py
2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 | |