Skip to content

GetFindingsRequest

Source code in docs_src/capo_codeguru_security/types/get_findings_request.py
class GetFindingsRequest(TypedDict, closed=True):
    scan_name: "capo_codeguru_security.types.scan_name.ScanName"
    """<p>The name of the scan you want to retrieve findings from.</p>"""
    next_token: NotRequired["capo_codeguru_security.types.next_token.NextToken"]
    """<p>A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the <code>nextToken</code> value returned from the previous request to continue listing results after the first page.</p>"""
    max_results: NotRequired["int"]
    """<p>The maximum number of results to return in the response. Use this parameter when paginating results. If additional results exist beyond the number you specify, the <code>nextToken</code> element is returned in the response. Use <code>nextToken</code> in a subsequent request to retrieve additional results. If not specified, returns 1000 results.</p>"""
    status: NotRequired["capo_codeguru_security.types.status.Status"]
    """<p>The status of the findings you want to get. Pass either <code>Open</code>, <code>Closed</code>, or <code>All</code>.</p>"""

max_results instance-attribute

max_results: NotRequired[int]

The maximum number of results to return in the response. Use this parameter when paginating results. If additional results exist beyond the number you specify, the nextToken element is returned in the response. Use nextToken in a subsequent request to retrieve additional results. If not specified, returns 1000 results.

next_token instance-attribute

next_token: NotRequired[NextToken]

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.

scan_name instance-attribute

scan_name: ScanName

The name of the scan you want to retrieve findings from.

status instance-attribute

status: NotRequired[Status]

The status of the findings you want to get. Pass either Open, Closed, or All.