NAME

Paws::GuardDuty::GetUsageStatistics - Arguments for method GetUsageStatistics on Paws::GuardDuty

DESCRIPTION

This class represents the parameters used for calling the method GetUsageStatistics on the Amazon GuardDuty service. Use the attributes of this class as arguments to method GetUsageStatistics.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetUsageStatistics.

SYNOPSIS

    my $guardduty = Paws->service('GuardDuty');
    my $GetUsageStatisticsResponse = $guardduty->GetUsageStatistics(
      DetectorId    => 'MyDetectorId',
      UsageCriteria => {
        DataSources => [
          'FLOW_LOGS', ...   # values: FLOW_LOGS, CLOUD_TRAIL, DNS_LOGS, S3_LOGS
        ],
        AccountIds => [
          'MyAccountId', ...    # min: 12, max: 12
        ],    # min: 1, max: 50; OPTIONAL
        Resources => [ 'MyString', ... ],    # OPTIONAL
      },
      UsageStatisticType => 'SUM_BY_ACCOUNT',
      MaxResults         => 1,                  # OPTIONAL
      NextToken          => 'MyString',         # OPTIONAL
      Unit               => 'MyString',         # OPTIONAL
    );
    # Results:
    my $NextToken       = $GetUsageStatisticsResponse->NextToken;
    my $UsageStatistics = $GetUsageStatisticsResponse->UsageStatistics;
    # Returns a L<Paws::GuardDuty::GetUsageStatisticsResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/guardduty/GetUsageStatistics>

ATTRIBUTES

REQUIRED DetectorId => Str

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

MaxResults => Int

The maximum number of results to return in the response.

NextToken => Str

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.

Unit => Str

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

REQUIRED UsageCriteria => Paws::GuardDuty::UsageCriteria

Represents the criteria used for querying usage.

REQUIRED UsageStatisticType => Str

The type of usage statistics to retrieve.

Valid values are: "SUM_BY_ACCOUNT", "SUM_BY_DATA_SOURCE", "SUM_BY_RESOURCE", "TOP_RESOURCES"

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>