« blib/lib/Paws/Athena/QueryExecutionStatistics.pm
↑ Summary
blib/lib/Paws/Athena/ResultConfiguration.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Athena::QueryExecutionStatus; | ||
| 3 | use Moose; | ||
| 4 | has CompletionDateTime => (is => 'ro', isa => 'Str'); | ||
| 5 | has State => (is => 'ro', isa => 'Str'); | ||
| 6 | has StateChangeReason => (is => 'ro', isa => 'Str'); | ||
| 7 | has SubmissionDateTime => (is => 'ro', isa => 'Str'); | ||
| 8 | |||
| 9 | 1; | ||
| 10 | |||
| 11 | ### main pod documentation begin ### | ||
| 12 | |||
| 13 | =head1 NAME | ||
| 14 | |||
| 15 | Paws::Athena::QueryExecutionStatus | ||
| 16 | |||
| 17 | =head1 USAGE | ||
| 18 | |||
| 19 | This class represents one of two things: | ||
| 20 | |||
| 21 | =head3 Arguments in a call to a service | ||
| 22 | |||
| 23 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 24 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 25 | |||
| 26 | As an example, if Att1 is expected to be a Paws::Athena::QueryExecutionStatus object: | ||
| 27 | |||
| 28 | $service_obj->Method(Att1 => { CompletionDateTime => $value, ..., SubmissionDateTime => $value }); | ||
| 29 | |||
| 30 | =head3 Results returned from an API call | ||
| 31 | |||
| 32 | Use accessors for each attribute. If Att1 is expected to be an Paws::Athena::QueryExecutionStatus object: | ||
| 33 | |||
| 34 | $result = $service_obj->Method(...); | ||
| 35 | $result->Att1->CompletionDateTime | ||
| 36 | |||
| 37 | =head1 DESCRIPTION | ||
| 38 | |||
| 39 | The completion date, current state, submission time, and state change | ||
| 40 | reason (if applicable) for the query execution. | ||
| 41 | |||
| 42 | =head1 ATTRIBUTES | ||
| 43 | |||
| 44 | |||
| 45 | =head2 CompletionDateTime => Str | ||
| 46 | |||
| 47 | The date and time that the query completed. | ||
| 48 | |||
| 49 | |||
| 50 | =head2 State => Str | ||
| 51 | |||
| 52 | The state of query execution. C<QUEUED> indicates that the query has | ||
| 53 | been submitted to the service, and Athena will execute the query as | ||
| 54 | soon as resources are available. C<RUNNING> indicates that the query is | ||
| 55 | in execution phase. C<SUCCEEDED> indicates that the query completed | ||
| 56 | without errors. C<FAILED> indicates that the query experienced an error | ||
| 57 | and did not complete processing. C<CANCELLED> indicates that a user | ||
| 58 | input interrupted query execution. | ||
| 59 | |||
| 60 | Athena automatically retries your queries in cases of certain transient | ||
| 61 | errors. As a result, you may see the query state transition from | ||
| 62 | C<RUNNING> or C<FAILED> to C<QUEUED>. | ||
| 63 | |||
| 64 | |||
| 65 | =head2 StateChangeReason => Str | ||
| 66 | |||
| 67 | Further detail about the status of the query. | ||
| 68 | |||
| 69 | |||
| 70 | =head2 SubmissionDateTime => Str | ||
| 71 | |||
| 72 | The date and time that the query was submitted. | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | =head1 SEE ALSO | ||
| 77 | |||
| 78 | This class forms part of L<Paws>, describing an object used in L<Paws::Athena> | ||
| 79 | |||
| 80 | =head1 BUGS and CONTRIBUTIONS | ||
| 81 | |||
| 82 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 83 | |||
| 84 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 85 | |||
| 86 | =cut | ||
| 87 |