[ aws . guardduty ]

describe-malware-scans

Description

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 .

See also: AWS API Documentation

describe-malware-scans is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: Scans

Synopsis

  describe-malware-scans
--detector-id <value>
[--filter-criteria <value>]
[--sort-criteria <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--detector-id (string)

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 (structure)

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

FilterCriterion -> (list)

Represents a condition that when matched will be added to the response of the operation.

(structure)

Represents a condition that when matched will be added to the response of the operation. Irrespective of using any filter criteria, an administrator account can view the scan entries for all of its member accounts. However, each member account can view the scan entries only for their own account.

CriterionKey -> (string)

An enum value representing possible scan properties to match with given scan entries.

Note

Replace the enum value CLUSTER_NAME with EKS_CLUSTER_NAME . CLUSTER_NAME has been deprecated.

FilterCondition -> (structure)

Contains information about the condition.

EqualsValue -> (string)

Represents an equal condition to be applied to a single field when querying for scan entries.

GreaterThan -> (long)

Represents a greater than condition to be applied to a single field when querying for scan entries.

LessThan -> (long)

Represents a less than condition to be applied to a single field when querying for scan entries.

JSON Syntax:

{
  "FilterCriterion": [
    {
      "CriterionKey": "EC2_INSTANCE_ARN"|"SCAN_ID"|"ACCOUNT_ID"|"GUARDDUTY_FINDING_ID"|"SCAN_START_TIME"|"SCAN_STATUS"|"SCAN_TYPE",
      "FilterCondition": {
        "EqualsValue": "string",
        "GreaterThan": long,
        "LessThan": long
      }
    }
    ...
  ]
}

--sort-criteria (structure)

Represents the criteria used for sorting scan entries. The ` attributeName https://docs.aws.amazon.com/guardduty/latest/APIReference/API_SortCriteria.html#guardduty-Type-SortCriteria-attributeName`__ is required and it must be scanStartTime .

AttributeName -> (string)

Represents the finding attribute, such as accountId , that sorts the findings.

OrderBy -> (string)

The order by which the sorted findings are to be displayed.

Shorthand Syntax:

AttributeName=string,OrderBy=string

JSON Syntax:

{
  "AttributeName": "string",
  "OrderBy": "ASC"|"DESC"
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

Scans -> (list)

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

(structure)

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

DetectorId -> (string)

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

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

AdminDetectorId -> (string)

The unique detector ID of the administrator account that the request is associated with. If the account is an administrator, the AdminDetectorId will be the same as the one used for DetectorId .

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

ScanId -> (string)

The unique scan ID associated with a scan entry.

ScanStatus -> (string)

An enum value representing possible scan statuses.

FailureReason -> (string)

Represents the reason for FAILED scan status.

ScanStartTime -> (timestamp)

The timestamp of when the scan was triggered.

ScanEndTime -> (timestamp)

The timestamp of when the scan was finished.

TriggerDetails -> (structure)

Specifies the reason why the scan was initiated.

GuardDutyFindingId -> (string)

The ID of the GuardDuty finding that triggered the malware scan.

Description -> (string)

The description of the scan trigger.

ResourceDetails -> (structure)

Represents the resources that were scanned in the scan entry.

InstanceArn -> (string)

Instance ARN that was scanned in the scan entry.

ScanResultDetails -> (structure)

Represents the result of the scan.

ScanResult -> (string)

An enum value representing possible scan results.

AccountId -> (string)

The ID for the account that belongs to the scan.

TotalBytes -> (long)

Represents total bytes that were scanned.

FileCount -> (long)

Represents the number of files that were scanned.

AttachedVolumes -> (list)

List of volumes that were attached to the original instance to be scanned.

(structure)

Contains EBS volume details.

VolumeArn -> (string)

EBS volume ARN information.

VolumeType -> (string)

The EBS volume type.

DeviceName -> (string)

The device name for the EBS volume.

VolumeSizeInGB -> (integer)

EBS volume size in GB.

EncryptionType -> (string)

EBS volume encryption type.

SnapshotArn -> (string)

Snapshot ARN of the EBS volume.

KmsKeyArn -> (string)

KMS key ARN used to encrypt the EBS volume.

ScanType -> (string)

Specifies the scan type that invoked the malware scan.

NextToken -> (string)

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