Skip to content

DescribeMalwareScansRequest

Source code in docs_src/capo_guardduty/types/describe_malware_scans_request.py
class DescribeMalwareScansRequest(TypedDict, closed=True):
    detector_id: "capo_guardduty.types.detector_id.DetectorId"
    """<p>The unique ID of the detector that the request is associated with.</p> <p>To find the <code>detectorId</code> in the current Region, see the Settings page in the GuardDuty console, or run the <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html">ListDetectors</a> API.</p>"""
    next_token: NotRequired["capo_guardduty.types.string.String"]
    """<p>You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.</p>"""
    max_results: NotRequired[
        "capo_guardduty.types.integer_value_with_max.IntegerValueWithMax"
    ]
    """<p>You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 50. The maximum value is 50.</p>"""
    filter_criteria: NotRequired["capo_guardduty.types.filter_criteria.FilterCriteria"]
    """<p>Represents the criteria to be used in the filter for describing scan entries.</p>"""
    sort_criteria: NotRequired["capo_guardduty.types.sort_criteria.SortCriteria"]
    """<p>Represents the criteria used for sorting scan entries. The <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_SortCriteria.html#guardduty-Type-SortCriteria-attributeName"> <code>attributeName</code> </a> is required and it must be <code>scanStartTime</code>.</p>"""

detector_id instance-attribute

detector_id: DetectorId

The unique ID of the detector that the request is associated with.

To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

filter_criteria instance-attribute

filter_criteria: NotRequired[FilterCriteria]

Represents the criteria to be used in the filter for describing scan entries.

max_results instance-attribute

max_results: NotRequired[IntegerValueWithMax]

You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 50. The maximum value is 50.

next_token instance-attribute

next_token: NotRequired[String]

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

sort_criteria instance-attribute

sort_criteria: NotRequired[SortCriteria]

Represents the criteria used for sorting scan entries. The attributeName is required and it must be scanStartTime.