SSMContacts / Client / list_rotation_shifts

list_rotation_shifts

SSMContacts.Client.list_rotation_shifts(**kwargs)

Returns a list of shifts generated by an existing rotation in the system.

See also: AWS API Documentation

Request Syntax

response = client.list_rotation_shifts(
    RotationId='string',
    StartTime=datetime(2015, 1, 1),
    EndTime=datetime(2015, 1, 1),
    NextToken='string',
    MaxResults=123
)
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.

  • 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

{
    'RotationShifts': [
        {
            'ContactIds': [
                'string',
            ],
            'StartTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1),
            'Type': 'REGULAR'|'OVERRIDDEN',
            'ShiftDetails': {
                'OverriddenContactIds': [
                    'string',
                ]
            }
        },
    ],
    'NextToken': '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) –

    • NextToken (string) –

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

Exceptions

  • SSMContacts.Client.exceptions.AccessDeniedException

  • SSMContacts.Client.exceptions.ConflictException

  • SSMContacts.Client.exceptions.InternalServerException

  • SSMContacts.Client.exceptions.ResourceNotFoundException

  • SSMContacts.Client.exceptions.ThrottlingException

  • SSMContacts.Client.exceptions.ValidationException