SSMContacts / Client / create_rotation

create_rotation#

SSMContacts.Client.create_rotation(**kwargs)#

Creates a rotation in an on-call schedule.

See also: AWS API Documentation

Request Syntax

response = client.create_rotation(
    Name='string',
    ContactIds=[
        'string',
    ],
    StartTime=datetime(2015, 1, 1),
    TimeZoneId='string',
    Recurrence={
        'MonthlySettings': [
            {
                'DayOfMonth': 123,
                'HandOffTime': {
                    'HourOfDay': 123,
                    'MinuteOfHour': 123
                }
            },
        ],
        'WeeklySettings': [
            {
                'DayOfWeek': 'MON'|'TUE'|'WED'|'THU'|'FRI'|'SAT'|'SUN',
                'HandOffTime': {
                    'HourOfDay': 123,
                    'MinuteOfHour': 123
                }
            },
        ],
        'DailySettings': [
            {
                'HourOfDay': 123,
                'MinuteOfHour': 123
            },
        ],
        'NumberOfOnCalls': 123,
        'ShiftCoverages': {
            'string': [
                {
                    'Start': {
                        'HourOfDay': 123,
                        'MinuteOfHour': 123
                    },
                    'End': {
                        'HourOfDay': 123,
                        'MinuteOfHour': 123
                    }
                },
            ]
        },
        'RecurrenceMultiplier': 123
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    IdempotencyToken='string'
)
Parameters:

  • Name (string) –

    [REQUIRED]

    The name of the rotation.

  • ContactIds (list) –

    [REQUIRED]

    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.

    • (string) –

  • StartTime (datetime) – The date and time that the rotation goes into effect.

  • TimeZoneId (string) –

    [REQUIRED]

    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.

    Note

    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.

  • Recurrence (dict) –

    [REQUIRED]

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

    • MonthlySettings (list) –

      Information about on-call rotations that recur monthly.

      • (dict) –

        Information about on-call rotations that recur monthly.

        • DayOfMonth (integer) – [REQUIRED]

          The day of the month when monthly recurring on-call rotations begin.

        • HandOffTime (dict) – [REQUIRED]

          The time of day when a monthly recurring on-call shift rotation begins.

          • HourOfDay (integer) – [REQUIRED]

            The hour when an on-call rotation shift begins or ends.

          • MinuteOfHour (integer) – [REQUIRED]

            The minute when an on-call rotation shift begins or ends.

    • WeeklySettings (list) –

      Information about on-call rotations that recur weekly.

      • (dict) –

        Information about rotations that recur weekly.

        • DayOfWeek (string) – [REQUIRED]

          The day of the week when weekly recurring on-call shift rotations begins.

        • HandOffTime (dict) – [REQUIRED]

          The time of day when a weekly recurring on-call shift rotation begins.

          • HourOfDay (integer) – [REQUIRED]

            The hour when an on-call rotation shift begins or ends.

          • MinuteOfHour (integer) – [REQUIRED]

            The minute when an on-call rotation shift begins or ends.

    • DailySettings (list) –

      Information about on-call rotations that recur daily.

      • (dict) –

        Details about when an on-call rotation shift begins or ends.

        • HourOfDay (integer) – [REQUIRED]

          The hour when an on-call rotation shift begins or ends.

        • MinuteOfHour (integer) – [REQUIRED]

          The minute when an on-call rotation shift begins or ends.

    • NumberOfOnCalls (integer) – [REQUIRED]

      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.

    • ShiftCoverages (dict) –

      Information about the days of the week included in on-call rotation coverage.

      • (string) –

        • (list) –

          • (dict) –

            Information about when an on-call shift begins and ends.

            • Start (dict) –

              Information about when the on-call rotation shift begins.

              • HourOfDay (integer) – [REQUIRED]

                The hour when an on-call rotation shift begins or ends.

              • MinuteOfHour (integer) – [REQUIRED]

                The minute when an on-call rotation shift begins or ends.

            • End (dict) –

              Information about when the on-call rotation shift ends.

              • HourOfDay (integer) – [REQUIRED]

                The hour when an on-call rotation shift begins or ends.

              • MinuteOfHour (integer) – [REQUIRED]

                The minute when an on-call rotation shift begins or ends.

    • RecurrenceMultiplier (integer) – [REQUIRED]

      The number of days, weeks, or months a single rotation lasts.

  • Tags (list) –

    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.

    • (dict) –

      A container of a key-value name pair.

      • Key (string) –

        Name of the object key.

      • Value (string) –

        Value of the tag.

  • IdempotencyToken (string) – A token that ensures that the operation is called only once with the specified details.

Return type:

dict

Returns:

Response Syntax

{
    'RotationArn': 'string'
}

Response Structure

  • (dict) –

    • RotationArn (string) –

      The Amazon Resource Name (ARN) of the created rotation.

Exceptions