Skip to content

describe_malware_scans

Operation

describe_malware_scans

describe_malware_scans(request: DescribeMalwareScansInput | DescribeMalwareScansInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeMalwareScansInputDict]) -> DescribeMalwareScansOutput

Returns a list of malware scans. Each member account can view the malware scans for their own accounts. An administrator can view the malware scans for all the member accounts.

There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.

Parameters:

Name Type Description Default
request DescribeMalwareScansInput | DescribeMalwareScansInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[DescribeMalwareScansInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeMalwareScansOutput

An instance of DescribeMalwareScansOutput.

describe_malware_scans async

describe_malware_scans(request: DescribeMalwareScansInput | DescribeMalwareScansInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeMalwareScansInputDict]) -> DescribeMalwareScansOutput

Returns a list of malware scans. Each member account can view the malware scans for their own accounts. An administrator can view the malware scans for all the member accounts.

There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.

Parameters:

Name Type Description Default
request DescribeMalwareScansInput | DescribeMalwareScansInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[DescribeMalwareScansInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeMalwareScansOutput

An instance of DescribeMalwareScansOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

DescribeMalwareScansInputDict

Bases: TypedDict

Dictionary form of DescribeMalwareScansInput.

Attributes

detector_id instance-attribute
detector_id: Required[str]

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: FilterCriteria | FilterCriteriaDict | None

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

max_results instance-attribute
max_results: int | None

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: str | None

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: SortCriteria | SortCriteriaDict | None

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

DescribeMalwareScansInput dataclass

Bases: _SerdeShape

Dataclass for DescribeMalwareScansInput structure.

Attributes

detector_id class-attribute instance-attribute
detector_id: str | None = ...

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 class-attribute instance-attribute
filter_criteria: FilterCriteria | None = ...

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

max_results class-attribute instance-attribute
max_results: int | None = ...

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 class-attribute instance-attribute
next_token: str | None = ...

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 class-attribute instance-attribute
sort_criteria: SortCriteria | None = ...

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

Output

DescribeMalwareScansOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeMalwareScansOutput structure.

Attributes

next_token class-attribute instance-attribute
next_token: str | None = ...

The pagination parameter to be used on the next list operation to retrieve more items.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

scans class-attribute instance-attribute
scans: list[Scan] | None = ...

Contains information about malware scans associated with GuardDuty Malware Protection for EC2.