SSMContacts / Paginator / ListRotationShifts

ListRotationShifts#

class SSMContacts.Paginator.ListRotationShifts#
paginator = client.get_paginator('list_rotation_shifts')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from SSMContacts.Client.list_rotation_shifts().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    RotationId='string',
    StartTime=datetime(2015, 1, 1),
    EndTime=datetime(2015, 1, 1),
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:

  • RotationId (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the rotation to retrieve shift information about.

  • StartTime (datetime) – The date and time for the beginning of the time range to list shifts for.

  • EndTime (datetime) –

    [REQUIRED]

    The date and time for the end of the time range to list shifts for.

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'RotationShifts': [
        {
            'ContactIds': [
                'string',
            ],
            'StartTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1),
            'Type': 'REGULAR'|'OVERRIDDEN',
            'ShiftDetails': {
                'OverriddenContactIds': [
                    'string',
                ]
            }
        },
    ],

}

Response Structure

  • (dict) –

    • RotationShifts (list) –

      Information about shifts that meet the filter criteria.

      • (dict) –

        Information about a shift that belongs to an on-call rotation.

        • ContactIds (list) –

          The Amazon Resource Names (ARNs) of the contacts who are part of the shift rotation.

          • (string) –

        • StartTime (datetime) –

          The time a shift rotation begins.

        • EndTime (datetime) –

          The time a shift rotation ends.

        • Type (string) –

          The type of shift rotation.

        • ShiftDetails (dict) –

          Additional information about an on-call rotation shift.

          • OverriddenContactIds (list) –

            The Amazon Resources Names (ARNs) of the contacts who were replaced in a shift when an override was created. If the override is deleted, these contacts are restored to the shift.

            • (string) –