Skip to content

ListCommentsRequest

Source code in docs_src/capo_security_ir/types/list_comments_request.py
class ListCommentsRequest(TypedDict, closed=True):
    next_token: NotRequired["str"]
    """<p>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. </p>"""
    max_results: NotRequired["int"]
    """<p>Optional element for ListComments to limit the number of responses.</p>"""
    case_id: "capo_security_ir.types.case_id.CaseId"
    """<p>Required element for ListComments to designate the case to query.</p>"""

case_id instance-attribute

case_id: CaseId

Required element for ListComments to designate the case to query.

max_results instance-attribute

max_results: NotRequired[int]

Optional element for ListComments to limit the number of responses.

next_token instance-attribute

next_token: NotRequired[str]

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.