« blib/lib/Paws/Macie2/GetMemberResponse.pm
↑ Summary
blib/lib/Paws/Macie2/GetUsageStatisticsResponse.pm »
| 1 | |||
| 2 | package Paws::Macie2::GetUsageStatistics; | ||
| 3 | use Moose; | ||
| 4 | has FilterBy => (is => 'ro', isa => 'ArrayRef[Paws::Macie2::UsageStatisticsFilter]', traits => ['NameInRequest'], request_name => 'filterBy'); | ||
| 5 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'maxResults'); | ||
| 6 | has NextToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'nextToken'); | ||
| 7 | has SortBy => (is => 'ro', isa => 'Paws::Macie2::UsageStatisticsSortBy', traits => ['NameInRequest'], request_name => 'sortBy'); | ||
| 8 | has TimeRange => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'timeRange'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetUsageStatistics'); | ||
| 13 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/usage/statistics'); | ||
| 14 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Macie2::GetUsageStatisticsResponse'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::Macie2::GetUsageStatistics - Arguments for method GetUsageStatistics on L<Paws::Macie2> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method GetUsageStatistics on the | ||
| 27 | L<Amazon Macie 2|Paws::Macie2> service. Use the attributes of this class | ||
| 28 | as arguments to method GetUsageStatistics. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetUsageStatistics. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $macie2 = Paws->service('Macie2'); | ||
| 35 | my $GetUsageStatisticsResponse = $macie2->GetUsageStatistics( | ||
| 36 | FilterBy => [ | ||
| 37 | { | ||
| 38 | Comparator => | ||
| 39 | 'GT', # values: GT, GTE, LT, LTE, EQ, NE, CONTAINS; OPTIONAL | ||
| 40 | Key => 'accountId' | ||
| 41 | , # values: accountId, serviceLimit, freeTrialStartDate, total; OPTIONAL | ||
| 42 | Values => [ 'My__string', ... ], # OPTIONAL | ||
| 43 | }, | ||
| 44 | ... | ||
| 45 | ], # OPTIONAL | ||
| 46 | MaxResults => 1, # OPTIONAL | ||
| 47 | NextToken => 'My__string', # OPTIONAL | ||
| 48 | SortBy => { | ||
| 49 | Key => 'accountId' | ||
| 50 | , # values: accountId, total, serviceLimitValue, freeTrialStartDate; OPTIONAL | ||
| 51 | OrderBy => 'ASC', # values: ASC, DESC; OPTIONAL | ||
| 52 | }, # OPTIONAL | ||
| 53 | TimeRange => 'MONTH_TO_DATE', # OPTIONAL | ||
| 54 | ); | ||
| 55 | |||
| 56 | # Results: | ||
| 57 | my $NextToken = $GetUsageStatisticsResponse->NextToken; | ||
| 58 | my $Records = $GetUsageStatisticsResponse->Records; | ||
| 59 | my $TimeRange = $GetUsageStatisticsResponse->TimeRange; | ||
| 60 | |||
| 61 | # Returns a L<Paws::Macie2::GetUsageStatisticsResponse> object. | ||
| 62 | |||
| 63 | 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. | ||
| 64 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/macie2/GetUsageStatistics> | ||
| 65 | |||
| 66 | =head1 ATTRIBUTES | ||
| 67 | |||
| 68 | |||
| 69 | =head2 FilterBy => ArrayRef[L<Paws::Macie2::UsageStatisticsFilter>] | ||
| 70 | |||
| 71 | An array of objects, one for each condition to use to filter the query | ||
| 72 | results. If you specify more than one condition, Amazon Macie uses an | ||
| 73 | AND operator to join the conditions. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head2 MaxResults => Int | ||
| 78 | |||
| 79 | The maximum number of items to include in each page of the response. | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head2 NextToken => Str | ||
| 84 | |||
| 85 | The nextToken string that specifies which page of results to return in | ||
| 86 | a paginated response. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head2 SortBy => L<Paws::Macie2::UsageStatisticsSortBy> | ||
| 91 | |||
| 92 | The criteria to use to sort the query results. | ||
| 93 | |||
| 94 | |||
| 95 | |||
| 96 | =head2 TimeRange => Str | ||
| 97 | |||
| 98 | The inclusive time period to query usage data for. Valid values are: | ||
| 99 | MONTH_TO_DATE, for the current calendar month to date; and, | ||
| 100 | PAST_30_DAYS, for the preceding 30 days. If you don't specify a value, | ||
| 101 | Amazon Macie provides usage data for the preceding 30 days. | ||
| 102 | |||
| 103 | Valid values are: C<"MONTH_TO_DATE">, C<"PAST_30_DAYS"> | ||
| 104 | |||
| 105 | |||
| 106 | =head1 SEE ALSO | ||
| 107 | |||
| 108 | This class forms part of L<Paws>, documenting arguments for method GetUsageStatistics in L<Paws::Macie2> | ||
| 109 | |||
| 110 | =head1 BUGS and CONTRIBUTIONS | ||
| 111 | |||
| 112 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 113 | |||
| 114 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 115 | |||
| 116 | =cut | ||
| 117 |