:doc:`SecurityIncidentResponse <../../security-ir>` / Client / list_comments

*************
list_comments
*************



.. py:method:: SecurityIncidentResponse.Client.list_comments(**kwargs)

  

  Returns comments for a designated case.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/security-ir-2018-05-10/ListComments>`_  


  **Request Syntax**
  ::

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

    An optional string that, if supplied, must be copied from the output of a previous call to ListComments. When provided in this manner, the API fetches the next page of results.

    

  
  :type maxResults: integer
  :param maxResults: 

    Optional element for ListComments to limit the number of responses.

    

  
  :type caseId: string
  :param caseId: **[REQUIRED]** 

    Required element for ListComments to designate the case to query.

    

  
  
  :rtype: 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) --* 

        An optional string that, if supplied on subsequent calls to ListComments, allows the API to fetch the next page of results.

        
      

      - **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**
  
  *   :py:class:`SecurityIncidentResponse.Client.exceptions.ServiceQuotaExceededException`

  
  *   :py:class:`SecurityIncidentResponse.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`SecurityIncidentResponse.Client.exceptions.ValidationException`

  
  *   :py:class:`SecurityIncidentResponse.Client.exceptions.SecurityIncidentResponseNotActiveException`

  
  *   :py:class:`SecurityIncidentResponse.Client.exceptions.InternalServerException`

  
  *   :py:class:`SecurityIncidentResponse.Client.exceptions.ThrottlingException`

  
  *   :py:class:`SecurityIncidentResponse.Client.exceptions.ConflictException`

  
  *   :py:class:`SecurityIncidentResponse.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`SecurityIncidentResponse.Client.exceptions.InvalidTokenException`

  