You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::GuardDuty::Types::GetUsageStatisticsRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing GetUsageStatisticsRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  detector_id: "DetectorId", # required
  usage_statistic_type: "SUM_BY_ACCOUNT", # required, accepts SUM_BY_ACCOUNT, SUM_BY_DATA_SOURCE, SUM_BY_RESOURCE, TOP_RESOURCES
  usage_criteria: { # required
    account_ids: ["AccountId"],
    data_sources: ["FLOW_LOGS"], # required, accepts FLOW_LOGS, CLOUD_TRAIL, DNS_LOGS, S3_LOGS
    resources: ["String"],
  },
  unit: "String",
  max_results: 1,
  next_token: "String",
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#detector_id ⇒ String

The ID of the detector that specifies the GuardDuty service whose usage statistics you want to retrieve.

Returns:

  • (String) —

    The ID of the detector that specifies the GuardDuty service whose usage statistics you want to retrieve.

#max_results ⇒ Integer

The maximum number of results to return in the response.

Returns:

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

Returns:

  • (String) —

    A token to use for paginating results that are returned in the response.

#unit ⇒ String

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

Returns:

  • (String) —

    The currency unit you would like to view your usage statistics in.

#usage_criteria ⇒ Types::UsageCriteria

Represents the criteria used for querying usage.

Returns:

#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

Returns:

  • (String) —

    The type of usage statistics to retrieve.