AthenaClient Class

(QtAws::Athena::AthenaClient)

The AthenaClient class provides access to the Amazon Athena service. More...

Header: #include <AthenaClient>
Inherits: QtAws::Core::AwsAbstractClient

Public Functions

AthenaClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)
AthenaClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Public Slots

BatchGetNamedQueryResponse *batchGetNamedQuery(const BatchGetNamedQueryRequest &request)
BatchGetQueryExecutionResponse *batchGetQueryExecution(const BatchGetQueryExecutionRequest &request)
CreateNamedQueryResponse *createNamedQuery(const CreateNamedQueryRequest &request)
DeleteNamedQueryResponse *deleteNamedQuery(const DeleteNamedQueryRequest &request)
GetNamedQueryResponse *getNamedQuery(const GetNamedQueryRequest &request)
GetQueryExecutionResponse *getQueryExecution(const GetQueryExecutionRequest &request)
GetQueryResultsResponse *getQueryResults(const GetQueryResultsRequest &request)
ListNamedQueriesResponse *listNamedQueries(const ListNamedQueriesRequest &request)
ListQueryExecutionsResponse *listQueryExecutions(const ListQueryExecutionsRequest &request)
StartQueryExecutionResponse *startQueryExecution(const StartQueryExecutionRequest &request)
StopQueryExecutionResponse *stopQueryExecution(const StopQueryExecutionRequest &request)

Additional Inherited Members

Detailed Description

The AthenaClient class provides access to the Amazon Athena service.

Amazon Athena is an interactive query service that lets you use standard SQL to analyze data directly in Amazon S3. You can point Athena at your data in Amazon S3 and run ad-hoc queries and get results in seconds. Athena is serverless, so there is no infrastructure to set up or manage. You pay only for the queries you run. Athena scales automatically—executing queries in parallel—so results are fast, even with large datasets and complex queries. For more information, see <a href="http://docs.aws.amazon.com/athena/latest/ug/what-is.html">What is Amazon Athena</a> in the <i>Amazon Athena User

Guide</i>>

For code samples using the AWS SDK for Java, see <a href="http://docs.aws.amazon.com/athena/latest/ug/code-samples.html">Examples and Code Samples</a> in the <i>Amazon Athena User

Member Function Documentation

AthenaClient::AthenaClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Constructs a AthenaClient object.

The new client object will region, credentials, and manager for network operations.

The new object will be owned by parent, if set.

AthenaClient::AthenaClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

This function overloads AthenaClient().

This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).

See also QtAws::Core::AwsEndpoint::getEndpoint.

[slot] BatchGetNamedQueryResponse *AthenaClient::batchGetNamedQuery(const BatchGetNamedQueryRequest &request)

Sends request to the AthenaClient service, and returns a pointer to an BatchGetNamedQueryResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns the details of a single named query or a list of up to 50 queries, which you provide as an array of query ID strings. Use <a>ListNamedQueries</a> to get the list of named query IDs. If information could not be retrieved for a submitted query ID, information about the query ID submitted is listed under <a>UnprocessedNamedQueryId</a>. Named queries are different from executed queries. Use <a>BatchGetQueryExecution</a> to get details about each unique query execution, and <a>ListQueryExecutions</a> to get a list of query execution

[slot] BatchGetQueryExecutionResponse *AthenaClient::batchGetQueryExecution(const BatchGetQueryExecutionRequest &request)

Sends request to the AthenaClient service, and returns a pointer to an BatchGetQueryExecutionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns the details of a single query execution or a list of up to 50 query executions, which you provide as an array of query execution ID strings. To get a list of query execution IDs, use <a>ListQueryExecutions</a>. Query executions are different from named (saved) queries. Use <a>BatchGetNamedQuery</a> to get details about named

[slot] CreateNamedQueryResponse *AthenaClient::createNamedQuery(const CreateNamedQueryRequest &request)

Sends request to the AthenaClient service, and returns a pointer to an CreateNamedQueryResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a named

query>

For code samples using the AWS SDK for Java, see <a href="http://docs.aws.amazon.com/athena/latest/ug/code-samples.html">Examples and Code Samples</a> in the <i>Amazon Athena User

[slot] DeleteNamedQueryResponse *AthenaClient::deleteNamedQuery(const DeleteNamedQueryRequest &request)

Sends request to the AthenaClient service, and returns a pointer to an DeleteNamedQueryResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes a named

query>

For code samples using the AWS SDK for Java, see <a href="http://docs.aws.amazon.com/athena/latest/ug/code-samples.html">Examples and Code Samples</a> in the <i>Amazon Athena User

[slot] GetNamedQueryResponse *AthenaClient::getNamedQuery(const GetNamedQueryRequest &request)

Sends request to the AthenaClient service, and returns a pointer to an GetNamedQueryResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns information about a single

[slot] GetQueryExecutionResponse *AthenaClient::getQueryExecution(const GetQueryExecutionRequest &request)

Sends request to the AthenaClient service, and returns a pointer to an GetQueryExecutionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns information about a single execution of a query. Each time a query executes, information about the query execution is saved with a unique

[slot] GetQueryResultsResponse *AthenaClient::getQueryResults(const GetQueryResultsRequest &request)

Sends request to the AthenaClient service, and returns a pointer to an GetQueryResultsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns the results of a single query execution specified by <code>QueryExecutionId</code>. This request does not execute the query but returns results. Use <a>StartQueryExecution</a> to run a

[slot] ListNamedQueriesResponse *AthenaClient::listNamedQueries(const ListNamedQueriesRequest &request)

Sends request to the AthenaClient service, and returns a pointer to an ListNamedQueriesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Provides a list of all available query

IDs>

For code samples using the AWS SDK for Java, see <a href="http://docs.aws.amazon.com/athena/latest/ug/code-samples.html">Examples and Code Samples</a> in the <i>Amazon Athena User

[slot] ListQueryExecutionsResponse *AthenaClient::listQueryExecutions(const ListQueryExecutionsRequest &request)

Sends request to the AthenaClient service, and returns a pointer to an ListQueryExecutionsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Provides a list of all available query execution

IDs>

For code samples using the AWS SDK for Java, see <a href="http://docs.aws.amazon.com/athena/latest/ug/code-samples.html">Examples and Code Samples</a> in the <i>Amazon Athena User

[slot] StartQueryExecutionResponse *AthenaClient::startQueryExecution(const StartQueryExecutionRequest &request)

Sends request to the AthenaClient service, and returns a pointer to an StartQueryExecutionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Runs (executes) the SQL query statements contained in the <code>Query</code>

string>

For code samples using the AWS SDK for Java, see <a href="http://docs.aws.amazon.com/athena/latest/ug/code-samples.html">Examples and Code Samples</a> in the <i>Amazon Athena User

[slot] StopQueryExecutionResponse *AthenaClient::stopQueryExecution(const StopQueryExecutionRequest &request)

Sends request to the AthenaClient service, and returns a pointer to an StopQueryExecutionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Stops a query

execution>

For code samples using the AWS SDK for Java, see <a href="http://docs.aws.amazon.com/athena/latest/ug/code-samples.html">Examples and Code Samples</a> in the <i>Amazon Athena User

© 2018 Paul Colby Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.