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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

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.

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

Returns:

  • (String) 


4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
 
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 4428

class GetUsageStatisticsRequest < Struct.new(
  :detector_id,
  :usage_statistic_type,
  :usage_criteria,
  :unit,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of results to return in the response.

Returns:

  • (Integer) 


4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
 
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 4428

class GetUsageStatisticsRequest < Struct.new(
  :detector_id,
  :usage_statistic_type,
  :usage_criteria,
  :unit,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

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


4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
 
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 4428

class GetUsageStatisticsRequest < Struct.new(
  :detector_id,
  :usage_statistic_type,
  :usage_criteria,
  :unit,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#unit ⇒ String

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

Returns:

  • (String) 


4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
 
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 4428

class GetUsageStatisticsRequest < Struct.new(
  :detector_id,
  :usage_statistic_type,
  :usage_criteria,
  :unit,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#usage_criteria ⇒ Types::UsageCriteria

Represents the criteria used for querying usage.

Returns:



4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
 
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 4428

class GetUsageStatisticsRequest < Struct.new(
  :detector_id,
  :usage_statistic_type,
  :usage_criteria,
  :unit,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#usage_statistic_type ⇒ String

The type of usage statistics to retrieve.

Returns:

  • (String) 


4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
 
# File 'gems/aws-sdk-guardduty/lib/aws-sdk-guardduty/types.rb', line 4428

class GetUsageStatisticsRequest < Struct.new(
  :detector_id,
  :usage_statistic_type,
  :usage_criteria,
  :unit,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end