SSMContacts / Paginator / ListRotationOverrides

ListRotationOverrides#

class SSMContacts.Paginator.ListRotationOverrides#
paginator = client.get_paginator('list_rotation_overrides')
paginate(**kwargs)#

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

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 information about.

  • StartTime (datetime) –

    [REQUIRED]

    The date and time for the beginning of a time range for listing overrides.

  • EndTime (datetime) –

    [REQUIRED]

    The date and time for the end of a time range for listing overrides.

  • 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

{
    'RotationOverrides': [
        {
            'RotationOverrideId': 'string',
            'NewContactIds': [
                'string',
            ],
            'StartTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1),
            'CreateTime': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

  • (dict) –

    • RotationOverrides (list) –

      A list of rotation overrides in the specified time range.

      • (dict) –

        Information about an override specified for an on-call rotation.

        • RotationOverrideId (string) –

          The Amazon Resource Name (ARN) of the override to an on-call rotation.

        • NewContactIds (list) –

          The Amazon Resource Names (ARNs) of the contacts assigned to the override of the on-call rotation.

          • (string) –

        • StartTime (datetime) –

          The time a rotation override begins.

        • EndTime (datetime) –

          The time a rotation override ends.

        • CreateTime (datetime) –

          The time a rotation override was created.