Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ 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.

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 <value>]
[--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>]

Options

--detector-id (string)

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

--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.

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",
      "FilterCondition": {
        "EqualsValue": "string",
        "GreaterThan": long,
        "LessThan": long
      }
    }
    ...
  ]
}

--sort-criteria (structure)

Represents the criteria used for sorting scan entries.

AttributeName -> (string)

Represents the finding attribute (for example, accountId) to sort findings by.

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 (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--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.

Output

Scans -> (list)

Contains information about malware scans.

(structure)

Contains information about a malware scan.

DetectorId -> (string)

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

AdminDetectorId -> (string)

The unique detector ID of the administrator account that the request is associated with. Note that this value will be the same as the one used for DetectorId if the account is an administrator.

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)

Represents the reason the scan was triggered.

GuardDutyFindingId -> (string)

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

Description -> (string)

The description of the scan trigger.

ResourceDetails -> (structure)

Represents the resources that were scanned in the scan entry.

InstanceArn -> (string)

InstanceArn 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.

NextToken -> (string)

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