SSMContacts / Client / list_rotations

list_rotations#

SSMContacts.Client.list_rotations(**kwargs)#

Retrieves a list of on-call rotations.

See also: AWS API Documentation

Request Syntax

response = client.list_rotations(
    RotationNamePrefix='string',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • RotationNamePrefix (string) – 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.

  • NextToken (string) – A token to start the list. Use this token to get the next set of results.

  • MaxResults (integer) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'Rotations': [
        {
            'RotationArn': 'string',
            '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
            }
        },
    ]
}

Response Structure

  • (dict) –

    • NextToken (string) –

      The token for the next set of items to return. Use this token to get the next set of results.

    • Rotations (list) –

      Information about rotations that meet the filter criteria.

      • (dict) –

        Information about a rotation in an on-call schedule.

        • RotationArn (string) –

          The Amazon Resource Name (ARN) of the rotation.

        • Name (string) –

          The name of the rotation.

        • ContactIds (list) –

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

          • (string) –

        • StartTime (datetime) –

          The date and time the rotation becomes active.

        • TimeZoneId (string) –

          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”.

        • Recurrence (dict) –

          Information about when an on-call rotation is in effect and how long the rotation period lasts.

          • MonthlySettings (list) –

            Information about on-call rotations that recur monthly.

            • (dict) –

              Information about on-call rotations that recur monthly.

              • DayOfMonth (integer) –

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

              • HandOffTime (dict) –

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

                • HourOfDay (integer) –

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

                • MinuteOfHour (integer) –

                  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) –

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

              • HandOffTime (dict) –

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

                • HourOfDay (integer) –

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

                • MinuteOfHour (integer) –

                  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) –

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

              • MinuteOfHour (integer) –

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

          • NumberOfOnCalls (integer) –

            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) –

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

                    • MinuteOfHour (integer) –

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

                  • End (dict) –

                    Information about when the on-call rotation shift ends.

                    • HourOfDay (integer) –

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

                    • MinuteOfHour (integer) –

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

          • RecurrenceMultiplier (integer) –

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

Exceptions