« blib/lib/Paws/CloudWatchLogs/DescribeLogStreamsResponse.pm
↑ Summary
blib/lib/Paws/CloudWatchLogs/FilterLogEventsResponse.pm »
| 1 | |||
| 2 | package Paws::CloudWatchLogs::FilterLogEvents; | ||
| 3 | 2 | ▶ | use Moose; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 4 | 2 | has EndTime => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'endTime' ); | |
| 5 | 2 | has FilterPattern => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'filterPattern' ); | |
| 6 | 2 | has Interleaved => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'interleaved' ); | |
| 7 | 2 | has Limit => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'limit' ); | |
| 8 | 2 | has LogGroupName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'logGroupName' , required => 1); | |
| 9 | 2 | has LogStreamNamePrefix => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'logStreamNamePrefix' ); | |
| 10 | 2 | has LogStreamNames => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'logStreamNames' ); | |
| 11 | 2 | has NextToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'nextToken' ); | |
| 12 | 2 | has StartTime => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'startTime' ); | |
| 13 | |||
| 14 | 2 | ▶ | use MooseX::ClassAttribute; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 15 | |||
| 16 | 2 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'FilterLogEvents'); | |
| 17 | 2 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudWatchLogs::FilterLogEventsResponse'); | |
| 18 | 2 | class_has _result_key => (isa => 'Str', is => 'ro'); | |
| 19 | 2 | 1; | |
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::CloudWatchLogs::FilterLogEvents - Arguments for method FilterLogEvents on L<Paws::CloudWatchLogs> | ||
| 26 | |||
| 27 | =head1 DESCRIPTION | ||
| 28 | |||
| 29 | This class represents the parameters used for calling the method FilterLogEvents on the | ||
| 30 | L<Amazon CloudWatch Logs|Paws::CloudWatchLogs> service. Use the attributes of this class | ||
| 31 | as arguments to method FilterLogEvents. | ||
| 32 | |||
| 33 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to FilterLogEvents. | ||
| 34 | |||
| 35 | =head1 SYNOPSIS | ||
| 36 | |||
| 37 | my $logs = Paws->service('CloudWatchLogs'); | ||
| 38 | my $FilterLogEventsResponse = $logs->FilterLogEvents( | ||
| 39 | LogGroupName => 'MyLogGroupName', | ||
| 40 | EndTime => 1, # OPTIONAL | ||
| 41 | FilterPattern => 'MyFilterPattern', # OPTIONAL | ||
| 42 | Interleaved => 1, # OPTIONAL | ||
| 43 | Limit => 1, # OPTIONAL | ||
| 44 | LogStreamNamePrefix => 'MyLogStreamName', # OPTIONAL | ||
| 45 | LogStreamNames => [ | ||
| 46 | 'MyLogStreamName', ... # min: 1, max: 512 | ||
| 47 | ], # OPTIONAL | ||
| 48 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 49 | StartTime => 1, # OPTIONAL | ||
| 50 | ); | ||
| 51 | |||
| 52 | # Results: | ||
| 53 | my $Events = $FilterLogEventsResponse->Events; | ||
| 54 | my $NextToken = $FilterLogEventsResponse->NextToken; | ||
| 55 | my $SearchedLogStreams = $FilterLogEventsResponse->SearchedLogStreams; | ||
| 56 | |||
| 57 | # Returns a L<Paws::CloudWatchLogs::FilterLogEventsResponse> object. | ||
| 58 | |||
| 59 | 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. | ||
| 60 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/logs/FilterLogEvents> | ||
| 61 | |||
| 62 | =head1 ATTRIBUTES | ||
| 63 | |||
| 64 | |||
| 65 | =head2 EndTime => Int | ||
| 66 | |||
| 67 | The end of the time range, expressed as the number of milliseconds | ||
| 68 | after Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this | ||
| 69 | time are not returned. | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head2 FilterPattern => Str | ||
| 74 | |||
| 75 | The filter pattern to use. For more information, see Filter and Pattern | ||
| 76 | Syntax | ||
| 77 | (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html). | ||
| 78 | |||
| 79 | If not provided, all the events are matched. | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head2 Interleaved => Bool | ||
| 84 | |||
| 85 | If the value is true, the operation makes a best effort to provide | ||
| 86 | responses that contain events from multiple log streams within the log | ||
| 87 | group, interleaved in a single response. If the value is false, all the | ||
| 88 | matched log events in the first log stream are searched first, then | ||
| 89 | those in the next log stream, and so on. The default is false. | ||
| 90 | |||
| 91 | B<Important:> Starting on June 17, 2019, this parameter is ignored and | ||
| 92 | the value is assumed to be true. The response from this operation | ||
| 93 | always interleaves events from multiple log streams within a log group. | ||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | =head2 Limit => Int | ||
| 98 | |||
| 99 | The maximum number of events to return. The default is 10,000 events. | ||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | =head2 B<REQUIRED> LogGroupName => Str | ||
| 104 | |||
| 105 | The name of the log group to search. | ||
| 106 | |||
| 107 | |||
| 108 | |||
| 109 | =head2 LogStreamNamePrefix => Str | ||
| 110 | |||
| 111 | Filters the results to include only events from log streams that have | ||
| 112 | names starting with this prefix. | ||
| 113 | |||
| 114 | If you specify a value for both C<logStreamNamePrefix> and | ||
| 115 | C<logStreamNames>, but the value for C<logStreamNamePrefix> does not | ||
| 116 | match any log stream names specified in C<logStreamNames>, the action | ||
| 117 | returns an C<InvalidParameterException> error. | ||
| 118 | |||
| 119 | |||
| 120 | |||
| 121 | =head2 LogStreamNames => ArrayRef[Str|Undef] | ||
| 122 | |||
| 123 | Filters the results to only logs from the log streams in this list. | ||
| 124 | |||
| 125 | If you specify a value for both C<logStreamNamePrefix> and | ||
| 126 | C<logStreamNames>, the action returns an C<InvalidParameterException> | ||
| 127 | error. | ||
| 128 | |||
| 129 | |||
| 130 | |||
| 131 | =head2 NextToken => Str | ||
| 132 | |||
| 133 | The token for the next set of events to return. (You received this | ||
| 134 | token from a previous call.) | ||
| 135 | |||
| 136 | |||
| 137 | |||
| 138 | =head2 StartTime => Int | ||
| 139 | |||
| 140 | The start of the time range, expressed as the number of milliseconds | ||
| 141 | after Jan 1, 1970 00:00:00 UTC. Events with a timestamp before this | ||
| 142 | time are not returned. | ||
| 143 | |||
| 144 | |||
| 145 | |||
| 146 | |||
| 147 | =head1 SEE ALSO | ||
| 148 | |||
| 149 | This class forms part of L<Paws>, documenting arguments for method FilterLogEvents in L<Paws::CloudWatchLogs> | ||
| 150 | |||
| 151 | =head1 BUGS and CONTRIBUTIONS | ||
| 152 | |||
| 153 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 154 | |||
| 155 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 156 | |||
| 157 | =cut | ||
| 158 | |||