SecurityIncidentResponse / Paginator / ListComments

ListComments

class SecurityIncidentResponse.Paginator.ListComments

paginator = client.get_paginator('list_comments')

paginate(**kwargs)

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

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 for ListComments to designate 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': [
        {
            'commentId': 'string',
            'createdDate': datetime(2015, 1, 1),
            'lastUpdatedDate': datetime(2015, 1, 1),
            'creator': 'string',
            'lastUpdatedBy': 'string',
            'body': 'string'
        },
    ],
    'total': 123,
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • items (list) –

    Response element for ListComments providing the body, commentID, createDate, creator, lastUpdatedBy and lastUpdatedDate for each response.

    • (dict) –

      • commentId (string) –

      • createdDate (datetime) –

      • lastUpdatedDate (datetime) –

      • creator (string) –

      • lastUpdatedBy (string) –

      • body (string) –

  • total (integer) –

    Response element for ListComments identifying the number of responses.

  • NextToken (string) –

    A token to resume pagination.