SecurityIncidentResponse / Client / list_comments

list_comments#

SecurityIncidentResponse.Client.list_comments(**kwargs)#

Grants permissions to list and view comments for a designated case.

See also: AWS API Documentation

Request Syntax

response = client.list_comments(
    nextToken='string',
    maxResults=123,
    caseId='string'
)
Parameters:

  • nextToken (string) – Optional element.

  • maxResults (integer) – Optional element for ListComments to limit the number of responses.

  • caseId (string) –

    [REQUIRED]

    Required element for ListComments to designate the case to query.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'items': [
        {
            'commentId': 'string',
            'createdDate': datetime(2015, 1, 1),
            'lastUpdatedDate': datetime(2015, 1, 1),
            'creator': 'string',
            'lastUpdatedBy': 'string',
            'body': 'string'
        },
    ],
    'total': 123
}

Response Structure

  • (dict) –

    • nextToken (string) –

      Optional request elements.

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

Exceptions