SSMContacts / Client / list_rotation_overrides

list_rotation_overrides#

SSMContacts.Client.list_rotation_overrides(**kwargs)#

Retrieves a list of overrides currently specified for an on-call rotation.

See also: AWS API Documentation

Request Syntax

response = client.list_rotation_overrides(
    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 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.

  • 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

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

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.

    • 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.InternalServerException

  • SSMContacts.Client.exceptions.ResourceNotFoundException

  • SSMContacts.Client.exceptions.ThrottlingException

  • SSMContacts.Client.exceptions.ValidationException