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 a capacity reservation with the specified name and number of requested data processing units.

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.

Creates a prepared statement for use with SQL queries in Athena.

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 a data catalog.
Deletes the named query if you have access to the workgroup in which the query was saved.
Deletes the specified notebook.
Deletes the prepared statement with the specified name from the specified workgroup.

Deletes the workgroup with the specified name.

Exports the specified notebook and its metadata.
Describes a previously submitted calculation execution.
Retrieves the unencrypted code that was executed for the calculation.
Gets the status of a current calculation.
Gets the capacity assignment configuration for a capacity reservation, if one exists.
Returns information about the capacity reservation with the specified name.
Returns the specified data catalog.
Returns a database object for the specified database and data catalog.

Returns information about a single query.

Retrieves notebook metadata for the specified notebook ID.
Retrieves the prepared statement with the specified name from the specified workgroup.

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.

Gets the full details of a previously created session, including the session status and configuration.
Gets the current status of a session.
Returns table metadata for the specified catalog, database, and table.
Returns information about the workgroup with the specified name.

Imports a single ipynb file to a Spark enabled workgroup.

Returns the supported DPU sizes for the supported application runtimes (for example, Athena notebook version 1).

Lists the calculations that have been submitted to a session in descending order.

Lists the capacity reservations for the current account.

Lists the data catalogs in the current Amazon Web Services account.

Lists the databases in the specified data catalog.
Returns a list of engine versions that are available to choose from, including the Auto option.

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.

Displays the notebook files for the specified workgroup in paginated format.

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.

Lists the prepared statements in the specified workgroup.

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.

Lists the metadata for the tables in the specified data catalog database.
Lists the tags associated with an Athena resource.
Lists available workgroups for the account.

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.

Removes one or more tags from an Athena resource.
Updates the number of requested data processing units for the capacity reservation with the specified name.
Updates the data catalog that has the specified name.

Updates a NamedQuery object.

Updates the contents of a Spark notebook.
Updates the metadata for a notebook.
Updates a prepared statement.

Updates the workgroup with the specified name.

Functions

Link to this function

batch_get_named_query(Client, Input)

View Source

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. Use ListNamedQueriesInput 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.
Link to this function

batch_get_named_query(Client, Input, Options)

View Source
Link to this function

batch_get_prepared_statement(Client, Input)

View Source

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 in UnprocessedPreparedStatementNames.
Link to this function

batch_get_prepared_statement(Client, Input, Options)

View Source
Link to this function

batch_get_query_execution(Client, Input)

View Source

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, use ListQueryExecutionsInput$WorkGroup. Query executions differ from named (saved) queries. Use BatchGetNamedQueryInput to get details about named queries.
Link to this function

batch_get_query_execution(Client, Input, Options)

View Source
Link to this function

cancel_capacity_reservation(Client, Input)

View Source

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.
Link to this function

cancel_capacity_reservation(Client, Input, Options)

View Source
Link to this function

create_capacity_reservation(Client, Input)

View Source
Creates a capacity reservation with the specified name and number of requested data processing units.
Link to this function

create_capacity_reservation(Client, Input, Options)

View Source
Link to this function

create_data_catalog(Client, Input)

View Source

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.
Link to this function

create_data_catalog(Client, Input, Options)

View Source
Link to this function

create_named_query(Client, Input)

View Source

Creates a named query in the specified workgroup.

Requires that you have access to the workgroup.
Link to this function

create_named_query(Client, Input, Options)

View Source
Link to this function

create_notebook(Client, Input)

View Source

Creates an empty ipynb file in the specified Apache Spark enabled workgroup.

Throws an error if a file in the workgroup with the same name already exists.
Link to this function

create_notebook(Client, Input, Options)

View Source
Link to this function

create_prepared_statement(Client, Input)

View Source
Creates a prepared statement for use with SQL queries in Athena.
Link to this function

create_prepared_statement(Client, Input, Options)

View Source
Link to this function

create_presigned_notebook_url(Client, Input)

View Source

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.
Link to this function

create_presigned_notebook_url(Client, Input, Options)

View Source
Link to this function

create_work_group(Client, Input)

View Source

Creates a workgroup with the specified name.

A workgroup can be an Apache Spark enabled workgroup or an Athena SQL workgroup.
Link to this function

create_work_group(Client, Input, Options)

View Source
Link to this function

delete_capacity_reservation(Client, Input)

View Source

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 by GetCapacityReservation, and deleted reservations do not appear in the output of ListCapacityReservations.
Link to this function

delete_capacity_reservation(Client, Input, Options)

View Source
Link to this function

delete_data_catalog(Client, Input)

View Source
Deletes a data catalog.
Link to this function

delete_data_catalog(Client, Input, Options)

View Source
Link to this function

delete_named_query(Client, Input)

View Source
Deletes the named query if you have access to the workgroup in which the query was saved.
Link to this function

delete_named_query(Client, Input, Options)

View Source
Link to this function

delete_notebook(Client, Input)

View Source
Deletes the specified notebook.
Link to this function

delete_notebook(Client, Input, Options)

View Source
Link to this function

delete_prepared_statement(Client, Input)

View Source
Deletes the prepared statement with the specified name from the specified workgroup.
Link to this function

delete_prepared_statement(Client, Input, Options)

View Source
Link to this function

delete_work_group(Client, Input)

View Source

Deletes the workgroup with the specified name.

The primary workgroup cannot be deleted.
Link to this function

delete_work_group(Client, Input, Options)

View Source
Link to this function

export_notebook(Client, Input)

View Source
Exports the specified notebook and its metadata.
Link to this function

export_notebook(Client, Input, Options)

View Source
Link to this function

get_calculation_execution(Client, Input)

View Source
Describes a previously submitted calculation execution.
Link to this function

get_calculation_execution(Client, Input, Options)

View Source
Link to this function

get_calculation_execution_code(Client, Input)

View Source
Retrieves the unencrypted code that was executed for the calculation.
Link to this function

get_calculation_execution_code(Client, Input, Options)

View Source
Link to this function

get_calculation_execution_status(Client, Input)

View Source
Gets the status of a current calculation.
Link to this function

get_calculation_execution_status(Client, Input, Options)

View Source
Link to this function

get_capacity_assignment_configuration(Client, Input)

View Source
Gets the capacity assignment configuration for a capacity reservation, if one exists.
Link to this function

get_capacity_assignment_configuration(Client, Input, Options)

View Source
Link to this function

get_capacity_reservation(Client, Input)

View Source
Returns information about the capacity reservation with the specified name.
Link to this function

get_capacity_reservation(Client, Input, Options)

View Source
Link to this function

get_data_catalog(Client, Input)

View Source
Returns the specified data catalog.
Link to this function

get_data_catalog(Client, Input, Options)

View Source
Link to this function

get_database(Client, Input)

View Source
Returns a database object for the specified database and data catalog.
Link to this function

get_database(Client, Input, Options)

View Source
Link to this function

get_named_query(Client, Input)

View Source

Returns information about a single query.

Requires that you have access to the workgroup in which the query was saved.
Link to this function

get_named_query(Client, Input, Options)

View Source
Link to this function

get_notebook_metadata(Client, Input)

View Source
Retrieves notebook metadata for the specified notebook ID.
Link to this function

get_notebook_metadata(Client, Input, Options)

View Source
Link to this function

get_prepared_statement(Client, Input)

View Source
Retrieves the prepared statement with the specified name from the specified workgroup.
Link to this function

get_prepared_statement(Client, Input, Options)

View Source
Link to this function

get_query_execution(Client, Input)

View Source

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.
Link to this function

get_query_execution(Client, Input, Options)

View Source
Link to this function

get_query_results(Client, Input)

View Source

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.

IAM principals with permission to the Amazon S3 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.
Link to this function

get_query_results(Client, Input, Options)

View Source
Link to this function

get_query_runtime_statistics(Client, Input)

View Source

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 when QueryExecutionStatus$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.
Link to this function

get_query_runtime_statistics(Client, Input, Options)

View Source
Link to this function

get_session(Client, Input)

View Source
Gets the full details of a previously created session, including the session status and configuration.
Link to this function

get_session(Client, Input, Options)

View Source
Link to this function

get_session_status(Client, Input)

View Source
Gets the current status of a session.
Link to this function

get_session_status(Client, Input, Options)

View Source
Link to this function

get_table_metadata(Client, Input)

View Source
Returns table metadata for the specified catalog, database, and table.
Link to this function

get_table_metadata(Client, Input, Options)

View Source
Link to this function

get_work_group(Client, Input)

View Source
Returns information about the workgroup with the specified name.
Link to this function

get_work_group(Client, Input, Options)

View Source
Link to this function

import_notebook(Client, Input)

View Source

Imports a single ipynb file to a Spark enabled workgroup.

To import the notebook, the request must specify a value for either 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.
Link to this function

import_notebook(Client, Input, Options)

View Source
Link to this function

list_application_d_p_u_sizes(Client, Input)

View Source
Returns the supported DPU sizes for the supported application runtimes (for example, Athena notebook version 1).
Link to this function

list_application_d_p_u_sizes(Client, Input, Options)

View Source
Link to this function

list_calculation_executions(Client, Input)

View Source

Lists the calculations that have been submitted to a session in descending order.

Newer calculations are listed first; older calculations are listed later.
Link to this function

list_calculation_executions(Client, Input, Options)

View Source
Link to this function

list_capacity_reservations(Client, Input)

View Source
Lists the capacity reservations for the current account.
Link to this function

list_capacity_reservations(Client, Input, Options)

View Source
Link to this function

list_data_catalogs(Client, Input)

View Source

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.
Link to this function

list_data_catalogs(Client, Input, Options)

View Source
Link to this function

list_databases(Client, Input)

View Source
Lists the databases in the specified data catalog.
Link to this function

list_databases(Client, Input, Options)

View Source
Link to this function

list_engine_versions(Client, Input)

View Source
Returns a list of engine versions that are available to choose from, including the Auto option.
Link to this function

list_engine_versions(Client, Input, Options)

View Source
Link to this function

list_executors(Client, Input)

View Source

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.
Link to this function

list_executors(Client, Input, Options)

View Source
Link to this function

list_named_queries(Client, Input)

View Source

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.
Link to this function

list_named_queries(Client, Input, Options)

View Source
Link to this function

list_notebook_metadata(Client, Input)

View Source
Displays the notebook files for the specified workgroup in paginated format.
Link to this function

list_notebook_metadata(Client, Input, Options)

View Source
Link to this function

list_notebook_sessions(Client, Input)

View Source

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.

Newer sessions are listed first; older sessions are listed later.
Link to this function

list_notebook_sessions(Client, Input, Options)

View Source
Link to this function

list_prepared_statements(Client, Input)

View Source
Lists the prepared statements in the specified workgroup.
Link to this function

list_prepared_statements(Client, Input, Options)

View Source
Link to this function

list_query_executions(Client, Input)

View Source

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.
Link to this function

list_query_executions(Client, Input, Options)

View Source
Link to this function

list_sessions(Client, Input)

View Source

Lists the sessions in a workgroup that are in an active state like CREATING, CREATED, IDLE, or BUSY.

Newer sessions are listed first; older sessions are listed later.
Link to this function

list_sessions(Client, Input, Options)

View Source
Link to this function

list_table_metadata(Client, Input)

View Source
Lists the metadata for the tables in the specified data catalog database.
Link to this function

list_table_metadata(Client, Input, Options)

View Source
Link to this function

list_tags_for_resource(Client, Input)

View Source
Lists the tags associated with an Athena resource.
Link to this function

list_tags_for_resource(Client, Input, Options)

View Source
Link to this function

list_work_groups(Client, Input)

View Source
Lists available workgroups for the account.
Link to this function

list_work_groups(Client, Input, Options)

View Source
Link to this function

put_capacity_assignment_configuration(Client, Input)

View Source

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.
Link to this function

put_capacity_assignment_configuration(Client, Input, Options)

View Source
Link to this function

start_calculation_execution(Client, Input)

View Source

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 the StartCalculationExecutionRequest$CodeBlock parameter or the CalculationConfiguration$CodeBlock parameter, but not both. Because CalculationConfiguration$CodeBlock is deprecated, use the StartCalculationExecutionRequest$CodeBlock parameter instead.
Link to this function

start_calculation_execution(Client, Input, Options)

View Source
Link to this function

start_query_execution(Client, Input)

View Source

Runs the SQL query statements contained in the Query.

Requires you to have access to the workgroup in which the query ran. Running queries against an external catalog requires 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.
Link to this function

start_query_execution(Client, Input, Options)

View Source
Link to this function

start_session(Client, Input)

View Source

Creates a session for running calculations within a workgroup.

The session is ready when it reaches an IDLE state.
Link to this function

start_session(Client, Input, Options)

View Source
Link to this function

stop_calculation_execution(Client, Input)

View Source

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.

Cancelling a calculation is done on a best effort basis. If a calculation cannot be cancelled, you can be charged for its completion. If you are concerned about being charged for a calculation that cannot be cancelled, consider terminating the session in which the calculation is running.
Link to this function

stop_calculation_execution(Client, Input, Options)

View Source
Link to this function

stop_query_execution(Client, Input)

View Source

Stops a query execution.

Requires you to have access to the workgroup in which the query ran.
Link to this function

stop_query_execution(Client, Input, Options)

View Source
Link to this function

tag_resource(Client, Input)

View Source

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.
Link to this function

tag_resource(Client, Input, Options)

View Source
Link to this function

terminate_session(Client, Input)

View Source

Terminates an active session.

A TerminateSession 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.
Link to this function

terminate_session(Client, Input, Options)

View Source
Link to this function

untag_resource(Client, Input)

View Source
Removes one or more tags from an Athena resource.
Link to this function

untag_resource(Client, Input, Options)

View Source
Link to this function

update_capacity_reservation(Client, Input)

View Source
Updates the number of requested data processing units for the capacity reservation with the specified name.
Link to this function

update_capacity_reservation(Client, Input, Options)

View Source
Link to this function

update_data_catalog(Client, Input)

View Source
Updates the data catalog that has the specified name.
Link to this function

update_data_catalog(Client, Input, Options)

View Source
Link to this function

update_named_query(Client, Input)

View Source

Updates a NamedQuery object.

The database or workgroup cannot be updated.
Link to this function

update_named_query(Client, Input, Options)

View Source
Link to this function

update_notebook(Client, Input)

View Source
Updates the contents of a Spark notebook.
Link to this function

update_notebook(Client, Input, Options)

View Source
Link to this function

update_notebook_metadata(Client, Input)

View Source
Updates the metadata for a notebook.
Link to this function

update_notebook_metadata(Client, Input, Options)

View Source
Link to this function

update_prepared_statement(Client, Input)

View Source
Updates a prepared statement.
Link to this function

update_prepared_statement(Client, Input, Options)

View Source
Link to this function

update_work_group(Client, Input)

View Source

Updates the workgroup with the specified name.

The workgroup's name cannot be changed. Only ConfigurationUpdates can be specified.
Link to this function

update_work_group(Client, Input, Options)

View Source