Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

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

See 'aws help' for descriptions of global parameters.

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

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

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

Shorthand Syntax:

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

JSON Syntax:

{
  "AccountIds": ["string", ...],
  "DataSources": ["FLOW_LOGS"|"CLOUD_TRAIL"|"DNS_LOGS"|"S3_LOGS", ...],
  "Resources": ["string", ...]
}

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

See 'aws help' for descriptions of global parameters.

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.

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

Resource -> (string)

The AWS 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 AWS resource.

Resource -> (string)

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

NextToken -> (string)

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