The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Paws-0.40
River stage two • 9 direct dependents • 11 total dependents
57 ++
/ Paws::Athena

NAME

Paws::Athena - Perl Interface to AWS Amazon Athena

SYNOPSIS

  use Paws;

  my $obj = Paws->service('Athena');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

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 What is Amazon Athena (http://docs.aws.amazon.com/athena/latest/ug/what-is.html) in the Amazon Athena User Guide.

If you connect to Athena using the JDBC driver, use version 1.1.0 of the driver or later with the Amazon Athena API. Earlier version drivers do not support the API. For more information and to download the driver, see Accessing Amazon Athena with JDBC (https://docs.aws.amazon.com/athena/latest/ug/connect-with-jdbc.html).

For code samples using the AWS SDK for Java, see Examples and Code Samples (https://docs.aws.amazon.com/athena/latest/ug/code-samples.html) in the Amazon Athena User Guide.

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18

METHODS

BatchGetNamedQuery

NamedQueryIds => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::Athena::BatchGetNamedQuery

Returns: a Paws::Athena::BatchGetNamedQueryOutput instance

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 ListNamedQueries 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 UnprocessedNamedQueryId. Named queries are different from executed queries. Use BatchGetQueryExecution to get details about each unique query execution, and ListQueryExecutions to get a list of query execution IDs.

BatchGetQueryExecution

QueryExecutionIds => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::Athena::BatchGetQueryExecution

Returns: a Paws::Athena::BatchGetQueryExecutionOutput instance

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 ListQueryExecutions. Query executions are different from named (saved) queries. Use BatchGetNamedQuery to get details about named queries.

CreateNamedQuery

Database => Str
Name => Str
QueryString => Str
[ClientRequestToken => Str]
[Description => Str]

Each argument is described in detail in: Paws::Athena::CreateNamedQuery

Returns: a Paws::Athena::CreateNamedQueryOutput instance

Creates a named query.

For code samples using the AWS SDK for Java, see Examples and Code Samples (http://docs.aws.amazon.com/athena/latest/ug/code-samples.html) in the Amazon Athena User Guide.

DeleteNamedQuery

NamedQueryId => Str

Each argument is described in detail in: Paws::Athena::DeleteNamedQuery

Returns: a Paws::Athena::DeleteNamedQueryOutput instance

Deletes a named query.

For code samples using the AWS SDK for Java, see Examples and Code Samples (http://docs.aws.amazon.com/athena/latest/ug/code-samples.html) in the Amazon Athena User Guide.

GetNamedQuery

NamedQueryId => Str

Each argument is described in detail in: Paws::Athena::GetNamedQuery

Returns: a Paws::Athena::GetNamedQueryOutput instance

Returns information about a single query.

GetQueryExecution

QueryExecutionId => Str

Each argument is described in detail in: Paws::Athena::GetQueryExecution

Returns: a Paws::Athena::GetQueryExecutionOutput instance

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

GetQueryResults

QueryExecutionId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Athena::GetQueryResults

Returns: a Paws::Athena::GetQueryResultsOutput instance

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

ListNamedQueries

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Athena::ListNamedQueries

Returns: a Paws::Athena::ListNamedQueriesOutput instance

Provides a list of all available query IDs.

For code samples using the AWS SDK for Java, see Examples and Code Samples (http://docs.aws.amazon.com/athena/latest/ug/code-samples.html) in the Amazon Athena User Guide.

ListQueryExecutions

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Athena::ListQueryExecutions

Returns: a Paws::Athena::ListQueryExecutionsOutput instance

Provides a list of all available query execution IDs.

For code samples using the AWS SDK for Java, see Examples and Code Samples (http://docs.aws.amazon.com/athena/latest/ug/code-samples.html) in the Amazon Athena User Guide.

StartQueryExecution

QueryString => Str
ResultConfiguration => Paws::Athena::ResultConfiguration
[ClientRequestToken => Str]
[QueryExecutionContext => Paws::Athena::QueryExecutionContext]

Each argument is described in detail in: Paws::Athena::StartQueryExecution

Returns: a Paws::Athena::StartQueryExecutionOutput instance

Runs (executes) the SQL query statements contained in the Query string.

For code samples using the AWS SDK for Java, see Examples and Code Samples (http://docs.aws.amazon.com/athena/latest/ug/code-samples.html) in the Amazon Athena User Guide.

StopQueryExecution

QueryExecutionId => Str

Each argument is described in detail in: Paws::Athena::StopQueryExecution

Returns: a Paws::Athena::StopQueryExecutionOutput instance

Stops a query execution.

For code samples using the AWS SDK for Java, see Examples and Code Samples (http://docs.aws.amazon.com/athena/latest/ug/code-samples.html) in the Amazon Athena User Guide.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

GetAllQueryResults(sub { },QueryExecutionId => Str, [MaxResults => Int, NextToken => Str])

GetAllQueryResults(QueryExecutionId => Str, [MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - ResultSet.Rows, passing the object as the first parameter, and the string 'ResultSet.Rows' as the second parameter

If not, it will return a a Paws::Athena::GetQueryResultsOutput instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllNamedQueries(sub { },[MaxResults => Int, NextToken => Str])

ListAllNamedQueries([MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - NamedQueryIds, passing the object as the first parameter, and the string 'NamedQueryIds' as the second parameter

If not, it will return a a Paws::Athena::ListNamedQueriesOutput instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllQueryExecutions(sub { },[MaxResults => Int, NextToken => Str])

ListAllQueryExecutions([MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - QueryExecutionIds, passing the object as the first parameter, and the string 'QueryExecutionIds' as the second parameter

If not, it will return a a Paws::Athena::ListQueryExecutionsOutput instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

SEE ALSO

This service class forms part of Paws

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