Athena

This page documents function available when using the Athena module, created with @service Athena.

Index

Documentation

Main.Athena.batch_get_named_queryMethod
batch_get_named_query(named_query_ids)
batch_get_named_query(named_query_ids, params::Dict{String,<:Any})

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.

Arguments

  • named_query_ids: An array of query IDs.
source
Main.Athena.batch_get_prepared_statementMethod
batch_get_prepared_statement(prepared_statement_names, work_group)
batch_get_prepared_statement(prepared_statement_names, work_group, params::Dict{String,<:Any})

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.

Arguments

  • prepared_statement_names: A list of prepared statement names to return.
  • work_group: The name of the workgroup to which the prepared statements belong.
source
Main.Athena.batch_get_query_executionMethod
batch_get_query_execution(query_execution_ids)
batch_get_query_execution(query_execution_ids, params::Dict{String,<:Any})

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

Arguments

  • query_execution_ids: An array of query execution IDs.
source
Main.Athena.create_data_catalogMethod
create_data_catalog(name, type)
create_data_catalog(name, type, params::Dict{String,<:Any})

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.

Arguments

  • name: The name of the data catalog to create. The catalog name must be unique for the Amazon Web Services account and can use a maximum of 127 alphanumeric, underscore, at sign, or hyphen characters. The remainder of the length constraint of 256 is reserved for use by Athena.
  • type: The type of data catalog to create: LAMBDA for a federated catalog, HIVE for an external hive metastore, or GLUE for an Glue Data Catalog.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Description": A description of the data catalog to be created.
  • "Parameters": Specifies the Lambda function or functions to use for creating the data catalog. This is a mapping whose values depend on the catalog type. For the HIVE data catalog type, use the following syntax. The metadata-function parameter is required. The sdk-version parameter is optional and defaults to the currently supported version. metadata-function=lambdaarn, sdk-version=versionnumber For the LAMBDA data catalog type, use one of the following sets of required parameters, but not both. If you have one Lambda function that processes metadata and another for reading the actual data, use the following syntax. Both parameters are required. metadata-function=lambdaarn, record-function=lambdaarn If you have a composite Lambda function that processes both metadata and data, use the following syntax to specify your Lambda function. function=lambdaarn The GLUE type takes a catalog ID parameter and is required. The catalogid is the account ID of the Amazon Web Services account to which the Glue Data Catalog belongs. catalog-id=catalogid The GLUE data catalog type also applies to the default AwsDataCatalog that already exists in your account, of which you can have only one and cannot modify. Queries that specify a Glue Data Catalog other than the default AwsDataCatalog must be run on Athena engine version 2. In Regions where Athena engine version 2 is not available, creating new Glue data catalogs results in an INVALIDINPUT error.
  • "Tags": A list of comma separated tags to add to the data catalog that is created.
source
Main.Athena.create_named_queryMethod
create_named_query(database, name, query_string)
create_named_query(database, name, query_string, params::Dict{String,<:Any})

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.

Arguments

  • database: The database to which the query belongs.
  • name: The query name.
  • query_string: The contents of the query with all query statements.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientRequestToken": A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another CreateNamedQuery request is received, the same response is returned and another query is not created. If a parameter has changed, for example, the QueryString, an error is returned. This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.
  • "Description": The query description.
  • "WorkGroup": The name of the workgroup in which the named query is being created.
source
Main.Athena.create_notebookMethod
create_notebook(name, work_group)
create_notebook(name, work_group, params::Dict{String,<:Any})

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.

Arguments

  • name: The name of the ipynb file to be created in the Spark workgroup, without the .ipynb extension.
  • work_group: The name of the Spark enabled workgroup in which the notebook will be created.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientRequestToken": A unique case-sensitive string used to ensure the request to create the notebook is idempotent (executes only once). This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for you. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.
source
Main.Athena.create_prepared_statementMethod
create_prepared_statement(query_statement, statement_name, work_group)
create_prepared_statement(query_statement, statement_name, work_group, params::Dict{String,<:Any})

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

Arguments

  • query_statement: The query string for the prepared statement.
  • statement_name: The name of the prepared statement.
  • work_group: The name of the workgroup to which the prepared statement belongs.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Description": The description of the prepared statement.
source
Main.Athena.create_presigned_notebook_urlMethod
create_presigned_notebook_url(session_id)
create_presigned_notebook_url(session_id, params::Dict{String,<:Any})

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.

Arguments

  • session_id: The session ID.
source
Main.Athena.create_work_groupMethod
create_work_group(name)
create_work_group(name, params::Dict{String,<:Any})

Creates a workgroup with the specified name. Only one of Configurations or Configuration can be specified; Configurations for a workgroup with multi engine support (for example, an Apache Spark enabled workgroup) or Configuration for an Athena SQL workgroup.

Arguments

  • name: The workgroup name.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Configuration": Contains configuration information for creating an Athena SQL workgroup, which includes the location in Amazon S3 where query results are stored, the encryption configuration, if any, used for encrypting query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup, the limit for the amount of bytes scanned (cutoff) per query, if it is specified, and whether workgroup's settings (specified with EnforceWorkGroupConfiguration) in the WorkGroupConfiguration override client-side settings. See WorkGroupConfigurationEnforceWorkGroupConfiguration.
  • "Description": The workgroup description.
  • "Tags": A list of comma separated tags to add to the workgroup that is created.
source
Main.Athena.delete_data_catalogMethod
delete_data_catalog(name)
delete_data_catalog(name, params::Dict{String,<:Any})

Deletes a data catalog.

Arguments

  • name: The name of the data catalog to delete.
source
Main.Athena.delete_named_queryMethod
delete_named_query(named_query_id)
delete_named_query(named_query_id, params::Dict{String,<:Any})

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.

Arguments

  • named_query_id: The unique ID of the query to delete.
source
Main.Athena.delete_notebookMethod
delete_notebook(notebook_id)
delete_notebook(notebook_id, params::Dict{String,<:Any})

Deletes the specified notebook.

Arguments

  • notebook_id: The ID of the notebook to delete.
source
Main.Athena.delete_prepared_statementMethod
delete_prepared_statement(statement_name, work_group)
delete_prepared_statement(statement_name, work_group, params::Dict{String,<:Any})

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

Arguments

  • statement_name: The name of the prepared statement to delete.
  • work_group: The workgroup to which the statement to be deleted belongs.
source
Main.Athena.delete_work_groupMethod
delete_work_group(work_group)
delete_work_group(work_group, params::Dict{String,<:Any})

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

Arguments

  • work_group: The unique name of the workgroup to delete.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "RecursiveDeleteOption": The option to delete the workgroup and its contents even if the workgroup contains any named queries or query executions.
source
Main.Athena.export_notebookMethod
export_notebook(notebook_id)
export_notebook(notebook_id, params::Dict{String,<:Any})

Exports the specified notebook and its metadata.

Arguments

  • notebook_id: The ID of the notebook to export.
source
Main.Athena.get_calculation_executionMethod
get_calculation_execution(calculation_execution_id)
get_calculation_execution(calculation_execution_id, params::Dict{String,<:Any})

Describes a previously submitted calculation execution.

Arguments

  • calculation_execution_id: The calculation execution UUID.
source
Main.Athena.get_calculation_execution_codeMethod
get_calculation_execution_code(calculation_execution_id)
get_calculation_execution_code(calculation_execution_id, params::Dict{String,<:Any})

Retrieves a pre-signed URL to a copy of the code that was executed for the calculation.

Arguments

  • calculation_execution_id: The calculation execution UUID.
source
Main.Athena.get_calculation_execution_statusMethod
get_calculation_execution_status(calculation_execution_id)
get_calculation_execution_status(calculation_execution_id, params::Dict{String,<:Any})

Gets the status of a current calculation.

Arguments

  • calculation_execution_id: The calculation execution UUID.
source
Main.Athena.get_data_catalogMethod
get_data_catalog(name)
get_data_catalog(name, params::Dict{String,<:Any})

Returns the specified data catalog.

Arguments

  • name: The name of the data catalog to return.
source
Main.Athena.get_databaseMethod
get_database(catalog_name, database_name)
get_database(catalog_name, database_name, params::Dict{String,<:Any})

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

Arguments

  • catalog_name: The name of the data catalog that contains the database to return.
  • database_name: The name of the database to return.
source
Main.Athena.get_named_queryMethod
get_named_query(named_query_id)
get_named_query(named_query_id, params::Dict{String,<:Any})

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

Arguments

  • named_query_id: The unique ID of the query. Use ListNamedQueries to get query IDs.
source
Main.Athena.get_notebook_metadataMethod
get_notebook_metadata(notebook_id)
get_notebook_metadata(notebook_id, params::Dict{String,<:Any})

Retrieves notebook metadata for the specified notebook ID.

Arguments

  • notebook_id: The ID of the notebook whose metadata is to be retrieved.
source
Main.Athena.get_prepared_statementMethod
get_prepared_statement(statement_name, work_group)
get_prepared_statement(statement_name, work_group, params::Dict{String,<:Any})

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

Arguments

  • statement_name: The name of the prepared statement to retrieve.
  • work_group: The workgroup to which the statement to be retrieved belongs.
source
Main.Athena.get_query_executionMethod
get_query_execution(query_execution_id)
get_query_execution(query_execution_id, params::Dict{String,<:Any})

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.

Arguments

  • query_execution_id: The unique ID of the query execution.
source
Main.Athena.get_query_resultsMethod
get_query_results(query_execution_id)
get_query_results(query_execution_id, params::Dict{String,<:Any})

Streams the results of a single query execution specified by QueryExecutionId from the Athena query results location in Amazon S3. For more information, see Query Results 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.

Arguments

  • query_execution_id: The unique ID of the query execution.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The maximum number of results (rows) to return in this request.
  • "NextToken": A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.
source
Main.Athena.get_query_runtime_statisticsMethod
get_query_runtime_statistics(query_execution_id)
get_query_runtime_statistics(query_execution_id, params::Dict{String,<:Any})

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 QueryExecutionStatusState 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.

Arguments

  • query_execution_id: The unique ID of the query execution.
source
Main.Athena.get_sessionMethod
get_session(session_id)
get_session(session_id, params::Dict{String,<:Any})

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

Arguments

  • session_id: The session ID.
source
Main.Athena.get_session_statusMethod
get_session_status(session_id)
get_session_status(session_id, params::Dict{String,<:Any})

Gets the current status of a session.

Arguments

  • session_id: The session ID.
source
Main.Athena.get_table_metadataMethod
get_table_metadata(catalog_name, database_name, table_name)
get_table_metadata(catalog_name, database_name, table_name, params::Dict{String,<:Any})

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

Arguments

  • catalog_name: The name of the data catalog that contains the database and table metadata to return.
  • database_name: The name of the database that contains the table metadata to return.
  • table_name: The name of the table for which metadata is returned.
source
Main.Athena.get_work_groupMethod
get_work_group(work_group)
get_work_group(work_group, params::Dict{String,<:Any})

Returns information about the workgroup with the specified name.

Arguments

  • work_group: The name of the workgroup.
source
Main.Athena.import_notebookMethod
import_notebook(name, payload, type, work_group)
import_notebook(name, payload, type, work_group, params::Dict{String,<:Any})

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.

Arguments

  • name: The name of the notebook to import.
  • payload: The notebook content to be imported.
  • type: The notebook content type. Currently, the only valid type is IPYNB.
  • work_group: The name of the Spark enabled workgroup to import the notebook to.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientRequestToken": A unique case-sensitive string used to ensure the request to import the notebook is idempotent (executes only once). This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for you. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.
source
Main.Athena.list_application_dpusizesMethod
list_application_dpusizes()
list_application_dpusizes(params::Dict{String,<:Any})

Returns the supported DPU sizes for the supported application runtimes (for example, Jupyter 1.0).

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": Specifies the maximum number of results to return.
  • "NextToken": A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated.
source
Main.Athena.list_calculation_executionsMethod
list_calculation_executions(session_id)
list_calculation_executions(session_id, params::Dict{String,<:Any})

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

Arguments

  • session_id: The session ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The maximum number of calculation executions to return.
  • "NextToken": A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.
  • "StateFilter": A filter for a specific calculation execution state. A description of each state follows. CREATING - The calculation is in the process of being created. CREATED - The calculation has been created and is ready to run. QUEUED - The calculation has been queued for processing. RUNNING - The calculation is running. CANCELING - A request to cancel the calculation has been received and the system is working to stop it. CANCELED - The calculation is no longer running as the result of a cancel request. COMPLETED - The calculation has completed without error. FAILED - The calculation failed and is no longer running.
source
Main.Athena.list_data_catalogsMethod
list_data_catalogs()
list_data_catalogs(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": Specifies the maximum number of data catalogs to return.
  • "NextToken": A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.
source
Main.Athena.list_databasesMethod
list_databases(catalog_name)
list_databases(catalog_name, params::Dict{String,<:Any})

Lists the databases in the specified data catalog.

Arguments

  • catalog_name: The name of the data catalog that contains the databases to return.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": Specifies the maximum number of results to return.
  • "NextToken": A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.
source
Main.Athena.list_engine_versionsMethod
list_engine_versions()
list_engine_versions(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The maximum number of engine versions to return in this request.
  • "NextToken": A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.
source
Main.Athena.list_executorsMethod
list_executors(session_id)
list_executors(session_id, params::Dict{String,<:Any})

Lists, in descending order, the executors that have been submitted to a session. Newer executors are listed first; older executors are listed later. The result can be optionally filtered by state.

Arguments

  • session_id: The session ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ExecutorStateFilter": A filter for a specific executor state. A description of each state follows. CREATING - The executor is being started, including acquiring resources. CREATED - The executor has been started. REGISTERED - The executor has been registered. TERMINATING - The executor is in the process of shutting down. TERMINATED - The executor is no longer running. FAILED - Due to a failure, the executor is no longer running.
  • "MaxResults": The maximum number of executors to return.
  • "NextToken": A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.
source
Main.Athena.list_named_queriesMethod
list_named_queries()
list_named_queries(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The maximum number of queries to return in this request.
  • "NextToken": A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.
  • "WorkGroup": The name of the workgroup from which the named queries are being returned. If a workgroup is not specified, the saved queries for the primary workgroup are returned.
source
Main.Athena.list_notebook_metadataMethod
list_notebook_metadata(work_group)
list_notebook_metadata(work_group, params::Dict{String,<:Any})

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

Arguments

  • work_group: The name of the Spark enabled workgroup to retrieve notebook metadata for.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Filters": Search filter string.
  • "MaxResults": Specifies the maximum number of results to return.
  • "NextToken": A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated.
source
Main.Athena.list_notebook_sessionsMethod
list_notebook_sessions(notebook_id)
list_notebook_sessions(notebook_id, params::Dict{String,<:Any})

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.

Arguments

  • notebook_id: The ID of the notebook to list sessions for.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The maximum number of notebook sessions to return.
  • "NextToken": A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.
source
Main.Athena.list_prepared_statementsMethod
list_prepared_statements(work_group)
list_prepared_statements(work_group, params::Dict{String,<:Any})

Lists the prepared statements in the specified workgroup.

Arguments

  • work_group: The workgroup to list the prepared statements for.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The maximum number of results to return in this request.
  • "NextToken": A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.
source
Main.Athena.list_query_executionsMethod
list_query_executions()
list_query_executions(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The maximum number of query executions to return in this request.
  • "NextToken": A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.
  • "WorkGroup": The name of the workgroup from which queries are being returned. If a workgroup is not specified, a list of available query execution IDs for the queries in the primary workgroup is returned.
source
Main.Athena.list_sessionsMethod
list_sessions(work_group)
list_sessions(work_group, params::Dict{String,<:Any})

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.

Arguments

  • work_group: The workgroup to which the session belongs.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The maximum number of sessions to return.
  • "NextToken": A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.
  • "StateFilter": A filter for a specific session state. A description of each state follows. CREATING - The session is being started, including acquiring resources. CREATED
    • The session has been started. IDLE - The session is able to accept a calculation. BUSY
    • The session is processing another task and is unable to accept a calculation.
    TERMINATING - The session is in the process of shutting down. TERMINATED - The session and its resources are no longer running. DEGRADED - The session has no healthy coordinators. FAILED - Due to a failure, the session and its resources are no longer running.
source
Main.Athena.list_table_metadataMethod
list_table_metadata(catalog_name, database_name)
list_table_metadata(catalog_name, database_name, params::Dict{String,<:Any})

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

Arguments

  • catalog_name: The name of the data catalog for which table metadata should be returned.
  • database_name: The name of the database for which table metadata should be returned.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Expression": A regex filter that pattern-matches table names. If no expression is supplied, metadata for all tables are listed.
  • "MaxResults": Specifies the maximum number of results to return.
  • "NextToken": A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.
source
Main.Athena.list_tags_for_resourceMethod
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

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

Arguments

  • resource_arn: Lists the tags for the resource with the specified ARN.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The maximum number of results to be returned per request that lists the tags for the resource.
  • "NextToken": The token for the next set of results, or null if there are no additional results for this request, where the request lists the tags for the resource with the specified ARN.
source
Main.Athena.list_work_groupsMethod
list_work_groups()
list_work_groups(params::Dict{String,<:Any})

Lists available workgroups for the account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The maximum number of workgroups to return in this request.
  • "NextToken": A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.
source
Main.Athena.start_calculation_executionMethod
start_calculation_execution(session_id)
start_calculation_execution(session_id, params::Dict{String,<:Any})

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

Arguments

  • session_id: The session ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "CalculationConfiguration": Contains configuration information for the calculation.
  • "ClientRequestToken": A unique case-sensitive string used to ensure the request to create the calculation is idempotent (executes only once). If another StartCalculationExecutionRequest is received, the same response is returned and another calculation is not created. If a parameter has changed, an error is returned. This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.
  • "CodeBlock": A string that contains the code of the calculation.
  • "Description": A description of the calculation.
source
Main.Athena.start_query_executionMethod
start_query_execution(query_string)
start_query_execution(query_string, params::Dict{String,<:Any})

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 in the Amazon Athena User Guide.

Arguments

  • query_string: The SQL query statements to be executed.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientRequestToken": A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another StartQueryExecution request is received, the same response is returned and another query is not created. If a parameter has changed, for example, the QueryString, an error is returned. This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.
  • "ExecutionParameters": A list of values for the parameters in a query. The values are applied sequentially to the parameters in the query in the order in which the parameters occur.
  • "QueryExecutionContext": The database within which the query executes.
  • "ResultConfiguration": Specifies information about where and how to save the results of the query execution. If the query runs in a workgroup, then workgroup's settings may override query settings. This affects the query results location. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfigurationEnforceWorkGroupConfiguration.
  • "ResultReuseConfiguration": Specifies the query result reuse behavior for the query.
  • "WorkGroup": The name of the workgroup in which the query is being started.
source
Main.Athena.start_sessionMethod
start_session(engine_configuration, work_group)
start_session(engine_configuration, work_group, params::Dict{String,<:Any})

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

Arguments

  • engine_configuration: Contains engine data processing unit (DPU) configuration settings and parameter mappings.
  • work_group: The workgroup to which the session belongs.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientRequestToken": A unique case-sensitive string used to ensure the request to create the session is idempotent (executes only once). If another StartSessionRequest is received, the same response is returned and another session is not created. If a parameter has changed, an error is returned. This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.
  • "Description": The session description.
  • "NotebookVersion": The notebook version. This value is required only when requesting that a notebook server be started for the session. The only valid notebook version is Jupyter1.0.
  • "SessionIdleTimeoutInMinutes": The idle timeout in minutes for the session.
source
Main.Athena.stop_calculation_executionMethod
stop_calculation_execution(calculation_execution_id)
stop_calculation_execution(calculation_execution_id, params::Dict{String,<:Any})

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.

Arguments

  • calculation_execution_id: The calculation execution UUID.
source
Main.Athena.stop_query_executionMethod
stop_query_execution(query_execution_id)
stop_query_execution(query_execution_id, params::Dict{String,<:Any})

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.

Arguments

  • query_execution_id: The unique ID of the query execution to stop.
source
Main.Athena.tag_resourceMethod
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})

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.

Arguments

  • resource_arn: Specifies the ARN of the Athena resource (workgroup or data catalog) to which tags are to be added.
  • tags: A collection of one or more tags, separated by commas, to be added to an Athena workgroup or data catalog resource.
source
Main.Athena.terminate_sessionMethod
terminate_session(session_id)
terminate_session(session_id, params::Dict{String,<:Any})

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.

Arguments

  • session_id: The session ID.
source
Main.Athena.untag_resourceMethod
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

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

Arguments

  • resource_arn: Specifies the ARN of the resource from which tags are to be removed.
  • tag_keys: A comma-separated list of one or more tag keys whose tags are to be removed from the specified resource.
source
Main.Athena.update_data_catalogMethod
update_data_catalog(name, type)
update_data_catalog(name, type, params::Dict{String,<:Any})

Updates the data catalog that has the specified name.

Arguments

  • name: The name of the data catalog to update. The catalog name must be unique for the Amazon Web Services account and can use a maximum of 127 alphanumeric, underscore, at sign, or hyphen characters. The remainder of the length constraint of 256 is reserved for use by Athena.
  • type: Specifies the type of data catalog to update. Specify LAMBDA for a federated catalog, HIVE for an external hive metastore, or GLUE for an Glue Data Catalog.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Description": New or modified text that describes the data catalog.
  • "Parameters": Specifies the Lambda function or functions to use for updating the data catalog. This is a mapping whose values depend on the catalog type. For the HIVE data catalog type, use the following syntax. The metadata-function parameter is required. The sdk-version parameter is optional and defaults to the currently supported version. metadata-function=lambdaarn, sdk-version=versionnumber For the LAMBDA data catalog type, use one of the following sets of required parameters, but not both. If you have one Lambda function that processes metadata and another for reading the actual data, use the following syntax. Both parameters are required. metadata-function=lambdaarn, record-function=lambdaarn If you have a composite Lambda function that processes both metadata and data, use the following syntax to specify your Lambda function. function=lambda_arn
source
Main.Athena.update_named_queryMethod
update_named_query(name, named_query_id, query_string)
update_named_query(name, named_query_id, query_string, params::Dict{String,<:Any})

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

Arguments

  • name: The name of the query.
  • named_query_id: The unique identifier (UUID) of the query.
  • query_string: The contents of the query with all query statements.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Description": The query description.
source
Main.Athena.update_notebookMethod
update_notebook(notebook_id, payload, type)
update_notebook(notebook_id, payload, type, params::Dict{String,<:Any})

Updates the contents of a Spark notebook.

Arguments

  • notebook_id: The ID of the notebook to update.
  • payload: The updated content for the notebook.
  • type: The notebook content type. Currently, the only valid type is IPYNB.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientRequestToken": A unique case-sensitive string used to ensure the request to create the notebook is idempotent (executes only once). This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for you. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.
  • "SessionId": The ID of the session in which the notebook will be updated.
source
Main.Athena.update_notebook_metadataMethod
update_notebook_metadata(name, notebook_id)
update_notebook_metadata(name, notebook_id, params::Dict{String,<:Any})

Updates the metadata for a notebook.

Arguments

  • name: The name to update the notebook to.
  • notebook_id: The ID of the notebook to update the metadata for.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientRequestToken": A unique case-sensitive string used to ensure the request to create the notebook is idempotent (executes only once). This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for you. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.
source
Main.Athena.update_prepared_statementMethod
update_prepared_statement(query_statement, statement_name, work_group)
update_prepared_statement(query_statement, statement_name, work_group, params::Dict{String,<:Any})

Updates a prepared statement.

Arguments

  • query_statement: The query string for the prepared statement.
  • statement_name: The name of the prepared statement.
  • work_group: The workgroup for the prepared statement.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Description": The description of the prepared statement.
source
Main.Athena.update_work_groupMethod
update_work_group(work_group)
update_work_group(work_group, params::Dict{String,<:Any})

Updates the workgroup with the specified name. The workgroup's name cannot be changed. Only one of ConfigurationsUpdates or ConfigurationUpdates can be specified; ConfigurationsUpdates for a workgroup with multi engine support (for example, an Apache Spark enabled workgroup) or ConfigurationUpdates for an Athena SQL workgroup.

Arguments

  • work_group: The specified workgroup that will be updated.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ConfigurationUpdates": Contains configuration updates for an Athena SQL workgroup.
  • "Description": The workgroup description.
  • "State": The workgroup state that will be updated for the given workgroup.
source