« blib/lib/Paws/Macie2/GetCustomDataIdentifierResponse.pm
↑ Summary
blib/lib/Paws/Macie2/GetFindingStatisticsResponse.pm »
| 1 | |||
| 2 | package Paws::Macie2::GetFindingStatistics; | ||
| 3 | use Moose; | ||
| 4 | has FindingCriteria => (is => 'ro', isa => 'Paws::Macie2::FindingCriteria', traits => ['NameInRequest'], request_name => 'findingCriteria'); | ||
| 5 | has GroupBy => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'groupBy', required => 1); | ||
| 6 | has Size => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'size'); | ||
| 7 | has SortCriteria => (is => 'ro', isa => 'Paws::Macie2::FindingStatisticsSortCriteria', traits => ['NameInRequest'], request_name => 'sortCriteria'); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetFindingStatistics'); | ||
| 12 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/findings/statistics'); | ||
| 13 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Macie2::GetFindingStatisticsResponse'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::Macie2::GetFindingStatistics - Arguments for method GetFindingStatistics on L<Paws::Macie2> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method GetFindingStatistics on the | ||
| 26 | L<Amazon Macie 2|Paws::Macie2> service. Use the attributes of this class | ||
| 27 | as arguments to method GetFindingStatistics. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetFindingStatistics. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $macie2 = Paws->service('Macie2'); | ||
| 34 | my $GetFindingStatisticsResponse = $macie2->GetFindingStatistics( | ||
| 35 | GroupBy => 'resourcesAffected.s3Bucket.name', | ||
| 36 | FindingCriteria => { | ||
| 37 | Criterion => { | ||
| 38 | 'My__string' => { | ||
| 39 | Eq => [ 'My__string', ... ], # OPTIONAL | ||
| 40 | EqExactMatch => [ 'My__string', ... ], # OPTIONAL | ||
| 41 | Gt => 1, # OPTIONAL | ||
| 42 | Gte => 1, # OPTIONAL | ||
| 43 | Lt => 1, # OPTIONAL | ||
| 44 | Lte => 1, # OPTIONAL | ||
| 45 | Neq => [ 'My__string', ... ], # OPTIONAL | ||
| 46 | }, | ||
| 47 | }, # OPTIONAL | ||
| 48 | }, # OPTIONAL | ||
| 49 | Size => 1, # OPTIONAL | ||
| 50 | SortCriteria => { | ||
| 51 | AttributeName => 'groupKey', # values: groupKey, count; OPTIONAL | ||
| 52 | OrderBy => 'ASC', # values: ASC, DESC; OPTIONAL | ||
| 53 | }, # OPTIONAL | ||
| 54 | ); | ||
| 55 | |||
| 56 | # Results: | ||
| 57 | my $CountsByGroup = $GetFindingStatisticsResponse->CountsByGroup; | ||
| 58 | |||
| 59 | # Returns a L<Paws::Macie2::GetFindingStatisticsResponse> object. | ||
| 60 | |||
| 61 | 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. | ||
| 62 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/macie2/GetFindingStatistics> | ||
| 63 | |||
| 64 | =head1 ATTRIBUTES | ||
| 65 | |||
| 66 | |||
| 67 | =head2 FindingCriteria => L<Paws::Macie2::FindingCriteria> | ||
| 68 | |||
| 69 | The criteria to use to filter the query results. | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head2 B<REQUIRED> GroupBy => Str | ||
| 74 | |||
| 75 | The finding property to use to group the query results. Valid values | ||
| 76 | are: | ||
| 77 | |||
| 78 | =over | ||
| 79 | |||
| 80 | =item * | ||
| 81 | |||
| 82 | classificationDetails.jobId - The unique identifier for the | ||
| 83 | classification job that produced the finding. | ||
| 84 | |||
| 85 | =item * | ||
| 86 | |||
| 87 | resourcesAffected.s3Bucket.name - The name of the S3 bucket that the | ||
| 88 | finding applies to. | ||
| 89 | |||
| 90 | =item * | ||
| 91 | |||
| 92 | severity.description - The severity level of the finding, such as High | ||
| 93 | or Medium. | ||
| 94 | |||
| 95 | =item * | ||
| 96 | |||
| 97 | type - The type of finding, such as Policy:IAMUser/S3BucketPublic and | ||
| 98 | SensitiveData:S3Object/Personal. | ||
| 99 | |||
| 100 | =back | ||
| 101 | |||
| 102 | |||
| 103 | Valid values are: C<"resourcesAffected.s3Bucket.name">, C<"type">, C<"classificationDetails.jobId">, C<"severity.description"> | ||
| 104 | |||
| 105 | =head2 Size => Int | ||
| 106 | |||
| 107 | The maximum number of items to include in each page of the response. | ||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | =head2 SortCriteria => L<Paws::Macie2::FindingStatisticsSortCriteria> | ||
| 112 | |||
| 113 | The criteria to use to sort the query results. | ||
| 114 | |||
| 115 | |||
| 116 | |||
| 117 | |||
| 118 | =head1 SEE ALSO | ||
| 119 | |||
| 120 | This class forms part of L<Paws>, documenting arguments for method GetFindingStatistics in L<Paws::Macie2> | ||
| 121 | |||
| 122 | =head1 BUGS and CONTRIBUTIONS | ||
| 123 | |||
| 124 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 125 | |||
| 126 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 127 | |||
| 128 | =cut | ||
| 129 |