amazonaws.com – athena

Tools (62)

Extracted live via the executor SDK.

• xAmzTargetAmazonAthenaBatchGetNamedQuery.batchGetNamedQuery

  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 [blocked] 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 [blocked]. Named queries differ from executed queries. Use BatchGetQueryExecutionInput [blocked] to get details about each unique query execution, and ListQueryExecutionsInput [blocked] to get a list of query execution IDs.

• xAmzTargetAmazonAthenaBatchGetPreparedStatement.batchGetPreparedStatement

  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.

• xAmzTargetAmazonAthenaBatchGetQueryExecution.batchGetQueryExecution

  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 [blocked]. Query executions differ from named (saved) queries. Use BatchGetNamedQueryInput [blocked] to get details about named queries.

• xAmzTargetAmazonAthenaCreateDataCatalog.createDataCatalog

  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.

• xAmzTargetAmazonAthenaCreateNamedQuery.createNamedQuery

  Creates a named query in the specified workgroup. Requires that you have access to the workgroup.

  For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.

• xAmzTargetAmazonAthenaCreateNotebook.createNotebook

  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.

• xAmzTargetAmazonAthenaCreatePreparedStatement.createPreparedStatement

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

• xAmzTargetAmazonAthenaCreatePresignedNotebookUrl.createPresignedNotebookUrl

  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.

• xAmzTargetAmazonAthenaCreateWorkGroup.createWorkGroup

  Creates a workgroup with the specified name. A workgroup can be an Apache Spark enabled workgroup or an Athena SQL workgroup.

• xAmzTargetAmazonAthenaDeleteDataCatalog.deleteDataCatalog

  Deletes a data catalog.

• xAmzTargetAmazonAthenaDeleteNamedQuery.deleteNamedQuery

  Deletes the named query if you have access to the workgroup in which the query was saved.

  For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.

• xAmzTargetAmazonAthenaDeleteNotebook.deleteNotebook

  Deletes the specified notebook.

• xAmzTargetAmazonAthenaDeletePreparedStatement.deletePreparedStatement

  Deletes the prepared statement with the specified name from the specified workgroup.

• xAmzTargetAmazonAthenaDeleteWorkGroup.deleteWorkGroup

  Deletes the workgroup with the specified name. The primary workgroup cannot be deleted.

• xAmzTargetAmazonAthenaExportNotebook.exportNotebook

  Exports the specified notebook and its metadata.

• xAmzTargetAmazonAthenaGetCalculationExecution.getCalculationExecution

  Describes a previously submitted calculation execution.

• xAmzTargetAmazonAthenaGetCalculationExecutionCode.getCalculationExecutionCode

  Retrieves the unencrypted code that was executed for the calculation.

• xAmzTargetAmazonAthenaGetCalculationExecutionStatus.getCalculationExecutionStatus

  Gets the status of a current calculation.

• xAmzTargetAmazonAthenaGetDatabase.getDatabase

  Returns a database object for the specified database and data catalog.

• xAmzTargetAmazonAthenaGetDataCatalog.getDataCatalog

  Returns the specified data catalog.

• xAmzTargetAmazonAthenaGetNamedQuery.getNamedQuery

  Returns information about a single query. Requires that you have access to the workgroup in which the query was saved.

• xAmzTargetAmazonAthenaGetNotebookMetadata.getNotebookMetadata

  Retrieves notebook metadata for the specified notebook ID.

• xAmzTargetAmazonAthenaGetPreparedStatement.getPreparedStatement

  Retrieves the prepared statement with the specified name from the specified workgroup.

• xAmzTargetAmazonAthenaGetQueryExecution.getQueryExecution

  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.

• xAmzTargetAmazonAthenaGetQueryResults.getQueryResults

  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 in the Amazon Athena User Guide. This request does not execute the query but returns results. Use StartQueryExecution [blocked] 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.

• xAmzTargetAmazonAthenaGetQueryRuntimeStatistics.getQueryRuntimeStatistics

  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 [blocked] 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.

• xAmzTargetAmazonAthenaGetSession.getSession

  Gets the full details of a previously created session, including the session status and configuration.

• xAmzTargetAmazonAthenaGetSessionStatus.getSessionStatus

  Gets the current status of a session.

• xAmzTargetAmazonAthenaGetTableMetadata.getTableMetadata

  Returns table metadata for the specified catalog, database, and table.

• xAmzTargetAmazonAthenaGetWorkGroup.getWorkGroup

  Returns information about the workgroup with the specified name.

• xAmzTargetAmazonAthenaImportNotebook.importNotebook

  Imports a single ipynb file to a Spark enabled workgroup. 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.

• xAmzTargetAmazonAthenaListApplicationDpuSizes.listApplicationDpuSizes

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

• xAmzTargetAmazonAthenaListCalculationExecutions.listCalculationExecutions

  Lists the calculations that have been submitted to a session in descending order. Newer calculations are listed first; older calculations are listed later.

• xAmzTargetAmazonAthenaListDatabases.listDatabases

  Lists the databases in the specified data catalog.

• xAmzTargetAmazonAthenaListDataCatalogs.listDataCatalogs

  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.

• xAmzTargetAmazonAthenaListEngineVersions.listEngineVersions

  Returns a list of engine versions that are available to choose from, including the Auto option.

• xAmzTargetAmazonAthenaListExecutors.listExecutors

  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.

• xAmzTargetAmazonAthenaListNamedQueries.listNamedQueries

  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.

  For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.

• xAmzTargetAmazonAthenaListNotebookMetadata.listNotebookMetadata

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

• xAmzTargetAmazonAthenaListNotebookSessions.listNotebookSessions

  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.

• xAmzTargetAmazonAthenaListPreparedStatements.listPreparedStatements

  Lists the prepared statements in the specified workgroup.

• xAmzTargetAmazonAthenaListQueryExecutions.listQueryExecutions

  Provides a list of available query execution IDs for the queries in the specified workgroup. 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.

  For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.

• xAmzTargetAmazonAthenaListSessions.listSessions

  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.

• xAmzTargetAmazonAthenaListTableMetadata.listTableMetadata

  Lists the metadata for the tables in the specified data catalog database.

• xAmzTargetAmazonAthenaListTagsForResource.listTagsForResource

  Lists the tags associated with an Athena workgroup or data catalog resource.

• xAmzTargetAmazonAthenaListWorkGroups.listWorkGroups

  Lists available workgroups for the account.

• xAmzTargetAmazonAthenaStartCalculationExecution.startCalculationExecution

  Submits calculations for execution within a session. You can supply the code to run as an inline code block within the request.

• xAmzTargetAmazonAthenaStartQueryExecution.startQueryExecution

  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 [blocked] permission to the catalog. For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.

• xAmzTargetAmazonAthenaStartSession.startSession

  Creates a session for running calculations within a workgroup. The session is ready when it reaches an IDLE state.

• xAmzTargetAmazonAthenaStopCalculationExecution.stopCalculationExecution

  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.

• xAmzTargetAmazonAthenaStopQueryExecution.stopQueryExecution

  Stops a query execution. Requires you to have access to the workgroup in which the query ran.

  For code samples using the Amazon Web Services SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.

• xAmzTargetAmazonAthenaTagResource.tagResource

  Adds one or more tags to an Athena resource. A tag is a label that you assign to a resource. In Athena, a resource can be a workgroup or data catalog. 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 or data catalogs by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter workgroups or data catalogs in your account. For best practices, see Tagging Best Practices. 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._

• xAmzTargetAmazonAthenaTerminateSession.terminateSession

  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.

• xAmzTargetAmazonAthenaUntagResource.untagResource

  Removes one or more tags from a data catalog or workgroup resource.

• xAmzTargetAmazonAthenaUpdateDataCatalog.updateDataCatalog

  Updates the data catalog that has the specified name.

• xAmzTargetAmazonAthenaUpdateNamedQuery.updateNamedQuery

  Updates a NamedQuery [blocked] object. The database or workgroup cannot be updated.

• xAmzTargetAmazonAthenaUpdateNotebook.updateNotebook

  Updates the contents of a Spark notebook.

• xAmzTargetAmazonAthenaUpdateNotebookMetadata.updateNotebookMetadata

  Updates the metadata for a notebook.

• xAmzTargetAmazonAthenaUpdatePreparedStatement.updatePreparedStatement

  Updates a prepared statement.

• xAmzTargetAmazonAthenaUpdateWorkGroup.updateWorkGroup

  Updates the workgroup with the specified name. The workgroup's name cannot be changed. Only ConfigurationUpdates can be specified.

• openapi.previewSpec

  Preview an OpenAPI document before adding it as a source

• openapi.addSource

  Add an OpenAPI source and register its operations as tools