AWS CLI Command Reference

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 ]

update-malware-scan-settings

Description

Updates the malware scan settings.

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

Synopsis

  update-malware-scan-settings
--detector-id <value>
[--scan-resource-criteria <value>]
[--ebs-snapshot-preservation <value>]
[--cli-input-json <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 specifies the GuardDuty service where you want to update scan settings.

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

--scan-resource-criteria (structure)

Represents the criteria to be used in the filter for selecting resources to scan.

Include -> (map)

Represents condition that when matched will allow a malware scan for a certain resource.

key -> (string)

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

value -> (structure)

Contains information about the condition.

MapEquals -> (list)

Represents an mapEqual condition to be applied to a single field when triggering for malware scan.

(structure)

Represents the key:value pair to be matched against given resource property.

Key -> (string)

Represents the key in the map condition.

Value -> (string)

Represents optional value in the map condition. If not specified, only the key will be matched.

Exclude -> (map)

Represents condition that when matched will prevent a malware scan for a certain resource.

key -> (string)

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

value -> (structure)

Contains information about the condition.

MapEquals -> (list)

Represents an mapEqual condition to be applied to a single field when triggering for malware scan.

(structure)

Represents the key:value pair to be matched against given resource property.

Key -> (string)

Represents the key in the map condition.

Value -> (string)

Represents optional value in the map condition. If not specified, only the key will be matched.

JSON Syntax:

{
  "Include": {"EC2_INSTANCE_TAG": {
        "MapEquals": [
          {
            "Key": "string",
            "Value": "string"
          }
          ...
        ]
      }
    ...},
  "Exclude": {"EC2_INSTANCE_TAG": {
        "MapEquals": [
          {
            "Key": "string",
            "Value": "string"
          }
          ...
        ]
      }
    ...}
}

--ebs-snapshot-preservation (string)

An enum value representing possible snapshot preservation settings.

Possible values:

  • NO_RETENTION
  • RETENTION_WITH_FINDING

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

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

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

None