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

Description

Lists Amazon GuardDuty usage statistics over the last 30 days for the specified detector ID. For newly enabled detectors or data sources, the cost returned will include only the usage so far under 30 days. This may differ from the cost metrics in the console, which project usage over 30 days to provide a monthly cost estimate. For more information, see Understanding How Usage Costs are Calculated .

See also: AWS API Documentation

Synopsis

  get-usage-statistics
--detector-id <value>
--usage-statistic-type <value>
--usage-criteria <value>
[--unit <value>]
[--max-results <value>]
[--next-token <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 ID of the detector that specifies the GuardDuty service whose usage statistics you want to retrieve.

--usage-statistic-type (string)

The type of usage statistics to retrieve.

Possible values:

  • SUM_BY_ACCOUNT
  • SUM_BY_DATA_SOURCE
  • SUM_BY_RESOURCE
  • TOP_RESOURCES
  • SUM_BY_FEATURES
  • TOP_ACCOUNTS_BY_FEATURE

--usage-criteria (structure)

Represents the criteria used for querying usage.

AccountIds -> (list)

The account IDs to aggregate usage statistics from.

(string)

DataSources -> (list)

The data sources to aggregate usage statistics from.

(string)

Resources -> (list)

The resources to aggregate usage statistics from. Only accepts exact resource names.

(string)

Features -> (list)

The features to aggregate usage statistics from.

(string)

Shorthand Syntax:

AccountIds=string,string,DataSources=string,string,Resources=string,string,Features=string,string

JSON Syntax:

{
  "AccountIds": ["string", ...],
  "DataSources": ["FLOW_LOGS"|"CLOUD_TRAIL"|"DNS_LOGS"|"S3_LOGS"|"KUBERNETES_AUDIT_LOGS"|"EC2_MALWARE_SCAN", ...],
  "Resources": ["string", ...],
  "Features": ["FLOW_LOGS"|"CLOUD_TRAIL"|"DNS_LOGS"|"S3_DATA_EVENTS"|"EKS_AUDIT_LOGS"|"EBS_MALWARE_PROTECTION"|"RDS_LOGIN_EVENTS"|"LAMBDA_NETWORK_LOGS"|"EKS_RUNTIME_MONITORING"|"FARGATE_RUNTIME_MONITORING"|"EC2_RUNTIME_MONITORING"|"RDS_DBI_PROTECTION_PROVISIONED"|"RDS_DBI_PROTECTION_SERVERLESS", ...]
}

--unit (string)

The currency unit you would like to view your usage statistics in. Current valid values are USD.

--max-results (integer)

The maximum number of results to return in the response.

--next-token (string)

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

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

UsageStatistics -> (structure)

The usage statistics object. If a UsageStatisticType was provided, the objects representing other types will be null.

SumByAccount -> (list)

The usage statistic sum organized by account ID.

(structure)

Contains information on the total of usage based on account IDs.

AccountId -> (string)

The Account ID that generated usage.

Total -> (structure)

Represents the total of usage for the Account ID.

Amount -> (string)

The total usage.

Unit -> (string)

The currency unit that the amount is given in.

TopAccountsByFeature -> (list)

Lists the top 50 accounts by feature that have generated the most GuardDuty usage, in the order from most to least expensive.

Currently, this doesn't support RDS_LOGIN_EVENTS .

(structure)

Information about the usage statistics, calculated by top accounts by feature.

Feature -> (string)

Features by which you can generate the usage statistics.

RDS_LOGIN_EVENTS is currently not supported with topAccountsByFeature .

Accounts -> (list)

The accounts that contributed to the total usage cost.

(structure)

Contains information on the total of usage based on the topmost 50 account IDs.

AccountId -> (string)

The unique account ID.

Total -> (structure)

Contains the total usage with the corresponding currency unit for that value.

Amount -> (string)

The total usage.

Unit -> (string)

The currency unit that the amount is given in.

SumByDataSource -> (list)

The usage statistic sum organized by on data source.

(structure)

Contains information on the result of usage based on data source type.

DataSource -> (string)

The data source type that generated usage.

Total -> (structure)

Represents the total of usage for the specified data source.

Amount -> (string)

The total usage.

Unit -> (string)

The currency unit that the amount is given in.

SumByResource -> (list)

The usage statistic sum organized by resource.

(structure)

Contains information on the sum of usage based on an Amazon Web Services resource.

Resource -> (string)

The Amazon Web Services resource that generated usage.

Total -> (structure)

Represents the sum total of usage for the specified resource type.

Amount -> (string)

The total usage.

Unit -> (string)

The currency unit that the amount is given in.

TopResources -> (list)

Lists the top 50 resources that have generated the most GuardDuty usage, in order from most to least expensive.

(structure)

Contains information on the sum of usage based on an Amazon Web Services resource.

Resource -> (string)

The Amazon Web Services resource that generated usage.

Total -> (structure)

Represents the sum total of usage for the specified resource type.

Amount -> (string)

The total usage.

Unit -> (string)

The currency unit that the amount is given in.

SumByFeature -> (list)

The usage statistic sum organized by feature.

(structure)

Contains information about the result of the total usage based on the feature.

Feature -> (string)

The feature that generated the usage cost.

Total -> (structure)

Contains the total usage with the corresponding currency unit for that value.

Amount -> (string)

The total usage.

Unit -> (string)

The currency unit that the amount is given in.

NextToken -> (string)

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