Class: Aws::Athena::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Athena::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb
Overview
An API client for Athena. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::Athena::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#batch_get_named_query(params = {}) ⇒ Types::BatchGetNamedQueryOutput
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.
-
#batch_get_prepared_statement(params = {}) ⇒ Types::BatchGetPreparedStatementOutput
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.
-
#batch_get_query_execution(params = {}) ⇒ Types::BatchGetQueryExecutionOutput
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.
-
#cancel_capacity_reservation(params = {}) ⇒ Struct
Cancels the capacity reservation with the specified name.
-
#create_capacity_reservation(params = {}) ⇒ Struct
Creates a capacity reservation with the specified name and number of requested data processing units.
-
#create_data_catalog(params = {}) ⇒ Types::CreateDataCatalogOutput
Creates (registers) a data catalog with the specified name and properties.
-
#create_named_query(params = {}) ⇒ Types::CreateNamedQueryOutput
Creates a named query in the specified workgroup.
-
#create_notebook(params = {}) ⇒ Types::CreateNotebookOutput
Creates an empty
ipynb
file in the specified Apache Spark enabled workgroup. -
#create_prepared_statement(params = {}) ⇒ Struct
Creates a prepared statement for use with SQL queries in Athena.
-
#create_presigned_notebook_url(params = {}) ⇒ Types::CreatePresignedNotebookUrlResponse
Gets an authentication token and the URL at which the notebook can be accessed.
-
#create_work_group(params = {}) ⇒ Struct
Creates a workgroup with the specified name.
-
#delete_capacity_reservation(params = {}) ⇒ Struct
Deletes a cancelled capacity reservation.
-
#delete_data_catalog(params = {}) ⇒ Types::DeleteDataCatalogOutput
Deletes a data catalog.
-
#delete_named_query(params = {}) ⇒ Struct
Deletes the named query if you have access to the workgroup in which the query was saved.
-
#delete_notebook(params = {}) ⇒ Struct
Deletes the specified notebook.
-
#delete_prepared_statement(params = {}) ⇒ Struct
Deletes the prepared statement with the specified name from the specified workgroup.
-
#delete_work_group(params = {}) ⇒ Struct
Deletes the workgroup with the specified name.
-
#export_notebook(params = {}) ⇒ Types::ExportNotebookOutput
Exports the specified notebook and its metadata.
-
#get_calculation_execution(params = {}) ⇒ Types::GetCalculationExecutionResponse
Describes a previously submitted calculation execution.
-
#get_calculation_execution_code(params = {}) ⇒ Types::GetCalculationExecutionCodeResponse
Retrieves the unencrypted code that was executed for the calculation.
-
#get_calculation_execution_status(params = {}) ⇒ Types::GetCalculationExecutionStatusResponse
Gets the status of a current calculation.
-
#get_capacity_assignment_configuration(params = {}) ⇒ Types::GetCapacityAssignmentConfigurationOutput
Gets the capacity assignment configuration for a capacity reservation, if one exists.
-
#get_capacity_reservation(params = {}) ⇒ Types::GetCapacityReservationOutput
Returns information about the capacity reservation with the specified name.
-
#get_data_catalog(params = {}) ⇒ Types::GetDataCatalogOutput
Returns the specified data catalog.
-
#get_database(params = {}) ⇒ Types::GetDatabaseOutput
Returns a database object for the specified database and data catalog.
-
#get_named_query(params = {}) ⇒ Types::GetNamedQueryOutput
Returns information about a single query.
-
#get_notebook_metadata(params = {}) ⇒ Types::GetNotebookMetadataOutput
Retrieves notebook metadata for the specified notebook ID.
-
#get_prepared_statement(params = {}) ⇒ Types::GetPreparedStatementOutput
Retrieves the prepared statement with the specified name from the specified workgroup.
-
#get_query_execution(params = {}) ⇒ Types::GetQueryExecutionOutput
Returns information about a single execution of a query if you have access to the workgroup in which the query ran.
-
#get_query_results(params = {}) ⇒ Types::GetQueryResultsOutput
Streams the results of a single query execution specified by
QueryExecutionId
from the Athena query results location in Amazon S3. -
#get_query_runtime_statistics(params = {}) ⇒ Types::GetQueryRuntimeStatisticsOutput
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.
-
#get_session(params = {}) ⇒ Types::GetSessionResponse
Gets the full details of a previously created session, including the session status and configuration.
-
#get_session_status(params = {}) ⇒ Types::GetSessionStatusResponse
Gets the current status of a session.
-
#get_table_metadata(params = {}) ⇒ Types::GetTableMetadataOutput
Returns table metadata for the specified catalog, database, and table.
-
#get_work_group(params = {}) ⇒ Types::GetWorkGroupOutput
Returns information about the workgroup with the specified name.
-
#import_notebook(params = {}) ⇒ Types::ImportNotebookOutput
Imports a single
ipynb
file to a Spark enabled workgroup. -
#list_application_dpu_sizes(params = {}) ⇒ Types::ListApplicationDPUSizesOutput
Returns the supported DPU sizes for the supported application runtimes (for example,
Athena notebook version 1
). -
#list_calculation_executions(params = {}) ⇒ Types::ListCalculationExecutionsResponse
Lists the calculations that have been submitted to a session in descending order.
-
#list_capacity_reservations(params = {}) ⇒ Types::ListCapacityReservationsOutput
Lists the capacity reservations for the current account.
-
#list_data_catalogs(params = {}) ⇒ Types::ListDataCatalogsOutput
Lists the data catalogs in the current Amazon Web Services account.
-
#list_databases(params = {}) ⇒ Types::ListDatabasesOutput
Lists the databases in the specified data catalog.
-
#list_engine_versions(params = {}) ⇒ Types::ListEngineVersionsOutput
Returns a list of engine versions that are available to choose from, including the Auto option.
-
#list_executors(params = {}) ⇒ Types::ListExecutorsResponse
Lists, in descending order, the executors that joined a session.
-
#list_named_queries(params = {}) ⇒ Types::ListNamedQueriesOutput
Provides a list of available query IDs only for queries saved in the specified workgroup.
-
#list_notebook_metadata(params = {}) ⇒ Types::ListNotebookMetadataOutput
Displays the notebook files for the specified workgroup in paginated format.
-
#list_notebook_sessions(params = {}) ⇒ Types::ListNotebookSessionsResponse
Lists, in descending order, the sessions that have been created in a notebook that are in an active state like
CREATING
,CREATED
,IDLE
orBUSY
. -
#list_prepared_statements(params = {}) ⇒ Types::ListPreparedStatementsOutput
Lists the prepared statements in the specified workgroup.
-
#list_query_executions(params = {}) ⇒ Types::ListQueryExecutionsOutput
Provides a list of available query execution IDs for the queries in the specified workgroup.
-
#list_sessions(params = {}) ⇒ Types::ListSessionsResponse
Lists the sessions in a workgroup that are in an active state like
CREATING
,CREATED
,IDLE
, orBUSY
. -
#list_table_metadata(params = {}) ⇒ Types::ListTableMetadataOutput
Lists the metadata for the tables in the specified data catalog database.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
Lists the tags associated with an Athena resource.
-
#list_work_groups(params = {}) ⇒ Types::ListWorkGroupsOutput
Lists available workgroups for the account.
-
#put_capacity_assignment_configuration(params = {}) ⇒ Struct
Puts a new capacity assignment configuration for a specified capacity reservation.
-
#start_calculation_execution(params = {}) ⇒ Types::StartCalculationExecutionResponse
Submits calculations for execution within a session.
-
#start_query_execution(params = {}) ⇒ Types::StartQueryExecutionOutput
Runs the SQL query statements contained in the
Query
. -
#start_session(params = {}) ⇒ Types::StartSessionResponse
Creates a session for running calculations within a workgroup.
-
#stop_calculation_execution(params = {}) ⇒ Types::StopCalculationExecutionResponse
Requests the cancellation of a calculation.
-
#stop_query_execution(params = {}) ⇒ Struct
Stops a query execution.
-
#tag_resource(params = {}) ⇒ Struct
Adds one or more tags to an Athena resource.
-
#terminate_session(params = {}) ⇒ Types::TerminateSessionResponse
Terminates an active session.
-
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from an Athena resource.
-
#update_capacity_reservation(params = {}) ⇒ Struct
Updates the number of requested data processing units for the capacity reservation with the specified name.
-
#update_data_catalog(params = {}) ⇒ Struct
Updates the data catalog that has the specified name.
-
#update_named_query(params = {}) ⇒ Struct
Updates a NamedQuery object.
-
#update_notebook(params = {}) ⇒ Struct
Updates the contents of a Spark notebook.
-
#update_notebook_metadata(params = {}) ⇒ Struct
Updates the metadata for a notebook.
-
#update_prepared_statement(params = {}) ⇒ Struct
Updates a prepared statement.
-
#update_work_group(params = {}) ⇒ Struct
Updates the workgroup with the specified name.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
473 474 475 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 473 def initialize(*args) super end |
Instance Method Details
#batch_get_named_query(params = {}) ⇒ Types::BatchGetNamedQueryOutput
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.
522 523 524 525 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 522 def batch_get_named_query(params = {}, = {}) req = build_request(:batch_get_named_query, params) req.send_request() end |
#batch_get_prepared_statement(params = {}) ⇒ Types::BatchGetPreparedStatementOutput
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
.
569 570 571 572 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 569 def batch_get_prepared_statement(params = {}, = {}) req = build_request(:batch_get_prepared_statement, params) req.send_request() end |
#batch_get_query_execution(params = {}) ⇒ Types::BatchGetQueryExecutionOutput
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.
646 647 648 649 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 646 def batch_get_query_execution(params = {}, = {}) req = build_request(:batch_get_query_execution, params) req.send_request() end |
#cancel_capacity_reservation(params = {}) ⇒ Struct
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.
672 673 674 675 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 672 def cancel_capacity_reservation(params = {}, = {}) req = build_request(:cancel_capacity_reservation, params) req.send_request() end |
#create_capacity_reservation(params = {}) ⇒ Struct
Creates a capacity reservation with the specified name and number of requested data processing units.
708 709 710 711 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 708 def create_capacity_reservation(params = {}, = {}) req = build_request(:create_capacity_reservation, params) req.send_request() end |
#create_data_catalog(params = {}) ⇒ Types::CreateDataCatalogOutput
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.
For a FEDERATED
catalog, this API operation creates the following
resources.
CFN Stack Name with a maximum length of 128 characters and prefix
athenafederatedcatalog-CATALOG_NAME_SANITIZED
with length 23 characters.Lambda Function Name with a maximum length of 64 characters and prefix
athenafederatedcatalog_CATALOG_NAME_SANITIZED
with length 23 characters.Glue Connection Name with a maximum length of 255 characters and a prefix
athenafederatedcatalog_CATALOG_NAME_SANITIZED
with length 23 characters.
863 864 865 866 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 863 def create_data_catalog(params = {}, = {}) req = build_request(:create_data_catalog, params) req.send_request() end |
#create_named_query(params = {}) ⇒ Types::CreateNamedQueryOutput
Creates a named query in the specified workgroup. Requires that you have access to the workgroup.
925 926 927 928 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 925 def create_named_query(params = {}, = {}) req = build_request(:create_named_query, params) req.send_request() end |
#create_notebook(params = {}) ⇒ Types::CreateNotebookOutput
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.
972 973 974 975 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 972 def create_notebook(params = {}, = {}) req = build_request(:create_notebook, params) req.send_request() end |
#create_prepared_statement(params = {}) ⇒ Struct
Creates a prepared statement for use with SQL queries in Athena.
1006 1007 1008 1009 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1006 def create_prepared_statement(params = {}, = {}) req = build_request(:create_prepared_statement, params) req.send_request() end |
#create_presigned_notebook_url(params = {}) ⇒ Types::CreatePresignedNotebookUrlResponse
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.
1046 1047 1048 1049 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1046 def create_presigned_notebook_url(params = {}, = {}) req = build_request(:create_presigned_notebook_url, params) req.send_request() end |
#create_work_group(params = {}) ⇒ Struct
Creates a workgroup with the specified name. A workgroup can be an Apache Spark enabled workgroup or an Athena SQL workgroup.
1131 1132 1133 1134 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1131 def create_work_group(params = {}, = {}) req = build_request(:create_work_group, params) req.send_request() end |
#delete_capacity_reservation(params = {}) ⇒ Struct
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
.
1158 1159 1160 1161 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1158 def delete_capacity_reservation(params = {}, = {}) req = build_request(:delete_capacity_reservation, params) req.send_request() end |
#delete_data_catalog(params = {}) ⇒ Types::DeleteDataCatalogOutput
Deletes a data catalog.
1200 1201 1202 1203 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1200 def delete_data_catalog(params = {}, = {}) req = build_request(:delete_data_catalog, params) req.send_request() end |
#delete_named_query(params = {}) ⇒ Struct
Deletes the named query if you have access to the workgroup in which the query was saved.
1226 1227 1228 1229 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1226 def delete_named_query(params = {}, = {}) req = build_request(:delete_named_query, params) req.send_request() end |
#delete_notebook(params = {}) ⇒ Struct
Deletes the specified notebook.
1248 1249 1250 1251 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1248 def delete_notebook(params = {}, = {}) req = build_request(:delete_notebook, params) req.send_request() end |
#delete_prepared_statement(params = {}) ⇒ Struct
Deletes the prepared statement with the specified name from the specified workgroup.
1275 1276 1277 1278 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1275 def delete_prepared_statement(params = {}, = {}) req = build_request(:delete_prepared_statement, params) req.send_request() end |
#delete_work_group(params = {}) ⇒ Struct
Deletes the workgroup with the specified name. The primary workgroup cannot be deleted.
1303 1304 1305 1306 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1303 def delete_work_group(params = {}, = {}) req = build_request(:delete_work_group, params) req.send_request() end |
#export_notebook(params = {}) ⇒ Types::ExportNotebookOutput
Exports the specified notebook and its metadata.
1338 1339 1340 1341 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1338 def export_notebook(params = {}, = {}) req = build_request(:export_notebook, params) req.send_request() end |
#get_calculation_execution(params = {}) ⇒ Types::GetCalculationExecutionResponse
Describes a previously submitted calculation execution.
1385 1386 1387 1388 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1385 def get_calculation_execution(params = {}, = {}) req = build_request(:get_calculation_execution, params) req.send_request() end |
#get_calculation_execution_code(params = {}) ⇒ Types::GetCalculationExecutionCodeResponse
Retrieves the unencrypted code that was executed for the calculation.
1413 1414 1415 1416 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1413 def get_calculation_execution_code(params = {}, = {}) req = build_request(:get_calculation_execution_code, params) req.send_request() end |
#get_calculation_execution_status(params = {}) ⇒ Types::GetCalculationExecutionStatusResponse
Gets the status of a current calculation.
1447 1448 1449 1450 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1447 def get_calculation_execution_status(params = {}, = {}) req = build_request(:get_calculation_execution_status, params) req.send_request() end |
#get_capacity_assignment_configuration(params = {}) ⇒ Types::GetCapacityAssignmentConfigurationOutput
Gets the capacity assignment configuration for a capacity reservation, if one exists.
1480 1481 1482 1483 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1480 def get_capacity_assignment_configuration(params = {}, = {}) req = build_request(:get_capacity_assignment_configuration, params) req.send_request() end |
#get_capacity_reservation(params = {}) ⇒ Types::GetCapacityReservationOutput
Returns information about the capacity reservation with the specified name.
1518 1519 1520 1521 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1518 def get_capacity_reservation(params = {}, = {}) req = build_request(:get_capacity_reservation, params) req.send_request() end |
#get_data_catalog(params = {}) ⇒ Types::GetDataCatalogOutput
Returns the specified data catalog.
1558 1559 1560 1561 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1558 def get_data_catalog(params = {}, = {}) req = build_request(:get_data_catalog, params) req.send_request() end |
#get_database(params = {}) ⇒ Types::GetDatabaseOutput
Returns a database object for the specified database and data catalog.
1599 1600 1601 1602 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1599 def get_database(params = {}, = {}) req = build_request(:get_database, params) req.send_request() end |
#get_named_query(params = {}) ⇒ Types::GetNamedQueryOutput
Returns information about a single query. Requires that you have access to the workgroup in which the query was saved.
1633 1634 1635 1636 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1633 def get_named_query(params = {}, = {}) req = build_request(:get_named_query, params) req.send_request() end |
#get_notebook_metadata(params = {}) ⇒ Types::GetNotebookMetadataOutput
Retrieves notebook metadata for the specified notebook ID.
1666 1667 1668 1669 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1666 def (params = {}, = {}) req = build_request(:get_notebook_metadata, params) req.send_request() end |
#get_prepared_statement(params = {}) ⇒ Types::GetPreparedStatementOutput
Retrieves the prepared statement with the specified name from the specified workgroup.
1703 1704 1705 1706 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1703 def get_prepared_statement(params = {}, = {}) req = build_request(:get_prepared_statement, params) req.send_request() end |
#get_query_execution(params = {}) ⇒ Types::GetQueryExecutionOutput
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.
1771 1772 1773 1774 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1771 def get_query_execution(params = {}, = {}) req = build_request(:get_query_execution, params) req.send_request() end |
#get_query_results(params = {}) ⇒ Types::GetQueryResultsOutput
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 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1848 1849 1850 1851 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1848 def get_query_results(params = {}, = {}) req = build_request(:get_query_results, params) req.send_request() end |
#get_query_runtime_statistics(params = {}) ⇒ Types::GetQueryRuntimeStatisticsOutput
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. Statistics from the Timeline
section of the response
object are available as soon as QueryExecutionStatus$State is in a
SUCCEEDED or FAILED state. The remaining non-timeline statistics in
the response (like stage-level input and output row count and data
size) are updated asynchronously and may not be available immediately
after a query completes. The non-timeline statistics are also not
included when a query has row-level filters defined in Lake Formation.
1908 1909 1910 1911 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1908 def get_query_runtime_statistics(params = {}, = {}) req = build_request(:get_query_runtime_statistics, params) req.send_request() end |
#get_session(params = {}) ⇒ Types::GetSessionResponse
Gets the full details of a previously created session, including the session status and configuration.
1968 1969 1970 1971 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 1968 def get_session(params = {}, = {}) req = build_request(:get_session, params) req.send_request() end |
#get_session_status(params = {}) ⇒ Types::GetSessionStatusResponse
Gets the current status of a session.
2003 2004 2005 2006 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2003 def get_session_status(params = {}, = {}) req = build_request(:get_session_status, params) req.send_request() end |
#get_table_metadata(params = {}) ⇒ Types::GetTableMetadataOutput
Returns table metadata for the specified catalog, database, and table.
2059 2060 2061 2062 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2059 def (params = {}, = {}) req = build_request(:get_table_metadata, params) req.send_request() end |
#get_work_group(params = {}) ⇒ Types::GetWorkGroupOutput
Returns information about the workgroup with the specified name.
2111 2112 2113 2114 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2111 def get_work_group(params = {}, = {}) req = build_request(:get_work_group, params) req.send_request() end |
#import_notebook(params = {}) ⇒ Types::ImportNotebookOutput
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.
2173 2174 2175 2176 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2173 def import_notebook(params = {}, = {}) req = build_request(:import_notebook, params) req.send_request() end |
#list_application_dpu_sizes(params = {}) ⇒ Types::ListApplicationDPUSizesOutput
Returns the supported DPU sizes for the supported application runtimes
(for example, Athena notebook version 1
).
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2214 2215 2216 2217 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2214 def list_application_dpu_sizes(params = {}, = {}) req = build_request(:list_application_dpu_sizes, params) req.send_request() end |
#list_calculation_executions(params = {}) ⇒ Types::ListCalculationExecutionsResponse
Lists the calculations that have been submitted to a session in descending order. Newer calculations are listed first; older calculations are listed later.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2288 2289 2290 2291 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2288 def list_calculation_executions(params = {}, = {}) req = build_request(:list_calculation_executions, params) req.send_request() end |
#list_capacity_reservations(params = {}) ⇒ Types::ListCapacityReservationsOutput
Lists the capacity reservations for the current account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2335 2336 2337 2338 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2335 def list_capacity_reservations(params = {}, = {}) req = build_request(:list_capacity_reservations, params) req.send_request() end |
#list_data_catalogs(params = {}) ⇒ Types::ListDataCatalogsOutput
Lists the data catalogs in the current Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2389 2390 2391 2392 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2389 def list_data_catalogs(params = {}, = {}) req = build_request(:list_data_catalogs, params) req.send_request() end |
#list_databases(params = {}) ⇒ Types::ListDatabasesOutput
Lists the databases in the specified data catalog.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2442 2443 2444 2445 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2442 def list_databases(params = {}, = {}) req = build_request(:list_databases, params) req.send_request() end |
#list_engine_versions(params = {}) ⇒ Types::ListEngineVersionsOutput
Returns a list of engine versions that are available to choose from, including the Auto option.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2484 2485 2486 2487 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2484 def list_engine_versions(params = {}, = {}) req = build_request(:list_engine_versions, params) req.send_request() end |
#list_executors(params = {}) ⇒ Types::ListExecutorsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2555 2556 2557 2558 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2555 def list_executors(params = {}, = {}) req = build_request(:list_executors, params) req.send_request() end |
#list_named_queries(params = {}) ⇒ Types::ListNamedQueriesOutput
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2604 2605 2606 2607 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2604 def list_named_queries(params = {}, = {}) req = build_request(:list_named_queries, params) req.send_request() end |
#list_notebook_metadata(params = {}) ⇒ Types::ListNotebookMetadataOutput
Displays the notebook files for the specified workgroup in paginated format.
2657 2658 2659 2660 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2657 def (params = {}, = {}) req = build_request(:list_notebook_metadata, params) req.send_request() end |
#list_notebook_sessions(params = {}) ⇒ Types::ListNotebookSessionsResponse
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.
2703 2704 2705 2706 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2703 def list_notebook_sessions(params = {}, = {}) req = build_request(:list_notebook_sessions, params) req.send_request() end |
#list_prepared_statements(params = {}) ⇒ Types::ListPreparedStatementsOutput
Lists the prepared statements in the specified workgroup.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2748 2749 2750 2751 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2748 def list_prepared_statements(params = {}, = {}) req = build_request(:list_prepared_statements, params) req.send_request() end |
#list_query_executions(params = {}) ⇒ Types::ListQueryExecutionsOutput
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2798 2799 2800 2801 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2798 def list_query_executions(params = {}, = {}) req = build_request(:list_query_executions, params) req.send_request() end |
#list_sessions(params = {}) ⇒ Types::ListSessionsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2878 2879 2880 2881 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2878 def list_sessions(params = {}, = {}) req = build_request(:list_sessions, params) req.send_request() end |
#list_table_metadata(params = {}) ⇒ Types::ListTableMetadataOutput
Lists the metadata for the tables in the specified data catalog database.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2952 2953 2954 2955 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2952 def (params = {}, = {}) req = build_request(:list_table_metadata, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
Lists the tags associated with an Athena resource.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2997 2998 2999 3000 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 2997 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_work_groups(params = {}) ⇒ Types::ListWorkGroupsOutput
Lists available workgroups for the account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3043 3044 3045 3046 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 3043 def list_work_groups(params = {}, = {}) req = build_request(:list_work_groups, params) req.send_request() end |
#put_capacity_assignment_configuration(params = {}) ⇒ Struct
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.
3077 3078 3079 3080 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 3077 def put_capacity_assignment_configuration(params = {}, = {}) req = build_request(:put_capacity_assignment_configuration, params) req.send_request() end |
#start_calculation_execution(params = {}) ⇒ Types::StartCalculationExecutionResponse
Submits calculations for execution within a session. You can supply the code to run as an inline code block within the request.
3145 3146 3147 3148 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 3145 def start_calculation_execution(params = {}, = {}) req = build_request(:start_calculation_execution, params) req.send_request() end |
#start_query_execution(params = {}) ⇒ Types::StartQueryExecutionOutput
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.
3248 3249 3250 3251 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 3248 def start_query_execution(params = {}, = {}) req = build_request(:start_query_execution, params) req.send_request() end |
#start_session(params = {}) ⇒ Types::StartSessionResponse
Creates a session for running calculations within a workgroup. The
session is ready when it reaches an IDLE
state.
3325 3326 3327 3328 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 3325 def start_session(params = {}, = {}) req = build_request(:start_session, params) req.send_request() end |
#stop_calculation_execution(params = {}) ⇒ Types::StopCalculationExecutionResponse
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.
3364 3365 3366 3367 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 3364 def stop_calculation_execution(params = {}, = {}) req = build_request(:stop_calculation_execution, params) req.send_request() end |
#stop_query_execution(params = {}) ⇒ Struct
Stops a query execution. Requires you to have access to the workgroup in which the query ran.
3390 3391 3392 3393 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 3390 def stop_query_execution(params = {}, = {}) req = build_request(:stop_query_execution, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
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. 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.
3438 3439 3440 3441 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 3438 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#terminate_session(params = {}) ⇒ Types::TerminateSessionResponse
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
.
3470 3471 3472 3473 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 3470 def terminate_session(params = {}, = {}) req = build_request(:terminate_session, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from an Athena resource.
3497 3498 3499 3500 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 3497 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_capacity_reservation(params = {}) ⇒ Struct
Updates the number of requested data processing units for the capacity reservation with the specified name.
3524 3525 3526 3527 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 3524 def update_capacity_reservation(params = {}, = {}) req = build_request(:update_capacity_reservation, params) req.send_request() end |
#update_data_catalog(params = {}) ⇒ Struct
Updates the data catalog that has the specified name.
3590 3591 3592 3593 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 3590 def update_data_catalog(params = {}, = {}) req = build_request(:update_data_catalog, params) req.send_request() end |
#update_named_query(params = {}) ⇒ Struct
Updates a NamedQuery object. The database or workgroup cannot be updated.
3625 3626 3627 3628 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 3625 def update_named_query(params = {}, = {}) req = build_request(:update_named_query, params) req.send_request() end |
#update_notebook(params = {}) ⇒ Struct
Updates the contents of a Spark notebook.
3671 3672 3673 3674 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 3671 def update_notebook(params = {}, = {}) req = build_request(:update_notebook, params) req.send_request() end |
#update_notebook_metadata(params = {}) ⇒ Struct
Updates the metadata for a notebook.
3708 3709 3710 3711 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 3708 def (params = {}, = {}) req = build_request(:update_notebook_metadata, params) req.send_request() end |
#update_prepared_statement(params = {}) ⇒ Struct
Updates a prepared statement.
3742 3743 3744 3745 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 3742 def update_prepared_statement(params = {}, = {}) req = build_request(:update_prepared_statement, params) req.send_request() end |
#update_work_group(params = {}) ⇒ Struct
Updates the workgroup with the specified name. The workgroup's name
cannot be changed. Only ConfigurationUpdates
can be specified.
3814 3815 3816 3817 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/client.rb', line 3814 def update_work_group(params = {}, = {}) req = build_request(:update_work_group, params) req.send_request() end |