NAME

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

DESCRIPTION

This class represents the parameters used for calling the method GetUsageStatistics on the Amazon Macie 2 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 $macie2 = Paws->service('Macie2');
my $GetUsageStatisticsResponse = $macie2->GetUsageStatistics(
  FilterBy => [
    {
      Comparator =>
        'GT',    # values: GT, GTE, LT, LTE, EQ, NE, CONTAINS; OPTIONAL
      Key => 'accountId'
      , # values: accountId, serviceLimit, freeTrialStartDate, total; OPTIONAL
      Values => [ 'My__string', ... ],    # OPTIONAL
    },
    ...
  ],    # OPTIONAL
  MaxResults => 1,               # OPTIONAL
  NextToken  => 'My__string',    # OPTIONAL
  SortBy     => {
    Key => 'accountId'
    , # values: accountId, total, serviceLimitValue, freeTrialStartDate; OPTIONAL
    OrderBy => 'ASC',    # values: ASC, DESC; OPTIONAL
  },    # OPTIONAL
  TimeRange => 'MONTH_TO_DATE',    # OPTIONAL
);

# Results:
my $NextToken = $GetUsageStatisticsResponse->NextToken;
my $Records   = $GetUsageStatisticsResponse->Records;
my $TimeRange = $GetUsageStatisticsResponse->TimeRange;

# Returns a L<Paws::Macie2::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/macie2/GetUsageStatistics

ATTRIBUTES

FilterBy => ArrayRef[Paws::Macie2::UsageStatisticsFilter]

An array of objects, one for each condition to use to filter the query results. If you specify more than one condition, Amazon Macie uses an AND operator to join the conditions.

MaxResults => Int

The maximum number of items to include in each page of the response.

NextToken => Str

The nextToken string that specifies which page of results to return in a paginated response.

SortBy => Paws::Macie2::UsageStatisticsSortBy

The criteria to use to sort the query results.

TimeRange => Str

The inclusive time period to query usage data for. Valid values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days. If you don't specify a value, Amazon Macie provides usage data for the preceding 30 days.

Valid values are: "MONTH_TO_DATE", "PAST_30_DAYS"

SEE ALSO

This class forms part of Paws, documenting arguments for method GetUsageStatistics in Paws::Macie2

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