« blib/lib/Paws/Athena/PreparedStatementSummary.pm
↑ Summary
blib/lib/Paws/Athena/QueryExecutionContext.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Athena::QueryExecution; | ||
| 3 | use Moose; | ||
| 4 | has EngineVersion => (is => 'ro', isa => 'Paws::Athena::EngineVersion'); | ||
| 5 | has Query => (is => 'ro', isa => 'Str'); | ||
| 6 | has QueryExecutionContext => (is => 'ro', isa => 'Paws::Athena::QueryExecutionContext'); | ||
| 7 | has QueryExecutionId => (is => 'ro', isa => 'Str'); | ||
| 8 | has ResultConfiguration => (is => 'ro', isa => 'Paws::Athena::ResultConfiguration'); | ||
| 9 | has StatementType => (is => 'ro', isa => 'Str'); | ||
| 10 | has Statistics => (is => 'ro', isa => 'Paws::Athena::QueryExecutionStatistics'); | ||
| 11 | has Status => (is => 'ro', isa => 'Paws::Athena::QueryExecutionStatus'); | ||
| 12 | has WorkGroup => (is => 'ro', isa => 'Str'); | ||
| 13 | |||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::Athena::QueryExecution | ||
| 21 | |||
| 22 | =head1 USAGE | ||
| 23 | |||
| 24 | This class represents one of two things: | ||
| 25 | |||
| 26 | =head3 Arguments in a call to a service | ||
| 27 | |||
| 28 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 29 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 30 | |||
| 31 | As an example, if Att1 is expected to be a Paws::Athena::QueryExecution object: | ||
| 32 | |||
| 33 | $service_obj->Method(Att1 => { EngineVersion => $value, ..., WorkGroup => $value }); | ||
| 34 | |||
| 35 | =head3 Results returned from an API call | ||
| 36 | |||
| 37 | Use accessors for each attribute. If Att1 is expected to be an Paws::Athena::QueryExecution object: | ||
| 38 | |||
| 39 | $result = $service_obj->Method(...); | ||
| 40 | $result->Att1->EngineVersion | ||
| 41 | |||
| 42 | =head1 DESCRIPTION | ||
| 43 | |||
| 44 | Information about a single instance of a query execution. | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 EngineVersion => L<Paws::Athena::EngineVersion> | ||
| 50 | |||
| 51 | The engine version that executed the query. | ||
| 52 | |||
| 53 | |||
| 54 | =head2 Query => Str | ||
| 55 | |||
| 56 | The SQL query statements which the query execution ran. | ||
| 57 | |||
| 58 | |||
| 59 | =head2 QueryExecutionContext => L<Paws::Athena::QueryExecutionContext> | ||
| 60 | |||
| 61 | The database in which the query execution occurred. | ||
| 62 | |||
| 63 | |||
| 64 | =head2 QueryExecutionId => Str | ||
| 65 | |||
| 66 | The unique identifier for each query execution. | ||
| 67 | |||
| 68 | |||
| 69 | =head2 ResultConfiguration => L<Paws::Athena::ResultConfiguration> | ||
| 70 | |||
| 71 | The location in Amazon S3 where query results were stored and the | ||
| 72 | encryption option, if any, used for query results. These are known as | ||
| 73 | "client-side settings". If workgroup settings override client-side | ||
| 74 | settings, then the query uses the location for the query results and | ||
| 75 | the encryption configuration that are specified for the workgroup. | ||
| 76 | |||
| 77 | |||
| 78 | =head2 StatementType => Str | ||
| 79 | |||
| 80 | The type of query statement that was run. C<DDL> indicates DDL query | ||
| 81 | statements. C<DML> indicates DML (Data Manipulation Language) query | ||
| 82 | statements, such as C<CREATE TABLE AS SELECT>. C<UTILITY> indicates | ||
| 83 | query statements other than DDL and DML, such as C<SHOW CREATE TABLE>, | ||
| 84 | or C<DESCRIBE E<lt>tableE<gt>>. | ||
| 85 | |||
| 86 | |||
| 87 | =head2 Statistics => L<Paws::Athena::QueryExecutionStatistics> | ||
| 88 | |||
| 89 | Query execution statistics, such as the amount of data scanned, the | ||
| 90 | amount of time that the query took to process, and the type of | ||
| 91 | statement that was run. | ||
| 92 | |||
| 93 | |||
| 94 | =head2 Status => L<Paws::Athena::QueryExecutionStatus> | ||
| 95 | |||
| 96 | The completion date, current state, submission time, and state change | ||
| 97 | reason (if applicable) for the query execution. | ||
| 98 | |||
| 99 | |||
| 100 | =head2 WorkGroup => Str | ||
| 101 | |||
| 102 | The name of the workgroup in which the query ran. | ||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | =head1 SEE ALSO | ||
| 107 | |||
| 108 | This class forms part of L<Paws>, describing an object used in L<Paws::Athena> | ||
| 109 | |||
| 110 | =head1 BUGS and CONTRIBUTIONS | ||
| 111 | |||
| 112 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 113 | |||
| 114 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 115 | |||
| 116 | =cut | ||
| 117 |