Skip to content

CreateRotationRequest

Source code in docs_src/capo_ssm_contacts/types/create_rotation_request.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
class CreateRotationRequest(TypedDict, closed=True):
    name: "capo_ssm_contacts.types.rotation_name.RotationName"
    """<p>The name of the rotation.</p>"""
    contact_ids: (
        "capo_ssm_contacts.types.rotation_contacts_arn_list.RotationContactsArnList"
    )
    """<p>The Amazon Resource Names (ARNs) of the contacts to add to the rotation.</p> <note> <p>Only the <code>PERSONAL</code> contact type is supported. The contact types <code>ESCALATION</code> and <code>ONCALL_SCHEDULE</code> are not supported for this operation. </p> </note> <p>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 <a>UpdateRotation</a> operation.</p>"""
    start_time: NotRequired["capo_ssm_contacts.types.date_time.DateTime"]
    """<p>The date and time that the rotation goes into effect.</p>"""
    time_zone_id: "capo_ssm_contacts.types.time_zone_id.TimeZoneId"
    """<p>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 <a href="https://www.iana.org/time-zones">Time Zone Database</a> on the IANA website.</p> <note> <p>Designators for time zones that don’t support Daylight Savings Time rules, such as Pacific Standard Time (PST), are not supported.</p> </note>"""
    recurrence: "capo_ssm_contacts.types.recurrence_settings.RecurrenceSettings"
    """<p>Information about the rule that specifies when a shift's team members rotate.</p>"""
    tags: NotRequired["capo_ssm_contacts.types.tags_list.TagsList"]
    """<p>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 <a href="https://docs.aws.amazon.com/incident-manager/latest/userguide/tagging.html">Tagging Incident Manager resources</a> in the <i>Incident Manager User Guide</i>.</p>"""
    idempotency_token: NotRequired[
        "capo_ssm_contacts.types.idempotency_token.IdempotencyToken"
    ]
    """<p>A token that ensures that the operation is called only once with the specified details.</p>"""

contact_ids instance-attribute 

contact_ids: RotationContactsArnList

The Amazon Resource Names (ARNs) of the contacts to add to the rotation.

Only the PERSONAL contact type is supported. The contact types ESCALATION and ONCALL_SCHEDULE are not supported for this operation.

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.

idempotency_token instance-attribute 

idempotency_token: NotRequired[IdempotencyToken]

A token that ensures that the operation is called only once with the specified details.

name instance-attribute 

name: RotationName

The name of the rotation.

recurrence instance-attribute 

recurrence: RecurrenceSettings

Information about the rule that specifies when a shift's team members rotate.

start_time instance-attribute 

start_time: NotRequired[DateTime]

The date and time that the rotation goes into effect.

tags instance-attribute 

tags: NotRequired[TagsList]

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.

time_zone_id instance-attribute 

time_zone_id: TimeZoneId

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), are not supported.