« blib/lib/Paws/CloudTrail/GetTrailStatusResponse.pm
↑ Summary
blib/lib/Paws/CloudTrail/LookupEventsResponse.pm »
| 1 | |||
| 2 | package Paws::CloudTrail::LookupEvents; | ||
| 3 | 1 | ▶ | use Moose; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 4 | 1 | has EndTime => (is => 'ro', isa => 'Str'); | |
| 5 | 1 | has EventCategory => (is => 'ro', isa => 'Str'); | |
| 6 | 1 | has LookupAttributes => (is => 'ro', isa => 'ArrayRef[Paws::CloudTrail::LookupAttribute]'); | |
| 7 | 1 | has MaxResults => (is => 'ro', isa => 'Int'); | |
| 8 | 1 | has NextToken => (is => 'ro', isa => 'Str'); | |
| 9 | 1 | has StartTime => (is => 'ro', isa => 'Str'); | |
| 10 | |||
| 11 | 1 | ▶ | use MooseX::ClassAttribute; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 12 | |||
| 13 | 1 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'LookupEvents'); | |
| 14 | 1 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudTrail::LookupEventsResponse'); | |
| 15 | 1 | class_has _result_key => (isa => 'Str', is => 'ro'); | |
| 16 | 1 | 1; | |
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::CloudTrail::LookupEvents - Arguments for method LookupEvents on L<Paws::CloudTrail> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method LookupEvents on the | ||
| 27 | L<AWS CloudTrail|Paws::CloudTrail> service. Use the attributes of this class | ||
| 28 | as arguments to method LookupEvents. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to LookupEvents. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $cloudtrail = Paws->service('CloudTrail'); | ||
| 35 | my $LookupEventsResponse = $cloudtrail->LookupEvents( | ||
| 36 | EndTime => '1970-01-01T01:00:00', # OPTIONAL | ||
| 37 | EventCategory => 'insight', # OPTIONAL | ||
| 38 | LookupAttributes => [ | ||
| 39 | { | ||
| 40 | AttributeKey => 'EventId' | ||
| 41 | , # values: EventId, EventName, ReadOnly, Username, ResourceType, ResourceName, EventSource, AccessKeyId | ||
| 42 | AttributeValue => 'MyString', | ||
| 43 | |||
| 44 | }, | ||
| 45 | ... | ||
| 46 | ], # OPTIONAL | ||
| 47 | MaxResults => 1, # OPTIONAL | ||
| 48 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 49 | StartTime => '1970-01-01T01:00:00', # OPTIONAL | ||
| 50 | ); | ||
| 51 | |||
| 52 | # Results: | ||
| 53 | my $Events = $LookupEventsResponse->Events; | ||
| 54 | my $NextToken = $LookupEventsResponse->NextToken; | ||
| 55 | |||
| 56 | # Returns a L<Paws::CloudTrail::LookupEventsResponse> object. | ||
| 57 | |||
| 58 | 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. | ||
| 59 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/cloudtrail/LookupEvents> | ||
| 60 | |||
| 61 | =head1 ATTRIBUTES | ||
| 62 | |||
| 63 | |||
| 64 | =head2 EndTime => Str | ||
| 65 | |||
| 66 | Specifies that only events that occur before or at the specified time | ||
| 67 | are returned. If the specified end time is before the specified start | ||
| 68 | time, an error is returned. | ||
| 69 | |||
| 70 | |||
| 71 | |||
| 72 | =head2 EventCategory => Str | ||
| 73 | |||
| 74 | Specifies the event category. If you do not specify an event category, | ||
| 75 | events of the category are not returned in the response. For example, | ||
| 76 | if you do not specify C<insight> as the value of C<EventCategory>, no | ||
| 77 | Insights events are returned. | ||
| 78 | |||
| 79 | Valid values are: C<"insight"> | ||
| 80 | |||
| 81 | =head2 LookupAttributes => ArrayRef[L<Paws::CloudTrail::LookupAttribute>] | ||
| 82 | |||
| 83 | Contains a list of lookup attributes. Currently the list can contain | ||
| 84 | only one item. | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head2 MaxResults => Int | ||
| 89 | |||
| 90 | The number of events to return. Possible values are 1 through 50. The | ||
| 91 | default is 50. | ||
| 92 | |||
| 93 | |||
| 94 | |||
| 95 | =head2 NextToken => Str | ||
| 96 | |||
| 97 | The token to use to get the next page of results after a previous API | ||
| 98 | call. This token must be passed in with the same parameters that were | ||
| 99 | specified in the the original call. For example, if the original call | ||
| 100 | specified an AttributeKey of 'Username' with a value of 'root', the | ||
| 101 | call with NextToken should include those same parameters. | ||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | =head2 StartTime => Str | ||
| 106 | |||
| 107 | Specifies that only events that occur after or at the specified time | ||
| 108 | are returned. If the specified start time is after the specified end | ||
| 109 | time, an error is returned. | ||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | |||
| 114 | =head1 SEE ALSO | ||
| 115 | |||
| 116 | This class forms part of L<Paws>, documenting arguments for method LookupEvents in L<Paws::CloudTrail> | ||
| 117 | |||
| 118 | =head1 BUGS and CONTRIBUTIONS | ||
| 119 | |||
| 120 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 121 | |||
| 122 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 123 | |||
| 124 | =cut | ||
| 125 | |||