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 ]

get-coverage-statistics

Description

Retrieves aggregated statistics for your account. If you are a GuardDuty administrator, you can retrieve the statistics for all the resources associated with the active member accounts in your organization who have enabled Runtime Monitoring and have the GuardDuty security agent running on their resources.

See also: AWS API Documentation

Synopsis

  get-coverage-statistics
--detector-id <value>
[--filter-criteria <value>]
--statistics-type <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 GuardDuty detector associated to the coverage statistics.

--filter-criteria (structure)

Represents the criteria used to filter the coverage statistics

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.

CriterionKey -> (string)

An enum value representing possible filter fields.

Note

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

FilterCondition -> (structure)

Contains information about the condition.

Equals -> (list)

Represents an equal condition that is applied to a single field while retrieving the coverage details.

(string)

NotEquals -> (list)

Represents a not equal condition that is applied to a single field while retrieving the coverage details.

(string)

JSON Syntax:

{
  "FilterCriterion": [
    {
      "CriterionKey": "ACCOUNT_ID"|"CLUSTER_NAME"|"RESOURCE_TYPE"|"COVERAGE_STATUS"|"ADDON_VERSION"|"MANAGEMENT_TYPE"|"EKS_CLUSTER_NAME"|"ECS_CLUSTER_NAME"|"AGENT_VERSION"|"INSTANCE_ID"|"CLUSTER_ARN",
      "FilterCondition": {
        "Equals": ["string", ...],
        "NotEquals": ["string", ...]
      }
    }
    ...
  ]
}

--statistics-type (list)

Represents the statistics type used to aggregate the coverage details.

(string)

Syntax:

"string" "string" ...

Where valid values are:
  COUNT_BY_RESOURCE_TYPE
  COUNT_BY_COVERAGE_STATUS

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

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

CoverageStatistics -> (structure)

Represents the count aggregated by the statusCode and resourceType .

CountByResourceType -> (map)

Represents coverage statistics for EKS clusters aggregated by resource type.

key -> (string)

value -> (long)

CountByCoverageStatus -> (map)

Represents coverage statistics for EKS clusters aggregated by coverage status.

key -> (string)

value -> (long)