« blib/lib/Paws/Macie2/DeleteMemberResponse.pm
↑ Summary
blib/lib/Paws/Macie2/DescribeBucketsResponse.pm »
| 1 | |||
| 2 | package Paws::Macie2::DescribeBuckets; | ||
| 3 | use Moose; | ||
| 4 | has Criteria => (is => 'ro', isa => 'Paws::Macie2::BucketCriteria', traits => ['NameInRequest'], request_name => 'criteria'); | ||
| 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 SortCriteria => (is => 'ro', isa => 'Paws::Macie2::BucketSortCriteria', traits => ['NameInRequest'], request_name => 'sortCriteria'); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeBuckets'); | ||
| 12 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/datasources/s3'); | ||
| 13 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Macie2::DescribeBucketsResponse'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::Macie2::DescribeBuckets - Arguments for method DescribeBuckets on L<Paws::Macie2> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method DescribeBuckets on the | ||
| 26 | L<Amazon Macie 2|Paws::Macie2> service. Use the attributes of this class | ||
| 27 | as arguments to method DescribeBuckets. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeBuckets. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $macie2 = Paws->service('Macie2'); | ||
| 34 | my $DescribeBucketsResponse = $macie2->DescribeBuckets( | ||
| 35 | Criteria => { | ||
| 36 | 'My__string' => { | ||
| 37 | Eq => [ 'My__string', ... ], # OPTIONAL | ||
| 38 | Gt => 1, # OPTIONAL | ||
| 39 | Gte => 1, # OPTIONAL | ||
| 40 | Lt => 1, # OPTIONAL | ||
| 41 | Lte => 1, # OPTIONAL | ||
| 42 | Neq => [ 'My__string', ... ], # OPTIONAL | ||
| 43 | Prefix => 'My__string', | ||
| 44 | }, | ||
| 45 | }, # OPTIONAL | ||
| 46 | MaxResults => 1, # OPTIONAL | ||
| 47 | NextToken => 'My__string', # OPTIONAL | ||
| 48 | SortCriteria => { | ||
| 49 | AttributeName => 'My__string', | ||
| 50 | OrderBy => 'ASC', # values: ASC, DESC; OPTIONAL | ||
| 51 | }, # OPTIONAL | ||
| 52 | ); | ||
| 53 | |||
| 54 | # Results: | ||
| 55 | my $Buckets = $DescribeBucketsResponse->Buckets; | ||
| 56 | my $NextToken = $DescribeBucketsResponse->NextToken; | ||
| 57 | |||
| 58 | # Returns a L<Paws::Macie2::DescribeBucketsResponse> object. | ||
| 59 | |||
| 60 | 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. | ||
| 61 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/macie2/DescribeBuckets> | ||
| 62 | |||
| 63 | =head1 ATTRIBUTES | ||
| 64 | |||
| 65 | |||
| 66 | =head2 Criteria => L<Paws::Macie2::BucketCriteria> | ||
| 67 | |||
| 68 | The criteria to use to filter the query results. | ||
| 69 | |||
| 70 | |||
| 71 | |||
| 72 | =head2 MaxResults => Int | ||
| 73 | |||
| 74 | The maximum number of items to include in each page of the response. | ||
| 75 | The default value is 50. | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | =head2 NextToken => Str | ||
| 80 | |||
| 81 | The nextToken string that specifies which page of results to return in | ||
| 82 | a paginated response. | ||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | =head2 SortCriteria => L<Paws::Macie2::BucketSortCriteria> | ||
| 87 | |||
| 88 | The criteria to use to sort the query results. | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | =head1 SEE ALSO | ||
| 94 | |||
| 95 | This class forms part of L<Paws>, documenting arguments for method DescribeBuckets in L<Paws::Macie2> | ||
| 96 | |||
| 97 | =head1 BUGS and CONTRIBUTIONS | ||
| 98 | |||
| 99 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 100 | |||
| 101 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 102 | |||
| 103 | =cut | ||
| 104 |