« blib/lib/Paws/Athena/QueryExecutionContext.pm
↑ Summary
blib/lib/Paws/Athena/QueryExecutionStatus.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Athena::QueryExecutionStatistics; | ||
| 3 | use Moose; | ||
| 4 | has DataManifestLocation => (is => 'ro', isa => 'Str'); | ||
| 5 | has DataScannedInBytes => (is => 'ro', isa => 'Int'); | ||
| 6 | has EngineExecutionTimeInMillis => (is => 'ro', isa => 'Int'); | ||
| 7 | has QueryPlanningTimeInMillis => (is => 'ro', isa => 'Int'); | ||
| 8 | has QueryQueueTimeInMillis => (is => 'ro', isa => 'Int'); | ||
| 9 | has ServiceProcessingTimeInMillis => (is => 'ro', isa => 'Int'); | ||
| 10 | has TotalExecutionTimeInMillis => (is => 'ro', isa => 'Int'); | ||
| 11 | |||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::Athena::QueryExecutionStatistics | ||
| 19 | |||
| 20 | =head1 USAGE | ||
| 21 | |||
| 22 | This class represents one of two things: | ||
| 23 | |||
| 24 | =head3 Arguments in a call to a service | ||
| 25 | |||
| 26 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 27 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 28 | |||
| 29 | As an example, if Att1 is expected to be a Paws::Athena::QueryExecutionStatistics object: | ||
| 30 | |||
| 31 | $service_obj->Method(Att1 => { DataManifestLocation => $value, ..., TotalExecutionTimeInMillis => $value }); | ||
| 32 | |||
| 33 | =head3 Results returned from an API call | ||
| 34 | |||
| 35 | Use accessors for each attribute. If Att1 is expected to be an Paws::Athena::QueryExecutionStatistics object: | ||
| 36 | |||
| 37 | $result = $service_obj->Method(...); | ||
| 38 | $result->Att1->DataManifestLocation | ||
| 39 | |||
| 40 | =head1 DESCRIPTION | ||
| 41 | |||
| 42 | The amount of data scanned during the query execution and the amount of | ||
| 43 | time that it took to execute, and the type of statement that was run. | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 DataManifestLocation => Str | ||
| 49 | |||
| 50 | The location and file name of a data manifest file. The manifest file | ||
| 51 | is saved to the Athena query results location in Amazon S3. The | ||
| 52 | manifest file tracks files that the query wrote to Amazon S3. If the | ||
| 53 | query fails, the manifest file also tracks files that the query | ||
| 54 | intended to write. The manifest is useful for identifying orphaned | ||
| 55 | files resulting from a failed query. For more information, see Working | ||
| 56 | with Query Results, Output Files, and Query History | ||
| 57 | (https://docs.aws.amazon.com/athena/latest/ug/querying.html) in the | ||
| 58 | I<Amazon Athena User Guide>. | ||
| 59 | |||
| 60 | |||
| 61 | =head2 DataScannedInBytes => Int | ||
| 62 | |||
| 63 | The number of bytes in the data that was queried. | ||
| 64 | |||
| 65 | |||
| 66 | =head2 EngineExecutionTimeInMillis => Int | ||
| 67 | |||
| 68 | The number of milliseconds that the query took to execute. | ||
| 69 | |||
| 70 | |||
| 71 | =head2 QueryPlanningTimeInMillis => Int | ||
| 72 | |||
| 73 | The number of milliseconds that Athena took to plan the query | ||
| 74 | processing flow. This includes the time spent retrieving table | ||
| 75 | partitions from the data source. Note that because the query engine | ||
| 76 | performs the query planning, query planning time is a subset of engine | ||
| 77 | processing time. | ||
| 78 | |||
| 79 | |||
| 80 | =head2 QueryQueueTimeInMillis => Int | ||
| 81 | |||
| 82 | The number of milliseconds that the query was in your query queue | ||
| 83 | waiting for resources. Note that if transient errors occur, Athena | ||
| 84 | might automatically add the query back to the queue. | ||
| 85 | |||
| 86 | |||
| 87 | =head2 ServiceProcessingTimeInMillis => Int | ||
| 88 | |||
| 89 | The number of milliseconds that Athena took to finalize and publish the | ||
| 90 | query results after the query engine finished running the query. | ||
| 91 | |||
| 92 | |||
| 93 | =head2 TotalExecutionTimeInMillis => Int | ||
| 94 | |||
| 95 | The number of milliseconds that Athena took to run the query. | ||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head1 SEE ALSO | ||
| 100 | |||
| 101 | This class forms part of L<Paws>, describing an object used in L<Paws::Athena> | ||
| 102 | |||
| 103 | =head1 BUGS and CONTRIBUTIONS | ||
| 104 | |||
| 105 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 106 | |||
| 107 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 108 | |||
| 109 | =cut | ||
| 110 |