The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

Paws::CloudWatchLogs::StartQuery - Arguments for method StartQuery on Paws::CloudWatchLogs

DESCRIPTION

This class represents the parameters used for calling the method StartQuery on the Amazon CloudWatch Logs service. Use the attributes of this class as arguments to method StartQuery.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartQuery.

SYNOPSIS

    my $logs = Paws->service('CloudWatchLogs');
    my $StartQueryResponse = $logs->StartQuery(
      EndTime       => 1,
      QueryString   => 'MyQueryString',
      StartTime     => 1,
      Limit         => 1,                   # OPTIONAL
      LogGroupName  => 'MyLogGroupName',    # OPTIONAL
      LogGroupNames => [
        'MyLogGroupName', ...               # min: 1, max: 512
      ],    # OPTIONAL
    );

    # Results:
    my $QueryId = $StartQueryResponse->QueryId;

    # Returns a L<Paws::CloudWatchLogs::StartQueryResponse> object.

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. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/logs/StartQuery

ATTRIBUTES

REQUIRED EndTime => Int

The end of the time range to query. The range is inclusive, so the specified end time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

Limit => Int

The maximum number of log events to return in the query. If the query string uses the fields command, only the specified fields and their values are returned. The default is 1000.

LogGroupName => Str

The log group on which to perform the query.

A StartQuery operation must include a logGroupNames or a logGroupName parameter, but not both.

LogGroupNames => ArrayRef[Str|Undef]

The list of log groups to be queried. You can include up to 20 log groups.

A StartQuery operation must include a logGroupNames or a logGroupName parameter, but not both.

REQUIRED QueryString => Str

The query string to use. For more information, see CloudWatch Logs Insights Query Syntax (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html).

REQUIRED StartTime => Int

The beginning of the time range to query. The range is inclusive, so the specified start time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

SEE ALSO

This class forms part of Paws, documenting arguments for method StartQuery in Paws::CloudWatchLogs

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues