« blib/lib/Paws/CloudWatchLogs/ResultField.pm
↑ Summary
blib/lib/Paws/CloudWatchLogs/StartQueryResponse.pm »
| 1 | |||
| 2 | package Paws::CloudWatchLogs::StartQuery; | ||
| 3 | use Moose; | ||
| 4 | has EndTime => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'endTime' , required => 1); | ||
| 5 | has Limit => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'limit' ); | ||
| 6 | has LogGroupName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'logGroupName' ); | ||
| 7 | has LogGroupNames => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'logGroupNames' ); | ||
| 8 | has QueryString => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'queryString' , required => 1); | ||
| 9 | has StartTime => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'startTime' , required => 1); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'StartQuery'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudWatchLogs::StartQueryResponse'); | ||
| 15 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::CloudWatchLogs::StartQuery - Arguments for method StartQuery on L<Paws::CloudWatchLogs> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method StartQuery on the | ||
| 27 | L<Amazon CloudWatch Logs|Paws::CloudWatchLogs> service. Use the attributes of this class | ||
| 28 | as arguments to method StartQuery. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartQuery. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $logs = Paws->service('CloudWatchLogs'); | ||
| 35 | my $StartQueryResponse = $logs->StartQuery( | ||
| 36 | EndTime => 1, | ||
| 37 | QueryString => 'MyQueryString', | ||
| 38 | StartTime => 1, | ||
| 39 | Limit => 1, # OPTIONAL | ||
| 40 | LogGroupName => 'MyLogGroupName', # OPTIONAL | ||
| 41 | LogGroupNames => [ | ||
| 42 | 'MyLogGroupName', ... # min: 1, max: 512 | ||
| 43 | ], # OPTIONAL | ||
| 44 | ); | ||
| 45 | |||
| 46 | # Results: | ||
| 47 | my $QueryId = $StartQueryResponse->QueryId; | ||
| 48 | |||
| 49 | # Returns a L<Paws::CloudWatchLogs::StartQueryResponse> object. | ||
| 50 | |||
| 51 | 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. | ||
| 52 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/logs/StartQuery> | ||
| 53 | |||
| 54 | =head1 ATTRIBUTES | ||
| 55 | |||
| 56 | |||
| 57 | =head2 B<REQUIRED> EndTime => Int | ||
| 58 | |||
| 59 | The end of the time range to query. The range is inclusive, so the | ||
| 60 | specified end time is included in the query. Specified as epoch time, | ||
| 61 | the number of seconds since January 1, 1970, 00:00:00 UTC. | ||
| 62 | |||
| 63 | |||
| 64 | |||
| 65 | =head2 Limit => Int | ||
| 66 | |||
| 67 | The maximum number of log events to return in the query. If the query | ||
| 68 | string uses the C<fields> command, only the specified fields and their | ||
| 69 | values are returned. The default is 1000. | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head2 LogGroupName => Str | ||
| 74 | |||
| 75 | The log group on which to perform the query. | ||
| 76 | |||
| 77 | A C<StartQuery> operation must include a C<logGroupNames> or a | ||
| 78 | C<logGroupName> parameter, but not both. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 LogGroupNames => ArrayRef[Str|Undef] | ||
| 83 | |||
| 84 | The list of log groups to be queried. You can include up to 20 log | ||
| 85 | groups. | ||
| 86 | |||
| 87 | A C<StartQuery> operation must include a C<logGroupNames> or a | ||
| 88 | C<logGroupName> parameter, but not both. | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head2 B<REQUIRED> QueryString => Str | ||
| 93 | |||
| 94 | The query string to use. For more information, see CloudWatch Logs | ||
| 95 | Insights Query Syntax | ||
| 96 | (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html). | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | =head2 B<REQUIRED> StartTime => Int | ||
| 101 | |||
| 102 | The beginning of the time range to query. The range is inclusive, so | ||
| 103 | the specified start time is included in the query. Specified as epoch | ||
| 104 | time, the number of seconds since January 1, 1970, 00:00:00 UTC. | ||
| 105 | |||
| 106 | |||
| 107 | |||
| 108 | |||
| 109 | =head1 SEE ALSO | ||
| 110 | |||
| 111 | This class forms part of L<Paws>, documenting arguments for method StartQuery in L<Paws::CloudWatchLogs> | ||
| 112 | |||
| 113 | =head1 BUGS and CONTRIBUTIONS | ||
| 114 | |||
| 115 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 116 | |||
| 117 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 118 | |||
| 119 | =cut | ||
| 120 |