SecurityIncidentResponse / Paginator / ListCaseEdits

ListCaseEdits#

class SecurityIncidentResponse.Paginator.ListCaseEdits#
paginator = client.get_paginator('list_case_edits')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from SecurityIncidentResponse.Client.list_case_edits().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    caseId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • caseId (string) –

    [REQUIRED]

    Required element used with ListCaseEdits to identify the case to query.

  • 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

{
    'items': [
        {
            'eventTimestamp': datetime(2015, 1, 1),
            'principal': 'string',
            'action': 'string',
            'message': 'string'
        },
    ],
    'total': 123,
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • items (list) –

      Response element for ListCaseEdits that includes the action, eventtimestamp, message, and principal for the response.

      • (dict) –

        • eventTimestamp (datetime) –

        • principal (string) –

        • action (string) –

        • message (string) –

    • total (integer) –

      Response element for ListCaseEdits that identifies the total number of edits.

    • NextToken (string) –

      A token to resume pagination.