View Source aws_athena (aws v1.0.4)
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.Summary
Functions
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.
Returns the details of a single prepared statement or a list of up to 256 prepared statements for the array of prepared statement names that you provide.
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.
Cancels the capacity reservation with the specified name.
Creates (registers) a data catalog with the specified name and properties.
Creates a named query in the specified workgroup.
Creates an empty ipynb
file in the specified Apache Spark enabled workgroup.
Gets an authentication token and the URL at which the notebook can be accessed.
Creates a workgroup with the specified name.
Deletes a cancelled capacity reservation.
Deletes the workgroup with the specified name.
Returns information about a single query.
Returns information about a single execution of a query if you have access to the workgroup in which the query ran.
Streams the results of a single query execution specified by QueryExecutionId
from the Athena query results location in Amazon S3.
Returns query execution runtime statistics related to a single execution of a query if you have access to the workgroup in which the query ran.
Imports a single ipynb
file to a Spark enabled workgroup.
Athena notebook version 1
).Lists the calculations that have been submitted to a session in descending order.
Lists the data catalogs in the current Amazon Web Services account.
Lists, in descending order, the executors that joined a session.
Provides a list of available query IDs only for queries saved in the specified workgroup.
Lists, in descending order, the sessions that have been created in a notebook that are in an active state like CREATING
, CREATED
, IDLE
or BUSY
.
Provides a list of available query execution IDs for the queries in the specified workgroup.
Lists the sessions in a workgroup that are in an active state like CREATING
, CREATED
, IDLE
, or BUSY
.
Puts a new capacity assignment configuration for a specified capacity reservation.
Submits calculations for execution within a session.
Runs the SQL query statements contained in the Query
.
Creates a session for running calculations within a workgroup.
Requests the cancellation of a calculation.
Stops a query execution.
Adds one or more tags to an Athena resource.
Terminates an active session.
Updates a NamedQuery
object.
Updates the workgroup with the specified name.
Functions
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.
Requires you to have access to the workgroup in which the queries were saved. UseListNamedQueriesInput
to get the list of named query IDs in the specified workgroup. If information could not be retrieved for a submitted query ID, information about the query ID submitted is listed under UnprocessedNamedQueryId
. Named queries differ from executed queries. Use BatchGetQueryExecutionInput
to get details about each unique query execution, and ListQueryExecutionsInput
to get a list of query execution IDs.
Returns the details of a single prepared statement or a list of up to 256 prepared statements for the array of prepared statement names that you provide.
Requires you to have access to the workgroup to which the prepared statements belong. If a prepared statement cannot be retrieved for the name specified, the statement is listed inUnprocessedPreparedStatementNames
.
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.
Requires you to have access to the workgroup in which the queries ran. To get a list of query execution IDs, useListQueryExecutionsInput$WorkGroup
. Query executions differ from named (saved) queries. Use BatchGetNamedQueryInput
to get details about named queries.
Cancels the capacity reservation with the specified name.
Cancelled reservations remain in your account and will be deleted 45 days after cancellation. During the 45 days, you cannot re-purpose or reuse a reservation that has been cancelled, but you can refer to its tags and view it for historical reference.Creates (registers) a data catalog with the specified name and properties.
Catalogs created are visible to all users of the same Amazon Web Services account.Creates a named query in the specified workgroup.
Requires that you have access to the workgroup.Creates an empty ipynb
file in the specified Apache Spark enabled workgroup.
Gets an authentication token and the URL at which the notebook can be accessed.
During programmatic access,CreatePresignedNotebookUrl
must be called every 10 minutes to refresh the authentication token. For information about granting programmatic access, see Grant programmatic access: https://docs.aws.amazon.com/athena/latest/ug/setting-up.html#setting-up-grant-programmatic-access.
Creates a workgroup with the specified name.
A workgroup can be an Apache Spark enabled workgroup or an Athena SQL workgroup.Deletes a cancelled capacity reservation.
A reservation must be cancelled before it can be deleted. A deleted reservation is immediately removed from your account and can no longer be referenced, including by its ARN. A deleted reservation cannot be called byGetCapacityReservation
, and deleted reservations do not appear in the output of ListCapacityReservations
.
Deletes the workgroup with the specified name.
The primary workgroup cannot be deleted.Returns information about a single query.
Requires that you have access to the workgroup in which the query was saved.Returns information about a single execution of a query if you have access to the workgroup in which the query ran.
Each time a query executes, information about the query execution is saved with a unique ID.Streams the results of a single query execution specified by QueryExecutionId
from the Athena query results location in Amazon S3.
For more information, see Working with query results, recent queries, and output files: https://docs.aws.amazon.com/athena/latest/ug/querying.html in the Amazon Athena User Guide. This request does not execute the query but returns results. Use StartQueryExecution
to run a query.
To stream query results successfully, the IAM principal with permission to call GetQueryResults
also must have permissions to the Amazon S3 GetObject
action for the Athena query results location.
GetObject
action for the query results location are able to retrieve query results from Amazon S3 even if permission to the GetQueryResults
action is denied. To restrict user or role access, ensure that Amazon S3 permissions to the Athena query location are denied.
Returns query execution runtime statistics related to a single execution of a query if you have access to the workgroup in which the query ran.
Query execution runtime statistics are returned only whenQueryExecutionStatus$State
is in a SUCCEEDED or FAILED state. Stage-level input and output row count and data size statistics are not shown when a query has row-level filters defined in Lake Formation.
Imports a single ipynb
file to a Spark enabled workgroup.
Payload
or NoteBookS3LocationUri
. If neither is specified or both are specified, an InvalidRequestException
occurs. The maximum file size that can be imported is 10 megabytes. If an ipynb
file with the same name already exists in the workgroup, throws an error.
Athena notebook version 1
).
Lists the calculations that have been submitted to a session in descending order.
Newer calculations are listed first; older calculations are listed later.Lists the data catalogs in the current Amazon Web Services account.
In the Athena console, data catalogs are listed as "data sources" on the Data sources page under the Data source name column.Lists, in descending order, the executors that joined a session.
Newer executors are listed first; older executors are listed later. The result can be optionally filtered by state.Provides a list of available query IDs only for queries saved in the specified workgroup.
Requires that you have access to the specified workgroup. If a workgroup is not specified, lists the saved queries for the primary workgroup.Lists, in descending order, the sessions that have been created in a notebook that are in an active state like CREATING
, CREATED
, IDLE
or BUSY
.
Provides a list of available query execution IDs for the queries in the specified workgroup.
Athena keeps a query history for 45 days. If a workgroup is not specified, returns a list of query execution IDs for the primary workgroup. Requires you to have access to the workgroup in which the queries ran.Lists the sessions in a workgroup that are in an active state like CREATING
, CREATED
, IDLE
, or BUSY
.
Puts a new capacity assignment configuration for a specified capacity reservation.
If a capacity assignment configuration already exists for the capacity reservation, replaces the existing capacity assignment configuration.Submits calculations for execution within a session.
You can supply the code to run as an inline code block within the request.
The request syntax requires theStartCalculationExecutionRequest$CodeBlock
parameter or the CalculationConfiguration$CodeBlock
parameter, but not both. Because CalculationConfiguration$CodeBlock
is deprecated, use the StartCalculationExecutionRequest$CodeBlock
parameter instead.
Runs the SQL query statements contained in the Query
.
GetDataCatalog
permission to the catalog. For code samples using the Amazon Web Services 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.
Creates a session for running calculations within a workgroup.
The session is ready when it reaches anIDLE
state.
Requests the cancellation of a calculation.
A StopCalculationExecution
call on a calculation that is already in a terminal state (for example, STOPPED
, FAILED
, or COMPLETED
) succeeds but has no effect.
Stops a query execution.
Requires you to have access to the workgroup in which the query ran.Adds one or more tags to an Athena resource.
A tag is a label that you assign to a resource. Each tag consists of a key and an optional value, both of which you define. For example, you can use tags to categorize Athena workgroups, data catalogs, or capacity reservations by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter the resources in your account. For best practices, see Tagging Best Practices: https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/tagging-best-practices.html. Tag keys can be from 1 to 128 UTF-8 Unicode characters, and tag values can be from 0 to 256 UTF-8 Unicode characters. Tags can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Tag keys must be unique per resource. If you specify more than one tag, separate them by commas.Terminates an active session.
ATerminateSession
call on a session that is already inactive (for example, in a FAILED
, TERMINATED
or TERMINATING
state) succeeds but has no effect. Calculations running in the session when TerminateSession
is called are forcefully stopped, but may display as FAILED
instead of STOPPED
.
Updates a NamedQuery
object.
Updates the workgroup with the specified name.
The workgroup's name cannot be changed. OnlyConfigurationUpdates
can be specified.